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

#include <chpfld.hxx>

Inheritance diagram for SwChapterField:
Collaboration diagram for SwChapterField:


struct  State

Public Member Functions

 SwChapterField (SwChapterFieldType *, sal_uInt32 nFormat=0)
void ChangeExpansion (const SwFrame &, const SwContentNode *, bool bSrchNum=false)
void ChangeExpansion (const SwTextNode &rNd, bool bSrchNum, SwRootFrame const *pLayout=nullptr)
sal_uInt8 GetLevel (SwRootFrame const *pLayout=nullptr) const
void SetLevel (sal_uInt8)
const OUString & GetNumber (SwRootFrame const *pLayout=nullptr) const
const OUString & GetTitle (SwRootFrame const *pLayout=nullptr) const
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 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

State m_State
State m_StateRLHidden


class SwChapterFieldType
class ToxTextGeneratorTest

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

Definition at line 48 of file chpfld.hxx.

Constructor & Destructor Documentation

◆ SwChapterField()

SwChapterField::SwChapterField ( SwChapterFieldType pTyp,
sal_uInt32  nFormat = 0 

Definition at line 74 of file chpfld.cxx.

Referenced by Copy().

Member Function Documentation

◆ ChangeExpansion() [1/2]

void SwChapterField::ChangeExpansion ( const SwFrame rFrame,
const SwContentNode pContentNode,
bool  bSrchNum = false 

◆ ChangeExpansion() [2/2]

void SwChapterField::ChangeExpansion ( const SwTextNode rNd,
bool  bSrchNum,
SwRootFrame const *  pLayout = nullptr 

◆ Copy()

std::unique_ptr< SwField > SwChapterField::Copy ( ) const

Implements SwField.

Definition at line 122 of file chpfld.cxx.

References SwField::GetFormat(), SwField::GetTyp(), m_State, m_StateRLHidden, and SwChapterField().

◆ ExpandImpl()

OUString SwChapterField::ExpandImpl ( SwRootFrame const *  pLayout) const

◆ GetLevel()

sal_uInt8 SwChapterField::GetLevel ( SwRootFrame const *  pLayout = nullptr) const

◆ GetNumber()

const OUString & SwChapterField::GetNumber ( SwRootFrame const *  pLayout = nullptr) const

◆ GetTitle()

const OUString & SwChapterField::GetTitle ( SwRootFrame const *  pLayout = nullptr) const

◆ PutValue()

bool SwChapterField::PutValue ( const css::uno::Any &  rVal,
sal_uInt16  nWhich 

◆ QueryValue()

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

◆ SetLevel()

void SwChapterField::SetLevel ( sal_uInt8  nLev)

Friends And Related Function Documentation

◆ SwChapterFieldType

friend class SwChapterFieldType

Definition at line 50 of file chpfld.hxx.

◆ ToxTextGeneratorTest

friend class ToxTextGeneratorTest

Definition at line 51 of file chpfld.hxx.

Member Data Documentation

◆ m_State

State SwChapterField::m_State

◆ m_StateRLHidden

State SwChapterField::m_StateRLHidden

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