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

Provides export of the data of a DV record. More...

#include <xecontent.hxx>

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

Public Member Functions

 XclExpDV (const XclExpRoot &rRoot, sal_uLong nScHandle)
 
virtual ~XclExpDV () override
 
sal_uLong GetScHandle () const
 Returns the core handle of the validation data. More...
 
void InsertCellRange (const ScRange &rPos)
 Inserts a new cell range into the cell range list. More...
 
bool Finalize ()
 Converts the Calc range list to the Excel range list. More...
 
virtual void SaveXml (XclExpXmlStream &rStrm) override
 
- Public Member Functions inherited from XclExpRecord
 XclExpRecord (sal_uInt16 nRecId=EXC_ID_UNKNOWN, std::size_t nRecSize=0)
 
 XclExpRecord (XclExpRecord const &)=default
 
virtual ~XclExpRecord () override
 
sal_uInt16 GetRecId () const
 Returns the current record ID. More...
 
std::size_t GetRecSize () const
 Returns the current record size prediction. More...
 
void SetRecId (sal_uInt16 nRecId)
 Sets a new record ID. More...
 
void SetRecSize (std::size_t nRecSize)
 Sets a new record size prediction. More...
 
void AddRecSize (std::size_t nRecSize)
 Adds a size value to the record size prediction. More...
 
void SetRecHeader (sal_uInt16 nRecId, std::size_t nRecSize)
 Sets record ID and size with one call. More...
 
virtual void Save (XclExpStream &rStrm) override
 Writes the record header and calls WriteBody(). More...
 
- 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 Member Functions

virtual void WriteBody (XclExpStream &rStrm) override
 Writes the body of the DV record. More...
 

Private Attributes

ScRangeList maScRanges
 
XclRangeList maXclRanges
 Calc range list with all affected cells. More...
 
XclExpString maPromptTitle
 Excel range list with all affected cells. More...
 
XclExpString maPromptText
 The prompt title. More...
 
XclExpString maErrorTitle
 The prompt text. More...
 
XclExpString maErrorText
 The error title. More...
 
XclExpStringRef mxString1
 The error text. More...
 
XclTokenArrayRef mxTokArr1
 String for first condition formula. More...
 
OUString msFormula1
 Formula for first condition. More...
 
OUString msList
 OOXML Formula for first condition. More...
 
XclTokenArrayRef mxTokArr2
 x12ac:list for first condition. More...
 
OUString msFormula2
 Formula for second condition. More...
 
sal_uInt32 mnFlags
 OOXML Formula for second condition. More...
 
sal_uLong mnScHandle
 Miscellaneous flags. More...
 

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

Provides export of the data of a DV record.

This record contains the settings for a data validation. In detail this is a pointer to the core validation data and a cell range list with all affected cells. The handle index is used to optimize list search algorithm.

Definition at line 315 of file xecontent.hxx.

Constructor & Destructor Documentation

XclExpDV::XclExpDV ( const XclExpRoot rRoot,
sal_uLong  nScHandle 
)
explicit
XclExpDV::~XclExpDV ( )
overridevirtual

Definition at line 1841 of file xecontent.cxx.

Member Function Documentation

bool XclExpDV::Finalize ( )

Converts the Calc range list to the Excel range list.

Returns
false = Resulting range list empty - do not write this record.

Definition at line 1850 of file xecontent.cxx.

References XclExpAddressConverter::ConvertRangeList(), XclRangeList::empty(), XclExpRoot::GetAddressConverter(), maScRanges, maXclRanges, and mnScHandle.

sal_uLong XclExpDV::GetScHandle ( ) const
inline

Returns the core handle of the validation data.

Definition at line 322 of file xecontent.hxx.

References mnScHandle.

void XclExpDV::InsertCellRange ( const ScRange rPos)

Inserts a new cell range into the cell range list.

Definition at line 1845 of file xecontent.cxx.

References ScRangeList::Join(), and maScRanges.

Referenced by XclExpDval::InsertCellRange().

void XclExpDV::SaveXml ( XclExpXmlStream rStrm)
overridevirtual
void XclExpDV::WriteBody ( XclExpStream rStrm)
overrideprivatevirtual

Writes the body of the DV record.

Reimplemented from XclExpRecord.

Definition at line 1856 of file xecontent.cxx.

References maErrorText, maErrorTitle, maPromptText, maPromptTitle, maXclRanges, mnFlags, mxString1, mxTokArr1, and mxTokArr2.

Member Data Documentation

XclExpString XclExpDV::maErrorText
private

The error title.

Definition at line 342 of file xecontent.hxx.

Referenced by SaveXml(), WriteBody(), and XclExpDV().

XclExpString XclExpDV::maErrorTitle
private

The prompt text.

Definition at line 341 of file xecontent.hxx.

Referenced by SaveXml(), WriteBody(), and XclExpDV().

XclExpString XclExpDV::maPromptText
private

The prompt title.

Definition at line 340 of file xecontent.hxx.

Referenced by SaveXml(), WriteBody(), and XclExpDV().

XclExpString XclExpDV::maPromptTitle
private

Excel range list with all affected cells.

Definition at line 339 of file xecontent.hxx.

Referenced by SaveXml(), WriteBody(), and XclExpDV().

ScRangeList XclExpDV::maScRanges
private

Definition at line 337 of file xecontent.hxx.

Referenced by Finalize(), InsertCellRange(), and SaveXml().

XclRangeList XclExpDV::maXclRanges
private

Calc range list with all affected cells.

Definition at line 338 of file xecontent.hxx.

Referenced by Finalize(), and WriteBody().

sal_uInt32 XclExpDV::mnFlags
private

OOXML Formula for second condition.

Definition at line 349 of file xecontent.hxx.

Referenced by SaveXml(), WriteBody(), and XclExpDV().

sal_uLong XclExpDV::mnScHandle
private

Miscellaneous flags.

Definition at line 350 of file xecontent.hxx.

Referenced by Finalize(), GetScHandle(), and XclExpDV().

OUString XclExpDV::msFormula1
private

Formula for first condition.

Definition at line 345 of file xecontent.hxx.

Referenced by SaveXml(), and XclExpDV().

OUString XclExpDV::msFormula2
private

Formula for second condition.

Definition at line 348 of file xecontent.hxx.

Referenced by SaveXml(), and XclExpDV().

OUString XclExpDV::msList
private

OOXML Formula for first condition.

Definition at line 346 of file xecontent.hxx.

Referenced by SaveXml(), and XclExpDV().

XclExpStringRef XclExpDV::mxString1
private

The error text.

Definition at line 343 of file xecontent.hxx.

Referenced by WriteBody(), and XclExpDV().

XclTokenArrayRef XclExpDV::mxTokArr1
private

String for first condition formula.

Definition at line 344 of file xecontent.hxx.

Referenced by WriteBody(), and XclExpDV().

XclTokenArrayRef XclExpDV::mxTokArr2
private

x12ac:list for first condition.

Definition at line 347 of file xecontent.hxx.

Referenced by WriteBody(), and XclExpDV().


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