#include <pagedesc.hxx>

Inheritance diagram for SwPageDesc:

Collaboration diagram for SwPageDesc:

Classes
struct	change_name

struct	StashedPageDesc

Public Member Functions
const OUString &	GetName () const

bool	SetName (const OUString &rNewName)

bool	GetLandscape () const

void	SetLandscape (bool bNew)

const SvxNumberType &	GetNumType () const

void	SetNumType (const SvxNumberType &rNew)

const SwPageFootnoteInfo &	GetFootnoteInfo () const

SwPageFootnoteInfo &	GetFootnoteInfo ()

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	StashFrameFormat (const SwFrameFormat &rFormat, bool bHeader, bool bLeft, bool bFirst)
	Remember original header/footer formats even when they are hidden by "sharing". More...

const SwFrameFormat *	GetStashedFrameFormat (bool bHeader, bool bLeft, bool bFirst) const
	Used to restore hidden header/footer formats. More...

bool	HasStashedFormat (bool bHeader, bool bLeft, bool bFirst)
	Checks if the pagedescriptor has a stashed format according to the parameters or not. More...

void	RemoveStashedFormat (bool bHeader, bool bLeft, bool bFirst)
	Gives the feature of removing the stashed format by hand if it is necessary. More...

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

SwFrameFormat &	GetMaster ()

SwFrameFormat &	GetLeft ()

SwFrameFormat &	GetFirstMaster ()

SwFrameFormat &	GetFirstLeft ()

const SwFrameFormat &	GetMaster () const

const SwFrameFormat &	GetLeft () const

const SwFrameFormat &	GetFirstMaster () const

const SwFrameFormat &	GetFirstLeft () const

void	ResetAllMasterAttr ()
	Reset all attrs of the format but keep the ones a pagedesc cannot live without. More...

SwFrameFormat *	GetRightFormat (bool const bFirst=false)
	Layout uses the following methods to obtain a format in order to be able to create a page. More...

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

SwFrameFormat *	GetLeftFormat (bool const bFirst=false)

const SwFrameFormat *	GetLeftFormat (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 SwPageDesc *	GetFollow () const

SwPageDesc *	GetFollow ()

void	SetRegisterFormatColl (const SwTextFormatColl *rFormat)
	set the style for the grid alignment More...

const SwTextFormatColl *	GetRegisterFormatColl () 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 SwFrameFormat *	GetPageFormatOfNode (const SwNode &rNd, bool bCheckForThisPgDc=true) const

bool	IsFollowNextPageOfNode (const SwNode &rNd) const

SwPageDesc &	operator= (const SwPageDesc &)

	SwPageDesc (const SwPageDesc &)

virtual	~SwPageDesc () override

void	dumpAsXml (xmlTextWriterPtr pWriter) const

Static Public Member Functions
static const SwPageDesc *	GetPageDescOfNode (const SwNode &rNd)
	Given a SwNode return the pagedesc in use at that location. More...

static SwPageDesc *	GetByName (SwDoc &rDoc, std::u16string_view rName)

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)

virtual void	SwClientNotify (const SwModify &, const SfxHint &) override
	special handling if the style of the grid alignment changes More...

Private Attributes
OUString	m_StyleName

SvxNumberType	m_NumType

SwFrameFormat	m_Master

SwFrameFormat	m_Left

SwFrameFormat	m_FirstMaster

SwFrameFormat	m_FirstLeft

StashedPageDesc	m_aStashedHeader

StashedPageDesc	m_aStashedFooter

sw::WriterMultiListener	m_aDepends
	Because of grid alignment (Registerhaltigkeit). More...

const SwTextFormatColl *	m_pTextFormatColl

SwPageDesc *	m_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_FootnoteInfo
	Footnote information. More...

SwPageDescs *	m_pdList
	Backref to the assigned SwPageDescs list to handle renames. More...

Friends
class	SwDoc

class	SwPageDescs

Detailed Description

Definition at line 138 of file pagedesc.hxx.

Constructor & Destructor Documentation

◆ SwPageDesc() [1/2]

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

private

Definition at line 44 of file pagedesc.cxx.

References All, FirstShare, FooterShare, and HeaderShare.

◆ SwPageDesc() [2/2]

SwPageDesc::SwPageDesc ( const SwPageDesc & rCpy )

Definition at line 66 of file pagedesc.cxx.

References GetName(), IsHidden(), sw::WriterMultiListener::IsListeningTo(), m_aDepends, m_aStashedFooter, m_aStashedHeader, SwPageDesc::StashedPageDesc::m_pStashedFirst, SwPageDesc::StashedPageDesc::m_pStashedFirstLeft, SwPageDesc::StashedPageDesc::m_pStashedLeft, m_pTextFormatColl, and sw::WriterMultiListener::StartListening().

◆ ~SwPageDesc()

SwPageDesc::~SwPageDesc ( )

overridevirtual

Definition at line 143 of file pagedesc.cxx.

Member Function Documentation

◆ ChgFirstShare()

void SwPageDesc::ChgFirstShare ( bool bNew )

Definition at line 401 of file pagedesc.cxx.

References FirstShare, m_eUse, and NoFirstShare.

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

