Contains all page (print) settings for a single sheet. More...

#include <xlpage.hxx>

Public Types
typedef std::unique_ptr< SvxBrushItem >	SvxBrushItemPtr

Public Member Functions
	XclPageData (const XclPageData &)=delete
	noncopyable More...

const XclPageData &	operator= (const XclPageData &)=delete

	XclPageData ()
	true = print grid lines. More...

	~XclPageData ()

void	SetDefaults ()
	Sets Excel default page settings. More...

Size	GetScPaperSize () const
	Returns the real paper size (twips) from the paper size index and paper orientation. More...

void	SetScPaperSize (const Size &rSize, bool bPortrait, bool bStrict=false)
	Sets the Excel paper size index and paper orientation from Calc paper size (twips). More...

Public Attributes
ScfUInt16Vec	maHorPageBreaks

ScfUInt16Vec	maVerPageBreaks
	Horizontal page breaks. More...

SvxBrushItemPtr	mxBrushItem
	Vertical page breaks. More...

OUString	maHeader
	Background bitmap. More...

OUString	maFooter
	Excel header string (empty = off). More...

OUString	maHeaderEven
	Excel footer string (empty = off). More...

OUString	maFooterEven
	Excel header string for even pages (empty = off). More...

OUString	maHeaderFirst
	Excel footer string for even pages (empty = off). More...

OUString	maFooterFirst
	Excel header string for first page (empty = off). More...

double	mfLeftMargin
	Excel footer string for first page (empty = off). More...

double	mfRightMargin
	Left margin in inches. More...

double	mfTopMargin
	Right margin in inches. More...

double	mfBottomMargin
	Top margin in inches. More...

double	mfHeaderMargin
	Bottom margin in inches. More...

double	mfFooterMargin
	Margin main page to header. More...

double	mfHdrLeftMargin
	Margin main page to footer. More...

double	mfHdrRightMargin
	Left margin to header. More...

double	mfFtrLeftMargin
	Right margin to header. More...

double	mfFtrRightMargin
	Left margin to footer. More...

sal_uInt16	mnPaperSize
	Right margin to footer. More...

sal_uInt16	mnStrictPaperSize
	Index into paper size table. More...

sal_uInt16	mnPaperWidth
	Same as papersize - but for ooxml (considering stricter dimensions) More...

sal_uInt16	mnPaperHeight
	Paper Width in mm. More...

sal_uInt16	mnCopies
	Paper Height in mm. More...

sal_uInt16	mnStartPage
	Number of copies. More...

sal_uInt16	mnScaling
	Start page number. More...

sal_uInt16	mnFitToWidth
	Scaling in percent. More...

sal_uInt16	mnFitToHeight
	Fit to number of pages in width. More...

sal_uInt16	mnHorPrintRes
	Fit to number of pages in height. More...

sal_uInt16	mnVerPrintRes
	Horizontal printing resolution. More...

bool	mbUseEvenHF
	Vertical printing resolution. More...

bool	mbUseFirstHF
	True = use maHeaderEven/maFooterEven. More...

bool	mbValid
	True = use maHeaderFirst/maFooterFirst. More...

bool	mbPortrait
	false = some of the values are not valid. More...

bool	mbPrintInRows
	true = portrait; false = landscape. More...

bool	mbBlackWhite
	true = in rows; false = in columns. More...

bool	mbDraftQuality
	true = black/white; false = colors. More...

bool	mbPrintNotes
	true = draft; false = default quality. More...

bool	mbManualStart
	true = print notes. More...

bool	mbFitToPages
	true = mnStartPage valid; false = automatic. More...

bool	mbHorCenter
	true = fit to pages; false = scale in percent. More...

bool	mbVerCenter
	true = centered horizontally; false = left aligned. More...

bool	mbPrintHeadings
	true = centered vertically; false = top aligned. More...

bool	mbPrintGrid
	true = print column and row headings. More...

Detailed Description

Contains all page (print) settings for a single sheet.

Definition at line 101 of file xlpage.hxx.

Member Typedef Documentation

◆ SvxBrushItemPtr

typedef std::unique_ptr< SvxBrushItem > XclPageData::SvxBrushItemPtr

Definition at line 107 of file xlpage.hxx.

Constructor & Destructor Documentation

◆ XclPageData() [1/2]

XclPageData::XclPageData ( const XclPageData & )

delete

noncopyable

◆ XclPageData() [2/2]

XclPageData::XclPageData ( )

explicit

true = print grid lines.

Definition at line 154 of file xlpage.cxx.

