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

#include <pagedesc.hxx>

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

Classes

struct  change_name
 

Public Member Functions

const OUString & GetName () const
 
bool SetName (const OUString &rNewName)
 
bool GetLandscape () const
 
void SetLandscape (bool bNew)
 
const SvxNumberTypeGetNumType () const
 
void SetNumType (const SvxNumberType &rNew)
 
const SwPageFootnoteInfoGetFootnoteInfo () const
 
SwPageFootnoteInfoGetFootnoteInfo ()
 
void SetFootnoteInfo (const SwPageFootnoteInfo &rNew)
 
bool IsHeaderShared () const
 
bool IsFooterShared () const
 
void ChgHeaderShare (bool bNew)
 
void ChgFooterShare (bool bNew)
 
bool IsFirstShared () const
 
void ChgFirstShare (bool bNew)
 
bool IsHidden () const
 
void SetHidden (bool const bValue)
 
void SetUseOn (UseOnPage eNew)
 Same as WriteUseOn(), but the >= HeaderShare part of the bitfield is not modified. More...
 
UseOnPage GetUseOn () const
 
void WriteUseOn (UseOnPage const eNew)
 
UseOnPage ReadUseOn () const
 
SwFrameFormatGetMaster ()
 
SwFrameFormatGetLeft ()
 
SwFrameFormatGetFirstMaster ()
 
SwFrameFormatGetFirstLeft ()
 
const SwFrameFormatGetMaster () const
 
const SwFrameFormatGetLeft () const
 
const SwFrameFormatGetFirstMaster () const
 
const SwFrameFormatGetFirstLeft () const
 
void ResetAllMasterAttr ()
 Reset all attrs of the format but keep the ones a pagedesc cannot live without. More...
 
SwFrameFormatGetRightFormat (bool const bFirst=false)
 Layout uses the following methods to obtain a format in order to be able to create a page. More...
 
const SwFrameFormatGetRightFormat (bool const bFirst=false) const
 
SwFrameFormatGetLeftFormat (bool const bFirst=false)
 
const SwFrameFormatGetLeftFormat (bool const bFirst=false) const
 
sal_uInt16 GetRegHeight () const
 
sal_uInt16 GetRegAscent () const
 
void SetRegHeight (sal_uInt16 const nNew)
 
void SetRegAscent (sal_uInt16 const nNew)
 
drawing::TextVerticalAdjust GetVerticalAdjustment () const
 
void SetVerticalAdjustment (const drawing::TextVerticalAdjust nVA)
 
void SetFollow (const SwPageDesc *pNew)
 
const SwPageDescGetFollow () const
 
SwPageDescGetFollow ()
 
void SetRegisterFormatColl (const SwTextFormatColl *rFormat)
 set the style for the grid alignment More...
 
const SwTextFormatCollGetRegisterFormatColl () const
 retrieve the style for the grid alignment More...
 
void RegisterChange ()
 notify all affected page frames More...
 
sal_uInt16 GetPoolFormatId () const
 Query and set PoolFormat-Id. More...
 
void SetPoolFormatId (sal_uInt16 const nId)
 
sal_uInt16 GetPoolHelpId () const
 
void SetPoolHelpId (sal_uInt16 const nId)
 
sal_uInt8 GetPoolHlpFileId () const
 
void SetPoolHlpFileId (sal_uInt8 const nId)
 
virtual bool GetInfo (SfxPoolItem &) const override
 Query information from Client. More...
 
const SwFrameFormatGetPageFormatOfNode (const SwNode &rNd, bool bCheckForThisPgDc=true) const
 
bool IsFollowNextPageOfNode (const SwNode &rNd) const
 
SwPageDescoperator= (const SwPageDesc &)
 
 SwPageDesc (const SwPageDesc &)
 
virtual ~SwPageDesc () override
 
- Public Member Functions inherited from SwModify
 SwModify ()
 
 SwModify (SwModify *pToRegisterIn)
 
