LibreOffice Module sw (master) 1
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
SwFormatFootnoteEndAtTextEnd Class Reference

SfxPoolItem subclass that is a wrapper around an SwFootnoteEndPosEnum, i.e. More...

#include <fmtftntx.hxx>

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

Public Member Functions

virtual sal_uInt16 GetValueCount () const override
 
virtual bool operator== (const SfxPoolItem &) 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
 
virtual bool GetPresentation (SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText, const IntlWrapper &rIntl) const override
 
bool IsAtEnd () const
 
SwFormatFootnoteEndAtTextEndoperator= (const SwFormatFootnoteEndAtTextEnd &rAttr)
 
 SwFormatFootnoteEndAtTextEnd (SwFormatFootnoteEndAtTextEnd const &)=default
 
SvxNumType GetNumType () const
 
void SetNumType (SvxNumType eType)
 
const SvxNumberTypeGetSwNumType () const
 
sal_uInt16 GetOffset () const
 
void SetOffset (sal_uInt16 nOff)
 
const OUString & GetPrefix () const
 
void SetPrefix (const OUString &rSet)
 
const OUString & GetSuffix () const
 
void SetSuffix (const OUString &rSet)
 
- Public Member Functions inherited from SfxEnumItem< SwFootnoteEndPosEnum >
EnumT GetValue () const
 
void SetValue (EnumT nTheValue)
 
virtual sal_uInt16 GetEnumValue () const override
 
virtual void SetEnumValue (sal_uInt16 nTheValue) override
 
virtual bool operator== (SfxPoolItem const &other) const override
 
- Public Member Functions inherited from SfxEnumItemInterface
virtual bool operator== (const SfxPoolItem &rItem) const override
 
virtual bool GetPresentation (SfxItemPresentation, MapUnit, MapUnit, OUString &rText, const IntlWrapper &) const override
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt8=0) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8) override
 
virtual sal_uInt16 GetValueCount () const=0
 
virtual sal_uInt16 GetEnumValue () const=0
 
virtual void SetEnumValue (sal_uInt16 nValue)=0
 
virtual bool HasBoolValue () const
 
virtual bool GetBoolValue () const
 
virtual void SetBoolValue (bool bValue)
 
- 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
 

Protected Member Functions

 SwFormatFootnoteEndAtTextEnd (sal_uInt16 nWhichL, SwFootnoteEndPosEnum ePos)
 
- Protected Member Functions inherited from SfxEnumItem< SwFootnoteEndPosEnum >
 SfxEnumItem (sal_uInt16 const nWhich, EnumT const nValue)
 
 SfxEnumItem (const SfxEnumItem &)=default
 
- Protected Member Functions inherited from SfxEnumItemInterface
 SfxEnumItemInterface (sal_uInt16 which)
 
 SfxEnumItemInterface (const SfxEnumItemInterface &)=default
 
- Protected Member Functions inherited from SfxPoolItem
 SfxPoolItem (sal_uInt16 nWhich=0)
 
 SfxPoolItem (const SfxPoolItem &rCopy)
 

Private Attributes

OUString m_sPrefix
 
OUString m_sSuffix
 
SvxNumberType m_aFormat
 
sal_uInt16 m_nOffset
 

Additional Inherited Members

- Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator lookup_iterator
 

Detailed Description

SfxPoolItem subclass that is a wrapper around an SwFootnoteEndPosEnum, i.e.

to decide where footnotes or endnotes should be collected. Available on the UI as Format -> Sections -> <Name> -> Options -> Footnotes/Endnotes. This is the shared base class for both footnotes and endnotes.

Definition at line 42 of file fmtftntx.hxx.

Constructor & Destructor Documentation

◆ SwFormatFootnoteEndAtTextEnd() [1/2]

SwFormatFootnoteEndAtTextEnd::SwFormatFootnoteEndAtTextEnd ( sal_uInt16  nWhichL,
SwFootnoteEndPosEnum  ePos 
)
inlineprotected

Definition at line 50 of file fmtftntx.hxx.

References ePos.

◆ SwFormatFootnoteEndAtTextEnd() [2/2]

SwFormatFootnoteEndAtTextEnd::SwFormatFootnoteEndAtTextEnd ( SwFormatFootnoteEndAtTextEnd const &  )
default