References SetDefaults().

◆ ~XclPageData()

XclPageData::~XclPageData ( )

Definition at line 159 of file xlpage.cxx.

Member Function Documentation

◆ GetScPaperSize()

Size XclPageData::GetScPaperSize ( ) const

Returns the real paper size (twips) from the paper size index and paper orientation.

Definition at line 193 of file xlpage.cxx.

References SvxPaperInfo::GetDefaultPaperSize(), SvxPaperInfo::GetPaperSize(), Size::Height(), mbPortrait, mnPaperSize, n, PAPER_USER, SAL_N_ELEMENTS, Size::setHeight(), Size::setWidth(), and Size::Width().

Referenced by XclImpPageSettings::Finalize(), and XclImpChartObj::FinalizeTabChart().

◆ operator=()

const XclPageData & XclPageData::operator= ( const XclPageData & )

delete

◆ SetDefaults()

void XclPageData::SetDefaults ( )

Sets Excel default page settings.

Definition at line 164 of file xlpage.cxx.

References EXC_MARGIN_DEFAULT_FLR, EXC_MARGIN_DEFAULT_HF, EXC_MARGIN_DEFAULT_HLR, EXC_MARGIN_DEFAULT_LR, EXC_MARGIN_DEFAULT_TB, EXC_PAPERSIZE_DEFAULT, XclTools::GetInchFromHmm(), maFooter, maFooterEven, maHeader, maHeaderEven, maHorPageBreaks, maVerPageBreaks, mbBlackWhite, mbDraftQuality, mbFitToPages, mbHorCenter, mbManualStart, mbPortrait, mbPrintGrid, mbPrintHeadings, mbPrintInRows, mbPrintNotes, mbUseEvenHF, mbUseFirstHF, mbValid, mbVerCenter, mfBottomMargin, mfFooterMargin, mfFtrLeftMargin, mfFtrRightMargin, mfHdrLeftMargin, mfHdrRightMargin, mfHeaderMargin, mfLeftMargin, mfRightMargin, mfTopMargin, mnCopies, mnFitToHeight, mnFitToWidth, mnHorPrintRes, mnPaperHeight, mnPaperSize, mnPaperWidth, mnScaling, mnStartPage, mnStrictPaperSize, mnVerPrintRes, and mxBrushItem.

Referenced by XclImpPageSettings::Initialize(), and XclPageData().

◆ SetScPaperSize()

void XclPageData::SetScPaperSize	(	const Size &	rSize,
		bool	bPortrait,
		bool	bStrict = `false`
	)

Sets the Excel paper size index and paper orientation from Calc paper size (twips).

Definition at line 220 of file xlpage.cxx.

References EXC_PAPERSIZE_DEFAULT, EXC_PAPERSIZE_USER, Size::Height(), mbPortrait, mnPaperHeight, mnPaperSize, mnPaperWidth, mnStrictPaperSize, nIndex, SetScPaperSize(), and Size::Width().

Referenced by SetScPaperSize(), and XclExpPageSettings::XclExpPageSettings().

Member Data Documentation

◆ maFooter

OUString XclPageData::maFooter

Excel header string (empty = off).

Definition at line 113 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadHeaderFooter(), XclExpPageSettings::Save(), XclExpChartPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ maFooterEven

OUString XclPageData::maFooterEven

Excel header string for even pages (empty = off).

Definition at line 115 of file xlpage.hxx.

Referenced by XclImpPageSettings::ReadHeaderFooter(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ maFooterFirst

OUString XclPageData::maFooterFirst

Excel header string for first page (empty = off).

Definition at line 117 of file xlpage.hxx.

Referenced by XclExpPageSettings::SaveXml(), and XclExpPageSettings::XclExpPageSettings().

◆ maHeader

OUString XclPageData::maHeader

Background bitmap.

Definition at line 112 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadHeaderFooter(), XclExpPageSettings::Save(), XclExpChartPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ maHeaderEven

OUString XclPageData::maHeaderEven

Excel footer string (empty = off).

Definition at line 114 of file xlpage.hxx.

Referenced by XclImpPageSettings::ReadHeaderFooter(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ maHeaderFirst

OUString XclPageData::maHeaderFirst

Excel footer string for even pages (empty = off).

Definition at line 116 of file xlpage.hxx.

Referenced by XclExpPageSettings::SaveXml(), and XclExpPageSettings::XclExpPageSettings().

◆ maHorPageBreaks

ScfUInt16Vec XclPageData::maHorPageBreaks

Definition at line 109 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadPageBreaks(), XclExpPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ maVerPageBreaks

ScfUInt16Vec XclPageData::maVerPageBreaks

Horizontal page breaks.

Definition at line 110 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadPageBreaks(), XclExpPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mbBlackWhite

bool XclPageData::mbBlackWhite

true = in rows; false = in columns.

Definition at line 144 of file xlpage.hxx.

Referenced by XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), and XclExpSetup::WriteBody().

◆ mbDraftQuality

bool XclPageData::mbDraftQuality

true = black/white; false = colors.

Definition at line 145 of file xlpage.hxx.

Referenced by XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), and XclExpSetup::WriteBody().

