LibreOffice Module sc (master)  1
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
XclExpChGroupBase Class Referenceabstract

Base class for chart record groups. More...

#include <xechart.hxx>

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

Public Member Functions

 XclExpChGroupBase (const XclExpChRoot &rRoot, sal_uInt16 nFrType, sal_uInt16 nRecId, std::size_t nRecSize=0)
 
virtual ~XclExpChGroupBase () override
 
virtual void Save (XclExpStream &rStrm) override
 Saves the header record. More...
 
virtual bool HasSubRecords () const
 Derived classes return whether there are any records embedded in this group. More...
 
virtual void WriteSubRecords (XclExpStream &rStrm)=0
 Derived classes implement writing any records embedded in this group. More...
 
- 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...
 
- Public Member Functions inherited from XclExpRecordBase
 XclExpRecordBase ()
 
 XclExpRecordBase (XclExpRecordBase const &)
 
 XclExpRecordBase (XclExpRecordBase &&)
 
XclExpRecordBaseoperator= (XclExpRecordBase const &)
 
XclExpRecordBaseoperator= (XclExpRecordBase &&) noexcept
 
virtual ~XclExpRecordBase ()
 
virtual void SaveXml (XclExpXmlStream &rStrm)
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Protected Member Functions

void SetFutureRecordContext (sal_uInt16 nFrContext, sal_uInt16 nFrValue1=0, sal_uInt16 nFrValue2=0)
 Sets context information for future record blocks. More...
 
- Protected Member Functions inherited from XclExpRecord
virtual void WriteBody (XclExpStream &rStrm)
 Writes the body of the record (without record header). More...
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 
- Protected Member Functions inherited from XclExpChRoot
void RegisterFutureRecBlock (const XclChFrBlock &rFrBlock)
 Called from XclExpChGroupBase::Save, registers a new future record level. More...
 
void InitializeFutureRecBlock (XclExpStream &rStrm)
 Called from XclExpChFutureRecordBase::Save, Initializes the current future record level. More...
 
void FinalizeFutureRecBlock (XclExpStream &rStrm)
 Called from XclExpChGroupBase::Save, finalizes the current future record level. More...
 
 XclExpChRoot (const XclExpRoot &rRoot, XclExpChChart &rChartData)
 
virtual ~XclExpChRoot () override
 
 XclExpChRoot (XclExpChRoot const &)=default
 
 XclExpChRoot (XclExpChRoot &&)=default
 
XclExpChRootoperator= (XclExpChRoot const &)=delete
 
XclExpChRootoperator= (XclExpChRoot &&)=delete
 
const XclExpChRootGetChRoot () const
 Returns this root instance - for code readability in derived classes. More...
 
css::uno::Reference< css::chart2::XChartDocument > const & GetChartDocument () const
 Returns the API Chart document model. More...
 
XclExpChChartGetChartData () const
 Returns a reference to the parent chart data object. More...
 
const XclChTypeInfoGetChartTypeInfo (XclChTypeId eType) const
 Returns chart type info for a unique chart type identifier. More...
 
const XclChTypeInfoGetChartTypeInfo (const OUString &rServiceName) const
 Returns the first fitting chart type info for the passed service name. More...
 
const XclChFormatInfoGetFormatInfo (XclChObjectType eObjType) const
 Returns an info struct about auto formatting for the passed object type. More...
 
void InitConversion (css::uno::Reference< css::chart2::XChartDocument > const &xChartDoc, const tools::Rectangle &rChartRect) const
 Starts the API chart document conversion. More...
 
void FinishConversion () const
 Finishes the API chart document conversion. More...
 
bool IsSystemColor (const Color &rColor, sal_uInt16 nSysColorIdx) const
 Returns true, if the passed color equals to the specified system color. More...
 
void SetSystemColor (Color &rColor, sal_uInt32 &rnColorId, sal_uInt16 nSysColorIdx) const
 Sets a system color and the respective color identifier. More...
 
sal_Int32 CalcChartXFromHmm (sal_Int32 nPosX) const
 Converts the passed horizontal coordinate from 1/100 mm to Excel chart units. More...
 
sal_Int32 CalcChartYFromHmm (sal_Int32 nPosY) const
 Converts the passed vertical coordinate from 1/100 mm to Excel chart units. More...
 
