LibreOffice Module sc (master)  1
Public Member Functions | Private Attributes | List of all members
XclImpPageSettings Class Reference

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

#include <xipage.hxx>

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

Public Member Functions

 XclImpPageSettings (const XclImpRoot &rRoot)
 
const XclPageDataGetPageData () const
 Returns read-only access to the page data. More...
 
void Initialize ()
 Initializes the object to be used for a new sheet. More...
 
void ReadSetup (XclImpStream &rStrm)
 Reads a SETUP record and inserts contained data. More...
 
void ReadMargin (XclImpStream &rStrm)
 Reads a ***MARGIN record (reads all 4 margin records). More...
 
void ReadCenter (XclImpStream &rStrm)
 Reads a HCENTER or VCENTER record. More...
 
void ReadHeaderFooter (XclImpStream &rStrm)
 Reads a HEADER or FOOTER record. More...
 
void ReadPageBreaks (XclImpStream &rStrm)
 Reads a HORIZONTALPAGEBREAKS or VERTICALPAGEBREAKS record. More...
 
void ReadPrintHeaders (XclImpStream &rStrm)
 Reads a PRINTHEADERS record. More...
 
void ReadPrintGridLines (XclImpStream &rStrm)
 Reads a PRINTGRIDLINES record. More...
 
void ReadImgData (XclImpStream &rStrm)
 Reads an IMGDATA record and creates the SvxBrushItem. More...
 
void SetPaperSize (sal_uInt16 nXclPaperSize, bool bPortrait)
 Overrides paper size and orientation (used in sheet-charts). More...
 
void SetFitToPages (bool bFitToPages)
 Sets or clears the fit-to-pages setting (contained in WSBOOL record). More...
 
void Finalize ()
 Creates a page stylesheet from current settings and sets it at current sheet. More...
 

Private Attributes

XclPageData maData
 
bool mbValidPaper
 Page settings data. More...
 

Additional Inherited Members

- Protected Member Functions inherited from XclImpRoot
 XclImpRoot (XclImpRootData &rImpRootData)
 
const XclImpRootGetRoot () const
 Returns this root instance - for code readability in derived classes. More...
 
XclImpRootGetRoot ()
 
void SetCodePage (sal_uInt16 nCodePage)
 Sets a code page read from a CODEPAGE record for byte string import. More...
 
void InitializeTable (SCTAB nScTab)
 Is called when import filter starts importing a single sheet (all BIFF versions). More...
 
void FinalizeTable ()
 Is called when import filter stops importing a single sheet (all BIFF versions). More...
 
XclImpAddressConverterGetAddressConverter () const
 Returns the address converter. More...
 
XclImpFormulaCompilerGetFormulaCompiler () const
 Returns the formula converter. More...
 
ExcelToScGetOldFmlaConverter () const
 Returns the old formula converter. More...
 
XclImpSstGetSst () const
 Returns the shared string table. More...
 
XclImpPaletteGetPalette () const
 Returns the color buffer. More...
 
XclImpFontBufferGetFontBuffer () const
 Returns the font buffer. More...
 
XclImpNumFmtBufferGetNumFmtBuffer () const
 Returns the number format buffer. More...
 
XclImpXFBufferGetXFBuffer () const
 Returns the cell formatting attributes buffer. More...
 
XclImpXFRangeBufferGetXFRangeBuffer () const
 Returns the buffer of XF index ranges for a sheet. More...
 
ScRangeListTabsGetPrintAreaBuffer () const
 Returns the buffer that contains all print areas in the document. More...
 
ScRangeListTabsGetTitleAreaBuffer () const
 Returns the buffer that contains all print titles in the document. More...
 
XclImpTabInfoGetTabInfo () const
 Returns the buffer that contains the sheet creation order. More...
 
XclImpNameManagerGetNameManager () const
 Returns the buffer that contains internal defined names. More...
 
XclImpLinkManagerGetLinkManager () const
 Returns the link manager. More...
 
XclImpObjectManagerGetObjectManager () const
 Returns the drawing object manager. More...
 
XclImpSheetDrawingGetCurrSheetDrawing () const
 Returns the drawing container of the current sheet. More...
 
XclImpCondFormatManagerGetCondFormatManager () const
 Returns the conditional formatting manager. More...
 
XclImpValidationManagerGetValidationManager () const
 
XclImpAutoFilterBufferGetFilterManager () const
 Returns the filter manager. More...
 
XclImpWebQueryBufferGetWebQueryBuffer () const
 Returns the web query buffer. More...
 
