LibreOffice Module sc (master)  1
Public Types | Public Member Functions | Public Attributes | List of all members
XclPageData Struct Reference

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

#include <xlpage.hxx>

Public Types

typedef std::unique_ptr< SvxBrushItemSvxBrushItemPtr
 

Public Member Functions

 XclPageData (const XclPageData &)=delete
 noncopyable More...
 
const XclPageDataoperator= (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...
 
double mfLeftMargin
 Excel footer string for even pages (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 mbValid
 True = use maHeaderEven/maFooterEven. 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 97 of file xlpage.hxx.

Member Typedef Documentation

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

Definition at line 103 of file xlpage.hxx.

Constructor & Destructor Documentation

XclPageData::XclPageData ( const XclPageData )
delete

noncopyable

XclPageData::XclPageData ( )
explicit

true = print grid lines.

Definition at line 166 of file xlpage.cxx.

References SetDefaults().

XclPageData::~XclPageData ( )

Definition at line 171 of file xlpage.cxx.

Member Function Documentation

Size XclPageData::GetScPaperSize ( ) const

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

Definition at line 205 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().

const XclPageData& XclPageData::operator= ( const XclPageData )
delete
void XclPageData::SetDefaults ( )
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 232 of file xlpage.cxx.

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

Referenced by XclExpPageSettings::XclExpPageSettings().

Member Data Documentation

OUString XclPageData::maFooter
OUString XclPageData::maFooterEven

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

Definition at line 111 of file xlpage.hxx.

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

OUString XclPageData::maHeader
OUString XclPageData::maHeaderEven

Excel footer string (empty = off).

Definition at line 110 of file xlpage.hxx.

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

ScfUInt16Vec XclPageData::maHorPageBreaks
ScfUInt16Vec XclPageData::maVerPageBreaks
bool XclPageData::mbBlackWhite

true = in rows; false = in columns.

Definition at line 138 of file xlpage.hxx.

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

bool XclPageData::mbDraftQuality

true = black/white; false = colors.

Definition at line 139 of file xlpage.hxx.

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

bool XclPageData::mbFitToPages

true = mnStartPage valid; false = automatic.

Definition at line 142 of file xlpage.hxx.

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

bool XclPageData::mbHorCenter
bool XclPageData::mbManualStart
bool XclPageData::mbPortrait
bool XclPageData::mbPrintGrid
bool XclPageData::mbPrintHeadings
bool XclPageData::mbPrintInRows
bool XclPageData::mbPrintNotes
bool XclPageData::mbUseEvenHF

Vertical printing resolution.

Definition at line 133 of file xlpage.hxx.

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

bool XclPageData::mbValid
bool XclPageData::mbVerCenter
double XclPageData::mfBottomMargin
double XclPageData::mfFooterMargin
double XclPageData::mfFtrLeftMargin

Right margin to header.

Definition at line 120 of file xlpage.hxx.

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

double XclPageData::mfFtrRightMargin

Left margin to footer.

Definition at line 121 of file xlpage.hxx.

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

double XclPageData::mfHdrLeftMargin

Margin main page to footer.

Definition at line 118 of file xlpage.hxx.

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

double XclPageData::mfHdrRightMargin

Left margin to header.

Definition at line 119 of file xlpage.hxx.

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

double XclPageData::mfHeaderMargin
double XclPageData::mfLeftMargin
double XclPageData::mfRightMargin
double XclPageData::mfTopMargin
sal_uInt16 XclPageData::mnCopies

Paper Height in mm.

Definition at line 126 of file xlpage.hxx.

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

sal_uInt16 XclPageData::mnFitToHeight
sal_uInt16 XclPageData::mnFitToWidth
sal_uInt16 XclPageData::mnHorPrintRes

Fit to number of pages in height.

Definition at line 131 of file xlpage.hxx.

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

sal_uInt16 XclPageData::mnPaperHeight

Paper Width in mm.

Definition at line 125 of file xlpage.hxx.

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

sal_uInt16 XclPageData::mnPaperSize
sal_uInt16 XclPageData::mnPaperWidth

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

Definition at line 124 of file xlpage.hxx.

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

sal_uInt16 XclPageData::mnScaling
sal_uInt16 XclPageData::mnStartPage
sal_uInt16 XclPageData::mnStrictPaperSize

Index into paper size table.

Definition at line 123 of file xlpage.hxx.

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

sal_uInt16 XclPageData::mnVerPrintRes

Horizontal printing resolution.

Definition at line 132 of file xlpage.hxx.

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

SvxBrushItemPtr XclPageData::mxBrushItem

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