LibreOffice Module sw (master)  1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SwAuthorityField Class Reference

invariant for SwAuthorityField is that it is always registered at its SwAuthorityFieldType via AddField()/RemoveField() & therefore has m_nHandle set - but it's possible that multiple SwAuthorityField have the same m_nHandle & so the number of instances is an upper bound on SwAuthorityField::m_DataArr.size() - it's not clear to me if more than one one of the instances with the same m_nHandle is actually in the document, they're all cloned via CopyField()... More...

#include <authfld.hxx>

Inheritance diagram for SwAuthorityField:
[legend]
Collaboration diagram for SwAuthorityField:
[legend]

Public Member Functions

OUString ConditionalExpandAuthIdentifier (SwRootFrame const *pLayout) const
 For internal use only, in general continue using ExpandField() instead. More...
 
SW_DLLPUBLIC OUString ExpandCitation (ToxAuthorityField eField, SwRootFrame const *pLayout) const
 
 SwAuthorityField (SwAuthorityFieldType *pType, const OUString &rFieldContents)
 
 SwAuthorityField (SwAuthorityFieldType *pType, SwAuthEntry *pAuthEntry)
 
virtual ~SwAuthorityField () override
 
const OUString & GetFieldText (ToxAuthorityField eField) const
 
virtual void SetPar1 (const OUString &rStr) override
 
virtual SwFieldTypeChgTyp (SwFieldType *) override
 Set new type (used for copying among documents). More...
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt16 nWhichId) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt16 nWhichId) override
 
SwAuthEntryGetAuthEntry () const
 
virtual OUString GetDescription () const override
 
- Public Member Functions inherited from SwField
virtual ~SwField ()
 
 SwField (SwField const &)=default
 
 SwField (SwField &&)=default
 
SwFieldoperator= (SwField const &)=default
 
SwFieldoperator= (SwField &&)=default
 
SwFieldTypeGetTyp () const
 
OUString ExpandField (bool bCached, SwRootFrame const *pLayout) const
 expand the field. More...
 
virtual OUString GetFieldName () const
 get name or content More...
 
std::unique_ptr< SwFieldCopyField () const
 
SwFieldIds Which () const
 ResId. More...
 
sal_uInt16 GetTypeId () const
 
virtual sal_uInt16 GetSubType () const
 
virtual void SetSubType (sal_uInt16)
 
LanguageType GetLanguage () const
 Language at field position. More...
 
virtual void SetLanguage (LanguageType nLng)
 
sal_uInt32 GetFormat () const
 Query parameters for dialog and for BASIC. More...
 
virtual OUString GetPar1 () const
 
virtual OUString GetPar2 () const
 
virtual OUString GetFormula () const
 
void ChangeFormat (sal_uInt32 n)
 
virtual void SetPar2 (const OUString &rStr)
 
bool HasClickHdl () const
 Does the field possess an action on its ClickHandler? (e.g. INetFields, ...). More...
 
bool IsFixed () const
 
bool IsAutomaticLanguage () const
 
void SetAutomaticLanguage (bool const bSet)
 
bool IsClickable () const
 Is this field clickable? More...
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 

Private Member Functions

virtual OUString ExpandImpl (SwRootFrame const *pLayout) const override
 
virtual std::unique_ptr< SwFieldCopy () const override
 

Private Attributes

rtl::Reference< SwAuthEntrym_xAuthEntry
 
sal_IntPtr m_nTempSequencePos
 
sal_IntPtr m_nTempSequencePosRLHidden
 hidden redlines More...
 

Additional Inherited Members

- Protected Member Functions inherited from SwField
void SetFormat (sal_uInt32 const nSet)
 
 SwField (SwFieldType *pTyp, sal_uInt32 nFormat=0, LanguageType nLang=LANGUAGE_SYSTEM, bool m_bUseFieldValueCache=true)
 

Detailed Description