◆ ChgFooterShare()

void SwPageDesc::ChgFooterShare ( bool bNew )

inline

Definition at line 334 of file pagedesc.hxx.

References FooterShare, m_eUse, and NoFooterShare.

Referenced by SwDoc::ChgPageDesc(), SwTextShell::ExecField(), SwView::ExecTabWin(), SwModule::InsertEnv(), SwModule::InsertLab(), and ItemSetToPageDesc().

◆ ChgHeaderShare()

void SwPageDesc::ChgHeaderShare ( bool bNew )

inline

Definition at line 327 of file pagedesc.hxx.

References HeaderShare, m_eUse, and NoHeaderShare.

Referenced by SwDoc::ChgPageDesc(), SwTextShell::ExecField(), SwView::ExecTabWin(), SwModule::InsertEnv(), SwModule::InsertLab(), and ItemSetToPageDesc().

◆ dumpAsXml()

void SwPageDesc::dumpAsXml ( xmlTextWriterPtr pWriter ) const

Definition at line 599 of file pagedesc.cxx.

References SwFrameFormat::dumpAsXml(), m_eUse, m_FirstLeft, m_FirstMaster, m_Left, m_Master, m_pFollow, and m_StyleName.

◆ GetByName()

SwPageDesc * SwPageDesc::GetByName	(	SwDoc &	rDoc,
		std::u16string_view	rName
	)

static

Definition at line 574 of file pagedesc.cxx.

References SwDoc::getIDocumentStylePoolAccess(), GetName(), SwDoc::GetPageDesc(), SwDoc::GetPageDescCnt(), IDocumentStylePoolAccess::GetPageDescFromPool(), i, RES_POOLPAGE_BEGIN, SAL_N_ELEMENTS, STR_POOLPAGE, and SwResId().

Referenced by lcl_SetSpecialProperty().

◆ GetFirstLeft() [1/2]

SwFrameFormat & SwPageDesc::GetFirstLeft ( )

inline

Definition at line 241 of file pagedesc.hxx.

Referenced by SwDoc::CheckDefaultPageFormat(), SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), sw::CreateParentXText(), sw::DocumentStylePoolManager::GetPageDescFromPool(), InsertNewPage(), SwDoc::MakePageDesc(), RegisterChange(), MSWordExportBase::SectionProperties(), and SwCursorShell::SetCursorInHdFt().

◆ GetFirstLeft() [2/2]

const SwFrameFormat & SwPageDesc::GetFirstLeft ( ) const

inline

Definition at line 245 of file pagedesc.hxx.

◆ GetFirstMaster() [1/2]

SwFrameFormat & SwPageDesc::GetFirstMaster ( )

inline

◆ GetFirstMaster() [2/2]

const SwFrameFormat & SwPageDesc::GetFirstMaster ( ) const

inline

Definition at line 244 of file pagedesc.hxx.

◆ GetFollow() [1/2]

SwPageDesc * SwPageDesc::GetFollow ( )

inline

Definition at line 268 of file pagedesc.hxx.

◆ GetFollow() [2/2]

const SwPageDesc * SwPageDesc::GetFollow ( ) const

inline

Definition at line 267 of file pagedesc.hxx.

Referenced by SwRootFrame::AssertFlyPages(), MSWordSections::CheckForFacinPg(), SwLayHelper::CheckInsertPage(), SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), SwTextShell::ExecField(), SwPageFrame::FindPageDesc(), SwTextFly::ForEach(), SwModule::InsertEnv(), SwFrame::InsertPage(), IsFollowNextPageOfNode(), lcl_CopyFollowPageDesc(), lcl_FindPageDesc(), lcl_PageDescOrFollowContainsHeaderFooter(), MSWordExportBase::NeedSectionBreak(), RtfExport::OutPageDescription(), MSWordExportBase::OutputFollowPageDesc(), MSWordExportBase::OutputSectionBreaks(), MSWordExportBase::OutputTextNode(), SwHTMLWriter::OutStyleSheet(), PageDescToItemSet(), MSWordExportBase::SectionProperties(), MSWordExportBase::SetCurrentPageDescFromNode(), SwDocStyleSheet::SetFollow(), SwPageDescExt::SetPageDesc(), SwUndoPageDesc::SwUndoPageDesc(), SwFrame::WannaRightPage(), RtfExport::WriteHeaderFooter(), and RtfExport::WritePageDescTable().

◆ GetFootnoteInfo() [1/2]

SwPageFootnoteInfo & SwPageDesc::GetFootnoteInfo ( )

inline

Definition at line 206 of file pagedesc.hxx.

◆ GetFootnoteInfo() [2/2]

const SwPageFootnoteInfo & SwPageDesc::GetFootnoteInfo ( ) const

inline

Definition at line 205 of file pagedesc.hxx.

Referenced by SwFrame::CheckPageDescs(), SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), DocxAttributeOutput::FootnotesEndnotes(), SwFootnoteContFrame::Format(), sw::DocumentStylePoolManager::GetPageDescFromPool(), PageDescToItemSet(), SwFootnoteContFrame::PaintLine(), SwPageFrame::SwClientNotify(), SwPageFrame::SwPageFrame(), and RtfExport::WriteFootnoteSettings().

