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

#include <docufld.hxx>

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

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 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 GetFormula () const
 
void ChangeFormat (sal_uInt32 n)
 
virtual void SetPar1 (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)
 
virtual OUString GetDescription () const
 
bool IsClickable () const
 Is this field clickable? More...
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 

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

Constructor & Destructor Documentation

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 164 of file docufld.cxx.

Referenced by Copy().

Member Function Documentation

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

Definition at line 173 of file docufld.cxx.

References m_nMaxPage, and m_nPageNumber.

std::unique_ptr< SwField > SwPageNumberField::Copy ( ) const
overridevirtual
OUString SwPageNumberField::ExpandImpl ( SwRootFrame const *  pLayout) const
overridevirtual
OUString SwPageNumberField::GetPar2 ( ) const
overridevirtual

Reimplemented from SwField.

Definition at line 216 of file docufld.cxx.

References m_nOffset.

sal_uInt16 SwPageNumberField::GetSubType ( ) const
overridevirtual

Reimplemented from SwField.

Definition at line 226 of file docufld.cxx.

References m_nSubType.

const OUString& SwPageNumberField::GetUserString ( ) const
inline

Definition at line 170 of file docufld.hxx.

bool SwPageNumberField::PutValue ( const css::uno::Any &  rVal,
sal_uInt16  nWhich 
)
overridevirtual
bool SwPageNumberField::QueryValue ( css::uno::Any &  rVal,
sal_uInt16  nWhich 
) const
overridevirtual
void SwPageNumberField::SetPar2 ( const OUString &  rStr)
overridevirtual

Reimplemented from SwField.

Definition at line 221 of file docufld.cxx.

References m_nOffset.

void SwPageNumberField::SetUserString ( const OUString &  rS)
inline

Definition at line 171 of file docufld.hxx.

Referenced by SwXTextField::attach().

Member Data Documentation

sal_uInt16 SwPageNumberField::m_nMaxPage
private

Definition at line 149 of file docufld.hxx.

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

short SwPageNumberField::m_nOffset
private

Definition at line 146 of file docufld.hxx.

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

sal_uInt16 SwPageNumberField::m_nPageNumber
private

Definition at line 148 of file docufld.hxx.

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

sal_uInt16 SwPageNumberField::m_nSubType
private

Definition at line 145 of file docufld.hxx.

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

OUString SwPageNumberField::m_sUserStr
private

Definition at line 144 of file docufld.hxx.

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


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