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

#include <workbooksettings.hxx>

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

Public Member Functions

 WorkbookSettings (const WorkbookHelper &rHelper)
 
void importFileSharing (const AttributeList &rAttribs)
 Imports the fileSharing element containing write protection settings. More...
 
void importWorkbookPr (const AttributeList &rAttribs)
 Imports the workbookPr element containing global workbook settings. More...
 
void importCalcPr (const AttributeList &rAttribs)
 Imports the calcPr element containing workbook calculation settings. More...
 
void importFileSharing (SequenceInputStream &rStrm)
 Imports the FILESHARING record containing write protection settings. More...
 
void importWorkbookPr (SequenceInputStream &rStrm)
 Imports the WORKBOOKPR record containing global workbook settings. More...
 
void importCalcPr (SequenceInputStream &rStrm)
 Imports the CALCPR record containing workbook calculation settings. More...
 
void finalizeImport ()
 Converts the imported workbook settings. More...
 
sal_Int16 getApiShowObjectMode () const
 Returns the show objects mode (considered a view setting in Calc). More...
 
css::util::Date const & getNullDate () const
 Returns the nulldate of this workbook. 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 Member Functions

void setDateMode (bool bDateMode1904, bool bDateCompatibility=true)
 Updates date mode and unit converter nulldate. More...
 

Private Attributes

FileSharingModel maFileSharing
 
WorkbookSettingsModel maBookSettings
 
CalcSettingsModel maCalcSettings
 

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 80 of file workbooksettings.hxx.

Constructor & Destructor Documentation

◆ WorkbookSettings()

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

Definition at line 106 of file workbooksettings.cxx.

Member Function Documentation

◆ finalizeImport()

void oox::xls::WorkbookSettings::finalizeImport ( )

◆ getApiShowObjectMode()

sal_Int16 oox::xls::WorkbookSettings::getApiShowObjectMode ( ) const

Returns the show objects mode (considered a view setting in Calc).

Definition at line 258 of file workbooksettings.cxx.

References maBookSettings, oox::xls::WorkbookSettingsModel::mnShowObjectMode, and XML_none.

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

◆ getNullDate()

css::util::Date const & oox::xls::WorkbookSettings::getNullDate ( ) const

◆ importCalcPr() [1/2]

void oox::xls::WorkbookSettings::importCalcPr ( const AttributeList rAttribs)

◆ importCalcPr() [2/2]

void oox::xls::WorkbookSettings::importCalcPr ( SequenceInputStream rStrm)

◆ importFileSharing() [1/2]

void oox::xls::WorkbookSettings::importFileSharing ( const AttributeList rAttribs)

◆ importFileSharing() [2/2]

void oox::xls::WorkbookSettings::importFileSharing ( SequenceInputStream rStrm)

Imports the FILESHARING record containing write protection settings.

Definition at line 147 of file workbooksettings.cxx.

References maFileSharing, oox::xls::FileSharingModel::maUserName, oox::xls::FileSharingModel::mbRecommendReadOnly, oox::xls::FileSharingModel::mnPasswordHash, and rStrm.

◆ importWorkbookPr() [1/2]

void oox::xls::WorkbookSettings::importWorkbookPr ( const AttributeList rAttribs)

◆ importWorkbookPr() [2/2]

void oox::xls::WorkbookSettings::importWorkbookPr ( SequenceInputStream rStrm)

◆ setDateMode()

void oox::xls::WorkbookSettings::setDateMode ( bool  bDateMode1904,
bool  bDateCompatibility = true 
)
private

Member Data Documentation

◆ maBookSettings

WorkbookSettingsModel oox::xls::WorkbookSettings::maBookSettings
private

◆ maCalcSettings

CalcSettingsModel oox::xls::WorkbookSettings::maCalcSettings
private

Definition at line 114 of file workbooksettings.hxx.

Referenced by finalizeImport(), and importCalcPr().

◆ maFileSharing

FileSharingModel oox::xls::WorkbookSettings::maFileSharing
private

Definition at line 112 of file workbooksettings.hxx.

Referenced by finalizeImport(), and importFileSharing().


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