◆ mbFitToPages

bool XclPageData::mbFitToPages

true = mnStartPage valid; false = automatic.

Definition at line 148 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), SetDefaults(), XclImpPageSettings::SetFitToPages(), and XclExpPageSettings::XclExpPageSettings().

◆ mbHorCenter

bool XclPageData::mbHorCenter

true = fit to pages; false = scale in percent.

Definition at line 149 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadCenter(), XclExpPageSettings::Save(), XclExpChartPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mbManualStart

bool XclPageData::mbManualStart

true = print notes.

Definition at line 147 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mbPortrait

bool XclPageData::mbPortrait

false = some of the values are not valid.

Definition at line 142 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), GetScPaperSize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclImpPageSettings::SetPaperSize(), SetScPaperSize(), and XclExpSetup::WriteBody().

◆ mbPrintGrid

bool XclPageData::mbPrintGrid

true = print column and row headings.

Definition at line 152 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadPrintGridLines(), XclExpPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mbPrintHeadings

bool XclPageData::mbPrintHeadings

true = centered vertically; false = top aligned.

Definition at line 151 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpChartObj::FinalizeTabChart(), XclImpPageSettings::ReadPrintHeaders(), XclExpPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mbPrintInRows

bool XclPageData::mbPrintInRows

true = portrait; false = landscape.

Definition at line 143 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mbPrintNotes

bool XclPageData::mbPrintNotes

true = draft; false = default quality.

Definition at line 146 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mbUseEvenHF

bool XclPageData::mbUseEvenHF

Vertical printing resolution.

Definition at line 139 of file xlpage.hxx.

Referenced by XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mbUseFirstHF

bool XclPageData::mbUseFirstHF

True = use maHeaderEven/maFooterEven.

Definition at line 140 of file xlpage.hxx.

Referenced by XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mbValid

bool XclPageData::mbValid

True = use maHeaderFirst/maFooterFirst.

Definition at line 141 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mbVerCenter

bool XclPageData::mbVerCenter

true = centered horizontally; false = left aligned.

Definition at line 150 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadCenter(), XclExpPageSettings::Save(), XclExpChartPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mfBottomMargin

double XclPageData::mfBottomMargin

Top margin in inches.

Definition at line 121 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpChartObj::FinalizeTabChart(), XclImpPageSettings::ReadMargin(), XclExpPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mfFooterMargin

double XclPageData::mfFooterMargin

Margin main page to header.

Definition at line 123 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpPageSettings::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mfFtrLeftMargin

double XclPageData::mfFtrLeftMargin

Right margin to header.

Definition at line 126 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), and SetDefaults().

◆ mfFtrRightMargin

double XclPageData::mfFtrRightMargin

Left margin to footer.

Definition at line 127 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), and SetDefaults().

◆ mfHdrLeftMargin

double XclPageData::mfHdrLeftMargin

Margin main page to footer.

Definition at line 124 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), and SetDefaults().

◆ mfHdrRightMargin

double XclPageData::mfHdrRightMargin

Left margin to header.

Definition at line 125 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), and SetDefaults().

◆ mfHeaderMargin

double XclPageData::mfHeaderMargin

Bottom margin in inches.

Definition at line 122 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpPageSettings::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mfLeftMargin

double XclPageData::mfLeftMargin

Excel footer string for first page (empty = off).

Definition at line 118 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpChartObj::FinalizeTabChart(), XclImpPageSettings::ReadMargin(), XclExpPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mfRightMargin

double XclPageData::mfRightMargin

Left margin in inches.

Definition at line 119 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpChartObj::FinalizeTabChart(), XclImpPageSettings::ReadMargin(), XclExpPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mfTopMargin

double XclPageData::mfTopMargin

Right margin in inches.