void NotifyClients (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void ModifyBroadcast (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
virtual void CallSwClientNotify (const SfxHint &rHint) const
 
virtual ~SwModify () override
 
void Add (SwClient *pDepend)
 
SwClientRemove (SwClient *pDepend)
 
bool HasWriterListeners () const
 
void LockModify ()
 
void UnlockModify ()
 
void SetInCache (bool bNew)
 
void SetInSwFntCache (bool bNew)
 
void SetInDocDTOR ()
 
bool IsModifyLocked () const
 
bool IsInCache () const
 
bool IsInSwFntCache () const
 
void CheckCaching (const sal_uInt16 nWhich)
 
bool HasOnlyOneListener () const
 
- Public Member Functions inherited from SwClient
 SwClient ()
 
 SwClient (SwClient &&) noexcept
 
virtual ~SwClient () override
 
std::unique_ptr< sw::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
 
virtual void ModifyNotification (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void SwClientNotifyCall (const SwModify &rModify, const SfxHint &rHint)
 
const SwModifyGetRegisteredIn () const
 
SwModifyGetRegisteredIn ()
 
void EndListeningAll ()
 
void StartListeningToSameModifyAs (const SwClient &)
 
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
 
- Public Member Functions inherited from sw::BroadcasterMixin
 BroadcasterMixin ()=default
 
 BroadcasterMixin (BroadcasterMixin const &)=default
 
BroadcasterMixinoperator= (const BroadcasterMixin &)
 
SvtBroadcasterGetNotifier ()
 

Static Public Member Functions

static const SwPageDescGetPageDescOfNode (const SwNode &rNd)
 Given a SwNode return the pagedesc in use at that location. More...
 
static SwPageDescGetByName (SwDoc &rDoc, const OUString &rName)
 

Protected Member Functions

virtual void SwClientNotify (const SwModify &, const SfxHint &) override
 special handling if the style of the grid alignment changes More...
 
- Protected Member Functions inherited from SwClient
 SwClient (SwModify *pToRegisterIn)
 
SwModifyGetRegisteredInNonConst () const
 
- Protected Member Functions inherited from sw::WriterListener
 WriterListener ()
 
virtual ~WriterListener () COVERITY_NOEXCEPT_FALSE
 

Private Member Functions

SAL_DLLPRIVATE void Mirror ()
 Called for mirroring of Chg (doc). More...
 
SAL_DLLPRIVATE void ResetAllAttr ()
 
SAL_DLLPRIVATE SwPageDesc (const OUString &, SwFrameFormat *, SwDoc *pDc)
 

Private Attributes

OUString m_StyleName
 
SvxNumberType m_NumType
 
SwFrameFormat m_Master
 
SwFrameFormat m_Left
 
SwFrameFormat m_FirstMaster
 
SwFrameFormat m_FirstLeft
 
sw::WriterMultiListener m_aDepends
 Because of grid alignment (Registerhaltigkeit). More...
 
const SwTextFormatCollm_pTextFormatColl
 
SwPageDescm_pFollow
 
sal_uInt16 m_nRegHeight
 Sentence spacing and fontascent of style. More...
 
sal_uInt16 m_nRegAscent
 For grid alignment (Registerhaltigkeit). More...
 
drawing::TextVerticalAdjust m_nVerticalAdjustment
 
UseOnPage m_eUse
 
bool m_IsLandscape
 
bool m_IsHidden
 
SwPageFootnoteInfo m_IsFootnoteInfo
 Footnote information. More...
 
SwPageDescsm_pdList
 Backref to the assigned SwPageDescs list to handle renames. More...
 

Friends

class SwDoc
 
class SwPageDescs
 

Detailed Description

Definition at line 137 of file pagedesc.hxx.

Constructor & Destructor Documentation

SwPageDesc::SwPageDesc ( const OUString &  rName,
SwFrameFormat pFormat,
SwDoc pDc 
)
private

Definition at line 43 of file pagedesc.cxx.

References All, FirstShare, FooterShare, and HeaderShare.

SwPageDesc::SwPageDesc ( const SwPageDesc rCpy)
SwPageDesc::~SwPageDesc ( )
overridevirtual

Definition at line 124 of file pagedesc.cxx.

Member Function Documentation

void SwPageDesc::ChgFirstShare ( bool  bNew)

Definition at line 380 of file pagedesc.cxx.

References FirstShare, m_eUse, and NoFirstShare.

Referenced by SwView::ExecTabWin(), and ItemSetToPageDesc().

void SwPageDesc::ChgFooterShare ( bool  bNew)
inline
void SwPageDesc::ChgHeaderShare ( bool  bNew)
inline
SwPageDesc * SwPageDesc::GetByName ( SwDoc rDoc,
const OUString &  rName 
)
static
SwFrameFormat& SwPageDesc::GetFirstLeft ( )
inline
const SwFrameFormat& SwPageDesc::GetFirstLeft ( ) const
inline

Definition at line 223 of file pagedesc.hxx.

SwFrameFormat& SwPageDesc::GetFirstMaster ( )
inline
const SwFrameFormat& SwPageDesc::GetFirstMaster ( ) const
inline

Definition at line 222 of file pagedesc.hxx.

const SwPageDesc* SwPageDesc::GetFollow ( ) const
inline
SwPageDesc* SwPageDesc::GetFollow ( )
inline

Definition at line 246 of file pagedesc.hxx.

const SwPageFootnoteInfo& SwPageDesc::GetFootnoteInfo ( ) const
inline
SwPageFootnoteInfo& SwPageDesc::GetFootnoteInfo ( )
inline

Definition at line 196 of file pagedesc.hxx.

bool SwPageDesc::GetInfo ( SfxPoolItem rInfo) const
overridevirtual

Query information from Client.

Reimplemented from SwModify.

Definition at line 179 of file pagedesc.cxx.

References SwModify::GetInfo(), m_FirstLeft, m_FirstMaster, m_Left, and m_Master.

Referenced by sw::DocumentStylePoolManager::IsPoolPageDescUsed().

bool SwPageDesc::GetLandscape ( ) const
inline
SwFrameFormat& SwPageDesc::GetLeft ( )
inline
const SwFrameFormat& SwPageDesc::GetLeft ( ) const
inline

Definition at line 221 of file pagedesc.hxx.

SwFrameFormat * SwPageDesc::GetLeftFormat ( bool const  bFirst = false)
const SwFrameFormat * SwPageDesc::GetLeftFormat ( bool const  bFirst = false) const
inline

Definition at line 347 of file pagedesc.hxx.

References GetLeftFormat().

SwFrameFormat& SwPageDesc::GetMaster ( )
inline

Definition at line 216 of file pagedesc.hxx.

Referenced by SwXTextView::BuildTmpSelectionDoc(), sw::DefaultToxTabStopTokenHandler::CalculatePageMarginFromPageDescription(), SwWrtShell::ChangeHeaderOrFooter(), SwDoc::CheckDefaultPageFormat(), SwViewShell::ChgAllPageOrientation(), SwViewShell::ChgAllPageSize(), SwDoc::ChgPageDesc(), SwDoc::CopyMasterFooter(), SwDoc::CopyMasterHeader(), SwDoc::CopyPageDesc(), SwWW8ImplReader::CopyPageDescHdFt(), WW8Export::CreateEscher(), sw::CreateParentXText(), SwUndoPageDesc::ExchangeContentNodes(), SwView::ExecTabWin(), SwHeaderFooterWin::ExecuteCommand(), SwBaseShell::ExecuteGallery(), RtfExport::ExportDocument_Impl(), SwNode::FindPageDesc(), SwHTMLParser::FixHeaderFooterDistance(), MSWordExportBase::getBackground(), WW8Export::GetCurrentPageBgBrush(), MSWordExportBase::GetCurrentPageDirection(), GetGridItem(), sw::DocumentStylePoolManager::GetPageDescFromPool(), GetPageFormatOfNode(), SwXPageStyle::GetPropertyValues_Impl(), SwView::GetState(), SwDoc::GetTextDirection(), SwModule::InsertEnv(), SwModule::InsertLab(), InsertNewPage(), wwSectionManager::InsertSection(), ItemSetToPageDesc(), lcl_GetFormatForStyle(), lcl_GetPaperBin(), lcl_PageDescOrFollowContainsHeaderFooter(), lcl_PageDescWithHeader(), SwHTMLWriter::MakeHeader(), SwDoc::MakePageDesc(), SwCSS1Parser::makePageDescBackground(), MSWordExportBase::NeedSectionBreak(), SwHTMLParser::NewDivision(), MSWordSections::NumberOfColumns(), OutCSS1_SwPageDesc(), OutHTML_SwTextNode(), RtfExport::OutPageDescription(), MSWordExportBase::OutputSectionBreaks(), PageDescToItemSet(), SwWW8ImplReader::Read_HdFt(), RegisterChange(), SwDoc::RemoveAllFormatLanguageDependencies(), ResetAllAttr(), MSWordExportBase::SectionProperties(), SwXStyle::setAllPropertiesToDefault(), MSWordExportBase::SetCurrentPageDescFromNode(), SwCursorShell::SetCursorInHdFt(), SwDoc::SetDefaultPageMode(), SwCSS1Parser::SetPageDescAttrs(), wwSectionManager::SetSegmentToPageDesc(), SwView::SetZoom_(), SwView::StateTabWin(), SwColumnDlg::SwColumnDlg(), SwEscherEx::SwEscherEx(), SwReadOnlyPopup::SwReadOnlyPopup(), SwUndoPageDesc::SwUndoPageDesc(), SwWriter::Write(), RtfExport::WriteHeaderFooter(), and SwHTMLWriter::WriteStream().

const SwFrameFormat& SwPageDesc::GetMaster ( ) const
inline

Definition at line 220 of file pagedesc.hxx.

const OUString& SwPageDesc::GetName ( ) const
inline
const SvxNumberType& SwPageDesc::GetNumType ( ) const
inline
const SwPageDesc * SwPageDesc::GetPageDescOfNode ( const SwNode rNd)
static

Given a SwNode return the pagedesc in use at that location.

Definition at line 311 of file pagedesc.cxx.

References SwFrame::FindPageFrame(), and lcl_GetFrameOfNode().

Referenced by MSWordExportBase::OutputSectionNode(), and MSWordExportBase::SetCurrentPageDescFromNode().

const SwFrameFormat * SwPageDesc::GetPageFormatOfNode ( const SwNode rNd,
bool  bCheckForThisPgDc = true 
) const
sal_uInt16 SwPageDesc::GetPoolFormatId ( ) const
inline
sal_uInt16 SwPageDesc::GetPoolHelpId ( ) const
inline

Definition at line 255 of file pagedesc.hxx.

References SwFormat::GetPoolHelpId().

Referenced by SwDoc::CopyPageDesc(), and SwDocShell::MakeByExample().

sal_uInt8 SwPageDesc::GetPoolHlpFileId ( ) const
inline

Definition at line 257 of file pagedesc.hxx.

References SwFormat::GetPoolHlpFileId().

Referenced by SwDocShell::MakeByExample().

sal_uInt16 SwPageDesc::GetRegAscent ( ) const
inline

Definition at line 237 of file pagedesc.hxx.

Referenced by SwTextFrame::FillRegister().

sal_uInt16 SwPageDesc::GetRegHeight ( ) const
inline

Definition at line 236 of file pagedesc.hxx.

Referenced by SwTextFrame::FillRegister().

const SwTextFormatColl * SwPageDesc::GetRegisterFormatColl ( ) const

retrieve the style for the grid alignment

Definition at line 203 of file pagedesc.cxx.

References sw::WriterMultiListener::IsListeningTo(), m_aDepends, and m_pTextFormatColl.

Referenced by SwDoc::ChgPageDesc(), SwTextFrame::FillRegister(), SwXStyle::GetStyleProperty(), and PageDescToItemSet().

SwFrameFormat * SwPageDesc::GetRightFormat ( bool const  bFirst = false)

Layout uses the following methods to obtain a format in order to be able to create a page.

Definition at line 368 of file pagedesc.cxx.

References m_eUse, m_FirstMaster, m_Master, and Right.

Referenced by SwRootFrame::AssertFlyPages(), SwFrame::CheckPageDescs(), GetRightFormat(), InsertNewPage(), SwFrame::InsertPage(), SwHeaderFooterWin::IsEmptyHeaderFooter(), SwEditWin::MouseButtonDown(), SwFrame::WannaRightPage(), and SwFrame::WrongPageDesc().

const SwFrameFormat * SwPageDesc::GetRightFormat ( bool const  bFirst = false) const
inline

Definition at line 343 of file pagedesc.hxx.

References GetRightFormat().

UseOnPage SwPageDesc::GetUseOn ( ) const
inline
drawing::TextVerticalAdjust SwPageDesc::GetVerticalAdjustment ( ) const
inline

Definition at line 241 of file pagedesc.hxx.

Referenced by MSWordExportBase::SectionProperties().

bool SwPageDesc::IsFirstShared ( ) const
bool SwPageDesc::IsFollowNextPageOfNode ( const SwNode rNd) const
bool SwPageDesc::IsFooterShared ( ) const
inline
bool SwPageDesc::IsHeaderShared ( ) const
inline
bool SwPageDesc::IsHidden ( ) const
inline
void SwPageDesc::Mirror ( )
private
SwPageDesc & SwPageDesc::operator= ( const SwPageDesc rSrc)
UseOnPage SwPageDesc::ReadUseOn ( ) const
inline
void SwPageDesc::RegisterChange ( )
void SwPageDesc::ResetAllAttr ( )
private
void SwPageDesc::ResetAllMasterAttr ( )
inline

Reset all attrs of the format but keep the ones a pagedesc cannot live without.

Definition at line 338 of file pagedesc.hxx.

References ResetAllAttr().

Referenced by SwXStyle::setAllPropertiesToDefault().

void SwPageDesc::SetFollow ( const SwPageDesc pNew)
inline
void SwPageDesc::SetFootnoteInfo ( const SwPageFootnoteInfo rNew)
inline
void SwPageDesc::SetHidden ( bool const  bValue)
inline

Definition at line 207 of file pagedesc.hxx.

Referenced by SwDocStyleSheet::SetHidden().

void SwPageDesc::SetLandscape ( bool  bNew)
inline
bool SwPageDesc::SetName ( const OUString &  rNewName)
void SwPageDesc::SetNumType ( const SvxNumberType rNew)
inline
void SwPageDesc::SetPoolFormatId ( sal_uInt16 const  nId)
inline
void SwPageDesc::SetPoolHelpId ( sal_uInt16 const  nId)
inline
void SwPageDesc::SetPoolHlpFileId ( sal_uInt8 const  nId)
inline
void SwPageDesc::SetRegAscent ( sal_uInt16 const  nNew)
inline

Definition at line 239 of file pagedesc.hxx.

Referenced by SwTextFrame::FillRegister().

void SwPageDesc::SetRegHeight ( sal_uInt16 const  nNew)
inline

Definition at line 238 of file pagedesc.hxx.

Referenced by SwTextFrame::FillRegister().

void SwPageDesc::SetRegisterFormatColl ( const SwTextFormatColl rFormat)

set the style for the grid alignment

Definition at line 191 of file pagedesc.cxx.

References sw::WriterMultiListener::EndListeningAll(), m_aDepends, m_pTextFormatColl, RegisterChange(), and sw::WriterMultiListener::StartListening().

Referenced by ItemSetToPageDesc().

void SwPageDesc::SetUseOn ( UseOnPage  eNew)
inline
void SwPageDesc::SetVerticalAdjustment ( const drawing::TextVerticalAdjust  nVA)
inline
void SwPageDesc::SwClientNotify ( const SwModify rModify,
const SfxHint rHint 
)
overrideprotectedvirtual

special handling if the style of the grid alignment changes

Reimplemented from SwClient.

Definition at line 263 of file pagedesc.cxx.

References isCHRATR(), m_pTextFormatColl, SwModify::NotifyClients(), RegisterChange(), RES_ATTRSET_CHG, RES_FMT_CHG, and RES_PARATR_LINESPACING.

void SwPageDesc::WriteUseOn ( UseOnPage const  eNew)
inline

Definition at line 213 of file pagedesc.hxx.

Referenced by SwDoc::CopyPageDesc(), and wwSectionManager::SetUseOn().

Friends And Related Function Documentation

friend class SwDoc
friend

Definition at line 141 of file pagedesc.hxx.

friend class SwPageDescs
friend

Definition at line 142 of file pagedesc.hxx.

Member Data Documentation

sw::WriterMultiListener SwPageDesc::m_aDepends
private

Because of grid alignment (Registerhaltigkeit).

Definition at line 151 of file pagedesc.hxx.

Referenced by GetRegisterFormatColl(), operator=(), SetRegisterFormatColl(), and SwPageDesc().

UseOnPage SwPageDesc::m_eUse
private
SwFrameFormat SwPageDesc::m_FirstLeft
private

Definition at line 150 of file pagedesc.hxx.

Referenced by GetInfo(), GetLeftFormat(), and operator=().

SwFrameFormat SwPageDesc::m_FirstMaster
private

Definition at line 149 of file pagedesc.hxx.

Referenced by GetInfo(), GetRightFormat(), and operator=().

SwPageFootnoteInfo SwPageDesc::m_IsFootnoteInfo
private

Footnote information.

Definition at line 162 of file pagedesc.hxx.

bool SwPageDesc::m_IsHidden
private

Definition at line 159 of file pagedesc.hxx.

bool SwPageDesc::m_IsLandscape
private

Definition at line 158 of file pagedesc.hxx.

Referenced by operator=().

SwFrameFormat SwPageDesc::m_Left
private

Definition at line 147 of file pagedesc.hxx.

Referenced by GetInfo(), GetLeftFormat(), Mirror(), and operator=().

SwFrameFormat SwPageDesc::m_Master
private

Definition at line 146 of file pagedesc.hxx.

Referenced by GetInfo(), GetRightFormat(), Mirror(), and operator=().

sal_uInt16 SwPageDesc::m_nRegAscent
private

For grid alignment (Registerhaltigkeit).

Definition at line 155 of file pagedesc.hxx.

Referenced by operator=().

sal_uInt16 SwPageDesc::m_nRegHeight
private

Sentence spacing and fontascent of style.

Definition at line 154 of file pagedesc.hxx.

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

SvxNumberType SwPageDesc::m_NumType
private

Definition at line 145 of file pagedesc.hxx.

Referenced by operator=().

drawing::TextVerticalAdjust SwPageDesc::m_nVerticalAdjustment
private

Definition at line 156 of file pagedesc.hxx.

Referenced by operator=().

SwPageDescs* SwPageDesc::m_pdList
private

Backref to the assigned SwPageDescs list to handle renames.

Definition at line 165 of file pagedesc.hxx.

Referenced by SetName().

SwPageDesc* SwPageDesc::m_pFollow
private

Definition at line 153 of file pagedesc.hxx.

Referenced by SwDoc::ChgPageDesc(), operator=(), and SetFollow().

const SwTextFormatColl* SwPageDesc::m_pTextFormatColl
mutableprivate
OUString SwPageDesc::m_StyleName
private

Definition at line 144 of file pagedesc.hxx.

Referenced by SwPageDesc::change_name::operator()(), operator=(), and SetName().


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