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

Represents the style of a paragraph. More...

#include <fmtcol.hxx>

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

Public Member Functions

virtual ~SwTextFormatColl ()
 
void SetNextTextFormatColl (SwTextFormatColl &rNext)
 Inline implementations. More...
 
SwTextFormatColl & GetNextTextFormatColl () const
 
void SetLinkedCharFormat (SwCharFormat *pLink)
 
const SwCharFormat * GetLinkedCharFormat () const
 
bool IsAtDocNodeSet () const
 
void SetAttrOutlineLevel (int)
 
int GetAttrOutlineLevel () const
 
int GetAssignedOutlineStyleLevel () const
 
bool IsAssignedToListLevelOfOutlineStyle () const
 
void AssignToListLevelOfOutlineStyle (const int nAssignedListLevel)
 
void DeleteAssignmentToListLevelOfOutlineStyle ()
 
virtual bool SetFormatAttr (const SfxPoolItem &rAttr) override
 Override to recognize changes on the <SwNumRuleItem> and register/unregister the paragragh style at the corresponding <SwNumRule> instance. More...
 
virtual bool SetFormatAttr (const SfxItemSet &rSet) override
 
virtual bool ResetFormatAttr (sal_uInt16 nWhich1, sal_uInt16 nWhich2=0) override
 
virtual sal_uInt16 ResetAllFormatAttr () override
 Override <ResetAllFormatAttr()> to stay assigned to list level of outline style. More...
 
bool StayAssignedToListLevelOfOutlineStyle () const
 
::sw::ListLevelIndents AreListLevelIndentsApplicable () const
 
bool AreListLevelIndentsApplicableImpl (sal_uInt16 nWhich) const
 
void dumpAsXml (xmlTextWriterPtr pWriter) const
 
virtual void FormatDropNotify (const SwFormatDrop &rDrop) override
 
bool IsInSwFntCache () const
 
void SetInSwFntCache ()
 
virtual void InvalidateInSwFntCache (sal_uInt16 nWhich) override
 
- Public Member Functions inherited from SwFormat
virtual ~SwFormat () override
 
SwFormat & operator= (const SwFormat &)
 
sal_uInt16 Which () const
 for Querying of Writer-functions. More...
 
void CopyAttrs (const SwFormat &)
 Copy attributes even among documents. More...
 
void DelDiffs (const SfxItemSet &rSet)
 Delete all attributes that are not in rFormat. More...
 
void DelDiffs (const SwFormat &rFormat)
 
bool SetDerivedFrom (SwFormat *pDerivedFrom=nullptr)
 0 is Default. More...
 
const SfxPoolItem & GetFormatAttr (sal_uInt16 nWhich, bool bInParents=true) const
 If bInParents is FALSE, search only in this format for attribute. More...
 
template<class T >
const T & GetFormatAttr (TypedWhichId< T > nWhich, bool bInParents=true) const
 
SfxItemState GetItemState (sal_uInt16 nWhich, bool bSrchInParent=true, const SfxPoolItem **ppItem=nullptr) const
 
template<class T >
SfxItemState GetItemState (TypedWhichId< T > nWhich, bool bSrchInParent=true, const T **ppItem=nullptr) const
 
template<class T >
const T * GetItemIfSet (TypedWhichId< T > nWhich, bool bSrchInParent=true) const
 Templatized version of GetItemState() to directly return the correct type. More...
 
SfxItemState GetBackgroundState (std::unique_ptr< SvxBrushItem > &rItem) const
 
virtual bool SetFormatAttr (const SfxPoolItem &rAttr)
 
virtual bool SetFormatAttr (const SfxItemSet &rSet)
 
virtual bool ResetFormatAttr (sal_uInt16 nWhich1, sal_uInt16 nWhich2=0)
 
virtual sal_uInt16 ResetAllFormatAttr ()
 Takes all hints from Delta-Array,. More...
 
SwFormat * DerivedFrom () const
 
bool IsDefault () const
 
const OUString & GetName () const
 
bool HasName (std::u16string_view rName) const
 
virtual void SetFormatName (const OUString &rNewName, bool bBroadcast=false)
 
const SwAttrSet & GetAttrSet () const
 For querying the attribute array. More...
 
const SwDoc * GetDoc () const
 The document is set in SwAttrPool now, therefore you always can access it. More...
 