◆ GetInfo()

bool SwPageDesc::GetInfo ( SfxPoolItem & rInfo ) const

overridevirtual

Query information from Client.

Definition at line 199 of file pagedesc.cxx.

References m_FirstLeft, m_FirstMaster, m_Left, and m_Master.

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

◆ GetLandscape()

bool SwPageDesc::GetLandscape ( ) const

inline

Definition at line 199 of file pagedesc.hxx.

Referenced by SwViewShell::ChgAllPageOrientation(), SwViewShell::ChgAllPageSize(), SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), RtfExport::ExportDocument_Impl(), DocxAttributeOutput::FormatFrameSize(), WW8AttributeOutput::FormatFrameSize(), sw::DocumentStylePoolManager::GetPageDescFromPool(), SwView::GetState(), OutCSS1_SwPageDesc(), RtfExport::OutPageDescription(), PageDescToItemSet(), and SwCSS1Parser::SetPageDescAttrs().

◆ GetLeft() [1/2]

SwFrameFormat & SwPageDesc::GetLeft ( )

inline

◆ GetLeft() [2/2]

const SwFrameFormat & SwPageDesc::GetLeft ( ) const

inline

Definition at line 243 of file pagedesc.hxx.

◆ GetLeftFormat() [1/2]

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

Definition at line 382 of file pagedesc.cxx.

References Left, m_eUse, m_FirstLeft, and m_Left.

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

◆ GetLeftFormat() [2/2]

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

inline

Definition at line 371 of file pagedesc.hxx.

References GetLeftFormat().

◆ GetMaster() [1/2]

SwFrameFormat & SwPageDesc::GetMaster ( )

inline

Definition at line 238 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(), WW8Export::CurrentPageWidth(), SwUndoPageDesc::ExchangeContentNodes(), SwTextShell::ExecField(), SwView::ExecTabWin(), SwView::Execute(), SwBaseShell::Execute(), SwHeaderFooterWin::ExecuteCommand(), SwBaseShell::ExecuteGallery(), RtfExport::ExportDocument_Impl(), SwNode::FindPageDesc(), SwHTMLParser::FixHeaderFooterDistance(), AttributeOutputBase::FormatColumns(), MSWordExportBase::getBackground(), WW8Export::GetCurrentPageBgBrush(), MSWordExportBase::GetCurrentPageDirection(), MSWordSections::GetFormatCol(), GetGridItem(), sw::DocumentStylePoolManager::GetPageDescFromPool(), GetPageFormatOfNode(), SwXTextViewCursor::getPosition(), SwView::GetState(), SwDoc::GetTextDirection(), IMPL_LINK_NOARG(), 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(), SwHTMLWriter::OutCSS1_FrameFormatBackground(), OutCSS1_SwPageDesc(), OutHTML_SwTextNode(), RtfExport::OutPageDescription(), MSWordExportBase::OutputSectionBreaks(), PageDescToItemSet(), SwWW8ImplReader::Read_HdFt(), RegisterChange(), SwDoc::RemoveAllFormatLanguageDependencies(), SwFieldRefPage::Reset(), ResetAllAttr(), MSWordExportBase::SectionProperties(), SwContentTree::SetActiveShell(), 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(), RtfAttributeOutput::WriteHeaderFooter_Impl(), and SwHTMLWriter::WriteStream().

◆ GetMaster() [2/2]

const SwFrameFormat & SwPageDesc::GetMaster ( ) const

inline

Definition at line 242 of file pagedesc.hxx.

◆ GetName()

const OUString & SwPageDesc::GetName ( ) const

inline

Definition at line 196 of file pagedesc.hxx.

Referenced by SwDoc::AppendDoc(), SwDocShell::ApplyStyles(), SwWrtShell::ChangeHeaderOrFooter(), SwDoc::ChgPageDesc(), SwDoc::ClearDoc(), SwDoc::ContainsPageDesc(), SwDoc::CopyFormatArr(), SwDoc::CopyPageDesc(), SwAttrSet::CopyToModify(), SwDoc::DelPageDesc(), SwPageFrame::dumpAsXml(), SwBaseShell::ExecDlg(), SwTextShell::ExecField(), SwHeaderFooterWin::ExecuteCommand(), RtfExport::ExportDocument_Impl(), SwXMLExport::ExportFormat(), SwTextFlowPage::FillItemSet(), SwTitlePageDlg::FillList(), SwViewShell::FillPrtDoc(), SwStyleSheetIterator::First(), GetByName(), SwWrtShell::GetCurPageStyle(), SwUnoCursorHelper::GetCurPageStyle(), SwPageDescExt::GetName(), SwFormatPageDesc::GetPresentation(), SwXFootnoteProperties::getPropertyValue(), SwXEndnoteProperties::getPropertyValue(), SwUndoPageDescCreate::GetRewriter(), IMPL_LINK_NOARG(), SwModule::InsertEnv(), lcl_CopyFollowPageDesc(), lcl_FindPageDesc(), lcl_GetSpecialProperty(), SwDoc::MakePageDesc(), std::less< SwPageDesc * >::operator()(), MSWordExportBase::OutputSectionBreaks(), PageDescToItemSet(), SwFEShell::PastePages(), SwFormatPageDesc::QueryValue(), SwDoc::ReplaceStyles(), SwEndNoteOptionPage::Reset(), SwTextFlowPage::Reset(), SwDocStyleSheet::SetFollow(), SwDocStyleSheet::SetItemSet(), SwDocStyleSheet::SetName(), SwHeaderFooterWin::SetOffset(), SwPageDescExt::SetPageDesc(), SwDocShell::StateStyleSheet(), SwBreakDlg::SwBreakDlg(), SwColumnDlg::SwColumnDlg(), SwToSfxPageDescAttr(), and RtfExport::WritePageDescTable().

