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

Manager that stores all internal defined names (NAME records) of the document. More...

#include <xename.hxx>

Inheritance diagram for XclExpNameManager:
[legend]
Collaboration diagram for XclExpNameManager:
[legend]

Public Member Functions

 XclExpNameManager (const XclExpRoot &rRoot)
 
virtual ~XclExpNameManager () override
 
void Initialize ()
 Creates NAME records for built-in and user defined names. More...
 
sal_uInt16 InsertName (SCTAB nTab, sal_uInt16 nScNameIdx, SCTAB nCurrTab)
 Inserts the Calc name with the passed index and returns the Excel NAME index. More...
 
sal_uInt16 InsertBuiltInName (sal_Unicode cBuiltIn, const ScRange &rRange)
 Inserts a new built-in defined name, referring to the passed sheet range. More...
 
sal_uInt16 InsertBuiltInName (sal_Unicode cBuiltIn, const ScRangeList &rRangeList)
 Inserts a new built-in defined name, referring to the passed sheet range list. More...
 
sal_uInt16 InsertUniqueName (const OUString &rName, const XclTokenArrayRef &xTokArr, SCTAB nScTab)
 Inserts a new defined name. More...
 
sal_uInt16 InsertRawName (const OUString &rName)
 Returns index of an existing name, or creates a name without definition. More...
 
sal_uInt16 InsertMacroCall (const OUString &rMacroName, bool bVBasic, bool bFunc, bool bHidden=false)
 Searches or inserts a defined name describing a macro name. More...
 
const OUString & GetOrigName (sal_uInt16 nNameIdx) const
 Returns the Calc sheet of a local defined name, or SCTAB_GLOBAL for global defined names. More...
 
SCTAB GetScTab (sal_uInt16 nNameIdx) const
 Returns the Calc sheet of a local defined name, or SCTAB_GLOBAL for global defined names. More...
 
bool IsVolatile (sal_uInt16 nNameIdx) const
 Returns true, if the specified defined name is volatile. More...
 
virtual void Save (XclExpStream &rStrm) override
 Writes the entire list of NAME records. More...
 
virtual void SaveXml (XclExpXmlStream &rStrm) override
 
- Public Member Functions inherited from XclExpRecordBase
 XclExpRecordBase ()
 
 XclExpRecordBase (XclExpRecordBase const &)
 
 XclExpRecordBase (XclExpRecordBase &&)
 
XclExpRecordBaseoperator= (XclExpRecordBase const &)
 
XclExpRecordBaseoperator= (XclExpRecordBase &&) noexcept
 
virtual ~XclExpRecordBase ()
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Private Types

typedef std::shared_ptr< XclExpNameManagerImplXclExpNameMgrImplRef
 

Private Attributes

XclExpNameMgrImplRef mxImpl
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static voidoperator new (std::size_t nSize)
 
static voidoperator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 
static void operator delete (void *pPtr)
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 
- Protected Member Functions inherited from XclExpRoot
 XclExpRoot (XclExpRootData &rExpRootData)
 
const XclExpRootGetRoot () const
 Returns this root instance - for code readability in derived classes. More...
 
bool IsRelUrl () const
 Returns true, if URLs should be stored relative to the document location. More...
 
sc::CompileFormulaContextGetCompileFormulaContext () const
 
XclExpTabInfoGetTabInfo () const
 Returns the buffer for Calc->Excel sheet index conversion. More...
 
XclExpAddressConverterGetAddressConverter () const
 Returns the address converter. More...
 
XclExpFormulaCompilerGetFormulaCompiler () const
 Returns the formula compiler to produce formula token arrays. More...
 
XclExpProgressBarGetProgressBar () const
 Returns the export progress bar. More...
 
XclExpSstGetSst () const
 Returns the shared string table. More...
 
XclExpPaletteGetPalette () const
 Returns the color buffer. More...
 
XclExpFontBufferGetFontBuffer () const
 Returns the font buffer. More...
 
XclExpNumFmtBufferGetNumFmtBuffer () const
 Returns the number format buffer. More...
 
XclExpXFBufferGetXFBuffer () const
 Returns the cell formatting attributes buffer. More...
 
XclExpLinkManagerGetGlobalLinkManager () const
 Returns the global link manager for defined names. More...
 
XclExpLinkManagerGetLocalLinkManager () const
 Returns the local link manager for the current sheet. More...
 
XclExpNameManagerGetNameManager () const
 Returns the buffer that contains internal defined names. More...
 
XclExpObjectManagerGetObjectManager () const
 Returns the drawing object manager. More...
 
XclExpFilterManagerGetFilterManager () const
 Returns the filter manager. More...
 
XclExpPivotTableManagerGetPivotTableManager () const
 Returns the pivot table manager. More...
 
XclExpDxfsGetDxfs () const
 Returns the differential formatting list. More...
 
OStringBuffer & GetStringBuf () const
 Clean and return the OStringBuffer. More...
 
XclExpXmlPivotTableManagerGetXmlPivotTableManager ()
 
XclExpTablesManagerGetTablesManager ()
 
void InitializeConvert ()
 Is called when export filter starts to create the Excel document (all BIFF versions). More...
 
void InitializeGlobals ()
 Is called when export filter starts to create the workbook global data (>=BIFF5). More...
 
void InitializeTable (SCTAB nScTab)
 Is called when export filter starts to create data for a single sheet (all BIFF versions). More...
 
void InitializeSave ()
 Is called before export filter starts to write the records to the stream. More...
 
XclExpRecordRef CreateRecord (sal_uInt16 nRecId) const
 Returns the reference to a record (or record list) representing a root object. More...
 
bool IsDocumentEncrypted () const
 
css::uno::Sequence< css::beans::NamedValue > GetEncryptionData () const
 
- Protected Member Functions inherited from XclRoot
 XclRoot (XclRootData &rRootData)
 
 XclRoot (const XclRoot &rRoot)
 
virtual ~XclRoot ()
 
XclRootoperator= (const XclRoot &rRoot)
 
RootDataGetOldRoot () const
 Returns old RootData struct. More...
 
XclBiff GetBiff () const
 Returns the current BIFF version of the importer/exporter. More...
 
XclOutput GetOutput () const
 Returns the current output format of the importer/exporter. More...
 
bool IsImport () const
 Returns true, if currently a document is imported. More...
 
rtl_TextEncoding GetTextEncoding () const
 Returns the text encoding to import/export byte strings. More...
 
LanguageType GetSysLanguage () const
 Returns the system language, i.e. More...
 
LanguageType GetDocLanguage () const
 Returns the document language. More...
 
LanguageType GetUILanguage () const
 Returns the UI language. More...
 
sal_Int16 GetDefApiScript () const
 Returns the default script type, e.g. More...
 
tools::Long GetCharWidth () const
 Returns the width of the '0' character (default font) for the current printer (twips). More...
 
bool IsInGlobals () const
 Returns the current Calc sheet index. More...
 
SCTAB GetCurrScTab () const
 Returns the current Calc sheet index. More...
 
sal_Int32 GetHmmFromPixelX (double fPixelX) const
 Calculates the width of the passed number of pixels in 1/100 mm. More...
 
sal_Int32 GetHmmFromPixelY (double fPixelY) const
 Calculates the height of the passed number of pixels in 1/100 mm. More...
 
SfxMediumGetMedium () const
 Returns the medium to import from. More...
 
const OUString & GetDocUrl () const
 Returns the document URL of the imported/exported file. More...
 
const OUString & GetBasePath () const
 Returns the base path of the imported/exported file. More...
 
const OUString & GetUserName () const
 Returns the current user name. More...
 
css::uno::Sequence< css::beans::NamedValue > RequestEncryptionData (::comphelper::IDocPasswordVerifier &rVerifier) const
 Requests and verifies a password from the medium or the user. More...
 
const tools::SvRef< SotStorage > & GetRootStorage () const
 Returns the OLE2 root storage of the imported/exported file. More...
 
bool HasVbaStorage () const
 Returns true, if the document contains a VBA storage. More...
 
tools::SvRef< SotStorageOpenStorage (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrgName) const
 Tries to open a storage as child of the specified storage for reading or writing. More...
 
tools::SvRef< SotStorageOpenStorage (const OUString &rStrgName) const
 Tries to open a storage as child of the root storage for reading or writing. More...
 
tools::SvRef< SotStorageStreamOpenStream (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrmName) const
 Tries to open a new stream in the specified storage for reading or writing. More...
 
tools::SvRef< SotStorageStreamOpenStream (const OUString &rStrmName) const
 Tries to open a new stream in the root storage for reading or writing. More...
 
ScDocumentGetDoc () const
 Returns reference to the destination document (import) or source document (export). More...
 
SfxObjectShellGetDocShell () const
 Returns the object shell of the Calc document. More...
 
ScModelObjGetDocModelObj () const
 Returns the object model of the Calc document. More...
 
OutputDeviceGetPrinter () const
 Returns pointer to the printer of the Calc document. More...
 
ScStyleSheetPoolGetStyleSheetPool () const
 Returns the style sheet pool of the Calc document. More...
 
ScRangeNameGetNamedRanges () const
 Returns the defined names container of the Calc document. More...
 
SdrPageGetSdrPage (SCTAB nScTab) const
 Returns the drawing layer page of the passed sheet, if present. More...
 
SvNumberFormatterGetFormatter () const
 Returns the number formatter of the Calc document. More...
 
DateTime GetNullDate () const
 Returns the null date of the current number formatter. More...
 
sal_uInt16 GetBaseYear () const
 Returns the base year depending on the current null date (1900 or 1904). More...
 
double GetDoubleFromDateTime (const DateTime &rDateTime) const
 Converts a date/time value to a floating-point value. More...
 
DateTime GetDateTimeFromDouble (double fValue) const
 Converts a floating-point value to a date/time value. More...
 
ScEditEngineDefaulterGetEditEngine () const
 Returns the edit engine for import/export of rich strings etc. More...
 
ScHeaderEditEngineGetHFEditEngine () const
 Returns the edit engine for import/export of headers/footers. More...
 
EditEngineGetDrawEditEngine () const
 Returns the edit engine for import/export of drawing text boxes. More...
 
XclFontPropSetHelperGetFontPropSetHelper () const
 Returns the property set helper for fonts. More...
 
XclChPropSetHelperGetChartPropSetHelper () const
 Returns the property set helper for the chart filters. More...
 
ScExtDocOptionsGetExtDocOptions () const
 Returns the extended document options. More...
 
XclTracerGetTracer () const
 Returns the filter tracer. More...
 
const ScAddressGetScMaxPos () const
 Returns the highest possible cell address in a Calc document. More...
 
const ScAddressGetXclMaxPos () const
 Returns the highest possible cell address in an Excel document (using current BIFF version). More...
 
const ScAddressGetMaxPos () const
 Returns the highest possible cell address valid in Calc and Excel (using current BIFF version). More...
 
void SetDocLanguage (LanguageType eLang)
 Sets the document language. More...
 
void SetUILanguage (LanguageType eLang)
 Sets the UI language, i.e. More...
 
void SetTextEncoding (rtl_TextEncoding eTextEnc)
 Sets the text encoding to import/export byte strings. More...
 
void SetCharWidth (const XclFontData &rFontData)
 Sets the width of the '0' character (default font) for the current printer (twips). More...
 
void SetCurrScTab (SCTAB nScTab)
 Sets the current Calc sheet index. More...
 
void IncCurrScTab ()
 Increases the current Calc sheet index by 1. More...
 
- Static Protected Member Functions inherited from XclExpRoot
static css::uno::Sequence< css::beans::NamedValue > GenerateEncryptionData (const OUString &aPass)
 
static css::uno::Sequence< css::beans::NamedValue > GenerateDefaultEncryptionData ()
 
- Static Protected Member Functions inherited from XclRoot
static OUString GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

Manager that stores all internal defined names (NAME records) of the document.

Definition at line 32 of file xename.hxx.

Member Typedef Documentation

Definition at line 70 of file xename.hxx.

Constructor & Destructor Documentation

XclExpNameManager::XclExpNameManager ( const XclExpRoot rRoot)
explicit

Definition at line 787 of file xename.cxx.

References make_shared().

XclExpNameManager::~XclExpNameManager ( )
overridevirtual

Definition at line 793 of file xename.cxx.

Member Function Documentation

const OUString & XclExpNameManager::GetOrigName ( sal_uInt16  nNameIdx) const

Returns the Calc sheet of a local defined name, or SCTAB_GLOBAL for global defined names.

Definition at line 840 of file xename.cxx.

References EMPTY_OUSTRING, and mxImpl.

Referenced by XclExpWebQueryBuffer::XclExpWebQueryBuffer().

SCTAB XclExpNameManager::GetScTab ( sal_uInt16  nNameIdx) const

Returns the Calc sheet of a local defined name, or SCTAB_GLOBAL for global defined names.

Definition at line 846 of file xename.cxx.

References mxImpl, and SCTAB_GLOBAL.

Referenced by XclExpFmlaCompImpl::ProcessDefinedName().

void XclExpNameManager::Initialize ( )

Creates NAME records for built-in and user defined names.

Definition at line 797 of file xename.cxx.

References mxImpl.

Referenced by XclExpRoot::InitializeGlobals().

sal_uInt16 XclExpNameManager::InsertBuiltInName ( sal_Unicode  cBuiltIn,
const ScRange rRange 
)

Inserts a new built-in defined name, referring to the passed sheet range.

Definition at line 807 of file xename.cxx.

References XclExpFormulaCompiler::CreateFormula(), EXC_FMLATYPE_NAME, XclExpRoot::GetFormulaCompiler(), and mxImpl.

Referenced by XclExpNameManagerImpl::CreateBuiltInNames(), and ExcAutoFilterRecs::ExcAutoFilterRecs().

sal_uInt16 XclExpNameManager::InsertBuiltInName ( sal_Unicode  cBuiltIn,
const ScRangeList rRangeList 
)

Inserts a new built-in defined name, referring to the passed sheet range list.

Definition at line 813 of file xename.cxx.

References ScRange::aStart, XclExpFormulaCompiler::CreateFormula(), ScRangeList::empty(), EXC_FMLATYPE_NAME, ScRangeList::front(), XclExpRoot::GetFormulaCompiler(), mxImpl, and ScAddress::Tab().

sal_uInt16 XclExpNameManager::InsertMacroCall ( const OUString &  rMacroName,
bool  bVBasic,
bool  bFunc,
bool  bHidden = false 
)

Searches or inserts a defined name describing a macro name.

Parameters
bVBasictrue = Visual Basic macro, false = Sheet macro.
bFunctrue = Macro function; false = Macro procedure.

Definition at line 835 of file xename.cxx.

References mxImpl.

Referenced by XclExpFmlaCompImpl::AppendMacroCallToken(), and XclMacroHelper::SetMacroLink().

sal_uInt16 XclExpNameManager::InsertName ( SCTAB  nTab,
sal_uInt16  nScNameIdx,
SCTAB  nCurrTab 
)

Inserts the Calc name with the passed index and returns the Excel NAME index.

Definition at line 802 of file xename.cxx.

References mxImpl.

Referenced by XclExpFmlaCompImpl::ProcessDefinedName().

sal_uInt16 XclExpNameManager::InsertRawName ( const OUString &  rName)

Returns index of an existing name, or creates a name without definition.

Definition at line 830 of file xename.cxx.

References mxImpl.

Referenced by XclExpFmlaCompImpl::AppendMissingNameToken().

sal_uInt16 XclExpNameManager::InsertUniqueName ( const OUString &  rName,
const XclTokenArrayRef xTokArr,
SCTAB  nScTab 
)

Inserts a new defined name.

Sets another unused name, if rName already exists.

Definition at line 824 of file xename.cxx.

References mxImpl.

Referenced by XclExpWebQueryBuffer::XclExpWebQueryBuffer().

bool XclExpNameManager::IsVolatile ( sal_uInt16  nNameIdx) const

Returns true, if the specified defined name is volatile.

Definition at line 852 of file xename.cxx.

References mxImpl.

Referenced by XclExpFmlaCompImpl::ProcessDefinedName().

void XclExpNameManager::Save ( XclExpStream rStrm)
overridevirtual

Writes the entire list of NAME records.

Reimplemented from XclExpRecordBase.

Definition at line 858 of file xename.cxx.

References mxImpl.

void XclExpNameManager::SaveXml ( XclExpXmlStream rStrm)
overridevirtual

Reimplemented from XclExpRecordBase.

Definition at line 863 of file xename.cxx.

References mxImpl.

Member Data Documentation

XclExpNameMgrImplRef XclExpNameManager::mxImpl
private

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