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

#include <defnamesbuffer.hxx>

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

Public Member Functions

 DefinedName (const WorkbookHelper &rHelper)
 
void importDefinedName (const AttributeList &rAttribs)
 Sets the attributes for this defined name from the passed attribute set. More...
 
void setFormula (const OUString &rFormula)
 Sets the formula string from the body of the definedName element. More...
 
void importDefinedName (SequenceInputStream &rStrm)
 Imports the defined name from a DEFINEDNAME record in the passed stream. More...
 
void createNameObject (sal_Int32 nIndex)
 Creates a defined name in the Calc document. More...
 
void convertFormula (const css::uno::Sequence< css::sheet::ExternalLinkInfo > &rExternalLinks)
 Converts the formula string or BIFF token array for this defined name. More...
 
std::unique_ptr< ScTokenArraygetScTokens (const css::uno::Sequence< css::sheet::ExternalLinkInfo > &rExternalLinks)
 
bool isGlobalName () const
 Returns true, if this defined name is global in the document. More...
 
bool isBuiltinName () const
 Returns true, if this defined name is a special builtin name. More...
 
bool isMacroFunction () const
 Returns true, if this defined name is a macro function call. More...
 
bool isVBName () const
 Returns true, if this defined name is a reference to a VBA macro. More...
 
sal_Int16 getLocalCalcSheet () const
 Returns the 0-based sheet index for local names, or -1 for global names. More...
 
sal_Unicode getBuiltinId () const
 Returns the built-in identifier of the defined name. More...
 
sal_Int32 getTokenIndex () const
 Returns the token index used in API token arrays (com.sun.star.sheet.FormulaToken). More...
 
bool getAbsoluteRange (ScRange &orRange) const
 Tries to resolve the defined name to an absolute cell range. More...
 
- Public Member Functions inherited from oox::xls::DefinedNameBase
 DefinedNameBase (const WorkbookHelper &rHelper)
 
const OUString & getModelName () const
 Returns the original name as imported from or exported to the file. More...
 
const OUString & getCalcName () const
 Returns the name as used in the Calc document. More...
 
const OUString & getUpcaseModelName () const
 Returns the original name as imported from or exported to the file. 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::unique_ptr< StreamDataSequenceStreamDataSeqPtr
 

Private Attributes

ScRangeDatampScRangeData
 
sal_Int32 mnTokenIndex
 ScRangeData of the defined name. More...
 
sal_Int16 mnCalcSheet
 Name index used in API token array. More...
 
sal_Unicode mcBuiltinId
 Calc sheet index for sheet-local names. More...
 
StreamDataSeqPtr mxFormula
 Identifier for built-in defined names. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from oox::xls::WorkbookHelper
static WorkbookGlobalsRef constructGlobals (ExcelFilter &rFilter)
 
- Protected Attributes inherited from oox::xls::DefinedNameBase
DefinedNameModel maModel
 
OUString maUpModelName
 Model data for this defined name. More...
 
OUString maCalcName
 Model name converted to uppercase ASCII. More...
 

Detailed Description

Definition at line 87 of file defnamesbuffer.hxx.

Member Typedef Documentation

typedef ::std::unique_ptr< StreamDataSequence > oox::xls::DefinedName::StreamDataSeqPtr
private

Definition at line 123 of file defnamesbuffer.hxx.

Constructor & Destructor Documentation

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

Definition at line 147 of file defnamesbuffer.cxx.

Member Function Documentation

void oox::xls::DefinedName::convertFormula ( const css::uno::Sequence< css::sheet::ExternalLinkInfo > &  rExternalLinks)
void oox::xls::DefinedName::createNameObject ( sal_Int32  nIndex)
bool oox::xls::DefinedName::getAbsoluteRange ( ScRange orRange) const
sal_Unicode oox::xls::DefinedName::getBuiltinId ( ) const
inline

Returns the built-in identifier of the defined name.

Definition at line 116 of file defnamesbuffer.hxx.

References mcBuiltinId.

sal_Int16 oox::xls::DefinedName::getLocalCalcSheet ( ) const
inline

Returns the 0-based sheet index for local names, or -1 for global names.

Definition at line 114 of file defnamesbuffer.hxx.

References mnCalcSheet.

std::unique_ptr< ScTokenArray > oox::xls::DefinedName::getScTokens ( const css::uno::Sequence< css::sheet::ExternalLinkInfo > &  rExternalLinks)
sal_Int32 oox::xls::DefinedName::getTokenIndex ( ) const
inline

Returns the token index used in API token arrays (com.sun.star.sheet.FormulaToken).

Definition at line 118 of file defnamesbuffer.hxx.

References mnTokenIndex.

void oox::xls::DefinedName::importDefinedName ( const AttributeList rAttribs)
void oox::xls::DefinedName::importDefinedName ( SequenceInputStream rStrm)
bool oox::xls::DefinedName::isBuiltinName ( ) const
inline

Returns true, if this defined name is a special builtin name.

Definition at line 107 of file defnamesbuffer.hxx.

References oox::xls::BIFF_DEFNAME_UNKNOWN, and mcBuiltinId.

Referenced by createNameObject().

bool oox::xls::DefinedName::isGlobalName ( ) const
inline

Returns true, if this defined name is global in the document.

Definition at line 105 of file defnamesbuffer.hxx.

References mnCalcSheet.

Referenced by convertFormula(), and createNameObject().

bool oox::xls::DefinedName::isMacroFunction ( ) const
inline

Returns true, if this defined name is a macro function call.

Definition at line 109 of file defnamesbuffer.hxx.

References oox::xls::DefinedNameBase::maModel, oox::xls::DefinedNameModel::mbFunction, and oox::xls::DefinedNameModel::mbMacro.

bool oox::xls::DefinedName::isVBName ( ) const
inline

Returns true, if this defined name is a reference to a VBA macro.

Definition at line 111 of file defnamesbuffer.hxx.

References oox::xls::DefinedNameBase::maModel, oox::xls::DefinedNameModel::mbMacro, and oox::xls::DefinedNameModel::mbVBName.

Referenced by oox::xls::FormulaParser::importMacroName().

void oox::xls::DefinedName::setFormula ( const OUString &  rFormula)

Sets the formula string from the body of the definedName element.

Definition at line 172 of file defnamesbuffer.cxx.

References oox::xls::DefinedNameModel::maFormula, and oox::xls::DefinedNameBase::maModel.

Member Data Documentation

sal_Unicode oox::xls::DefinedName::mcBuiltinId
private

Calc sheet index for sheet-local names.

Definition at line 128 of file defnamesbuffer.hxx.

Referenced by convertFormula(), createNameObject(), getBuiltinId(), importDefinedName(), and isBuiltinName().

sal_Int16 oox::xls::DefinedName::mnCalcSheet
private

Name index used in API token array.

Definition at line 127 of file defnamesbuffer.hxx.

Referenced by convertFormula(), getLocalCalcSheet(), getScTokens(), importDefinedName(), and isGlobalName().

sal_Int32 oox::xls::DefinedName::mnTokenIndex
private

ScRangeData of the defined name.

Definition at line 126 of file defnamesbuffer.hxx.

Referenced by createNameObject(), and getTokenIndex().

ScRangeData* oox::xls::DefinedName::mpScRangeData
private

Definition at line 125 of file defnamesbuffer.hxx.

Referenced by convertFormula(), createNameObject(), and getAbsoluteRange().

StreamDataSeqPtr oox::xls::DefinedName::mxFormula
private

Identifier for built-in defined names.

Definition at line 129 of file defnamesbuffer.hxx.

Referenced by importDefinedName().


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