XclImpPivotTableManagerGetPivotTableManager () const
 Returns the pivot table manager. More...
 
XclImpSheetProtectBufferGetSheetProtectBuffer () const
 Returns the sheet protection options of the current sheet. More...
 
XclImpDocProtectBufferGetDocProtectBuffer () const
 Returns the document protection options. More...
 
XclImpPageSettingsGetPageSettings () const
 Returns the page settings of the current sheet. More...
 
XclImpDocViewSettingsGetDocViewSettings () const
 Returns the view settings of the entire document. More...
 
XclImpTabViewSettingsGetTabViewSettings () const
 Returns the view settings of the current sheet. More...
 
bool HasBasic () const
 Returns true, if the document contains a VB project. More...
 
void SetHasBasic ()
 Called to indicate that the document contains a VB project. More...
 
void ReadCodeName (XclImpStream &rStrm, bool bGlobals)
 Reads the CODENAME record and inserts the codename into the document. More...
 
ScDocumentImportGetDocImport ()
 
- Protected Member Functions inherited from XclRoot
 XclRoot (XclRootData &rRootData)
 
 XclRoot (const XclRoot &rRoot)
 
virtual ~XclRoot ()
 
XclRootoperator= (const XclRoot &rRoot)
 
RootDataGetOldRoot () const
 Returns old RootData struct. More...
 
XclBiff GetBiff () const
 Returns the current BIFF version of the importer/exporter. More...
 
XclOutput GetOutput () const
 Returns the current output format of the importer/exporter. More...
 
bool IsImport () const
 Returns true, if currently a document is imported. More...
 
rtl_TextEncoding GetTextEncoding () const
 Returns the text encoding to import/export byte strings. More...
 
LanguageType GetSysLanguage () const
 Returns the system language, i.e. More...
 
LanguageType GetDocLanguage () const
 Returns the document language. More...
 
LanguageType GetUILanguage () const
 Returns the UI language. More...
 
sal_Int16 GetDefApiScript () const
 Returns the default script type, e.g. More...
 
tools::Long GetCharWidth () const
 Returns the width of the '0' character (default font) for the current printer (twips). More...
 
bool IsInGlobals () const
 Returns the current Calc sheet index. More...
 
SCTAB GetCurrScTab () const
 Returns the current Calc sheet index. More...
 
sal_Int32 GetHmmFromPixelX (double fPixelX) const
 Calculates the width of the passed number of pixels in 1/100 mm. More...
 
sal_Int32 GetHmmFromPixelY (double fPixelY) const
 Calculates the height of the passed number of pixels in 1/100 mm. More...
 
SfxMediumGetMedium () const
 Returns the medium to import from. More...
 
const OUString & GetDocUrl () const
 Returns the document URL of the imported/exported file. More...
 
const OUString & GetBasePath () const
 Returns the base path of the imported/exported file. More...
 
const OUString & GetUserName () const
 Returns the current user name. More...
 
css::uno::Sequence< css::beans::NamedValue > RequestEncryptionData (::comphelper::IDocPasswordVerifier &rVerifier) const
 Requests and verifies a password from the medium or the user. More...
 
const tools::SvRef< SotStorage > & GetRootStorage () const
 Returns the OLE2 root storage of the imported/exported file. More...
 
bool HasVbaStorage () const
 Returns true, if the document contains a VBA storage. More...
 
tools::SvRef< SotStorageOpenStorage (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrgName) const
 Tries to open a storage as child of the specified storage for reading or writing. More...
 
tools::SvRef< SotStorageOpenStorage (const OUString &rStrgName) const
 Tries to open a storage as child of the root storage for reading or writing. More...
 
tools::SvRef< SotStorageStreamOpenStream (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrmName) const
 Tries to open a new stream in the specified storage for reading or writing. More...
 
tools::SvRef< SotStorageStreamOpenStream (const OUString &rStrmName) const
 Tries to open a new stream in the root storage for reading or writing. More...
 
ScDocumentGetDoc () const
 Returns reference to the destination document (import) or source document (export). More...
 
SfxObjectShellGetDocShell () const
 Returns the object shell of the Calc document. More...
 
ScModelObjGetDocModelObj () const
 Returns the object model of the Calc document. More...
 
OutputDeviceGetPrinter () const
 Returns pointer to the printer of the Calc document. More...
 
ScStyleSheetPoolGetStyleSheetPool () const
 Returns the style sheet pool of the Calc document. More...
 
ScRangeNameGetNamedRanges () const
 Returns the defined names container of the Calc document. More...
 
SdrPageGetSdrPage (SCTAB nScTab) const
 Returns the drawing layer page of the passed sheet, if present. More...
 
SvNumberFormatterGetFormatter () const
 Returns the number formatter of the Calc document. More...
 
DateTime GetNullDate () const
 Returns the null date of the current number formatter. More...
 
sal_uInt16 GetBaseYear () const
 Returns the base year depending on the current null date (1900 or 1904). More...
 
double GetDoubleFromDateTime (const DateTime &rDateTime) const
 Converts a date/time value to a floating-point value. More...
 
DateTime GetDateTimeFromDouble (double fValue) const
 Converts a floating-point value to a date/time value. More...
 
ScEditEngineDefaulterGetEditEngine () const
 Returns the edit engine for import/export of rich strings etc. More...
 
ScHeaderEditEngineGetHFEditEngine () const
 Returns the edit engine for import/export of headers/footers. More...
 
EditEngineGetDrawEditEngine () const
 Returns the edit engine for import/export of drawing text boxes. More...
 
XclFontPropSetHelperGetFontPropSetHelper () const
 Returns the property set helper for fonts. More...
 
XclChPropSetHelperGetChartPropSetHelper () const
 Returns the property set helper for the chart filters. More...
 
ScExtDocOptionsGetExtDocOptions () const
 Returns the extended document options. More...
 
XclTracerGetTracer () const
 Returns the filter tracer. More...
 
const ScAddressGetScMaxPos () const
 Returns the highest possible cell address in a Calc document. More...
 
const ScAddressGetXclMaxPos () const
 Returns the highest possible cell address in an Excel document (using current BIFF version). More...
 
const ScAddressGetMaxPos () const
 Returns the highest possible cell address valid in Calc and Excel (using current BIFF version). More...
 
void SetDocLanguage (LanguageType eLang)
 Sets the document language. More...
 
void SetUILanguage (LanguageType eLang)
 Sets the UI language, i.e. More...
 
void SetTextEncoding (rtl_TextEncoding eTextEnc)
 Sets the text encoding to import/export byte strings. More...
 
void SetCharWidth (const XclFontData &rFontData)
 Sets the width of the '0' character (default font) for the current printer (twips). More...
 
void SetCurrScTab (SCTAB nScTab)
 Sets the current Calc sheet index. More...
 
void IncCurrScTab ()
 Increases the current Calc sheet index by 1. More...
 
- Static Protected Member Functions inherited from XclImpRoot
static OUString GetScAddInName (const OUString &rXclName)
 Returns the Calc add-in function name for an Excel function name. More...
 
- Static Protected Member Functions inherited from XclRoot
static OUString GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 

Detailed Description

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

Supports reading all related records and creating a page style sheet.

Definition at line 30 of file xipage.hxx.

Constructor & Destructor Documentation

XclImpPageSettings::XclImpPageSettings ( const XclImpRoot rRoot)
explicit

Definition at line 41 of file xipage.cxx.

References Initialize().

Member Function Documentation

void XclImpPageSettings::Finalize ( )

Creates a page stylesheet from current settings and sets it at current sheet.

Definition at line 224 of file xipage.cxx.

