#include <pagesettings.hxx>
Public Member Functions | |
| PageSettings (const WorksheetHelper &rHelper) | |
| void | importPrintOptions (const AttributeList &rAttribs) |
| Imports printing options from a printOptions element. More... | |
| void | importPageMargins (const AttributeList &rAttribs) |
| Imports pageMarings element containing page margins. More... | |
| void | importPageSetup (const ::oox::core::Relations &rRelations, const AttributeList &rAttribs) |
| Imports pageSetup element for worksheets. More... | |
| void | importChartPageSetup (const ::oox::core::Relations &rRelations, const AttributeList &rAttribs) |
| Imports pageSetup element for chart sheets. More... | |
| void | importHeaderFooter (const AttributeList &rAttribs) |
| Imports header and footer settings from a headerFooter element. More... | |
| void | importHeaderFooterCharacters (std::u16string_view rChars, sal_Int32 nElement) |
| Imports header/footer characters from a headerFooter element. More... | |
| void | importPicture (const ::oox::core::Relations &rRelations, const AttributeList &rAttribs) |
| Imports the picture element. More... | |
| void | importPrintOptions (SequenceInputStream &rStrm) |
| Imports the PRINTOPTIONS record from the passed stream. More... | |
| void | importPageMargins (SequenceInputStream &rStrm) |
| Imports the PAGEMARGINS record from the passed stream. More... | |
| void | importPageSetup (const ::oox::core::Relations &rRelations, SequenceInputStream &rStrm) |
| Imports the PAGESETUP record from the passed stream. More... | |
| void | importChartPageSetup (const ::oox::core::Relations &rRelations, SequenceInputStream &rStrm) |
| Imports the CHARTPAGESETUP record from the passed stream. More... | |
| void | importHeaderFooter (SequenceInputStream &rStrm) |
| Imports the HEADERFOOTER record from the passed stream. More... | |
| void | importPicture (const ::oox::core::Relations &rRelations, SequenceInputStream &rStrm) |
| Imports the PICTURE record from the passed stream. More... | |
| void | setFitToPagesMode (bool bFitToPages) |
| Sets whether percentual scaling or fit to width/height scaling is used. More... | |
| void | finalizeImport () |
| Creates a page style for the spreadsheet and sets all page properties. More... | |
 Public Member Functions inherited from oox::xls::WorksheetHelper | |