Definition at line 120 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpChartObj::FinalizeTabChart(), XclImpPageSettings::ReadMargin(), XclExpPageSettings::Save(), XclExpPageSettings::SaveXml(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

◆ mnCopies

sal_uInt16 XclPageData::mnCopies

Paper Height in mm.

Definition at line 132 of file xlpage.hxx.

Referenced by XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), and XclExpSetup::WriteBody().

◆ mnFitToHeight

sal_uInt16 XclPageData::mnFitToHeight

Fit to number of pages in width.

Definition at line 136 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mnFitToWidth

sal_uInt16 XclPageData::mnFitToWidth

Scaling in percent.

Definition at line 135 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mnHorPrintRes

sal_uInt16 XclPageData::mnHorPrintRes

Fit to number of pages in height.

Definition at line 137 of file xlpage.hxx.

Referenced by XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), and XclExpSetup::WriteBody().

◆ mnPaperHeight

sal_uInt16 XclPageData::mnPaperHeight

Paper Width in mm.

Definition at line 131 of file xlpage.hxx.

Referenced by XclExpSetup::SaveXml(), SetDefaults(), and SetScPaperSize().

◆ mnPaperSize

sal_uInt16 XclPageData::mnPaperSize

Right margin to footer.

Definition at line 128 of file xlpage.hxx.

Referenced by GetScPaperSize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclImpPageSettings::SetPaperSize(), SetScPaperSize(), and XclExpSetup::WriteBody().

◆ mnPaperWidth

sal_uInt16 XclPageData::mnPaperWidth

Same as papersize - but for ooxml (considering stricter dimensions)

Definition at line 130 of file xlpage.hxx.

Referenced by XclExpSetup::SaveXml(), SetDefaults(), and SetScPaperSize().

◆ mnScaling

sal_uInt16 XclPageData::mnScaling

Start page number.

Definition at line 134 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mnStartPage

sal_uInt16 XclPageData::mnStartPage

Number of copies.

Definition at line 133 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), XclExpSetup::WriteBody(), and XclExpPageSettings::XclExpPageSettings().

◆ mnStrictPaperSize

sal_uInt16 XclPageData::mnStrictPaperSize

Index into paper size table.

Definition at line 129 of file xlpage.hxx.

Referenced by XclExpSetup::SaveXml(), SetDefaults(), and SetScPaperSize().

◆ mnVerPrintRes

sal_uInt16 XclPageData::mnVerPrintRes

Horizontal printing resolution.

Definition at line 138 of file xlpage.hxx.

Referenced by XclImpPageSettings::ReadSetup(), XclExpSetup::SaveXml(), SetDefaults(), and XclExpSetup::WriteBody().

◆ mxBrushItem

SvxBrushItemPtr XclPageData::mxBrushItem

Vertical page breaks.

Definition at line 111 of file xlpage.hxx.

Referenced by XclImpPageSettings::Finalize(), XclExpPageSettings::getGraphicExport(), XclImpPageSettings::ReadImgData(), XclExpPageSettings::Save(), SetDefaults(), and XclExpPageSettings::XclExpPageSettings().

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

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ SvxBrushItemPtr

Constructor & Destructor Documentation

◆ XclPageData() [1/2]

◆ XclPageData() [2/2]

◆ ~XclPageData()

Member Function Documentation

◆ GetScPaperSize()

◆ operator=()

◆ SetDefaults()

◆ SetScPaperSize()

Member Data Documentation

◆ maFooter

◆ maFooterEven

◆ maFooterFirst

◆ maHeader

◆ maHeaderEven

◆ maHeaderFirst

◆ maHorPageBreaks

◆ maVerPageBreaks

◆ mbBlackWhite

◆ mbDraftQuality

◆ mbFitToPages

◆ mbHorCenter

◆ mbManualStart

◆ mbPortrait

◆ mbPrintGrid

◆ mbPrintHeadings

◆ mbPrintInRows

◆ mbPrintNotes

◆ mbUseEvenHF

◆ mbUseFirstHF

◆ mbValid

◆ mbVerCenter

◆ mfBottomMargin

◆ mfFooterMargin

◆ mfFtrLeftMargin

◆ mfFtrRightMargin

◆ mfHdrLeftMargin

◆ mfHdrRightMargin

◆ mfHeaderMargin

◆ mfLeftMargin

◆ mfRightMargin

◆ mfTopMargin

◆ mnCopies

◆ mnFitToHeight

◆ mnFitToWidth

◆ mnHorPrintRes

◆ mnPaperHeight

◆ mnPaperSize

◆ mnPaperWidth

◆ mnScaling

◆ mnStartPage

◆ mnStrictPaperSize

◆ mnVerPrintRes

◆ mxBrushItem