LibreOffice Module sc (master) 1
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
oox::xls::ViewSettings Class Reference

#include <viewsettings.hxx>

Inheritance diagram for oox::xls::ViewSettings:
[legend]
Collaboration diagram for oox::xls::ViewSettings:
[legend]

Public Member Functions

 ViewSettings (const WorkbookHelper &rHelper)
 
void importWorkbookView (const AttributeList &rAttribs)
 Imports the workbookView element containing workbook view settings. More...
 
void importOleSize (const AttributeList &rAttribs)
 Imports the oleSize element containing the visible size of the workbook. More...
 
void importWorkbookView (SequenceInputStream &rStrm)
 Imports the WORKBOOKVIEW record containing workbook view settings. More...
 
void importOleSize (SequenceInputStream &rStrm)
 Imports the OLESIZE record containing the visible size of the workbook. More...
 
void setSheetViewSettings (sal_Int16 nSheet, const SheetViewModelRef &rxSheetView, const css::uno::Any &rProperties)
 Stores converted view settings for a specific worksheet. More...
 
void setSheetUsedArea (const ScRange &rUsedArea)
 Stores the used area for a specific worksheet. More...
 
void finalizeImport ()
 Converts all imported document view settings. More...
 
sal_Int16 getActiveCalcSheet () const
 Returns the Calc index of the active sheet. More...
 
- Public Member Functions inherited from oox::xls::WorkbookHelper
 WorkbookHelper (WorkbookGlobals &rBookGlob)
 
virtual ~WorkbookHelper ()
 
 WorkbookHelper (WorkbookHelper const &)=default
 
 WorkbookHelper (WorkbookHelper &&)=default
 
WorkbookHelperoperator= (WorkbookHelper const &)=delete
 
WorkbookHelperoperator= (WorkbookHelper &&)=delete
 
::oox::core::FilterBasegetBaseFilter () const
 Returns the base filter object (base class of all filters). More...
 
SegmentProgressBargetProgressBar () 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)
 
ScDocumentgetScDocument ()
 
const ScDocumentgetScDocument () const
 
ScDocumentImportgetDocImport ()
 
const ScDocumentImportgetDocImport () const
 
ScEditEngineDefaultergetEditEngine () 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...
 