| WorksheetHelper (WorksheetGlobals &rSheetGlob) | |
| WorksheetType | getSheetType () const |
| Returns the type of this sheet. More... | |
| SCTAB | getSheetIndex () const |
| Returns the index of the current sheet. More... | |
| const css::uno::Reference< css::sheet::XSpreadsheet > & | getSheet () const |
| Returns the XSpreadsheet interface of the current sheet. More... | |
| css::uno::Reference< css::table::XCell > | getCell (const ScAddress &rAddress) const |
| Returns the XCell interface for the passed cell address. More... | |
| css::uno::Reference< css::table::XCellRange > | getCellRange (const ScRange &rRange) const |
| Returns the XCellRange interface for the passed cell range address. More... | |
| css::uno::Reference< css::drawing::XDrawPage > | getDrawPage () const |
| Returns the XDrawPage interface of the draw page of the current sheet. More... | |
| css::awt::Point | getCellPosition (sal_Int32 nCol, sal_Int32 nRow) const |
| Returns the absolute cell position in 1/100 mm. More... | |
| const css::awt::Size & | getDrawPageSize () const |
| Returns the size of the entire drawing page in 1/100 mm. More... | |
| SheetDataBuffer & | getSheetData () const |
| Returns the buffer for cell contents and cell formatting. More... | |
| CondFormatBuffer & | getCondFormats () const |
| Returns the conditional formatting in this sheet. More... | |
| CommentsBuffer & | getComments () const |
| Returns the buffer for all cell comments in this sheet. More... | |
| AutoFilterBuffer & | getAutoFilters () const |
| Returns the auto filters for the sheet. More... | |
| QueryTableBuffer & | getQueryTables () const |
| Returns the buffer for all web query tables in this sheet. More... | |
| WorksheetSettings & | getWorksheetSettings () const |
| Returns the worksheet settings object. More... | |
| PageSettings & | getPageSettings () const |
| Returns the page/print settings for this sheet. More... | |
| SheetViewSettings & | getSheetViewSettings () const |
| Returns the view settings for this sheet. More... | |
| VmlDrawing & | getVmlDrawing () const |
| Returns the VML drawing page for this sheet (OOXML/BIFF12 only). More... | |
| ExtLst & | getExtLst () const |
| void | setPageBreak (const PageBreakModel &rModel, bool bRowBreak) |
| Sets a column or row page break described in the passed struct. More... | |
| void | setHyperlink (const HyperlinkModel &rModel) |
| Inserts the hyperlink URL into the spreadsheet. More... | |
| void | setValidation (const ValidationModel &rModel) |
| Inserts the data validation settings into the spreadsheet. More... | |
| void | setDrawingPath (const OUString &rDrawingPath) |
| Sets the path to the DrawingML fragment of this sheet. More... | |
| void | setVmlDrawingPath (const OUString &rVmlDrawingPath) |
| Sets the path to the legacy VML drawing fragment of this sheet. More... | |
| void | extendUsedArea (const ScAddress &rAddress) |
| Extends the used area of this sheet by the passed cell position. More... | |
| void | extendUsedArea (const ScRange &rRange) |
| Extends the used area of this sheet by the passed cell range. More... | |
| void | extendShapeBoundingBox (const css::awt::Rectangle &rShapeRect) |
| Extends the shape bounding box by the position and size of the passed rectangle (in 1/100 mm). More... | |
| void | setBaseColumnWidth (sal_Int32 nWidth) |
| Sets base width for all columns (without padding pixels). More... | |
| void | setDefaultColumnWidth (double fWidth) |
| Sets default width for all columns. More... | |
| void | setColumnModel (const ColumnModel &rModel) |
| Sets column settings for a specific range of columns. More... | |
| void | setDefaultRowSettings (double fHeight, bool bCustomHeight, bool bHidden, bool bThickTop, bool bThickBottom) |
| Sets default height and hidden state for all unused rows in the sheet. More... | |
| void | setRowModel (const RowModel &rModel) |
| Sets row settings for a specific range of rows. More... | |
| void | putRichString (const ScAddress &rAddress, RichString &rString, const oox::xls::Font *pFirstPortionFont, bool bSingleLine=false) |
| Inserts a rich-string cell directly into the Calc sheet. More... | |
| void | putFormulaTokens (const ScAddress &rAddress, const ApiTokenSequence &rTokens) |
| Inserts a formula cell directly into the Calc sheet. More... | |
| void | initializeWorksheetImport () |
| Initial conversion before importing the worksheet. More... | |
| void | finalizeWorksheetImport () |
| Final conversion after importing the worksheet. More... | |
| void | finalizeDrawingImport () |
| Final import of drawing objects. More... | |
| void | setCellFormula (const ScAddress &rTokenAddress, const OUString &) |
| void | setCellFormula (const ScAddress &rAddr, sal_Int32 nSharedId, const OUString &rCellValue, sal_Int32 nValueType) |
| void | setCellArrayFormula (const ScRange &rRangeAddress, const ScAddress &rTokenAddress, const OUString &rTokenStr) |
| void | createSharedFormulaMapEntry (const ScAddress &rAddress, sal_Int32 nSharedId, const OUString &rTokens) |
| void | setCellFormulaValue (const ScAddress &rAddress, const OUString &rValueStr, sal_Int32 nCellType) |
| ScDocument & | getScDocument () |
| Public Member Functions inherited from oox::xls::WorkbookHelper | |
| WorkbookHelper (WorkbookGlobals &rBookGlob) | |
| virtual | ~WorkbookHelper () |
| WorkbookHelper (WorkbookHelper const &)=default | |
| WorkbookHelper (WorkbookHelper &&)=default | |
| WorkbookHelper & | operator= (WorkbookHelper const &)=delete |
| WorkbookHelper & | operator= (WorkbookHelper &&)=delete |
| ::oox::core::FilterBase & | getBaseFilter () const |
| Returns the base filter object (base class of all filters). More... | |
| SegmentProgressBar & | getProgressBar () const |
| Returns the filter progress bar. More... | |
| sal_Int16 | getCurrentSheetIndex () const |
| Returns the index of the current Calc sheet, if filter currently processes a sheet. More... | |
| bool | isGeneratorKnownGood () const |
| Returns true when reading a file generated by a known good generator. More... | |
| bool | hasCalculatedFormulaCells () const |
| Returns true if any formula cell is calculated. More... | |
| void | setCalculatedFormulaCells () |
| Set if any formula cell is calculated. More... | |
| void | setVbaProjectStorage (const StorageRef &rxVbaPrjStrg) |
| Sets the VBA project storage used to import VBA source code and forms. More... | |
| void | setCurrentSheetIndex (SCTAB nSheet) |
| Sets the index of the current Calc sheet, if filter currently processes a sheet. More... | |
| void | finalizeWorkbookImport () |
| Final conversion after importing the workbook. More... | |
| void | useInternalChartDataTable (bool bInternal) |
| ScDocument & | getScDocument () |
| const ScDocument & | getScDocument () const |
| ScDocumentImport & | getDocImport () |
| const ScDocumentImport & | getDocImport () const |
| ScEditEngineDefaulter & | getEditEngine () const |
| const css::uno::Reference< css::sheet::XSpreadsheetDocument > & | getDocument () const |
| Returns a reference to the source/target spreadsheet document model. More... | |
| css::uno::Reference< css::sheet::XSpreadsheet > | getSheetFromDoc (sal_Int32 nSheet) const |
| Returns a reference to the specified spreadsheet in the document model. More... | |
| css::uno::Reference< css::sheet::XSpreadsheet > | getSheetFromDoc (const OUString &rSheet) const |
| Returns a reference to the specified spreadsheet in the document model. More... | |
| css::uno::Reference< css::table::XCellRange > | getCellRangeFromDoc (const ScRange &rRange) const |
| Returns the XCellRange interface for the passed cell range address. More... | |
| css::uno::Reference< css::container::XNameContainer > | getCellStyleFamily () const |
| Returns the cell styles container from the Calc document. More... | |
| css::uno::Reference< css::style::XStyle > | getStyleObject (const OUString &rStyleName, bool bPageStyle) const |
| Returns the specified cell or page style from the Calc document. More... | |
| RangeDataRet | createNamedRangeObject (OUString &orName, sal_Int32 nIndex, sal_Int32 nNameFlags, bool bHidden) const |
| Creates and returns a defined name on-the-fly in the Calc document. More... | |
| RangeDataRet | createLocalNamedRangeObject (OUString &orName, sal_Int32 nIndex, sal_Int32 nNameFlags, sal_Int32 nTab, bool bHidden) const |
| Creates and returns a defined name on-the-fly in the sheet. More... | |
| css::uno::Reference< css::sheet::XDatabaseRange > | createDatabaseRangeObject (OUString &orName, const ScRange &rRangeAddr) const |
| Creates and returns a database range on-the-fly in the Calc document. More... | |
| css::uno::Reference< css::sheet::XDatabaseRange > | createUnnamedDatabaseRangeObject (const ScRange &rRangeAddr) const |
| Creates and returns an unnamed database range on-the-fly in the Calc document. More... | |
| ScDBData * | findDatabaseRangeByIndex (sal_uInt16 nIndex) const |
| Finds the (already existing) database range of the given formula token index. More... | |
| css::uno::Reference< css::style::XStyle > | createStyleObject (OUString &orStyleName, bool bPageStyle) const |
| Creates and returns a com.sun.star.style.Style object for cells or pages. More... | |
| FormulaBuffer & | getFormulaBuffer () const |
| WorkbookSettings & | getWorkbookSettings () const |
| Returns the global workbook settings object. More... | |
| ViewSettings & | getViewSettings () const |
| Returns the workbook and sheet view settings object. More... | |
| WorksheetBuffer & | getWorksheets () const |
| Returns the worksheet buffer containing sheet names and properties. More... | |
| ThemeBuffer & | getTheme () const |
| Returns the office theme object read from the theme substorage. More... | |
| StylesBuffer & | getStyles () const |
| Returns all cell formatting objects read from the styles substream. More... | |
| SharedStringsBuffer & | getSharedStrings () const |
| Returns the shared strings read from the shared strings substream. More... | |
| ExternalLinkBuffer & | getExternalLinks () const |
| Returns the external links read from the external links substream. More... | |
| DefinedNamesBuffer & | getDefinedNames () const |
| Returns the defined names read from the workbook globals. More... | |
| TableBuffer & | getTables () const |
| Returns the tables collection (equivalent to Calc's database ranges). More... | |
| ScenarioBuffer & | getScenarios () const |
| Returns the scenarios collection. More... | |
| ConnectionsBuffer & | getConnections () const |
| Returns the collection of external data connections. More... | |
| PivotCacheBuffer & | getPivotCaches () const |
| Returns the collection of pivot caches. More... | |
| PivotTableBuffer & | getPivotTables () const |
| Returns the collection of pivot tables. More... | |
| FormulaParser & | getFormulaParser () const |
| Returns a shared import formula parser (import filter only!). More... | |
| FormulaParser * | createFormulaParser () const |
| Returns an unshared import formula parser (import filter only!). More... | |
| UnitConverter & | getUnitConverter () const |
| Returns the measurement unit converter. More... | |
| AddressConverter & | getAddressConverter () const |
| Returns the converter for string to cell address/range conversion. More... | |
| oox::drawingml::chart::ChartConverter * | getChartConverter () const |
| Returns the chart object converter. More... | |
| PageSettingsConverter & | getPageSettingsConverter () const |
| Returns the page and print settings converter. More... | |
| ::oox::core::XmlFilterBase & | getOoxFilter () const |
| Returns the base OOXML/BIFF12 filter object. More... | |
| bool | importOoxFragment (const rtl::Reference< oox::core::FragmentHandler > &rxHandler) |
| Imports a fragment using the passed fragment handler, which contains the full path to the fragment stream. More... | |
| bool | importOoxFragment (const rtl::Reference< oox::core::FragmentHandler > &rxHandler, oox::core::FastParser &rParser) |
| rtl_TextEncoding | getTextEncoding () const |
| Returns the text encoding used to import/export byte strings. More... | |
Private Member Functions | |
| void | importPictureData (const ::oox::core::Relations &rRelations, const OUString &rRelId) |
| Imports the binary picture data from the fragment with the passed identifier. More... | |
Private Attributes | |
| PageSettingsModel | maModel |
Additional Inherited Members | |
| Public Types inherited from oox::xls::WorkbookHelper | |
| typedef std::pair< ScRangeData *, bool > | RangeDataRet |
| Static Public Member Functions inherited from oox::xls::WorksheetHelper | |
| static WorksheetGlobalsRef | constructGlobals (const WorkbookHelper &rHelper, const ISegmentProgressBarRef &rxProgressBar, WorksheetType eSheetType, SCTAB nSheet) |
| static IWorksheetProgress * | getWorksheetInterface (const WorksheetGlobalsRef &xRef) |
| Static Public Member Functions inherited from oox::xls::WorkbookHelper | |
| static WorkbookGlobalsRef | constructGlobals (ExcelFilter &rFilter) |
Detailed Description
Definition at line 84 of file pagesettings.hxx.
Constructor & Destructor Documentation
◆ PageSettings()
|
explicit |
Definition at line 136 of file pagesettings.cxx.
Member Function Documentation
◆ finalizeImport()
| void oox::xls::PageSettings::finalizeImport | ( | ) |
Creates a page style for the spreadsheet and sets all page properties.
Definition at line 319 of file pagesettings.cxx.
References oox::xls::WorkbookHelper::createStyleObject(), oox::xls::WorkbookHelper::getPageSettingsConverter(), oox::xls::WorksheetHelper::getScDocument(), oox::xls::WorksheetHelper::getSheet(), oox::xls::WorksheetHelper::getSheetIndex(), oox::xls::WorksheetHelper::getSheetType(), maModel, ScDocument::SetPageStyle(), and oox::xls::PageSettingsConverter::writePageSettingsProperties().
Referenced by oox::xls::WorksheetGlobals::finalizeWorksheetImport().
◆ importChartPageSetup() [1/2]
| void oox::xls::PageSettings::importChartPageSetup | ( | const ::oox::core::Relations & | rRelations, |
| const AttributeList & | rAttribs | ||
| ) |
Imports pageSetup element for chart sheets.
Referenced by oox::xls::ChartsheetFragment::onCreateContext(), and oox::xls::ChartsheetFragment::onCreateRecordContext().
◆ importChartPageSetup() [2/2]
| void oox::xls::PageSettings::importChartPageSetup | ( | const ::oox::core::Relations & | rRelations, |
| SequenceInputStream & | rStrm | ||
| ) |
Imports the CHARTPAGESETUP record from the passed stream.
◆ importHeaderFooter() [1/2]
| void oox::xls::PageSettings::importHeaderFooter | ( | const AttributeList & | rAttribs | ) |
Imports header and footer settings from a headerFooter element.
Definition at line 209 of file pagesettings.cxx.
References oox::AttributeList::getBool(), maModel, oox::xls::PageSettingsModel::mbUseEvenHF, and oox::xls::PageSettingsModel::mbUseFirstHF.
Referenced by oox::xls::ChartsheetFragment::onCreateContext(), oox::xls::WorksheetFragment::onCreateContext(), oox::xls::ChartsheetFragment::onCreateRecordContext(), and oox::xls::WorksheetFragment::onCreateRecordContext().
◆ importHeaderFooter() [2/2]
| void oox::xls::PageSettings::importHeaderFooter | ( | SequenceInputStream & | rStrm | ) |
Imports the HEADERFOOTER record from the passed stream.
Definition at line 298 of file pagesettings.cxx.
References oox::getFlag(), oox::xls::PageSettingsModel::maEvenFooter, oox::xls::PageSettingsModel::maEvenHeader, oox::xls::PageSettingsModel::maFirstFooter, oox::xls::PageSettingsModel::maFirstHeader, maModel, oox::xls::PageSettingsModel::maOddFooter, oox::xls::PageSettingsModel::maOddHeader, oox::xls::PageSettingsModel::mbUseEvenHF, oox::xls::PageSettingsModel::mbUseFirstHF, and rStrm.
◆ importHeaderFooterCharacters()
| void oox::xls::PageSettings::importHeaderFooterCharacters | ( | std::u16string_view | rChars, |
| sal_Int32 | nElement | ||
| ) |
Imports header/footer characters from a headerFooter element.
Definition at line 215 of file pagesettings.cxx.
References oox::xls::PageSettingsModel::maEvenFooter, oox::xls::PageSettingsModel::maEvenHeader, oox::xls::PageSettingsModel::maFirstFooter, oox::xls::PageSettingsModel::maFirstHeader, maModel, oox::xls::PageSettingsModel::maOddFooter, and oox::xls::PageSettingsModel::maOddHeader.
Referenced by oox::xls::ChartsheetFragment::onCharacters(), and oox::xls::WorksheetFragment::onCharacters().
◆ importPageMargins() [1/2]
| void oox::xls::PageSettings::importPageMargins | ( | const AttributeList & | rAttribs | ) |
Imports pageMarings element containing page margins.
Definition at line 149 of file pagesettings.cxx.
References oox::AttributeList::getDouble(), maModel, oox::xls::PageSettingsModel::mfBottomMargin, oox::xls::PageSettingsModel::mfFooterMargin, oox::xls::PageSettingsModel::mfHeaderMargin, oox::xls::PageSettingsModel::mfLeftMargin, oox::xls::PageSettingsModel::mfRightMargin, and oox::xls::PageSettingsModel::mfTopMargin.
Referenced by oox::xls::ChartsheetFragment::onCreateContext(), oox::xls::WorksheetFragment::onCreateContext(), oox::xls::ChartsheetFragment::onCreateRecordContext(), and oox::xls::WorksheetFragment::onCreateRecordContext().
◆ importPageMargins() [2/2]
| void oox::xls::PageSettings::importPageMargins | ( | SequenceInputStream & | rStrm | ) |
Imports the PAGEMARGINS record from the passed stream.
Definition at line 233 of file pagesettings.cxx.
References maModel, oox::xls::PageSettingsModel::mfBottomMargin, oox::xls::PageSettingsModel::mfFooterMargin, oox::xls::PageSettingsModel::mfHeaderMargin, oox::xls::PageSettingsModel::mfLeftMargin, oox::xls::PageSettingsModel::mfRightMargin, oox::xls::PageSettingsModel::mfTopMargin, and rStrm.
◆ importPageSetup() [1/2]
| void oox::xls::PageSettings::importPageSetup | ( | const ::oox::core::Relations & | rRelations, |
| const AttributeList & | rAttribs | ||
| ) |
Imports pageSetup element for worksheets.
Referenced by oox::xls::WorksheetFragment::onCreateContext(), and oox::xls::WorksheetFragment::onCreateRecordContext().
◆ importPageSetup() [2/2]
| void oox::xls::PageSettings::importPageSetup | ( | const ::oox::core::Relations & | rRelations, |
| SequenceInputStream & | rStrm | ||
| ) |
Imports the PAGESETUP record from the passed stream.
◆ importPicture() [1/2]
| void oox::xls::PageSettings::importPicture | ( | const ::oox::core::Relations & | rRelations, |
| const AttributeList & | rAttribs | ||
| ) |
Imports the picture element.
Referenced by oox::xls::ChartsheetFragment::onCreateContext(), oox::xls::WorksheetFragment::onCreateContext(), oox::xls::ChartsheetFragment::onCreateRecordContext(), and oox::xls::WorksheetFragment::onCreateRecordContext().
◆ importPicture() [2/2]
| void oox::xls::PageSettings::importPicture | ( | const ::oox::core::Relations & | rRelations, |
| SequenceInputStream & | rStrm | ||
| ) |
Imports the PICTURE record from the passed stream.
◆ importPictureData()
|
private |
Imports the binary picture data from the fragment with the passed identifier.
Definition at line 338 of file pagesettings.cxx.
References oox::xls::WorkbookHelper::getBaseFilter(), oox::core::FilterBase::getGraphicHelper(), oox::GraphicHelper::importEmbeddedGraphic(), maModel, and oox::xls::PageSettingsModel::mxGraphic.
◆ importPrintOptions() [1/2]
| void oox::xls::PageSettings::importPrintOptions | ( | const AttributeList & | rAttribs | ) |
Imports printing options from a printOptions element.
Definition at line 141 of file pagesettings.cxx.
References oox::AttributeList::getBool(), maModel, oox::xls::PageSettingsModel::mbHorCenter, oox::xls::PageSettingsModel::mbPrintGrid, oox::xls::PageSettingsModel::mbPrintHeadings, and oox::xls::PageSettingsModel::mbVerCenter.
Referenced by oox::xls::WorksheetFragment::onCreateContext(), and oox::xls::WorksheetFragment::onCreateRecordContext().
◆ importPrintOptions() [2/2]
| void oox::xls::PageSettings::importPrintOptions | ( | SequenceInputStream & | rStrm | ) |
Imports the PRINTOPTIONS record from the passed stream.
Definition at line 243 of file pagesettings.cxx.
References oox::getFlag(), maModel, oox::xls::PageSettingsModel::mbHorCenter, oox::xls::PageSettingsModel::mbPrintGrid, oox::xls::PageSettingsModel::mbPrintHeadings, oox::xls::PageSettingsModel::mbVerCenter, and rStrm.
◆ setFitToPagesMode()
| void oox::xls::PageSettings::setFitToPagesMode | ( | bool | bFitToPages | ) |
Sets whether percentual scaling or fit to width/height scaling is used.
Definition at line 314 of file pagesettings.cxx.
References maModel, and oox::xls::PageSettingsModel::mbFitToPages.
Referenced by oox::xls::WorksheetFragment::importPageSetUpPr(), and oox::xls::WorksheetSettings::importSheetPr().
Member Data Documentation
◆ maModel
|
private |
Definition at line 129 of file pagesettings.hxx.
Referenced by finalizeImport(), importHeaderFooter(), importHeaderFooterCharacters(), importPageMargins(), importPictureData(), importPrintOptions(), and setFitToPagesMode().
The documentation for this class was generated from the following files:
