LibreOffice Module svl (master) 1
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
SfxStyleSheetBase Class Reference

#include <style.hxx>

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

Public Member Functions

const OUString & GetName () const
 
virtual bool SetName (const OUString &rNewName, bool bReindexNow=true)
 
virtual const OUString & GetParent () const
 
virtual bool SetParent (const OUString &)
 
virtual const OUString & GetFollow () const
 Change follow. More...
 
virtual bool SetFollow (const OUString &)
 
virtual bool HasFollowSupport () const
 Next style possible? Default: Yes. More...
 
virtual bool HasParentSupport () const
 Base template possible? Default: Yes. More...
 
virtual bool HasClearParentSupport () const
 Setting base template to NULL possible? Default: No. More...
 
virtual bool IsUsed () const
 By default all stylesheets are set to used. More...
 
virtual OUString GetDescription (MapUnit eMetric)
 Return set attributes. More...
 
virtual OUString GetUsedBy ()
 
SfxStyleSheetBasePoolGetPool ()
 
SfxStyleFamily GetFamily () const
 
SfxStyleSearchBits GetMask () const
 
void SetMask (SfxStyleSearchBits mask)
 
bool IsUserDefined () const
 
virtual bool IsHidden () const
 
virtual void SetHidden (bool bValue)
 
virtual sal_uLong GetHelpId (OUString &rFile)
 Set help file and ID and return it. More...
 
virtual void SetHelpId (const OUString &r, sal_uLong nId)
 
virtual SfxItemSetGetItemSet ()
 Set Itemset The default implementation creates a new set. More...
 
virtual std::optional< SfxItemSetGetItemSetForPreview ()
 Due to writer's usual lack of sanity this is a separate function for preview only; it shall not create the style in case it does not exist. More...
 
virtual bool isScStyleSheet () const
 Fix for expensive dynamic_cast. More...
 

Protected Member Functions

 SfxStyleSheetBase (const OUString &, SfxStyleSheetBasePool *, SfxStyleFamily eFam, SfxStyleSearchBits mask)
 
 SfxStyleSheetBase (const SfxStyleSheetBase &)
 
virtual ~SfxStyleSheetBase () override
 

Protected Attributes

SfxStyleSheetBasePoolm_pPool
 
SfxStyleFamily nFamily
 
OUString aName
 
OUString aParent
 
OUString aFollow
 
OUString aHelpFile
 
SfxItemSetpSet
 
SfxStyleSearchBits nMask
 
sal_uLong nHelpId
 
bool bMySet
 
bool bHidden
 

Friends

class SfxStyleSheetBasePool
 

Detailed Description

Definition at line 114 of file style.hxx.

Constructor & Destructor Documentation

◆ SfxStyleSheetBase() [1/2]

SfxStyleSheetBase::SfxStyleSheetBase ( const OUString &  rName,
SfxStyleSheetBasePool p,
SfxStyleFamily  eFam,
SfxStyleSearchBits  mask 
)
protected

Definition at line 104 of file style.cxx.

References aDbgStyleSheetReferences, aName, and p.

◆ SfxStyleSheetBase() [2/2]

SfxStyleSheetBase::SfxStyleSheetBase ( const SfxStyleSheetBase r)
protected

Definition at line 120 of file style.cxx.

References aDbgStyleSheetReferences, aName, bMySet, and pSet.

◆ ~SfxStyleSheetBase()

SfxStyleSheetBase::~SfxStyleSheetBase ( )
overrideprotectedvirtual

Definition at line 142 of file style.cxx.

References aDbgStyleSheetReferences, bMySet, and pSet.

Member Function Documentation

◆ GetDescription()

OUString SfxStyleSheetBase::GetDescription ( MapUnit  eMetric)
virtual

◆ GetFamily()

SfxStyleFamily SfxStyleSheetBase::GetFamily ( ) const
inline

Definition at line 163 of file style.hxx.

Referenced by SfxStyleSheetBasePool::Add(), and svl::IndexedStyleSheets::Register().

◆ GetFollow()

const OUString & SfxStyleSheetBase::GetFollow ( ) const
virtual

Change follow.

Definition at line 231 of file style.cxx.

References aFollow.

◆ GetHelpId()

sal_uLong SfxStyleSheetBase::GetHelpId ( OUString &  rFile)
virtual

Set help file and ID and return it.

Definition at line 273 of file style.cxx.

References aHelpFile, and nHelpId.

◆ GetItemSet()

SfxItemSet & SfxStyleSheetBase::GetItemSet ( )
virtual

Set Itemset The default implementation creates a new set.

Definition at line 255 of file style.cxx.

References bMySet, SfxStyleSheetBasePool::GetPool(), m_pPool, and pSet.

Referenced by GetDescription(), and GetItemSetForPreview().

◆ GetItemSetForPreview()

std::optional< SfxItemSet > SfxStyleSheetBase::GetItemSetForPreview ( )
virtual

Due to writer's usual lack of sanity this is a separate function for preview only; it shall not create the style in case it does not exist.

If the style has parents, it is not required that the returned item set has parents (i.e. use it for display purposes only).

Definition at line 265 of file style.cxx.

References GetItemSet().

◆ GetMask()

SfxStyleSearchBits SfxStyleSheetBase::GetMask ( ) const
inline

Definition at line 164 of file style.hxx.

◆ GetName()