SwDoc * GetDoc ()
 
const IDocumentSettingAccess & getIDocumentSettingAccess () const
 Provides access to the document settings interface. More...
 
const IDocumentDrawModelAccess & getIDocumentDrawModelAccess () const
 Provides access to the document draw model interface. More...
 
IDocumentDrawModelAccess & getIDocumentDrawModelAccess ()
 
const IDocumentLayoutAccess & getIDocumentLayoutAccess () const
 Provides access to the document layout interface. More...
 
IDocumentLayoutAccess & getIDocumentLayoutAccess ()
 
IDocumentTimerAccess & getIDocumentTimerAccess ()
 Provides access to the document idle timer interface. More...
 
IDocumentFieldsAccess & getIDocumentFieldsAccess ()
 Provides access to the document idle timer interface. More...
 
IDocumentChartDataProviderAccess & getIDocumentChartDataProviderAccess ()
 Gives access to the chart data-provider. More...
 
sal_uInt16 GetPoolFormatId () const
 Get and set Pool style IDs. More...
 
void SetPoolFormatId (sal_uInt16 nId)
 
sal_uInt16 GetPoolHelpId () const
 Get and set Help-IDs for document templates. More...
 
void SetPoolHelpId (sal_uInt16 nId)
 
sal_uInt8 GetPoolHlpFileId () const
 
void SetPoolHlpFileId (sal_uInt8 nId)
 
void GetPresentation (SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText) const
 Get attribute-description. Returns passed string. More...
 
bool IsAuto () const
 Query / set AutoFormat-flag. More...
 
void SetAuto (bool bNew)
 
bool IsHidden () const
 
void SetHidden (bool bValue)
 
void GetGrabBagItem (css::uno::Any &rVal) const
 
void SetGrabBagItem (const css::uno::Any &rVal)
 
bool IsAutoUpdateOnDirectFormat () const
 Query / set m_bAutoUpdateOnDirectFormat-flag. More...
 
void SetAutoUpdateOnDirectFormat (bool bNew=true)
 
bool IsFormatInDTOR () const
 
const SvxUnderlineItem & GetUnderline (bool=true) const
 GetMethods: Bool indicates whether to search only in Set (FALSE) or also in Parents. More...
 
const SvxFontHeightItem & GetSize (bool=true) const
 
const SvxFontItem & GetFont (bool=true) const
 
const SvxColorItem & GetColor (bool=true) const
 
const SvxFontItem & GetCJKFont (bool=true) const
 
const SvxFontItem & GetCTLFont (bool=true) const
 
const SwFormatFillOrder & GetFillOrder (bool=true) const
 Frame-attributes - implemented in frmatr.hxx. More...
 
const SwFormatFrameSize & GetFrameSize (bool=true) const
 
const SwFormatHeader & GetHeader (bool=true) const
 
const SwFormatFooter & GetFooter (bool=true) const
 
const SwFormatSurround & GetSurround (bool=true) const
 
const SwFormatHoriOrient & GetHoriOrient (bool=true) const
 
const SwFormatAnchor & GetAnchor (bool=true) const
 
const SwFormatCol & GetCol (bool=true) const
 
const SvxPaperBinItem & GetPaperBin (bool=true) const
 
const SvxLeftMarginItem & GetLeftMargin (bool=true) const
 
const SvxTextLeftMarginItem & GetTextLeftMargin (bool=true) const
 
const SvxFirstLineIndentItem & GetFirstLineIndent (bool=true) const
 
const SvxRightMarginItem & GetRightMargin (bool=true) const
 
const SvxGutterLeftMarginItem & GetGutterLeftMargin (bool=true) const
 
const SvxGutterRightMarginItem & GetGutterRightMargin (bool=true) const
 
const SvxLRSpaceItem & GetLRSpace (bool=true) const
 
const SvxULSpaceItem & GetULSpace (bool=true) const
 
const SwFormatContent & GetContent (bool=true) const
 
const SvxPrintItem & GetPrint (bool=true) const
 
const SvxOpaqueItem & GetOpaque (bool=true) const
 
const SvxProtectItem & GetProtect (bool=true) const
 
const SwFormatVertOrient & GetVertOrient (bool=true) const
 
const SvxBoxItem & GetBox (bool=true) const
 