◆ GetNumType()

const SvxNumberType & SwPageDesc::GetNumType ( ) const

inline

Definition at line 202 of file pagedesc.hxx.

Referenced by SwRefPageGetField::ChangeExpansion(), SwDocStatField::ChangeExpansion(), SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), SwTextShell::ExecField(), SwViewShell::GetFirstLastVisPageNumbers(), SwAccessibleFrame::GetFormattedPageNumber(), SwFEShell::GetPageNumber(), lcl_GetPageNumber(), SwTextFormatter::NewFieldPortion(), RtfExport::OutPageDescription(), PageDescToItemSet(), MSWordExportBase::SectionProperties(), SwGetRefField::UpdateField(), and SwRefPageGetFieldType::UpdateField().

◆ GetPageDescOfNode()

const SwPageDesc * SwPageDesc::GetPageDescOfNode ( const SwNode & rNd )

static

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

Definition at line 332 of file pagedesc.cxx.

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

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

◆ GetPageFormatOfNode()

const SwFrameFormat * SwPageDesc::GetPageFormatOfNode	(	const SwNode &	rNd,
		bool	bCheckForThisPgDc = `true`
	)		const

Definition at line 341 of file pagedesc.cxx.

References SwFrame::FindPageFrame(), GetLeft(), GetMaster(), SwFrame::KnowsFormat(), and lcl_GetFrameOfNode().

Referenced by AttributeOutputBase::GetTablePageSize(), and MSWordExportBase::SectionProperties().

◆ GetPoolFormatId()

sal_uInt16 SwPageDesc::GetPoolFormatId ( ) const

inline

Query and set PoolFormat-Id.

Definition at line 275 of file pagedesc.hxx.

References SwFormat::GetPoolFormatId().

Referenced by SwDoc::CheckDefaultPageFormat(), SwDoc::CopyPageDesc(), SwDocStyleSheet::FillStyleSheet(), SwStyleSheetIterator::First(), SwDocStyleSheet::GetHelpId(), sw::DocumentStylePoolManager::GetPageDescFromPool(), sw::DocumentStylePoolManager::IsPoolPageDescUsed(), SwDocShell::MakeByExample(), OutCSS1_SvxFormatBreak_SwFormatPDesc_SvxFormatKeep(), OutCSS1_SwPageDesc(), and SwHTMLWriter::OutStyleSheet().

◆ GetPoolHelpId()

sal_uInt16 SwPageDesc::GetPoolHelpId ( ) const

inline

Definition at line 277 of file pagedesc.hxx.

References SwFormat::GetPoolHelpId().

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

◆ GetPoolHlpFileId()

sal_uInt8 SwPageDesc::GetPoolHlpFileId ( ) const

inline

Definition at line 279 of file pagedesc.hxx.

References SwFormat::GetPoolHlpFileId().

Referenced by SwDocStyleSheet::FillStyleSheet(), SwDocStyleSheet::GetHelpId(), and SwDocShell::MakeByExample().

◆ GetRegAscent()

sal_uInt16 SwPageDesc::GetRegAscent ( ) const

inline

Definition at line 259 of file pagedesc.hxx.

Referenced by SwTextFrame::FillRegister().

◆ GetRegHeight()

sal_uInt16 SwPageDesc::GetRegHeight ( ) const

inline

Definition at line 258 of file pagedesc.hxx.

Referenced by SwTextFrame::FillRegister().

◆ GetRegisterFormatColl()

const SwTextFormatColl * SwPageDesc::GetRegisterFormatColl ( ) const

retrieve the style for the grid alignment

Definition at line 223 of file pagedesc.cxx.

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

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

◆ GetRightFormat() [1/2]

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 389 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().

◆ GetRightFormat() [2/2]

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

inline

Definition at line 367 of file pagedesc.hxx.

References GetRightFormat().

◆ GetStashedFrameFormat()

const SwFrameFormat * SwPageDesc::GetStashedFrameFormat	(	bool	bHeader,
		bool	bLeft,
		bool	bFirst
	)		const

Used to restore hidden header/footer formats.

Definition at line 445 of file pagedesc.cxx.

References m_aStashedFooter, m_aStashedHeader, SwPageDesc::StashedPageDesc::m_pStashedFirst, SwPageDesc::StashedPageDesc::m_pStashedFirstLeft, SwPageDesc::StashedPageDesc::m_pStashedLeft, and SAL_WARN.