const OUString & SfxStyleSheetBase::GetName ( ) const

Definition at line 156 of file style.cxx.

References aName.

Referenced by SfxStyleSheetBasePool::Add(), svl::IndexedStyleSheets::Register(), and SetParent().

◆ GetParent()

const OUString & SfxStyleSheetBase::GetParent ( ) const
virtual

Definition at line 188 of file style.cxx.

References aParent.

Referenced by SetParent().

◆ GetPool()

SfxStyleSheetBasePool * SfxStyleSheetBase::GetPool ( )
inline

Definition at line 162 of file style.hxx.

◆ GetUsedBy()

virtual OUString SfxStyleSheetBase::GetUsedBy ( )
inlinevirtual

Definition at line 160 of file style.hxx.

◆ HasClearParentSupport()

bool SfxStyleSheetBase::HasClearParentSupport ( ) const
virtual

Setting base template to NULL possible? Default: No.

Definition at line 307 of file style.cxx.

◆ HasFollowSupport()

bool SfxStyleSheetBase::HasFollowSupport ( ) const
virtual

Next style possible? Default: Yes.

Definition at line 289 of file style.cxx.

◆ HasParentSupport()

bool SfxStyleSheetBase::HasParentSupport ( ) const
virtual

Base template possible? Default: Yes.

Definition at line 298 of file style.cxx.

◆ IsHidden()

virtual bool SfxStyleSheetBase::IsHidden ( ) const
inlinevirtual

Definition at line 169 of file style.hxx.

◆ isScStyleSheet()

virtual bool SfxStyleSheetBase::isScStyleSheet ( ) const
inlinevirtual

Fix for expensive dynamic_cast.

Definition at line 183 of file style.hxx.

◆ IsUsed()

bool SfxStyleSheetBase::IsUsed ( ) const
virtual

By default all stylesheets are set to used.

Definition at line 315 of file style.cxx.

Referenced by SfxStyleSheet::isUsedByModel().

◆ IsUserDefined()

bool SfxStyleSheetBase::IsUserDefined ( ) const
inline

Definition at line 166 of file style.hxx.

References UserDefined.

◆ SetFollow()

bool SfxStyleSheetBase::SetFollow ( const OUString &  rName)
virtual

Definition at line 236 of file style.cxx.

References aFollow.

◆ SetHelpId()

void SfxStyleSheetBase::SetHelpId ( const OUString &  r,
sal_uLong  nId 
)
virtual

Definition at line 279 of file style.cxx.

References aHelpFile, nHelpId, and nId.

◆ SetHidden()

void SfxStyleSheetBase::SetHidden ( bool  bValue)
virtual

Definition at line 222 of file style.cxx.

References bHidden, SfxBroadcaster::Broadcast(), hidden, m_pPool, and StyleSheetModified.

◆ SetMask()

void SfxStyleSheetBase::SetMask ( SfxStyleSearchBits  mask)
inline

Definition at line 165 of file style.hxx.

◆ SetName()

bool SfxStyleSheetBase::SetName ( const OUString &  rNewName,
bool  bReindexNow = true 
)
virtual

◆ SetParent()

bool SfxStyleSheetBase::SetParent ( const OUString &  rName)
virtual

Friends And Related Function Documentation

◆ SfxStyleSheetBasePool

friend class SfxStyleSheetBasePool
friend

Definition at line 117 of file style.hxx.

Member Data Documentation

◆ aFollow

OUString SfxStyleSheetBase::aFollow
protected

Definition at line 123 of file style.hxx.

Referenced by GetFollow(), SetFollow(), and SetName().

◆ aHelpFile

OUString SfxStyleSheetBase::aHelpFile
protected

Definition at line 124 of file style.hxx.

Referenced by GetHelpId(), and SetHelpId().

◆ aName

OUString SfxStyleSheetBase::aName
protected

Definition at line 123 of file style.hxx.

Referenced by GetName(), SetName(), and SetParent().

◆ aParent

OUString SfxStyleSheetBase::aParent
protected

Definition at line 123 of file style.hxx.

Referenced by GetParent(), SetParent(), and SfxStyleSheet::SetParent().

◆ bHidden

bool SfxStyleSheetBase::bHidden
protected

Definition at line 131 of file style.hxx.

Referenced by SetHidden().

◆ bMySet

bool SfxStyleSheetBase::bMySet
protected

Definition at line 130 of file style.hxx.

Referenced by GetItemSet(), SfxStyleSheetBase(), and ~SfxStyleSheetBase().

◆ m_pPool

SfxStyleSheetBasePool* SfxStyleSheetBase::m_pPool
protected

◆ nFamily

SfxStyleFamily SfxStyleSheetBase::nFamily
protected

Definition at line 121 of file style.hxx.

Referenced by SetName(), SetParent(), and SfxStyleSheet::SetParent().

◆ nHelpId

sal_uLong SfxStyleSheetBase::nHelpId
protected

Definition at line 128 of file style.hxx.

Referenced by GetHelpId(), and SetHelpId().

◆ nMask

SfxStyleSearchBits SfxStyleSheetBase::nMask
protected

Definition at line 126 of file style.hxx.

◆ pSet

SfxItemSet* SfxStyleSheetBase::pSet
protected

Definition at line 125 of file style.hxx.

Referenced by GetItemSet(), SfxStyleSheetBase(), and ~SfxStyleSheetBase().


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