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

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

#include <fmtpdsc.hxx>

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

Public Member Functions

 SwFormatPageDesc (const SwPageDesc *pDesc=nullptr)
 
 SwFormatPageDesc (const SwFormatPageDesc &rCpy)
 
SwFormatPageDescoperator= (const SwFormatPageDesc &rCpy)
 
virtual ~SwFormatPageDesc () override
 
virtual bool operator== (const SfxPoolItem &) const override
 "Pure virtual methods" of SfxPoolItem. More...
 
virtual SwFormatPageDescClone (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
 
SwPageDescGetPageDesc ()
 
const SwPageDescGetPageDesc () const
 
const ::std::optional< sal_uInt16 > & GetNumOffset () const
 
void SetNumOffset (const ::std::optional< sal_uInt16 > &oNum)
 
const sw::BroadcastingModifyGetDefinedIn () 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 SfxPoolItemClone (SfxItemPool *pPool=nullptr) const=0
 
std::unique_ptr< SfxPoolItemCloneSetWhich (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::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
 
void CheckRegistrationFormat (SwFormat &rOld)
 
const SwModifyGetRegisteredIn () const
 
SwModifyGetRegisteredIn ()
 
void EndListeningAll ()
 
void StartListeningToSameModifyAs (const SwClient &)
 
virtual bool GetInfo (SfxPoolItem &) const
 
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
 
virtual const SwCellFrameDynCastCellFrame () const
 
virtual const SwTabFrameDynCastTabFrame () const
 
virtual const SwRowFrameDynCastRowFrame () const
 
virtual const SwTableDynCastTable () 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::BroadcastingModifym_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)
 
SwModifyGetRegisteredInNonConst () 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

◆ 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 SwFrame::GetVirtPageNum(), SwAttrSet::SetModifyAtAttr(), and SwClientNotify().

◆ GetNumOffset()

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

◆ GetPageDesc() [1/2]

SwPageDesc * SwFormatPageDesc::GetPageDesc ( )
inline

◆ 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

◆ 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

◆ RegisterToPageDesc()

void SwFormatPageDesc::RegisterToPageDesc ( SwPageDesc rDesc)

◆ SetNumOffset()

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

◆ SwClientNotify()

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

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: