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

#include <xeescher.hxx>

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

Public Member Functions

 XclMacroHelper (const XclExpRoot &rRoot)
 
virtual ~XclMacroHelper () override
 
void WriteMacroSubRec (XclExpStream &rStrm)
 Writes an ftMacro subrecord containing a macro link, or nothing, if no macro present. More...
 
bool SetMacroLink (const css::script::ScriptEventDescriptor &rEvent, const XclTbxEventType &nEventType)
 Sets the name of a macro for object of passed type. More...
 
bool SetMacroLink (const OUString &rMacro)
 Sets the name of a macro. More...
 
const OUString & GetMacroName () const
 
- Public Member Functions inherited from XclExpControlHelper
 XclExpControlHelper (const XclExpRoot &rRoot)
 
virtual ~XclExpControlHelper () override
 

Private Attributes

XclTokenArrayRef mxMacroLink
 
OUString maMacroName
 Token array containing a link to an attached macro. More...
 

Additional Inherited Members

- Protected Member Functions inherited from XclExpControlHelper
void ConvertSheetLinks (css::uno::Reference< css::drawing::XShape > const &xShape)
 Tries to get spreadsheet cell link and source range link from the passed shape. More...
 
const XclTokenArrayGetCellLinkTokArr () const
 Returns the Excel token array of the cell link, or 0, if no link present. More...
 
const XclTokenArrayGetSourceRangeTokArr () const
 Returns the Excel token array of the source range, or 0, if no link present. More...
 
sal_uInt16 GetSourceEntryCount () const
 Returns the number of entries in the source range, or 0, if no source set. More...
 
- 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...
 
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 XclExpControlHelper
static void WriteFormula (XclExpStream &rStrm, const XclTokenArray &rTokArr)
 Writes a formula with special style only valid in OBJ records. More...
 
static void WriteFormulaSubRec (XclExpStream &rStrm, sal_uInt16 nSubRecId, const XclTokenArray &rTokArr)
 Writes a formula subrecord with special style only valid in OBJ records. More...
 
- Static Protected Member Functions inherited from XclExpRoot
static css::uno::Sequence< css::beans::NamedValue > GenerateEncryptionData (std::u16string_view 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 XclExpControlHelper
ScAddress mxCellLinkAddress
 Number of entries in source range. More...
 

Detailed Description

Definition at line 195 of file xeescher.hxx.

Constructor & Destructor Documentation

◆ XclMacroHelper()

XclMacroHelper::XclMacroHelper ( const XclExpRoot rRoot)
explicit

Definition at line 1817 of file xeescher.cxx.

◆ ~XclMacroHelper()

XclMacroHelper::~XclMacroHelper ( )
overridevirtual

Definition at line 1822 of file xeescher.cxx.

Member Function Documentation

◆ GetMacroName()

const OUString & XclMacroHelper::GetMacroName ( ) const

Definition at line 1832 of file xeescher.cxx.

References maMacroName.

Referenced by XclExpTbxControlObj::SaveSheetXml(), and XclExpTbxControlObj::SaveVml().

◆ SetMacroLink() [1/2]

bool XclMacroHelper::SetMacroLink ( const css::script::ScriptEventDescriptor &  rEvent,
const XclTbxEventType nEventType 
)

Sets the name of a macro for object of passed type.

Returns
true = The passed event descriptor was valid, macro name has been found.

Referenced by XclExpTbxControlObj::SetMacroLink(), and XclExpShapeObj::XclExpShapeObj().

◆ SetMacroLink() [2/2]

bool XclMacroHelper::SetMacroLink ( const OUString &  rMacro)

◆ WriteMacroSubRec()

void XclMacroHelper::WriteMacroSubRec ( XclExpStream rStrm)

Writes an ftMacro subrecord containing a macro link, or nothing, if no macro present.

Definition at line 1826 of file xeescher.cxx.

References EXC_ID_OBJMACRO, mxMacroLink, rStrm, and XclExpControlHelper::WriteFormulaSubRec().

Referenced by XclExpShapeObj::WriteSubRecs(), and XclExpTbxControlObj::WriteSubRecs().

Member Data Documentation

◆ maMacroName

OUString XclMacroHelper::maMacroName
private

Token array containing a link to an attached macro.

Definition at line 198 of file xeescher.hxx.

Referenced by GetMacroName().

◆ mxMacroLink

XclTokenArrayRef XclMacroHelper::mxMacroLink
private

Definition at line 197 of file xeescher.hxx.

Referenced by SetMacroLink(), and WriteMacroSubRec().


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