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

#include <docufld.hxx>

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

Public Member Functions

 SwDocInfoField (SwDocInfoFieldType *, sal_uInt16 nSub, const OUString &rName, sal_uInt32 nFormat=0)
 
 SwDocInfoField (SwDocInfoFieldType *, sal_uInt16 nSub, const OUString &rName, const OUString &rValue, sal_uInt32 nFormat=0)
 
virtual void SetSubType (sal_uInt16) override
 
virtual sal_uInt16 GetSubType () const override
 
virtual void SetLanguage (LanguageType nLng) override
 set language of the format More...
 
virtual OUString GetFieldName () const override
 get name or content More...
 
const OUString & GetName () const
 
void SetName (const OUString &rName)
 
void SetExpansion (const OUString &rStr)
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt16 nWhich) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt16 nWhich) override
 
- Public Member Functions inherited from SwValueField
virtual ~SwValueField () override
 
virtual SwFieldTypeChgTyp (SwFieldType *) override
 Set a new type. More...
 
virtual void SetLanguage (LanguageType nLng) override
 set language of the format More...
 
SwDocGetDoc () const
 
virtual double GetValue () const
 
virtual void SetValue (const double &rVal)
 
OUString ExpandValue (const double &rVal, sal_uInt32 nFormat, LanguageType nLng) const
 
void dumpAsXml (xmlTextWriterPtr pWriter) 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
 
virtual SwFieldTypeChgTyp (SwFieldType *)
 Set new type (used for copying among documents). More...
 
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...
 
SwFieldTypesEnum 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 SetPar1 (const OUString &rStr)
 
virtual void SetPar2 (const OUString &rStr)
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt16 nWhichId) const
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt16 nWhichId)
 
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)
 
virtual OUString GetDescription () const
 
bool IsClickable () const
 Is this field clickable? More...
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 
const OUString & GetTitle () const
 
void SetTitle (const OUString &rTitle)
 

Private Member Functions

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

Private Attributes

sal_uInt16 m_nSubType
 
OUString m_aContent
 
OUString m_aName
 

Additional Inherited Members

- Static Public Member Functions inherited from SwValueField
static sal_uInt32 GetSystemFormat (SvNumberFormatter *pFormatter, sal_uInt32 nFormat)
 get format in office language More...
 
- Protected Member Functions inherited from SwValueField
 SwValueField (SwValueFieldType *pFieldType, sal_uInt32 nFormat, LanguageType nLang=LANGUAGE_SYSTEM, const double fVal=0.0)
 
 SwValueField (const SwValueField &rField)
 
- 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

Definition at line 531 of file docufld.hxx.

Constructor & Destructor Documentation

◆ SwDocInfoField() [1/2]

SwDocInfoField::SwDocInfoField ( SwDocInfoFieldType pTyp,
sal_uInt16  nSub,
const OUString &  rName,
sal_uInt32  nFormat = 0 
)

Definition at line 1011 of file docufld.cxx.

References Expand, SwField::GetLanguage(), SwField::GetTyp(), m_aContent, m_aName, and m_nSubType.

Referenced by Copy().

◆ SwDocInfoField() [2/2]

SwDocInfoField::SwDocInfoField ( SwDocInfoFieldType pTyp,
sal_uInt16  nSub,
const OUString &  rName,
const OUString &  rValue,
sal_uInt32  nFormat = 0 
)

Definition at line 1018 of file docufld.cxx.

References m_aContent, and m_aName.

Member Function Documentation

◆ Copy()

std::unique_ptr< SwField > SwDocInfoField::Copy ( ) const
overrideprivatevirtual

◆ ExpandImpl()

OUString SwDocInfoField::ExpandImpl ( SwRootFrame const *  pLayout) const
overrideprivatevirtual

◆ GetFieldName()

OUString SwDocInfoField::GetFieldName ( ) const
overridevirtual

◆ GetName()

const OUString & SwDocInfoField::GetName ( ) const
inline

◆ GetSubType()

sal_uInt16 SwDocInfoField::GetSubType ( ) const
overridevirtual

Reimplemented from SwField.

Definition at line 1154 of file docufld.cxx.

References m_nSubType.

Referenced by sw::DocumentFieldsManager::SetFixFields(), and SwXTextField::update().

◆ PutValue()

bool SwDocInfoField::PutValue ( const css::uno::Any &  rVal,
sal_uInt16  nWhich 
)
overridevirtual

◆ QueryValue()

bool SwDocInfoField::QueryValue ( css::uno::Any &  rVal,
sal_uInt16  nWhich 
) const
overridevirtual

◆ SetExpansion()

void SwDocInfoField::SetExpansion ( const OUString &  rStr)
inline

Definition at line 550 of file docufld.hxx.

References m_aContent.

Referenced by sw::DocumentFieldsManager::SetFixFields(), and SwXTextField::update().

◆ SetLanguage()

void SwDocInfoField::SetLanguage ( LanguageType  nLng)
overridevirtual

set language of the format

Reimplemented from SwValueField.

Definition at line 1164 of file docufld.cxx.

References SwField::GetFormat(), SwField::SetLanguage(), and SwValueField::SetLanguage().

◆ SetName()

void SwDocInfoField::SetName ( const OUString &  rName)
inline

Definition at line 549 of file docufld.hxx.

References m_aName.

Referenced by SwFieldPage::InsertField().

◆ SetSubType()

void SwDocInfoField::SetSubType ( sal_uInt16  nSub)
overridevirtual

Reimplemented from SwField.

Definition at line 1159 of file docufld.cxx.

References m_nSubType.

Member Data Documentation

◆ m_aContent

OUString SwDocInfoField::m_aContent
private

Definition at line 534 of file docufld.hxx.

Referenced by Copy(), ExpandImpl(), PutValue(), QueryValue(), and SwDocInfoField().

◆ m_aName

OUString SwDocInfoField::m_aName
private

Definition at line 535 of file docufld.hxx.

Referenced by Copy(), ExpandImpl(), GetFieldName(), QueryValue(), and SwDocInfoField().

◆ m_nSubType

sal_uInt16 SwDocInfoField::m_nSubType
private

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