Referenced by SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), and MSWordExportBase::SectionProperties().

◆ GetUseOn()

UseOnPage SwPageDesc::GetUseOn ( ) const

inline

Definition at line 353 of file pagedesc.hxx.

References m_eUse, NoFirstShare, NoFooterShare, and NoHeaderShare.

Referenced by SwDoc::ChgPageDesc(), SwAutoFormat::HasBreakAttr(), IMPL_LINK_NOARG(), PageDescToItemSet(), SwView::SetZoom_(), SwView::SwapPageMargin(), and DocxSdrExport::writeDMLDrawing().

◆ GetVerticalAdjustment()

drawing::TextVerticalAdjust SwPageDesc::GetVerticalAdjustment ( ) const

inline

Definition at line 263 of file pagedesc.hxx.

Referenced by MSWordExportBase::SectionProperties().

◆ HasStashedFormat()

bool SwPageDesc::HasStashedFormat	(	bool	bHeader,
		bool	bLeft,
		bool	bFirst
	)

Checks if the pagedescriptor has a stashed format according to the parameters or not.

Definition at line 473 of file pagedesc.cxx.

References m_aStashedFooter, m_aStashedHeader, SwPageDesc::StashedPageDesc::m_pStashedFirst, SwPageDesc::StashedPageDesc::m_pStashedFirstLeft, SwPageDesc::StashedPageDesc::m_pStashedLeft, and SAL_WARN.

Referenced by SwDoc::ChgPageDesc().

◆ IsFirstShared()

bool SwPageDesc::IsFirstShared ( ) const

Definition at line 396 of file pagedesc.cxx.

References FirstShare, and m_eUse.

Referenced by SwDoc::ChgPageDesc(), SwDoc::CopyMasterFooter(), SwDoc::CopyMasterHeader(), SwDoc::CopyPageDesc(), SwUndoPageDesc::ExchangeContentNodes(), SwTextShell::ExecField(), InsertNewPage(), PageDescToItemSet(), MSWordExportBase::SectionProperties(), SwHeaderFooterWin::SetOffset(), SwView::StateTabWin(), and SwUndoPageDesc::SwUndoPageDesc().

◆ IsFollowNextPageOfNode()

bool SwPageDesc::IsFollowNextPageOfNode ( const SwNode & rNd ) const

Definition at line 366 of file pagedesc.cxx.

References SwFrame::FindPageFrame(), GetFollow(), SwFrame::GetNext(), SwPageFrame::GetPageDesc(), SwFrame::IsPageFrame(), and lcl_GetFrameOfNode().

Referenced by MSWordSections::CheckForFacinPg(), and MSWordExportBase::SectionProperties().

◆ IsFooterShared()

bool SwPageDesc::IsFooterShared ( ) const

inline

Definition at line 323 of file pagedesc.hxx.

References FooterShare, and m_eUse.

Referenced by MSWordSections::CheckForFacinPg(), SwDoc::ChgPageDesc(), SwDoc::CopyMasterFooter(), SwDoc::CopyPageDesc(), SwUndoPageDesc::ExchangeContentNodes(), SwTextShell::ExecField(), PageDescToItemSet(), MSWordExportBase::SectionProperties(), SwView::StateTabWin(), and SwUndoPageDesc::SwUndoPageDesc().

◆ IsHeaderShared()

bool SwPageDesc::IsHeaderShared ( ) const

inline

Definition at line 319 of file pagedesc.hxx.

References HeaderShare, and m_eUse.

Referenced by MSWordSections::CheckForFacinPg(), SwDoc::ChgPageDesc(), SwDoc::CopyMasterHeader(), SwDoc::CopyPageDesc(), SwUndoPageDesc::ExchangeContentNodes(), SwTextShell::ExecField(), PageDescToItemSet(), MSWordExportBase::SectionProperties(), SwHeaderFooterWin::SetOffset(), SwView::StateTabWin(), and SwUndoPageDesc::SwUndoPageDesc().

◆ IsHidden()

bool SwPageDesc::IsHidden ( ) const

inline

Definition at line 216 of file pagedesc.hxx.

Referenced by SwStyleSheetIterator::AppendStyleList(), SwStyleSheetIterator::First(), and SwDocStyleSheet::IsHidden().

◆ Mirror()

void SwPageDesc::Mirror ( )

private

Called for mirroring of Chg (doc).

Only the margin is mirrored.

No adjustment at any other place.

Attributes like borders and so on are copied 1:1.

Definition at line 166 of file pagedesc.cxx.

References SwFormat::GetAttrSet(), SwFormat::GetBox(), SwFormat::GetCol(), SwFormat::GetFrameDir(), SwFormat::GetFrameSize(), SvxLRSpaceItem::GetGutterMargin(), SvxLRSpaceItem::GetLeft(), SwFormat::GetLRSpace(), SwFormat::GetPaperBin(), SwAttrSet::GetPool(), SfxItemSet::GetRanges(), SvxLRSpaceItem::GetRight(), SwFormat::GetShadow(), SwFormat::GetULSpace(), m_Left, m_Master, SwFormat::makeBackgroundBrushItem(), SfxItemSet::Put(), RES_LR_SPACE(), SwFormat::SetFormatAttr(), SvxLRSpaceItem::SetLeft(), SvxLRSpaceItem::SetRight(), and SvxLRSpaceItem::SetRightGutterMargin().