References ATTR_PAGE(), ATTR_PAGE_DYNAMIC(), ATTR_PAGE_FIRSTPAGENO(), ATTR_PAGE_FOOTERLEFT(), ATTR_PAGE_FOOTERRIGHT(), ATTR_PAGE_FOOTERSET(), ATTR_PAGE_GRID(), ATTR_PAGE_HEADERLEFT(), ATTR_PAGE_HEADERRIGHT(), ATTR_PAGE_HEADERS(), ATTR_PAGE_HEADERSET(), ATTR_PAGE_HORCENTER(), ATTR_PAGE_NOTES(), ATTR_PAGE_ON(), ATTR_PAGE_SCALE(), ATTR_PAGE_SIZE(), ATTR_PAGE_TOPDOWN(), ATTR_PAGE_VERCENTER(), EXC_ID_BOTTOMMARGIN, EXC_ID_LEFTMARGIN, EXC_ID_RIGHTMARGIN, EXC_ID_TOPMARGIN, XclImpHFConverter::FillToItemSet(), SfxItemSet::Get(), XclRoot::GetCurrScTab(), XclRoot::GetDoc(), XclTools::GetInchFromTwips(), ScStyleSheet::GetItemSet(), SfxStyleSheetBase::GetName(), XclImpRoot::GetRoot(), XclPageData::GetScPaperSize(), XclRoot::GetStyleSheetPool(), XclImpHFConverter::GetTotalHeight(), XclTools::GetTwipsFromInch(), maData, XclPageData::maFooter, XclPageData::maHeader, XclPageData::maHorPageBreaks, ScfTools::MakePageStyleSheet(), XclPageData::maVerPageBreaks, ScDocument::MaxCol(), ScDocument::MaxRow(), XclPageData::mbFitToPages, XclPageData::mbHorCenter, XclPageData::mbManualStart, XclPageData::mbPortrait, XclPageData::mbPrintGrid, XclPageData::mbPrintHeadings, XclPageData::mbPrintInRows, XclPageData::mbPrintNotes, XclPageData::mbValid, mbValidPaper, XclPageData::mbVerCenter, XclPageData::mfBottomMargin, XclPageData::mfFooterMargin, XclPageData::mfFtrLeftMargin, XclPageData::mfFtrRightMargin, XclPageData::mfHdrLeftMargin, XclPageData::mfHdrRightMargin, XclPageData::mfHeaderMargin, XclPageData::mfLeftMargin, XclPageData::mfRightMargin, XclPageData::mfTopMargin, XclPageData::mnFitToHeight, XclPageData::mnFitToWidth, XclPageData::mnScaling, XclPageData::mnStartPage, XclPageData::mxBrushItem, XclImpHFConverter::ParseString(), SfxItemSet::Put(), ScfTools::PutItem(), ScDocument::SetColBreak(), SvxPageItem::SetLandscape(), ScDocument::SetPageStyle(), and ScDocument::SetRowBreak().

Referenced by XclImpRoot::FinalizeTable().

const XclPageData& XclImpPageSettings::GetPageData ( ) const
inline

Returns read-only access to the page data.

Definition at line 36 of file xipage.hxx.

References maData.

Referenced by XclImpChartObj::FinalizeTabChart().

void XclImpPageSettings::Initialize ( )

Initializes the object to be used for a new sheet.

Definition at line 47 of file xipage.cxx.

References maData, mbValidPaper, and XclPageData::SetDefaults().

Referenced by XclImpRoot::InitializeTable(), and XclImpPageSettings().

void XclImpPageSettings::ReadCenter ( XclImpStream rStrm)
void XclImpPageSettings::ReadHeaderFooter ( XclImpStream rStrm)
void XclImpPageSettings::ReadImgData ( XclImpStream rStrm)
void XclImpPageSettings::ReadMargin ( XclImpStream rStrm)
void XclImpPageSettings::ReadPageBreaks ( XclImpStream rStrm)
void XclImpPageSettings::ReadPrintGridLines ( XclImpStream rStrm)

Reads a PRINTGRIDLINES record.

Definition at line 169 of file xipage.cxx.

References maData, XclPageData::mbPrintGrid, and XclImpStream::ReaduInt16().

Referenced by ImportExcel8::Read(), ImportExcel::Read(), and XclImpChart::ReadChartSubStream().

void XclImpPageSettings::ReadPrintHeaders ( XclImpStream rStrm)

Reads a PRINTHEADERS record.

Definition at line 164 of file xipage.cxx.

References maData, XclPageData::mbPrintHeadings, and XclImpStream::ReaduInt16().

Referenced by ImportExcel8::Read(), ImportExcel::Read(), and XclImpChart::ReadChartSubStream().

void XclImpPageSettings::ReadSetup ( XclImpStream rStrm)
void XclImpPageSettings::SetFitToPages ( bool  bFitToPages)
inline

Sets or clears the fit-to-pages setting (contained in WSBOOL record).

Definition at line 61 of file xipage.hxx.

References maData, and XclPageData::mbFitToPages.

Referenced by ImportExcel::Wsbool().

void XclImpPageSettings::SetPaperSize ( sal_uInt16  nXclPaperSize,
bool  bPortrait 
)

Overrides paper size and orientation (used in sheet-charts).

Definition at line 181 of file xipage.cxx.

References maData, XclPageData::mbPortrait, mbValidPaper, and XclPageData::mnPaperSize.

Referenced by XclImpChartObj::FinalizeTabChart().

Member Data Documentation

XclPageData XclImpPageSettings::maData
private
bool XclImpPageSettings::mbValidPaper
private

Page settings data.

Definition at line 68 of file xipage.hxx.

Referenced by Finalize(), Initialize(), ReadSetup(), and SetPaperSize().


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