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

#include <defnamesbuffer.hxx>

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

Public Member Functions

 DefinedNamesBuffer (const WorkbookHelper &rHelper)
 
DefinedNameRef importDefinedName (const AttributeList &rAttribs)
 Imports a defined name from the passed attribute set. More...
 
void importDefinedName (SequenceInputStream &rStrm)
 Imports a defined name from a DEFINEDNAME record in the passed stream. More...
 
void finalizeImport ()
 Creates all defined names in the document. More...
 
DefinedNameRef getByIndex (sal_Int32 nIndex) const
 Returns a defined name by zero-based index (order of appearance). More...
 
DefinedNameRef getByTokenIndex (sal_Int32 nIndex) const
 Returns a defined name by token index (index in XDefinedNames container). More...
 
DefinedNameRef getByModelName (const OUString &rModelName, sal_Int16 nCalcSheet=-1) const
 Returns a defined name by its model name. More...
 
DefinedNameRef getByBuiltinId (sal_Unicode cBuiltinId, sal_Int16 nCalcSheet) const
 Returns a built-in defined name by its built-in identifier. 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...
 
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...
 
ScRangeDatacreateNamedRangeObject (OUString &orName, const css::uno::Sequence< css::sheet::FormulaToken > &rTokens, sal_Int32 nIndex, sal_Int32 nNameFlags) const
 Creates and returns a defined name on-the-fly in the Calc document. More...
 
ScRangeDatacreateLocalNamedRangeObject (OUString &orName, const css::uno::Sequence< css::sheet::FormulaToken > &rTokens, sal_Int32 nIndex, sal_Int32 nNameFlags, sal_Int32 nTab) 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 ::std::pair< sal_Int16, OUString > SheetNameKey
 
typedef ::std::pair< sal_Int16, sal_UnicodeBuiltinKey
 
typedef RefVector< DefinedNameDefNameVector
 
typedef RefMap< SheetNameKey, DefinedNameDefNameNameMap
 
typedef RefMap< BuiltinKey, DefinedNameDefNameBuiltinMap
 
typedef RefMap< sal_Int32, DefinedNameDefNameTokenIdMap
 

Private Member Functions

DefinedNameRef createDefinedName ()
 

Private Attributes

DefNameVector maDefNames
 
DefNameNameMap maModelNameMap
 List of all defined names in insertion order. More...
 
DefNameBuiltinMap maBuiltinMap
 Maps all defined names by sheet index and model name. More...
 
DefNameTokenIdMap maTokenIdMap
 Maps all defined names by sheet index and built-in identifier. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from oox::xls::WorkbookHelper
static WorkbookGlobalsRef constructGlobals (ExcelFilter &rFilter)
 

Detailed Description

Definition at line 134 of file defnamesbuffer.hxx.

Member Typedef Documentation

typedef ::std::pair< sal_Int16, sal_Unicode > oox::xls::DefinedNamesBuffer::BuiltinKey
private

Definition at line 166 of file defnamesbuffer.hxx.

Definition at line 170 of file defnamesbuffer.hxx.

Definition at line 169 of file defnamesbuffer.hxx.

Definition at line 171 of file defnamesbuffer.hxx.

Definition at line 168 of file defnamesbuffer.hxx.

typedef ::std::pair< sal_Int16, OUString > oox::xls::DefinedNamesBuffer::SheetNameKey
private

Definition at line 165 of file defnamesbuffer.hxx.

Constructor & Destructor Documentation

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

Definition at line 336 of file defnamesbuffer.cxx.

Member Function Documentation

DefinedNameRef oox::xls::DefinedNamesBuffer::createDefinedName ( )
private

Definition at line 401 of file defnamesbuffer.cxx.

References maDefNames.

Referenced by importDefinedName().

void oox::xls::DefinedNamesBuffer::finalizeImport ( )
DefinedNameRef oox::xls::DefinedNamesBuffer::getByBuiltinId ( sal_Unicode  cBuiltinId,
sal_Int16  nCalcSheet 
) const

Returns a built-in defined name by its built-in identifier.

Parameters
nSheetThe sheet index of the built-in name.
Returns
Reference to the defined name or empty reference.

Definition at line 396 of file defnamesbuffer.cxx.

References oox::RefMap< KeyType, ObjType, CompType >::get(), and maBuiltinMap.

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

DefinedNameRef oox::xls::DefinedNamesBuffer::getByIndex ( sal_Int32  nIndex) const

Returns a defined name by zero-based index (order of appearance).

Definition at line 376 of file defnamesbuffer.cxx.

References oox::RefVector< ObjType >::get(), and maDefNames.

DefinedNameRef oox::xls::DefinedNamesBuffer::getByModelName ( const OUString &  rModelName,
sal_Int16  nCalcSheet = -1 
) const

Returns a defined name by its model name.

Parameters
nSheetThe sheet index for local names or -1 for global names. If no local name is found, tries to find a matching global name.
Returns
Reference to the defined name or empty reference.

Definition at line 386 of file defnamesbuffer.cxx.

References oox::RefMap< KeyType, ObjType, CompType >::get(), and maModelNameMap.

Referenced by oox::xls::QueryTable::finalizeImport(), oox::xls::PivotCache::finalizeInternalSheetSource(), and oox::xls::FormulaParser::importMacroName().

DefinedNameRef oox::xls::DefinedNamesBuffer::getByTokenIndex ( sal_Int32  nIndex) const

Returns a defined name by token index (index in XDefinedNames container).

Definition at line 381 of file defnamesbuffer.cxx.

References oox::RefMap< KeyType, ObjType, CompType >::get(), and maTokenIdMap.

DefinedNameRef oox::xls::DefinedNamesBuffer::importDefinedName ( const AttributeList rAttribs)

Imports a defined name from the passed attribute set.

Definition at line 341 of file defnamesbuffer.cxx.

References createDefinedName().

Referenced by oox::xls::WorkbookFragment::importDefinedName(), and oox::xls::WorkbookFragment::onCreateRecordContext().

void oox::xls::DefinedNamesBuffer::importDefinedName ( SequenceInputStream rStrm)

Imports a defined name from a DEFINEDNAME record in the passed stream.

Definition at line 348 of file defnamesbuffer.cxx.

References createDefinedName().

Member Data Documentation

DefNameBuiltinMap oox::xls::DefinedNamesBuffer::maBuiltinMap
private

Maps all defined names by sheet index and model name.

Definition at line 175 of file defnamesbuffer.hxx.

Referenced by finalizeImport(), and getByBuiltinId().

DefNameVector oox::xls::DefinedNamesBuffer::maDefNames
private

Definition at line 173 of file defnamesbuffer.hxx.

Referenced by createDefinedName(), finalizeImport(), and getByIndex().

DefNameNameMap oox::xls::DefinedNamesBuffer::maModelNameMap
private

List of all defined names in insertion order.

Definition at line 174 of file defnamesbuffer.hxx.

Referenced by finalizeImport(), and getByModelName().

DefNameTokenIdMap oox::xls::DefinedNamesBuffer::maTokenIdMap
private

Maps all defined names by sheet index and built-in identifier.

Definition at line 176 of file defnamesbuffer.hxx.

Referenced by finalizeImport(), and getByTokenIndex().


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