◆ operator=()

SwPageDesc & SwPageDesc::operator= ( const SwPageDesc & rSrc )

◆ ReadUseOn()

UseOnPage SwPageDesc::ReadUseOn ( ) const

inline

Definition at line 236 of file pagedesc.hxx.

Referenced by MSWordSections::CheckForFacinPg(), SwDoc::CopyPageDesc(), SwTextShell::ExecField(), RtfExport::ExportDocument_Impl(), SwNode::FindPageDesc(), DocxExport::isMirroredMargin(), MSWordExportBase::SectionProperties(), and RtfExport::WritePageDescTable().

◆ RegisterChange()

void SwPageDesc::RegisterChange ( )

notify all affected page frames

Definition at line 231 of file pagedesc.cxx.

References SwIterator< TElementType, TSource, eMode >::First(), IDocumentLayoutAccess::GetCurrentViewShell(), SwFormat::GetDoc(), GetFirstLeft(), GetFirstMaster(), SwDoc::getIDocumentLayoutAccess(), GetLeft(), GetMaster(), SwDoc::IsInDtor(), m_nRegHeight, and SwIterator< TElementType, TSource, eMode >::Next().

Referenced by SetRegisterFormatColl(), and SwClientNotify().

◆ RemoveStashedFormat()

void SwPageDesc::RemoveStashedFormat	(	bool	bHeader,
		bool	bLeft,
		bool	bFirst
	)

Gives the feature of removing the stashed format by hand if it is necessary.

Definition at line 517 of file pagedesc.cxx.

References m_aStashedFooter, m_aStashedHeader, SwPageDesc::StashedPageDesc::m_pStashedFirst, SwPageDesc::StashedPageDesc::m_pStashedFirstLeft, SwPageDesc::StashedPageDesc::m_pStashedLeft, and SAL_WARN.

Referenced by SwDoc::ChgPageDesc().

◆ ResetAllAttr()

void SwPageDesc::ResetAllAttr ( )

private

Definition at line 189 of file pagedesc.cxx.

References GetMaster(), RES_FRAMEDIR(), SwFormat::ResetAllFormatAttr(), and SwFormat::SetFormatAttr().

Referenced by ResetAllMasterAttr().

◆ ResetAllMasterAttr()

void SwPageDesc::ResetAllMasterAttr ( )

inline

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

Definition at line 362 of file pagedesc.hxx.

References ResetAllAttr().

◆ SetFollow()

void SwPageDesc::SetFollow ( const SwPageDesc * pNew )

inline

Definition at line 314 of file pagedesc.hxx.

References m_pFollow.

Referenced by SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), SwCSS1Parser::GetPageDesc(), sw::DocumentStylePoolManager::GetPageDescFromPool(), SwModule::InsertEnv(), SwModule::InsertLab(), wwSectionManager::InsertSegments(), lcl_CopyFollowPageDesc(), SwPageDescExt::operator SwPageDesc(), and SwDocStyleSheet::SetFollow().

◆ SetFootnoteInfo()

void SwPageDesc::SetFootnoteInfo ( const SwPageFootnoteInfo & rNew )

inline

Definition at line 207 of file pagedesc.hxx.

Referenced by SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), sw::DocumentStylePoolManager::GetPageDescFromPool(), and ItemSetToPageDesc().

◆ SetHidden()

void SwPageDesc::SetHidden ( bool const bValue )

inline

Definition at line 217 of file pagedesc.hxx.

Referenced by SwDocStyleSheet::SetHidden().

◆ SetLandscape()

void SwPageDesc::SetLandscape ( bool bNew )

inline

Definition at line 200 of file pagedesc.hxx.

Referenced by SwViewShell::ChgAllPageOrientation(), SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), sw::DocumentStylePoolManager::GetPageDescFromPool(), SwModule::InsertEnv(), SwModule::InsertLab(), ItemSetToPageDesc(), wwSectionManager::SetPage(), and SwCSS1Parser::SetPageDescAttrs().

◆ SetName()

bool SwPageDesc::SetName ( const OUString & rNewName )

Definition at line 147 of file pagedesc.cxx.

References SwPageDescs::end(), SwPageDescs::find_(), m_pdList, SwPageDescs::m_PosIndex, m_StyleName, and SAL_WARN.

Referenced by SwDoc::ChgPageDesc(), SwDoc::MakePageDesc(), and SwDocStyleSheet::SetName().

◆ SetNumType()

void SwPageDesc::SetNumType ( const SvxNumberType & rNew )

inline

Definition at line 203 of file pagedesc.hxx.

Referenced by SwDoc::ChgPageDesc(), SwDoc::CopyPageDesc(), SwTextShell::ExecField(), SwModule::InsertEnv(), SwModule::InsertLab(), ItemSetToPageDesc(), and wwSectionManager::SetNumberingType().

◆ SetPoolFormatId()

void SwPageDesc::SetPoolFormatId ( sal_uInt16 const nId )

