#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< SwField >	Copy () 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

SwField &	operator= (SwField const &)=default

SwField &	operator= (SwField &&)=default

SwFieldType *	GetTyp () const

virtual SwFieldType *	ChgTyp (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< SwField >	CopyField () 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

overridevirtual

Implements SwField.

Definition at line 210 of file docufld.cxx.

References SwField::GetFormat(), SwField::GetLanguage(), SwField::GetTyp(), m_nMaxPage, m_nOffset, m_nPageNumber, m_nSubType, m_sUserStr, and SwPageNumberField().

◆ ExpandImpl()

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

overridevirtual

Implements SwField.

Definition at line 184 of file docufld.cxx.

References SwPageNumberFieldType::Expand(), SwField::GetFormat(), SwField::GetLanguage(), SwField::GetTyp(), m_nMaxPage, m_nOffset, m_nPageNumber, m_nSubType, m_sUserStr, PG_NEXT, and PG_PREV.

◆ GetPar2()

OUString SwPageNumberField::GetPar2 ( ) const

overridevirtual

Reimplemented from SwField.

Definition at line 220 of file docufld.cxx.

References m_nOffset.

◆ GetSubType()

sal_uInt16 SwPageNumberField::GetSubType ( ) const

overridevirtual

Reimplemented from SwField.

Definition at line 230 of file docufld.cxx.

References m_nSubType.

◆ GetUserString()

const OUString & SwPageNumberField::GetUserString ( ) const

inline

Definition at line 175 of file docufld.hxx.

◆ PutValue()

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

overridevirtual

Reimplemented from SwField.

Definition at line 266 of file docufld.cxx.

References FIELD_PROP_FORMAT, FIELD_PROP_PAR1, FIELD_PROP_SUBTYPE, FIELD_PROP_USHORT1, SWUnoHelper::GetEnumAsInt32(), m_nOffset, m_nSubType, m_sUserStr, PG_NEXT, PG_PREV, PG_RANDOM, SwField::SetFormat(), and SVX_NUM_PAGEDESC.

◆ QueryValue()

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

overridevirtual

Reimplemented from SwField.

Definition at line 235 of file docufld.cxx.

References eType, FIELD_PROP_FORMAT, FIELD_PROP_PAR1, FIELD_PROP_SUBTYPE, FIELD_PROP_USHORT1, SwField::GetFormat(), m_nOffset, m_nSubType, m_sUserStr, PG_NEXT, and PG_PREV.

◆ SetPar2()

void SwPageNumberField::SetPar2 ( const OUString & rStr )

overridevirtual

Reimplemented from SwField.

Definition at line 225 of file docufld.cxx.

References m_nOffset.

◆ SetUserString()

void SwPageNumberField::SetUserString ( const OUString & rS )

inline

Definition at line 176 of file docufld.hxx.

Referenced by SwXTextField::attach().

Member Data Documentation

◆ m_nMaxPage

sal_uInt16 SwPageNumberField::m_nMaxPage

private

Definition at line 154 of file docufld.hxx.

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

◆ m_nOffset

short SwPageNumberField::m_nOffset

private

Definition at line 151 of file docufld.hxx.

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

◆ m_nPageNumber

sal_uInt16 SwPageNumberField::m_nPageNumber

private

Definition at line 153 of file docufld.hxx.

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

◆ m_nSubType

sal_uInt16 SwPageNumberField::m_nSubType

private

Definition at line 150 of file docufld.hxx.

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

◆ m_sUserStr

OUString SwPageNumberField::m_sUserStr

private

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:

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SwPageNumberField()

Member Function Documentation

◆ ChangeExpansion()

◆ Copy()

◆ ExpandImpl()

◆ GetPar2()

◆ GetSubType()

◆ GetUserString()

◆ PutValue()

◆ QueryValue()

◆ SetPar2()

◆ SetUserString()

Member Data Documentation

◆ m_nMaxPage

◆ m_nOffset

◆ m_nPageNumber

◆ m_nSubType

◆ m_sUserStr