const SvxFormatKeepItem & GetKeep (bool=true) const
 
std::unique_ptr< SvxBrushItem > makeBackgroundBrushItem (bool=true) const
 
const SvxShadowItem & GetShadow (bool=true) const
 
const SwFormatPageDesc & GetPageDesc (bool=true) const
 
const SvxFormatBreakItem & GetBreak (bool=true) const
 
const SvxMacroItem & GetMacro (bool=true) const
 
const SwFormatURL & GetURL (bool=true) const
 
const SwFormatEditInReadonly & GetEditInReadonly (bool=true) const
 
const SwFormatLayoutSplit & GetLayoutSplit (bool=true) const
 
const SwFormatRowSplit & GetRowSplit (bool=true) const
 
const SwFormatFlySplit & GetFlySplit (bool=true) const
 
const SwFormatChain & GetChain (bool=true) const
 
const SwFormatFootnoteAtTextEnd & GetFootnoteAtTextEnd (bool=true) const
 
const SwFormatEndAtTextEnd & GetEndAtTextEnd (bool=true) const
 
const SwFormatNoBalancedColumns & GetBalancedColumns (bool=true) const
 
const SvxFrameDirectionItem & GetFrameDir (bool=true) const
 
const SwTextGridItem & GetTextGrid (bool=true) const
 
const SwHeaderAndFooterEatSpacingItem & GetHeaderAndFooterEatSpacing (bool=true) const
 
const SwFormatFollowTextFlow & GetFollowTextFlow (bool=true) const
 
const SwFormatWrapInfluenceOnObjPos & GetWrapInfluenceOnObjPos (bool=true) const
 
const SdrTextVertAdjustItem & GetTextVertAdjust (bool=true) const
 
const SvxLineSpacingItem & GetLineSpacing (bool=true) const
 Paragraph-attributes - implemented in paratr.hxx. More...
 
const SwNumRuleItem & GetNumRule (bool=true) const
 
const SvxTabStopItem & GetTabStops (bool=true) const
 
const SwFormatDrop & GetDrop (bool=true) const
 
const SwTableBoxNumFormat & GetTableBoxNumFormat (bool=true) const
 TableBox attributes - implemented in cellatr.hxx. More...
 
const SwTableBoxFormula & GetTableBoxFormula (bool=true) const
 
const SwTableBoxValue & GetTableBoxValue (bool=true) const
 
void SetPageFormatToDefault ()
 
virtual bool IsBackgroundTransparent () const
 SwFormat::IsBackgroundTransparent. More...
 
virtual drawinglayer::attribute::SdrAllFillAttributesHelperPtr getSdrAllFillAttributesHelper () const
 
virtual bool supportsFullDrawingLayerFillAttributeSet () const
 
void RemoveAllUnos ()
 
- Public Member Functions inherited from sw::BorderCacheOwner
 BorderCacheOwner ()
 
 BorderCacheOwner (BorderCacheOwner &)
 
BorderCacheOwner & operator= (const BorderCacheOwner &)
 
 ~BorderCacheOwner ()
 
bool IsInCache () const
 
void InvalidateInSwCache (const sal_uInt16)
 
virtual void FormatDropNotify (const SwFormatDrop &)=0
 

Protected Member Functions

 SwTextFormatColl (SwAttrPool &rPool, const char *pFormatCollName, SwTextFormatColl *pDerFrom=nullptr, sal_uInt16 nFormatWh=RES_TXTFMTCOLL)
 
 SwTextFormatColl (SwAttrPool &rPool, const OUString &rFormatCollName, SwTextFormatColl *pDerFrom, sal_uInt16 nFormatWh=RES_TXTFMTCOLL)
 
virtual void SwClientNotify (const SwModify &, const SfxHint &) override
 To get UL- / LR- / FontHeight-changes. More...
 
- Protected Member Functions inherited from SwFormatColl
 SwFormatColl (SwAttrPool &rPool, const char *pFormatName, const WhichRangesContainer &pWhichRanges, SwFormatColl *pDerFrom, sal_uInt16 nFormatWhich)
 
 SwFormatColl (SwAttrPool &rPool, const OUString &rFormatName, const WhichRangesContainer &pWhichRanges, SwFormatColl *pDerFrom, sal_uInt16 nFormatWhich)
 
- Protected Member Functions inherited from SwFormat
 SwFormat (SwAttrPool &rPool, const char *pFormatNm, const WhichRangesContainer &pWhichRanges, SwFormat *pDrvdFrame, sal_uInt16 nFormatWhich)
 
 SwFormat (SwAttrPool &rPool, OUString aFormatNm, const WhichRangesContainer &pWhichRanges, SwFormat *pDrvdFrame, sal_uInt16 nFormatWhich)
 
 SwFormat (const SwFormat &rFormat)
 
virtual void SwClientNotify (const SwModify &, const SfxHint &) override
 
- Protected Member Functions inherited from sw::FormatDropDefiner
virtual ~FormatDropDefiner ()
 

Private Member Functions

 SwTextFormatColl (const SwTextFormatColl &rRef)=delete
 

Private Attributes

bool mbStayAssignedToListLevelOfOutlineStyle
 
bool mbAssignedToOutlineStyle
 
bool m_bInSwFntCache
 
SwTextFormatColl * mpNextTextFormatColl
 
SwCharFormat * mpLinkedCharFormat = nullptr
 

Friends

class SwDoc
 
class ::sw::DocumentStylePoolManager
 

Detailed Description

Represents the style of a paragraph.

Definition at line 58 of file fmtcol.hxx.

Constructor & Destructor Documentation

◆ SwTextFormatColl() [1/3]

SwTextFormatColl::SwTextFormatColl ( const SwTextFormatColl &  rRef)
privatedelete

◆ SwTextFormatColl() [2/3]

SwTextFormatColl::SwTextFormatColl ( SwAttrPool &  rPool,
const char *  pFormatCollName,
SwTextFormatColl *  pDerFrom = nullptr,
sal_uInt16  nFormatWh = RES_TXTFMTCOLL 
)
inlineprotected

Definition at line 78 of file fmtcol.hxx.

◆ SwTextFormatColl() [3/3]

SwTextFormatColl::SwTextFormatColl ( SwAttrPool &  rPool,
const OUString &  rFormatCollName,
SwTextFormatColl *  pDerFrom,
sal_uInt16  nFormatWh = RES_TXTFMTCOLL 
)
inlineprotected

Definition at line 89 of file fmtcol.hxx.

◆ ~SwTextFormatColl()

SwTextFormatColl::~SwTextFormatColl ( )
virtual

Definition at line 110 of file fmtcol.cxx.

References SwCache::Delete(), SwFormat::GetDoc(), m_bInSwFntCache, and pSwFontCache.

Member Function Documentation

◆ AreListLevelIndentsApplicable()

sw::ListLevelIndents SwTextFormatColl::AreListLevelIndentsApplicable ( ) const

◆ AreListLevelIndentsApplicableImpl()

bool SwTextFormatColl::AreListLevelIndentsApplicableImpl ( sal_uInt16  nWhich) const

◆ AssignToListLevelOfOutlineStyle()

void SwTextFormatColl::AssignToListLevelOfOutlineStyle ( const int  nAssignedListLevel)

◆ DeleteAssignmentToListLevelOfOutlineStyle()

void SwTextFormatColl::DeleteAssignmentToListLevelOfOutlineStyle ( )

◆ dumpAsXml()

void SwTextFormatColl::dumpAsXml ( xmlTextWriterPtr  pWriter) const

◆ FormatDropNotify()

virtual void SwTextFormatColl::FormatDropNotify ( const SwFormatDrop &  rDrop)
inlineoverridevirtual

Implements sw::FormatDropDefiner.

Definition at line 150 of file fmtcol.hxx.

◆ GetAssignedOutlineStyleLevel()

int SwTextFormatColl::GetAssignedOutlineStyleLevel ( ) const

◆ GetAttrOutlineLevel()

int SwTextFormatColl::GetAttrOutlineLevel ( ) const

◆ GetLinkedCharFormat()

const SwCharFormat * SwTextFormatColl::GetLinkedCharFormat ( ) const

Definition at line 382 of file fmtcol.cxx.

References mpLinkedCharFormat.

Referenced by SwDocStyleSheet::FillStyleSheet().

◆ GetNextTextFormatColl()

SwTextFormatColl & SwTextFormatColl::GetNextTextFormatColl ( ) const
inline