inline

Definition at line 276 of file pagedesc.hxx.

References nId, and SwFormat::SetPoolFormatId().

Referenced by SwDoc::CopyPageDesc(), sw::DocumentStylePoolManager::GetPageDescFromPool(), SwDocShell::MakeByExample(), and SwDoc::MakePageDesc().

◆ SetPoolHelpId()

void SwPageDesc::SetPoolHelpId ( sal_uInt16 const nId )

inline

Definition at line 278 of file pagedesc.hxx.

References nId, and SwFormat::SetPoolHelpId().

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

◆ SetPoolHlpFileId()

void SwPageDesc::SetPoolHlpFileId ( sal_uInt8 const nId )

inline

Definition at line 280 of file pagedesc.hxx.

References nId, and SwFormat::SetPoolHlpFileId().

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

◆ SetRegAscent()

void SwPageDesc::SetRegAscent ( sal_uInt16 const nNew )

inline

Definition at line 261 of file pagedesc.hxx.

Referenced by SwTextFrame::FillRegister().

◆ SetRegHeight()

void SwPageDesc::SetRegHeight ( sal_uInt16 const nNew )

inline

Definition at line 260 of file pagedesc.hxx.

Referenced by SwTextFrame::FillRegister().

◆ SetRegisterFormatColl()

void SwPageDesc::SetRegisterFormatColl ( const SwTextFormatColl * rFormat )

set the style for the grid alignment

Definition at line 211 of file pagedesc.cxx.

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

Referenced by SwDoc::ChgPageDesc(), and ItemSetToPageDesc().

◆ SetUseOn()

void SwPageDesc::SetUseOn ( UseOnPage eNew )

inline

Same as WriteUseOn(), but the >= HeaderShare part of the bitfield is not modified.

Definition at line 341 of file pagedesc.hxx.

References FirstShare, FooterShare, HeaderShare, m_eUse, and NONE.

Referenced by SwDoc::ChgPageDesc(), sw::DocumentStylePoolManager::GetPageDescFromPool(), SwModule::InsertEnv(), SwModule::InsertLab(), wwSectionManager::InsertSegments(), and ItemSetToPageDesc().

◆ SetVerticalAdjustment()

void SwPageDesc::SetVerticalAdjustment ( const drawing::TextVerticalAdjust nVA )

inline

Definition at line 264 of file pagedesc.hxx.

Referenced by wwSectionManager::SetSegmentToPageDesc().

◆ StashFrameFormat()

void SwPageDesc::StashFrameFormat	(	const SwFrameFormat &	rFormat,
		bool	bHeader,
		bool	bLeft,
		bool	bFirst
	)

Remember original header/footer formats even when they are hidden by "sharing".

Definition at line 409 of file pagedesc.cxx.

References m_aStashedFooter, m_aStashedHeader, SwPageDesc::StashedPageDesc::m_pStashedFirst, SwPageDesc::StashedPageDesc::m_pStashedFirstLeft, SwPageDesc::StashedPageDesc::m_pStashedLeft, and SAL_WARN.

Referenced by SwDoc::ChgPageDesc(), and SwDoc::CopyPageDesc().

◆ SwClientNotify()

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

overrideprivatevirtual

special handling if the style of the grid alignment changes

Definition at line 283 of file pagedesc.cxx.

References SfxHint::GetId(), isCHRATR(), sw::LegacyModifyHint::m_pOld, m_pTextFormatColl, RegisterChange(), RES_ATTRSET_CHG(), RES_FMT_CHG(), RES_PARATR_LINESPACING(), and SfxPoolItem::Which().

◆ WriteUseOn()

void SwPageDesc::WriteUseOn ( UseOnPage const eNew )

inline

Definition at line 235 of file pagedesc.hxx.

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

Friends And Related Function Documentation

◆ SwDoc

friend class SwDoc

friend

Definition at line 141 of file pagedesc.hxx.

◆ SwPageDescs

friend class SwPageDescs

friend

Definition at line 142 of file pagedesc.hxx.

Member Data Documentation

◆ m_aDepends

sw::WriterMultiListener SwPageDesc::m_aDepends

private

Because of grid alignment (Registerhaltigkeit).

Definition at line 162 of file pagedesc.hxx.

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

◆ m_aStashedFooter

StashedPageDesc SwPageDesc::m_aStashedFooter

mutableprivate

Definition at line 160 of file pagedesc.hxx.

Referenced by GetStashedFrameFormat(), HasStashedFormat(), operator=(), RemoveStashedFormat(), StashFrameFormat(), and SwPageDesc().

◆ m_aStashedHeader

StashedPageDesc SwPageDesc::m_aStashedHeader

mutableprivate

Definition at line 159 of file pagedesc.hxx.

Referenced by GetStashedFrameFormat(), HasStashedFormat(), operator=(), RemoveStashedFormat(), StashFrameFormat(), and SwPageDesc().

◆ m_eUse

UseOnPage SwPageDesc::m_eUse

private

Definition at line 168 of file pagedesc.hxx.

