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

Represents a defined name. More...

#include <xiname.hxx>

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

Classes

struct  TokenStrmData
 

Public Member Functions

 XclImpName (const XclImpName &)=delete
 
const XclImpNameoperator= (const XclImpName &)=delete
 
 XclImpName (XclImpStream &rStrm, sal_uInt16 nXclNameIdx)
 
const OUString & GetXclName () const
 
const OUString & GetScName () const
 
SCTAB GetScTab () const
 
const ScRangeDataGetScRangeData () const
 
bool IsGlobal () const
 
bool IsVBName () const
 
bool IsMacro () const
 
void ConvertTokens ()
 

Private Member Functions

void InsertName (const ScTokenArray *pArray)
 

Private Attributes

OUString maXclName
 
OUString maScName
 Original name read from the file. More...
 
const ScRangeDatampScData
 Name inserted into the Calc document. More...
 
SCTAB mnScTab
 Pointer to Calc defined name (no ownership). More...
 
ScRangeData::Type meNameType
 Calc sheet index of local names. More...
 
sal_uInt16 mnXclTab
 
sal_uInt16 mnNameIndex
 
bool mbVBName:1
 
bool mbMacro:1
 true = Visual Basic procedure or function. More...
 
std::unique_ptr< TokenStrmDatampTokensData
 Whether it's a user-defined macro. More...
 

Additional Inherited Members

- Protected Member Functions inherited from XclImpRoot
 XclImpRoot (XclImpRootData &rImpRootData)
 
const XclImpRootGetRoot () const
 Returns this root instance - for code readability in derived classes. More...
 
XclImpRootGetRoot ()
 
void SetCodePage (sal_uInt16 nCodePage)
 Sets a code page read from a CODEPAGE record for byte string import. More...
 
void InitializeTable (SCTAB nScTab)
 Is called when import filter starts importing a single sheet (all BIFF versions). More...
 
void FinalizeTable ()
 Is called when import filter stops importing a single sheet (all BIFF versions). More...
 
XclImpAddressConverterGetAddressConverter () const
 Returns the address converter. More...
 
XclImpFormulaCompilerGetFormulaCompiler () const
 Returns the formula converter. More...
 
ExcelToScGetOldFmlaConverter () const
 Returns the old formula converter. More...
 
XclImpSstGetSst () const
 Returns the shared string table. More...
 
XclImpPaletteGetPalette () const
 Returns the color buffer. More...
 
XclImpFontBufferGetFontBuffer () const
 Returns the font buffer. More...
 
XclImpNumFmtBufferGetNumFmtBuffer () const
 Returns the number format buffer. More...
 
XclImpXFBufferGetXFBuffer () const
 Returns the cell formatting attributes buffer. More...
 
XclImpXFRangeBufferGetXFRangeBuffer () const
 Returns the buffer of XF index ranges for a sheet. More...
 
ScRangeListTabsGetPrintAreaBuffer () const
 Returns the buffer that contains all print areas in the document. More...
 
ScRangeListTabsGetTitleAreaBuffer () const
 Returns the buffer that contains all print titles in the document. More...
 
XclImpTabInfoGetTabInfo () const
 Returns the buffer that contains the sheet creation order. More...
 
XclImpNameManagerGetNameManager () const
 Returns the buffer that contains internal defined names. More...
 
XclImpLinkManagerGetLinkManager () const
 Returns the link manager. More...
 
XclImpObjectManagerGetObjectManager () const
 Returns the drawing object manager. More...
 
XclImpSheetDrawingGetCurrSheetDrawing () const
 Returns the drawing container of the current sheet. More...
 
XclImpCondFormatManagerGetCondFormatManager () const
 Returns the conditional formatting manager. More...
 
XclImpValidationManagerGetValidationManager () const
 
XclImpAutoFilterBufferGetFilterManager () const
 Returns the filter manager. More...
 
XclImpWebQueryBufferGetWebQueryBuffer () const
 Returns the web query buffer. More...
 
XclImpPivotTableManagerGetPivotTableManager () const
 Returns the pivot table manager. More...
 
XclImpSheetProtectBufferGetSheetProtectBuffer () const
 Returns the sheet protection options of the current sheet. More...
 
XclImpDocProtectBufferGetDocProtectBuffer () const
 Returns the document protection options. More...
 
XclImpPageSettingsGetPageSettings () const
 Returns the page settings of the current sheet. More...
 
XclImpDocViewSettingsGetDocViewSettings () const
 Returns the view settings of the entire document. More...
 
XclImpTabViewSettingsGetTabViewSettings () const
 Returns the view settings of the current sheet. More...
 
bool HasBasic () const
 Returns true, if the document contains a VB project. More...
 
void SetHasBasic ()
 Called to indicate that the document contains a VB project. More...
 
void ReadCodeName (XclImpStream &rStrm, bool bGlobals)
 Reads the CODENAME record and inserts the codename into the document. More...
 
ScDocumentImportGetDocImport ()
 
- 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...
 
tools::Long GetSpaceWidth () const
 
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' - '9' digit character as well as the ' ' space char (using the 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 XclImpRoot
static OUString GetScAddInName (const OUString &rXclName)
 Returns the Calc add-in function name for an Excel function name. More...
 
- Static Protected Member Functions inherited from XclRoot
static OUString GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 

Detailed Description

Represents a defined name.

It may be related to a single sheet or global.

Definition at line 33 of file xiname.hxx.

Constructor & Destructor Documentation

◆ XclImpName() [1/2]

XclImpName::XclImpName ( const XclImpName )
delete

◆ XclImpName() [2/2]

XclImpName::XclImpName ( XclImpStream rStrm,
sal_uInt16  nXclNameIdx 
)
explicit

Member Function Documentation

◆ ConvertTokens()

void XclImpName::ConvertTokens ( )

◆ GetScName()

const OUString & XclImpName::GetScName ( ) const
inline

Definition at line 52 of file xiname.hxx.

References maScName.

◆ GetScRangeData()

const ScRangeData * XclImpName::GetScRangeData ( ) const
inline

Definition at line 54 of file xiname.hxx.

References mpScData.

◆ GetScTab()

SCTAB XclImpName::GetScTab ( ) const
inline

Definition at line 53 of file xiname.hxx.

References mnScTab.

◆ GetXclName()

const OUString & XclImpName::GetXclName ( ) const
inline

Definition at line 51 of file xiname.hxx.

References maXclName.

◆ InsertName()

void XclImpName::InsertName ( const ScTokenArray pArray)
private

◆ IsGlobal()

bool XclImpName::IsGlobal ( ) const
inline

Definition at line 55 of file xiname.hxx.

References mnScTab, and SCTAB_MAX.

◆ IsMacro()

bool XclImpName::IsMacro ( ) const
inline

Definition at line 57 of file xiname.hxx.

References mbMacro.

◆ IsVBName()

bool XclImpName::IsVBName ( ) const
inline

Definition at line 56 of file xiname.hxx.

References mbVBName.

◆ operator=()

const XclImpName & XclImpName::operator= ( const XclImpName )
delete

Member Data Documentation

◆ maScName

OUString XclImpName::maScName
private

Original name read from the file.

Definition at line 64 of file xiname.hxx.

Referenced by GetScName(), InsertName(), and XclImpName().

◆ maXclName

OUString XclImpName::maXclName
private

Definition at line 63 of file xiname.hxx.

Referenced by GetXclName(), and XclImpName().

◆ mbMacro

bool XclImpName::mbMacro
private

true = Visual Basic procedure or function.

Definition at line 71 of file xiname.hxx.

Referenced by IsMacro(), and XclImpName().

◆ mbVBName

bool XclImpName::mbVBName
private

Definition at line 70 of file xiname.hxx.

Referenced by IsVBName(), and XclImpName().

◆ meNameType

ScRangeData::Type XclImpName::meNameType
private

Calc sheet index of local names.

Definition at line 67 of file xiname.hxx.

Referenced by InsertName(), and XclImpName().

◆ mnNameIndex

sal_uInt16 XclImpName::mnNameIndex
private

Definition at line 69 of file xiname.hxx.

Referenced by InsertName().

◆ mnScTab

SCTAB XclImpName::mnScTab
private

Pointer to Calc defined name (no ownership).

Definition at line 66 of file xiname.hxx.

Referenced by GetScTab(), InsertName(), IsGlobal(), and XclImpName().

◆ mnXclTab

sal_uInt16 XclImpName::mnXclTab
private

Definition at line 68 of file xiname.hxx.

Referenced by InsertName(), and XclImpName().

◆ mpScData

const ScRangeData* XclImpName::mpScData
private

Name inserted into the Calc document.

Definition at line 65 of file xiname.hxx.

Referenced by GetScRangeData(), and InsertName().

◆ mpTokensData

std::unique_ptr<TokenStrmData> XclImpName::mpTokensData
private

Whether it's a user-defined macro.

Definition at line 73 of file xiname.hxx.

Referenced by ConvertTokens(), and XclImpName().


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