ScDBDatafindDatabaseRangeByIndex (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...
 
FormulaBuffergetFormulaBuffer () const
 
WorkbookSettingsgetWorkbookSettings () const
 Returns the global workbook settings object. More...
 
ViewSettingsgetViewSettings () const
 Returns the workbook and sheet view settings object. More...
 
WorksheetBuffergetWorksheets () const
 Returns the worksheet buffer containing sheet names and properties. More...
 
ThemeBuffergetTheme () const
 Returns the office theme object read from the theme substorage. More...
 
StylesBuffergetStyles () const
 Returns all cell formatting objects read from the styles substream. More...
 
SharedStringsBuffergetSharedStrings () const
 Returns the shared strings read from the shared strings substream. More...
 
ExternalLinkBuffergetExternalLinks () const
 Returns the external links read from the external links substream. More...
 
DefinedNamesBuffergetDefinedNames () const
 Returns the defined names read from the workbook globals. More...
 
TableBuffergetTables () const
 Returns the tables collection (equivalent to Calc's database ranges). More...
 
ScenarioBuffergetScenarios () const
 Returns the scenarios collection. More...
 
ConnectionsBuffergetConnections () const
 Returns the collection of external data connections. More...
 
PivotCacheBuffergetPivotCaches () const
 Returns the collection of pivot caches. More...
 
PivotTableBuffergetPivotTables () const
 Returns the collection of pivot tables. More...
 
FormulaParsergetFormulaParser () const
 Returns a shared import formula parser (import filter only!). More...
 
FormulaParsercreateFormulaParser () const
 Returns an unshared import formula parser (import filter only!). More...
 
UnitConvertergetUnitConverter () const
 Returns the measurement unit converter. More...
 
AddressConvertergetAddressConverter () const
 Returns the converter for string to cell address/range conversion. More...
 
oox::drawingml::chart::ChartConvertergetChartConverter () const
 Returns the chart object converter. More...
 
PageSettingsConvertergetPageSettingsConverter () const
 Returns the page and print settings converter. More...
 
::oox::core::XmlFilterBasegetOoxFilter () 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 Types

typedef RefVector< WorkbookViewModelWorkbookViewModelVec
 
typedef RefMap< sal_Int16, SheetViewModelSheetViewModelMap
 

Private Member Functions

WorkbookViewModelcreateWorkbookView ()
 

Private Attributes

WorkbookViewModelVec maBookViews
 
SheetViewModelMap maSheetViews
 Workbook view models. More...
 
std::map< sal_Int16, css::uno::Any > maSheetProps
 Active view model for each sheet. More...
 
std::map< sal_Int16, ScRangemaSheetUsedAreas
 Converted property sequences for each sheet. More...
 
ScRange maOleSize
 Used area (cell range) of every sheet. More...
 
bool mbValidOleSize
 Visible area if this is an embedded OLE object. More...
 

Additional Inherited Members

- Public Types inherited from oox::xls::WorkbookHelper
typedef std::pair< ScRangeData *, bool > RangeDataRet
 
- Static Public Member Functions inherited from oox::xls::WorkbookHelper
static WorkbookGlobalsRef constructGlobals (ExcelFilter &rFilter)
 

Detailed Description

Definition at line 145 of file viewsettings.hxx.

Member Typedef Documentation

◆ SheetViewModelMap

Definition at line 177 of file viewsettings.hxx.

◆ WorkbookViewModelVec

Definition at line 176 of file viewsettings.hxx.

Constructor & Destructor Documentation

◆ ViewSettings()

oox::xls::ViewSettings::ViewSettings ( const WorkbookHelper rHelper)
explicit

Definition at line 475 of file viewsettings.cxx.

Member Function Documentation

◆ createWorkbookView()

WorkbookViewModel & oox::xls::ViewSettings::createWorkbookView ( )
private

Definition at line 642 of file viewsettings.cxx.

References maBookViews, and xModel.

Referenced by finalizeImport(), and importWorkbookView().

◆ finalizeImport()

void oox::xls::ViewSettings::finalizeImport ( )

◆ getActiveCalcSheet()

sal_Int16 oox::xls::ViewSettings::getActiveCalcSheet ( ) const

Returns the Calc index of the active sheet.

Definition at line 635 of file viewsettings.cxx.

References oox::xls::WorkbookHelper::getWorksheets(), and maBookViews.

Referenced by oox::xls::SheetViewSettings::finalizeImport(), finalizeImport(), and oox::xls::WorkbookFragment::finalizeImport().

◆ importOleSize() [1/2]

void oox::xls::ViewSettings::importOleSize ( const AttributeList rAttribs)

◆ importOleSize() [2/2]

void oox::xls::ViewSettings::importOleSize ( SequenceInputStream rStrm)

Imports the OLESIZE record containing the visible size of the workbook.

Definition at line 523 of file viewsettings.cxx.

References oox::xls::AddressConverter::convertToCellRange(), oox::xls::WorkbookHelper::getAddressConverter(), maOleSize, mbValidOleSize, and rStrm.

◆ importWorkbookView() [1/2]

void oox::xls::ViewSettings::importWorkbookView ( const AttributeList rAttribs)

◆ importWorkbookView() [2/2]

void oox::xls::ViewSettings::importWorkbookView ( SequenceInputStream rStrm)

◆ setSheetUsedArea()

void oox::xls::ViewSettings::setSheetUsedArea ( const ScRange rUsedArea)

Stores the used area for a specific worksheet.

Definition at line 536 of file viewsettings.cxx.

References ScRange::aStart, ScRange::IsValid(), maSheetUsedAreas, and ScAddress::Tab().

Referenced by oox::xls::WorksheetGlobals::finalizeDrawings().

◆ setSheetViewSettings()

void oox::xls::ViewSettings::setSheetViewSettings ( sal_Int16  nSheet,
const SheetViewModelRef rxSheetView,
const css::uno::Any &  rProperties 
)

Stores converted view settings for a specific worksheet.

Definition at line 530 of file viewsettings.cxx.

References maSheetProps, and maSheetViews.

Referenced by oox::xls::SheetViewSettings::finalizeImport().

Member Data Documentation

◆ maBookViews

WorkbookViewModelVec oox::xls::ViewSettings::maBookViews
private

Definition at line 179 of file viewsettings.hxx.

Referenced by createWorkbookView(), finalizeImport(), and getActiveCalcSheet().

◆ maOleSize

ScRange oox::xls::ViewSettings::maOleSize
private

Used area (cell range) of every sheet.

Definition at line 183 of file viewsettings.hxx.

Referenced by finalizeImport(), and importOleSize().

◆ maSheetProps

std::map< sal_Int16, css::uno::Any > oox::xls::ViewSettings::maSheetProps
private

Active view model for each sheet.

Definition at line 181 of file viewsettings.hxx.

Referenced by finalizeImport(), and setSheetViewSettings().

◆ maSheetUsedAreas

std::map< sal_Int16, ScRange > oox::xls::ViewSettings::maSheetUsedAreas
private

Converted property sequences for each sheet.

Definition at line 182 of file viewsettings.hxx.

Referenced by finalizeImport(), and setSheetUsedArea().

◆ maSheetViews

SheetViewModelMap oox::xls::ViewSettings::maSheetViews
private

Workbook view models.

Definition at line 180 of file viewsettings.hxx.

Referenced by finalizeImport(), and setSheetViewSettings().

◆ mbValidOleSize

bool oox::xls::ViewSettings::mbValidOleSize
private

Visible area if this is an embedded OLE object.

Definition at line 184 of file viewsettings.hxx.

Referenced by finalizeImport(), and importOleSize().


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