Referenced by ChgFirstShare(), ChgFooterShare(), ChgHeaderShare(), dumpAsXml(), GetLeftFormat(), GetRightFormat(), GetUseOn(), IsFirstShared(), IsFooterShared(), IsHeaderShared(), operator=(), and SetUseOn().

◆ m_FirstLeft

SwFrameFormat SwPageDesc::m_FirstLeft

private

Definition at line 150 of file pagedesc.hxx.

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

◆ m_FirstMaster

SwFrameFormat SwPageDesc::m_FirstMaster

private

Definition at line 149 of file pagedesc.hxx.

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

◆ m_FootnoteInfo

SwPageFootnoteInfo SwPageDesc::m_FootnoteInfo

private

Footnote information.

Definition at line 173 of file pagedesc.hxx.

◆ m_IsHidden

bool SwPageDesc::m_IsHidden

private

Definition at line 170 of file pagedesc.hxx.

◆ m_IsLandscape

bool SwPageDesc::m_IsLandscape

private

Definition at line 169 of file pagedesc.hxx.

Referenced by operator=().

◆ m_Left

SwFrameFormat SwPageDesc::m_Left

private

Definition at line 147 of file pagedesc.hxx.

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

◆ m_Master

SwFrameFormat SwPageDesc::m_Master

private

Definition at line 146 of file pagedesc.hxx.

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

◆ m_nRegAscent

sal_uInt16 SwPageDesc::m_nRegAscent

private

For grid alignment (Registerhaltigkeit).

Definition at line 166 of file pagedesc.hxx.

Referenced by operator=().

◆ m_nRegHeight

sal_uInt16 SwPageDesc::m_nRegHeight

private

Sentence spacing and fontascent of style.

Definition at line 165 of file pagedesc.hxx.

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

◆ m_NumType

SvxNumberType SwPageDesc::m_NumType

private

Definition at line 145 of file pagedesc.hxx.

Referenced by operator=().

◆ m_nVerticalAdjustment

drawing::TextVerticalAdjust SwPageDesc::m_nVerticalAdjustment

private

Definition at line 167 of file pagedesc.hxx.

Referenced by operator=().

◆ m_pdList

SwPageDescs* SwPageDesc::m_pdList

private

Backref to the assigned SwPageDescs list to handle renames.

Definition at line 176 of file pagedesc.hxx.

Referenced by SetName().

◆ m_pFollow

SwPageDesc* SwPageDesc::m_pFollow

private

Definition at line 164 of file pagedesc.hxx.

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

◆ m_pTextFormatColl

const SwTextFormatColl* SwPageDesc::m_pTextFormatColl

mutableprivate

Definition at line 163 of file pagedesc.hxx.

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

◆ m_StyleName

OUString SwPageDesc::m_StyleName

private

Definition at line 144 of file pagedesc.hxx.

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

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

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SwPageDesc() [1/2]

◆ SwPageDesc() [2/2]

◆ ~SwPageDesc()

Member Function Documentation

◆ ChgFirstShare()

◆ ChgFooterShare()

◆ ChgHeaderShare()

◆ dumpAsXml()

◆ GetByName()

◆ GetFirstLeft() [1/2]

◆ GetFirstLeft() [2/2]

◆ GetFirstMaster() [1/2]

◆ GetFirstMaster() [2/2]

◆ GetFollow() [1/2]

◆ GetFollow() [2/2]

◆ GetFootnoteInfo() [1/2]

◆ GetFootnoteInfo() [2/2]

◆ GetInfo()

◆ GetLandscape()

◆ GetLeft() [1/2]

◆ GetLeft() [2/2]

◆ GetLeftFormat() [1/2]

◆ GetLeftFormat() [2/2]

◆ GetMaster() [1/2]

◆ GetMaster() [2/2]

◆ GetName()

◆ GetNumType()

◆ GetPageDescOfNode()

◆ GetPageFormatOfNode()

◆ GetPoolFormatId()

◆ GetPoolHelpId()

◆ GetPoolHlpFileId()

◆ GetRegAscent()

◆ GetRegHeight()

◆ GetRegisterFormatColl()

◆ GetRightFormat() [1/2]

◆ GetRightFormat() [2/2]

◆ GetStashedFrameFormat()

◆ GetUseOn()

◆ GetVerticalAdjustment()

◆ HasStashedFormat()

◆ IsFirstShared()

◆ IsFollowNextPageOfNode()

◆ IsFooterShared()

◆ IsHeaderShared()

◆ IsHidden()

◆ Mirror()

◆ operator=()

◆ ReadUseOn()

◆ RegisterChange()

◆ RemoveStashedFormat()

◆ ResetAllAttr()

◆ ResetAllMasterAttr()

◆ SetFollow()

◆ SetFootnoteInfo()

◆ SetHidden()

◆ SetLandscape()

◆ SetName()

◆ SetNumType()

◆ SetPoolFormatId()

◆ SetPoolHelpId()

◆ SetPoolHlpFileId()

◆ SetRegAscent()

◆ SetRegHeight()

◆ SetRegisterFormatColl()

◆ SetUseOn()

◆ SetVerticalAdjustment()

◆ StashFrameFormat()

◆ SwClientNotify()

◆ WriteUseOn()

Friends And Related Function Documentation

◆ SwDoc