invariant for SwAuthorityField is that it is always registered at its SwAuthorityFieldType via AddField()/RemoveField() & therefore has m_nHandle set - but it's possible that multiple SwAuthorityField have the same m_nHandle & so the number of instances is an upper bound on SwAuthorityField::m_DataArr.size() - it's not clear to me if more than one one of the instances with the same m_nHandle is actually in the document, they're all cloned via CopyField()...

Definition at line 148 of file authfld.hxx.

Constructor & Destructor Documentation

SwAuthorityField::SwAuthorityField ( SwAuthorityFieldType pType,
const OUString &  rFieldContents 
)

Definition at line 459 of file authfld.cxx.

References SwAuthorityFieldType::AddField(), and m_xAuthEntry.

SwAuthorityField::SwAuthorityField ( SwAuthorityFieldType pType,
SwAuthEntry pAuthEntry 
)

Definition at line 468 of file authfld.cxx.

SwAuthorityField::~SwAuthorityField ( )
overridevirtual

Definition at line 477 of file authfld.cxx.

References SwField::GetTyp(), and m_xAuthEntry.

Member Function Documentation

SwFieldType * SwAuthorityField::ChgTyp ( SwFieldType pNewType)
overridevirtual

Set new type (used for copying among documents).

Set a new type.

This is needed/used for copying between documents. Needs to be always of the same type.

Parameters
pNewTypeThe new type.
Returns
The old type.

Reimplemented from SwField.

Definition at line 665 of file authfld.cxx.

References SwField::ChgTyp(), SwField::GetTyp(), m_xAuthEntry, and SwAuthorityFieldType::RemoveField().

OUString SwAuthorityField::ConditionalExpandAuthIdentifier ( SwRootFrame const *  pLayout) const
std::unique_ptr< SwField > SwAuthorityField::Copy ( ) const
overrideprivatevirtual

Implements SwField.

Definition at line 539 of file authfld.cxx.

References SwField::GetTyp(), and m_xAuthEntry.

OUString SwAuthorityField::ExpandCitation ( ToxAuthorityField  eField,
SwRootFrame const *  pLayout 
) const
OUString SwAuthorityField::ExpandImpl ( SwRootFrame const *  pLayout) const
overrideprivatevirtual

Implements SwField.

Definition at line 482 of file authfld.cxx.

References ConditionalExpandAuthIdentifier().

SwAuthEntry* SwAuthorityField::GetAuthEntry ( ) const
inline

Definition at line 176 of file authfld.hxx.

Referenced by SwAuthorityFieldType::GetSequencePos().

OUString SwAuthorityField::GetDescription ( ) const
overridevirtual

Reimplemented from SwField.

Definition at line 557 of file authfld.cxx.

References SwResId().

const OUString & SwAuthorityField::GetFieldText ( ToxAuthorityField  eField) const
bool SwAuthorityField::PutValue ( const css::uno::Any &  rVal,
sal_uInt16  nWhichId 
)
overridevirtual
bool SwAuthorityField::QueryValue ( css::uno::Any &  rVal,
sal_uInt16  nWhichId 
) const
overridevirtual

Reimplemented from SwField.

Definition at line 597 of file authfld.cxx.

References aFieldNames, AUTH_FIELD_AUTHORITY_TYPE, AUTH_FIELD_END, SwField::GetTyp(), i, and m_xAuthEntry.

void SwAuthorityField::SetPar1 ( const OUString &  rStr)
overridevirtual

Member Data Documentation

sal_IntPtr SwAuthorityField::m_nTempSequencePos
mutableprivate

Definition at line 151 of file authfld.hxx.

Referenced by ConditionalExpandAuthIdentifier(), and ExpandCitation().

sal_IntPtr SwAuthorityField::m_nTempSequencePosRLHidden
mutableprivate

hidden redlines

Definition at line 152 of file authfld.hxx.

Referenced by ConditionalExpandAuthIdentifier(), and ExpandCitation().

rtl::Reference<SwAuthEntry> SwAuthorityField::m_xAuthEntry
private

The documentation for this class was generated from the following files: