Pagedescriptor Client of SwPageDesc that is "described" by the attribute. More...

#include <fmtpdsc.hxx>

Inheritance diagram for SwFormatPageDesc:

Collaboration diagram for SwFormatPageDesc:

Public Member Functions
	SwFormatPageDesc (const SwPageDesc *pDesc=nullptr)

	SwFormatPageDesc (const SwFormatPageDesc &rCpy)

SwFormatPageDesc &	operator= (const SwFormatPageDesc &rCpy)

virtual	~SwFormatPageDesc () override

virtual bool	operator== (const SfxPoolItem &) const override
	"Pure virtual methods" of SfxPoolItem. More...

virtual SwFormatPageDesc *	Clone (SfxItemPool *pPool=nullptr) const override

virtual bool	GetPresentation (SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText, const IntlWrapper &rIntl) const override

virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const override

virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId) override

SwPageDesc *	GetPageDesc ()

const SwPageDesc *	GetPageDesc () const

const ::std::optional< sal_uInt16 > &	GetNumOffset () const

void	SetNumOffset (const ::std::optional< sal_uInt16 > &oNum)

const sw::BroadcastingModify *	GetDefinedIn () const
	Query / set where attribute is anchored. More...

void	ChgDefinedIn (const sw::BroadcastingModify *pNew)

void	RegisterToPageDesc (SwPageDesc &)

bool	KnowsPageDesc () const

void	dumpAsXml (xmlTextWriterPtr pWriter) const override

Public Member Functions inherited from SfxPoolItem
void	AddRef (sal_uInt32 n=1) const

virtual	~SfxPoolItem ()

void	SetWhich (sal_uInt16 nId)

sal_uInt16	Which () const

T &	StaticWhichCast (TypedWhichId< T > nId)

const T &	StaticWhichCast (TypedWhichId< T > nId) const

T *	DynamicWhichCast (TypedWhichId< T > nId)

const T *	DynamicWhichCast (TypedWhichId< T > nId) const

virtual bool	operator== (const SfxPoolItem &) const=0

bool	operator!= (const SfxPoolItem &rItem) const

virtual bool	operator< (const SfxPoolItem &) const

virtual bool	IsSortable () const

virtual bool	HasLookup () const

virtual lookup_iterator	Lookup (lookup_iterator, lookup_iterator end) const

virtual bool	GetPresentation (SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const

virtual void	ScaleMetrics (tools::Long lMult, tools::Long lDiv)

virtual bool	HasMetrics () const

virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const

virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId)

virtual SfxPoolItem *	Clone (SfxItemPool *pPool=nullptr) const=0

std::unique_ptr< SfxPoolItem >	CloneSetWhich (sal_uInt16 nNewWhich) const

std::unique_ptr< T >	CloneSetWhich (TypedWhichId< T > nId) const

sal_uInt32	GetRefCount () const

SfxItemKind	GetKind () const

virtual void	dumpAsXml (xmlTextWriterPtr pWriter) const

virtual boost::property_tree::ptree	dumpAsJSON () const

virtual bool	IsVoidItem () const

Public Member Functions inherited from SwClient
	SwClient ()

	SwClient (SwClient &&) noexcept

virtual	~SwClient () override

std::optional< sw::ModifyChangedHint >	CheckRegistration (const SfxPoolItem *pOldValue)

void	CheckRegistrationFormat (SwFormat &rOld)

const SwModify *	GetRegisteredIn () const

SwModify *	GetRegisteredIn ()

void	EndListeningAll ()

void	StartListeningToSameModifyAs (const SwClient &)

virtual bool	GetInfo (SfxPoolItem &) const

Public Member Functions inherited from sw::WriterListener
bool	IsLast () const

virtual const SwCellFrame *	DynCastCellFrame () const

virtual const SwTabFrame *	DynCastTabFrame () const

virtual const SwRowFrame *	DynCastRowFrame () const

virtual const SwTable *	DynCastTable () const

Private Member Functions
virtual void	SwClientNotify (const SwModify &, const SfxHint &rHint) override

Private Attributes
::std::optional< sal_uInt16 >	m_oNumOffset
	Offset page number. More...

sw::BroadcastingModify *	m_pDefinedIn
	Points to the object in which the attribute was set (ContentNode/Format). More...

Additional Inherited Members
Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator	lookup_iterator

Protected Member Functions inherited from SfxPoolItem
	SfxPoolItem (sal_uInt16 nWhich=0)

	SfxPoolItem (const SfxPoolItem &rCopy)

Protected Member Functions inherited from SwClient
	SwClient (SwModify *pToRegisterIn)

SwModify *	GetRegisteredInNonConst () const

virtual void	SwClientNotify (const SwModify &, const SfxHint &rHint) override

Protected Member Functions inherited from sw::WriterListener
	WriterListener ()

virtual	~WriterListener () COVERITY_NOEXCEPT_FALSE

virtual void	SwClientNotify (const SwModify &, const SfxHint &rHint)=0

Detailed Description

Pagedescriptor Client of SwPageDesc that is "described" by the attribute.

Definition at line 35 of file fmtpdsc.hxx.

Constructor & Destructor Documentation

◆ SwFormatPageDesc() [1/2]

SwFormatPageDesc::SwFormatPageDesc ( const SwPageDesc * pDesc = nullptr )

Definition at line 639 of file atrfrm.cxx.

Referenced by Clone().

◆ SwFormatPageDesc() [2/2]

SwFormatPageDesc::SwFormatPageDesc ( const SwFormatPageDesc & rCpy )

Definition at line 631 of file atrfrm.cxx.

◆ ~SwFormatPageDesc()

SwFormatPageDesc::~SwFormatPageDesc ( )

overridevirtual

Definition at line 659 of file atrfrm.cxx.

Member Function Documentation

◆ ChgDefinedIn()

void SwFormatPageDesc::ChgDefinedIn ( const sw::BroadcastingModify * pNew )

inline

Definition at line 69 of file fmtpdsc.hxx.

Referenced by SwAttrSet::SetModifyAtAttr(), SwHistorySetAttrSet::SwHistorySetAttrSet(), and SwHistorySetFormat::SwHistorySetFormat().

◆ Clone()

SwFormatPageDesc * SwFormatPageDesc::Clone ( SfxItemPool * pPool = nullptr ) const

overridevirtual

Implements SfxPoolItem.

Definition at line 674 of file atrfrm.cxx.

References SwFormatPageDesc().

◆ dumpAsXml()

void SwFormatPageDesc::dumpAsXml ( xmlTextWriterPtr pWriter ) const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 793 of file atrfrm.cxx.

References GetPageDesc(), m_oNumOffset, and SfxPoolItem::Which().

◆ GetDefinedIn()

const sw::BroadcastingModify * SwFormatPageDesc::GetDefinedIn ( ) const

inline

Query / set where attribute is anchored.

Definition at line 68 of file fmtpdsc.hxx.

Referenced by SwNode::FindPageDesc(), SwFrame::GetVirtPageNum(), SwAttrSet::SetModifyAtAttr(), and SwClientNotify().

◆ GetNumOffset()

const ::std::optional< sal_uInt16 > & SwFormatPageDesc::GetNumOffset ( ) const

inline

Definition at line 64 of file fmtpdsc.hxx.

Referenced by MSWordSections::AppendSection(), SwLayHelper::CheckInsertPage(), SwFEShell::ChgCurPageDesc(), SwAttrSet::CopyToModify(), SwTextFlowPage::FillItemSet(), SwFEShell::GetPageOffset(), SwFrame::GetVirtPageNum(), SwRootFrame::Init(), SwFrame::InsertPage(), wwSectionManager::InsertSegments(), MSWordExportBase::OutputSectionBreaks(), QueryValue(), SvXMLExportItemMapper::QueryXMLValue(), SwFEShell::SetPageOffset(), SwToSfxPageDescAttr(), SwFrame::WannaRightPage(), and SwFrame::WrongPageDesc().

◆ GetPageDesc() [1/2]

SwPageDesc * SwFormatPageDesc::GetPageDesc ( )

inline

Definition at line 61 of file fmtpdsc.hxx.

References SwClient::GetRegisteredIn().

Referenced by SwDoc::AppendDoc(), MSWordSections::AppendSection(), SwHTMLParser::BuildTableCell(), SwLayHelper::CheckInsertPage(), SwFEShell::ChgCurPageDesc(), SwDoc::CopyFormatArr(), SwAttrSet::CopyToModify(), dumpAsXml(), RtfExport::ExportDocument_Impl(), SwTextFlowPage::FillItemSet(), SwPageFrame::FindPageDesc(), GetPresentation(), SwAutoFormat::HasBreakAttr(), sw::HasPageBreakBefore(), SwRootFrame::Init(), SwFrame::InsertPage(), wwSectionManager::InsertSegments(), lcl_RemoveBreaks(), SwHTMLWriter::MakeHeader(), UnfloatTableButton::MouseButtonDown(), SwHTMLParser::MovePageDescAttrs(), MSWordExportBase::NoPageBreakSection(), operator=(), operator==(), OutCSS1_SvxFormatBreak_SwFormatPDesc_SvxFormatKeep(), OutHTML_SwTextNode(), MSWordExportBase::OutputSectionBreaks(), SwTabFrame::Paste(), QueryValue(), SwToSfxPageDescAttr(), SwTOXBaseSection::Update(), SwFrame::WannaRightPage(), and SwFrame::WrongPageDesc().

◆ GetPageDesc() [2/2]

const SwPageDesc * SwFormatPageDesc::GetPageDesc ( ) const

inline

Definition at line 62 of file fmtpdsc.hxx.

References SwClient::GetRegisteredIn().

◆ GetPresentation()

bool SwFormatPageDesc::GetPresentation	(	SfxItemPresentation	ePres,
		MapUnit	eCoreMetric,
		MapUnit	ePresMetric,
		OUString &	rText,
		const IntlWrapper &	rIntl
	)		const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 455 of file attrdesc.cxx.

References SwPageDesc::GetName(), GetPageDesc(), and SwResId().

◆ KnowsPageDesc()

bool SwFormatPageDesc::KnowsPageDesc ( ) const

Definition at line 661 of file atrfrm.cxx.

References SwClient::GetRegisteredIn().

Referenced by AttributeOutputBase::FormatPageDescription(), MSWordExportBase::OutputSectionBreaks(), and MSWordExportBase::OutputTextNode().

◆ operator=()

SwFormatPageDesc & SwFormatPageDesc::operator= ( const SwFormatPageDesc & rCpy )

Definition at line 646 of file atrfrm.cxx.

References GetPageDesc(), m_oNumOffset, m_pDefinedIn, and RegisterToPageDesc().

◆ operator==()

bool SwFormatPageDesc::operator== ( const SfxPoolItem & rAttr ) const

overridevirtual

"Pure virtual methods" of SfxPoolItem.

Implements SfxPoolItem.

Definition at line 666 of file atrfrm.cxx.

References GetPageDesc(), m_oNumOffset, and m_pDefinedIn.

◆ PutValue()

bool SwFormatPageDesc::PutValue	(	const css::uno::Any &	rVal,
		sal_uInt8	nMemberId
	)

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 760 of file atrfrm.cxx.

References uno::Any::hasValue(), MID_PAGEDESC_PAGEDESCNAME, MID_PAGEDESC_PAGENUMOFFSET, and SetNumOffset().

◆ QueryValue()

bool SwFormatPageDesc::QueryValue	(	css::uno::Any &	rVal,
		sal_uInt8	nMemberId = `0`
	)		const

overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 719 of file atrfrm.cxx.

References SwStyleNameMapper::FillProgName(), SwPageDesc::GetName(), GetNumOffset(), GetPageDesc(), MID_PAGEDESC_PAGEDESCNAME, MID_PAGEDESC_PAGENUMOFFSET, and PageDesc.

Referenced by SwXAutoStyle::getProperties().

◆ RegisterToPageDesc()

void SwFormatPageDesc::RegisterToPageDesc ( SwPageDesc & rDesc )

Definition at line 714 of file atrfrm.cxx.

Referenced by SwDoc::AppendDoc(), SwDoc::CopyFormatArr(), operator=(), SfxToSwPageDescAttr(), and SwClientNotify().

◆ SetNumOffset()

void SwFormatPageDesc::SetNumOffset ( const ::std::optional< sal_uInt16 > & oNum )

inline

Definition at line 65 of file fmtpdsc.hxx.

Referenced by SwDoc::AppendDoc(), SwFEShell::ChgCurPageDesc(), SwAttrSet::CopyToModify(), SwTextFlowPage::FillItemSet(), IMPL_LINK_NOARG(), SwWrtShell::InsertPageBreak(), lcl_SetAPageOffset(), PutValue(), SvXMLImportItemMapper::PutXMLValue(), wwSectionManager::SetSwFormatPageDesc(), and SfxToSwPageDescAttr().

◆ SwClientNotify()

void SwFormatPageDesc::SwClientNotify	(	const SwModify &	,
		const SfxHint &	rHint
	)

overrideprivatevirtual

Reimplemented from SwClient.

Definition at line 679 of file atrfrm.cxx.

References SwClient::EndListeningAll(), GetDefinedIn(), SfxHint::GetId(), m_pDefinedIn, name, RegisterToPageDesc(), RES_OBJECTDYING(), SAL_WARN, SetAttr, and SwFormat::SetFormatAttr().

Member Data Documentation

◆ m_oNumOffset

::std::optional<sal_uInt16> SwFormatPageDesc::m_oNumOffset

private

Offset page number.

Definition at line 37 of file fmtpdsc.hxx.

Referenced by dumpAsXml(), operator=(), and operator==().

◆ m_pDefinedIn

sw::BroadcastingModify* SwFormatPageDesc::m_pDefinedIn

private

Points to the object in which the attribute was set (ContentNode/Format).

Definition at line 38 of file fmtpdsc.hxx.

Referenced by operator=(), operator==(), and SwClientNotify().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SwFormatPageDesc() [1/2]

◆ SwFormatPageDesc() [2/2]

◆ ~SwFormatPageDesc()

Member Function Documentation

◆ ChgDefinedIn()

◆ Clone()

◆ dumpAsXml()

◆ GetDefinedIn()

◆ GetNumOffset()

◆ GetPageDesc() [1/2]

◆ GetPageDesc() [2/2]

◆ GetPresentation()

◆ KnowsPageDesc()

◆ operator=()

◆ operator==()

◆ PutValue()

◆ QueryValue()

◆ RegisterToPageDesc()

◆ SetNumOffset()

◆ SwClientNotify()

Member Data Documentation

◆ m_oNumOffset

◆ m_pDefinedIn