◆ InvalidateInSwFntCache()

virtual void SwTextFormatColl::InvalidateInSwFntCache ( sal_uInt16  nWhich)
inlineoverridevirtual

Reimplemented from SwFormat.

Definition at line 157 of file fmtcol.hxx.

References isCHRATR(), RES_ATTRSET_CHG(), RES_FMT_CHG(), and RES_OBJECTDYING().

◆ IsAssignedToListLevelOfOutlineStyle()

bool SwTextFormatColl::IsAssignedToListLevelOfOutlineStyle ( ) const
inline

◆ IsAtDocNodeSet()

bool SwTextFormatColl::IsAtDocNodeSet ( ) const

◆ IsInSwFntCache()

bool SwTextFormatColl::IsInSwFntCache ( ) const
inline

Definition at line 155 of file fmtcol.hxx.

◆ ResetAllFormatAttr()

sal_uInt16 SwTextFormatColl::ResetAllFormatAttr ( )
overridevirtual

◆ ResetFormatAttr()

bool SwTextFormatColl::ResetFormatAttr ( sal_uInt16  nWhich1,
sal_uInt16  nWhich2 = 0 
)
overridevirtual

◆ SetAttrOutlineLevel()

void SwTextFormatColl::SetAttrOutlineLevel ( int  nLevel)

Definition at line 666 of file fmtcol.cxx.

References MAXLEVEL, RES_PARATR_OUTLINELEVEL(), and SetFormatAttr().

Referenced by AssignToListLevelOfOutlineStyle().

◆ SetFormatAttr() [1/2]

bool SwTextFormatColl::SetFormatAttr ( const SfxItemSet &  rSet)
overridevirtual

◆ SetFormatAttr() [2/2]

bool SwTextFormatColl::SetFormatAttr ( const SfxPoolItem &  rAttr)
overridevirtual

◆ SetInSwFntCache()

void SwTextFormatColl::SetInSwFntCache ( )
inline

Definition at line 156 of file fmtcol.hxx.

Referenced by SwFontAccess::NewObj().

◆ SetLinkedCharFormat()

void SwTextFormatColl::SetLinkedCharFormat ( SwCharFormat *  pLink)

Definition at line 380 of file fmtcol.cxx.

References mpLinkedCharFormat, and pLink.

Referenced by SwDocStyleSheet::SetLink().

◆ SetNextTextFormatColl()

void SwTextFormatColl::SetNextTextFormatColl ( SwTextFormatColl &  rNext)
inline

◆ StayAssignedToListLevelOfOutlineStyle()

bool SwTextFormatColl::StayAssignedToListLevelOfOutlineStyle ( ) const
inline

◆ SwClientNotify()

void SwTextFormatColl::SwClientNotify ( const SwModify &  rModify,
const SfxHint &  rHint 
)
overrideprotectedvirtual

Friends And Related Function Documentation

◆ ::sw::DocumentStylePoolManager

friend class ::sw::DocumentStylePoolManager
friend

Definition at line 63 of file fmtcol.hxx.

◆ SwDoc

friend class SwDoc
friend

Definition at line 62 of file fmtcol.hxx.

Member Data Documentation

◆ m_bInSwFntCache

bool SwTextFormatColl::m_bInSwFntCache
private

Definition at line 71 of file fmtcol.hxx.

Referenced by ~SwTextFormatColl().

◆ mbAssignedToOutlineStyle

bool SwTextFormatColl::mbAssignedToOutlineStyle
private

◆ mbStayAssignedToListLevelOfOutlineStyle

bool SwTextFormatColl::mbStayAssignedToListLevelOfOutlineStyle
private

Definition at line 67 of file fmtcol.hxx.

Referenced by ResetAllFormatAttr().

◆ mpLinkedCharFormat

SwCharFormat* SwTextFormatColl::mpLinkedCharFormat = nullptr
private

Definition at line 75 of file fmtcol.hxx.

Referenced by dumpAsXml(), GetLinkedCharFormat(), and SetLinkedCharFormat().

◆ mpNextTextFormatColl

SwTextFormatColl* SwTextFormatColl::mpNextTextFormatColl
private

Definition at line 73 of file fmtcol.hxx.

Referenced by dumpAsXml(), and SetNextTextFormatColl().


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