XclChRectangle CalcChartRectFromHmm (const css::awt::Rectangle &rRect) const
 Converts the passed rectangle from 1/100 mm to Excel chart units. More...
 
void ConvertLineFormat (XclChLineFormat &rLineFmt, const ScfPropertySet &rPropSet, XclChPropertyMode ePropMode) const
 Reads all line properties from the passed property set. More...
 
bool ConvertAreaFormat (XclChAreaFormat &rAreaFmt, const ScfPropertySet &rPropSet, XclChPropertyMode ePropMode) const
 Reads solid area properties from the passed property set. More...
 
void ConvertEscherFormat (XclChEscherFormat &rEscherFmt, XclChPicFormat &rPicFmt, const ScfPropertySet &rPropSet, XclChPropertyMode ePropMode) const
 Reads gradient or bitmap area properties from the passed property set. More...
 
sal_uInt16 ConvertFont (const ScfPropertySet &rPropSet, sal_Int16 nScript) const
 Reads font properties from the passed property 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...
 
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...
 

Private Attributes

XclChFrBlock maFrBlock
 

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)
 
- Static Protected Member Functions inherited from XclExpChRoot
static sal_uInt16 ConvertPieRotation (const ScfPropertySet &rPropSet)
 Reads the pie rotation property and returns the converted angle. 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

Base class for chart record groups.

Provides helper functions to write sub records.

A chart record group consists of a header record, followed by a CHBEGIN record, followed by group sub records, and finished with a CHEND record.

Definition at line 167 of file xechart.hxx.

Constructor & Destructor Documentation

XclExpChGroupBase::XclExpChGroupBase ( const XclExpChRoot rRoot,
sal_uInt16  nFrType,
sal_uInt16  nRecId,
std::size_t  nRecSize = 0 
)
explicit

Definition at line 422 of file xechart.cxx.

XclExpChGroupBase::~XclExpChGroupBase ( )
overridevirtual

Definition at line 430 of file xechart.cxx.

Member Function Documentation

bool XclExpChGroupBase::HasSubRecords ( ) const
virtual

Derived classes return whether there are any records embedded in this group.

Reimplemented in XclExpChEscherFormat.

Definition at line 454 of file xechart.cxx.

Referenced by Save().

void XclExpChGroupBase::Save ( XclExpStream rStrm)
overridevirtual

Saves the header record.

Calls WriteSubRecords() to let derived classes write sub records.

Reimplemented from XclExpRecord.

Reimplemented in XclExpChFrame, and XclExpChEscherFormat.

Definition at line 434 of file xechart.cxx.

References EXC_ID_CHBEGIN, EXC_ID_CHEND, XclExpChRoot::FinalizeFutureRecBlock(), HasSubRecords(), maFrBlock, XclExpChRoot::RegisterFutureRecBlock(), XclExpRecord::Save(), and WriteSubRecords().

Referenced by XclExpChEscherFormat::Save(), and XclExpChFrame::Save().

void XclExpChGroupBase::SetFutureRecordContext ( sal_uInt16  nFrContext,
sal_uInt16  nFrValue1 = 0,
sal_uInt16  nFrValue2 = 0 
)
protected

Sets context information for future record blocks.

Definition at line 459 of file xechart.cxx.

References maFrBlock, XclChFrBlock::mnContext, XclChFrBlock::mnValue1, and XclChFrBlock::mnValue2.

Referenced by XclExpChText::ConvertDataLabel(), XclExpChText::ConvertTitle(), and XclExpChAxesSet::XclExpChAxesSet().

virtual void XclExpChGroupBase::WriteSubRecords ( XclExpStream rStrm)
pure virtual

Derived classes implement writing any records embedded in this group.

Implemented in XclExpChChart, XclExpChAxesSet, XclExpChAxis, XclExpChTypeGroup, XclExpChDropBar, XclExpChLegend, XclExpChSeries, XclExpChDataFormat, XclExpChText, XclExpChFrame, and XclExpChEscherFormat.

Referenced by Save().

Member Data Documentation

XclChFrBlock XclExpChGroupBase::maFrBlock
private

Definition at line 188 of file xechart.hxx.

Referenced by Save(), and SetFutureRecordContext().


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