Member Function Documentation

◆ GetNumType()

SvxNumType SwFormatFootnoteEndAtTextEnd::GetNumType ( ) const
inline

Definition at line 74 of file fmtftntx.hxx.

References SvxNumberType::GetNumberingType().

Referenced by SwSectionFootnoteEndTabPage::ResetState().

◆ GetOffset()

sal_uInt16 SwFormatFootnoteEndAtTextEnd::GetOffset ( ) const
inline

Definition at line 79 of file fmtftntx.hxx.

Referenced by SwSectionFootnoteEndTabPage::ResetState().

◆ GetPrefix()

const OUString & SwFormatFootnoteEndAtTextEnd::GetPrefix ( ) const
inline

◆ GetPresentation()

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

Reimplemented from SfxEnumItemInterface.

Definition at line 578 of file attrdesc.cxx.

◆ GetSuffix()

const OUString & SwFormatFootnoteEndAtTextEnd::GetSuffix ( ) const
inline

◆ GetSwNumType()

const SvxNumberType & SwFormatFootnoteEndAtTextEnd::GetSwNumType ( ) const
inline

Definition at line 77 of file fmtftntx.hxx.

Referenced by SwFormatFootnote::GetViewNumStr().

◆ GetValueCount()

sal_uInt16 SwFormatFootnoteEndAtTextEnd::GetValueCount ( ) const
overridevirtual

Implements SfxEnumItemInterface.

Definition at line 1995 of file atrfrm.cxx.

References FTNEND_ATTXTEND_END.

◆ IsAtEnd()

bool SwFormatFootnoteEndAtTextEnd::IsAtEnd ( ) const
inline

◆ operator=()

SwFormatFootnoteEndAtTextEnd & SwFormatFootnoteEndAtTextEnd::operator= ( const SwFormatFootnoteEndAtTextEnd rAttr)

◆ operator==()

bool SwFormatFootnoteEndAtTextEnd::operator== ( const SfxPoolItem rItem) const
overridevirtual

◆ PutValue()

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

◆ QueryValue()

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

◆ SetNumType()

void SwFormatFootnoteEndAtTextEnd::SetNumType ( SvxNumType  eType)
inline

Definition at line 75 of file fmtftntx.hxx.

References eType, and SvxNumberType::SetNumberingType().

Referenced by SwSectionFootnoteEndTabPage::FillItemSet().

◆ SetOffset()

void SwFormatFootnoteEndAtTextEnd::SetOffset ( sal_uInt16  nOff)
inline

Definition at line 80 of file fmtftntx.hxx.

Referenced by SwSectionFootnoteEndTabPage::FillItemSet().

◆ SetPrefix()

void SwFormatFootnoteEndAtTextEnd::SetPrefix ( const OUString &  rSet)
inline

Definition at line 83 of file fmtftntx.hxx.

References rSet.

Referenced by SwSectionFootnoteEndTabPage::FillItemSet().

◆ SetSuffix()

void SwFormatFootnoteEndAtTextEnd::SetSuffix ( const OUString &  rSet)
inline

Definition at line 86 of file fmtftntx.hxx.

References rSet.

Referenced by SwSectionFootnoteEndTabPage::FillItemSet().

Member Data Documentation

◆ m_aFormat

SvxNumberType SwFormatFootnoteEndAtTextEnd::m_aFormat
private

Definition at line 46 of file fmtftntx.hxx.

Referenced by operator=(), operator==(), PutValue(), and QueryValue().

◆ m_nOffset

sal_uInt16 SwFormatFootnoteEndAtTextEnd::m_nOffset
private

Definition at line 47 of file fmtftntx.hxx.

Referenced by operator=(), operator==(), PutValue(), and QueryValue().

◆ m_sPrefix

OUString SwFormatFootnoteEndAtTextEnd::m_sPrefix
private

Definition at line 44 of file fmtftntx.hxx.

Referenced by operator=(), operator==(), PutValue(), and QueryValue().

◆ m_sSuffix

OUString SwFormatFootnoteEndAtTextEnd::m_sSuffix
private

Definition at line 45 of file fmtftntx.hxx.

Referenced by operator=(), operator==(), PutValue(), and QueryValue().


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