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

#include <docufld.hxx>

Inheritance diagram for SwPageNumberField:
Collaboration diagram for SwPageNumberField:

Public Member Functions

 SwPageNumberField (SwPageNumberFieldType *, sal_uInt16 nSub, sal_uInt32 nFormat, short nOff=0, sal_uInt16 const nPageNumber=0, sal_uInt16 const nMaxPage=0)
void ChangeExpansion (sal_uInt16 const nPageNumber, sal_uInt16 const nMaxPage)
virtual OUString ExpandImpl (SwRootFrame const *pLayout) const override
virtual std::unique_ptr< SwFieldCopy () const override
virtual OUString GetPar2 () const override
virtual void SetPar2 (const OUString &rStr) override
virtual sal_uInt16 GetSubType () const override
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt16 nWhich) const override
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt16 nWhich) override
const OUString & GetUserString () const
void SetUserString (const OUString &rS)
- 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 Attributes

OUString m_sUserStr
sal_uInt16 m_nSubType
short m_nOffset
sal_uInt16 m_nPageNumber
sal_uInt16 m_nMaxPage

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 147 of file docufld.hxx.

Constructor & Destructor Documentation

◆ SwPageNumberField()

SwPageNumberField::SwPageNumberField ( SwPageNumberFieldType pTyp,
sal_uInt16  nSub,
sal_uInt32  nFormat,
short  nOff = 0,
sal_uInt16 const  nPageNumber = 0,
sal_uInt16 const  nMaxPage = 0 

Definition at line 168 of file docufld.cxx.

Referenced by Copy().

Member Function Documentation

◆ ChangeExpansion()

void SwPageNumberField::ChangeExpansion ( sal_uInt16 const  nPageNumber,
sal_uInt16 const  nMaxPage 

Definition at line 177 of file docufld.cxx.

References m_nMaxPage, and m_nPageNumber.

◆ Copy()

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

◆ ExpandImpl()

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

◆ GetPar2()

OUString SwPageNumberField::GetPar2 ( ) const

Reimplemented from SwField.

Definition at line 220 of file docufld.cxx.

References m_nOffset.

◆ GetSubType()

sal_uInt16 SwPageNumberField::GetSubType ( ) const

Reimplemented from SwField.

Definition at line 230 of file docufld.cxx.

References m_nSubType.

◆ GetUserString()

const OUString & SwPageNumberField::GetUserString ( ) const

Definition at line 175 of file docufld.hxx.

◆ PutValue()

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

◆ QueryValue()

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

◆ SetPar2()

void SwPageNumberField::SetPar2 ( const OUString &  rStr)

Reimplemented from SwField.

Definition at line 225 of file docufld.cxx.

References m_nOffset.

◆ SetUserString()

void SwPageNumberField::SetUserString ( const OUString &  rS)

Definition at line 176 of file docufld.hxx.

Referenced by SwXTextField::attach().

Member Data Documentation

◆ m_nMaxPage

sal_uInt16 SwPageNumberField::m_nMaxPage

Definition at line 154 of file docufld.hxx.

Referenced by ChangeExpansion(), Copy(), and ExpandImpl().

◆ m_nOffset

short SwPageNumberField::m_nOffset

Definition at line 151 of file docufld.hxx.

Referenced by Copy(), ExpandImpl(), GetPar2(), PutValue(), QueryValue(), and SetPar2().

◆ m_nPageNumber

sal_uInt16 SwPageNumberField::m_nPageNumber

Definition at line 153 of file docufld.hxx.

Referenced by ChangeExpansion(), Copy(), and ExpandImpl().

◆ m_nSubType

sal_uInt16 SwPageNumberField::m_nSubType

Definition at line 150 of file docufld.hxx.

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

◆ m_sUserStr

OUString SwPageNumberField::m_sUserStr

Definition at line 149 of file docufld.hxx.

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

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