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

Base class for complex chart classes, provides access to other components of the chart. More...

#include <xechart.hxx>

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

Public Member Functions

 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...
 
- Public 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
 
- Public 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...
 
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 Public Member Functions

static sal_uInt16 ConvertPieRotation (const ScfPropertySet &rPropSet)
 Reads the pie rotation property and returns the converted angle. More...
 
- Static Public 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 Public Member Functions inherited from XclRoot
static const OUStringLiteral & GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 

Protected Member Functions

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...
 

Private Types

typedef std::shared_ptr< XclExpChRootDataXclExpChRootDataRef
 

Private Attributes

XclExpChRootDataRef mxChData
 

Detailed Description

Base class for complex chart classes, provides access to other components of the chart.

Keeps also track of future record levels and writes the needed future records on demand.

Definition at line 80 of file xechart.hxx.

Member Typedef Documentation

typedef std::shared_ptr< XclExpChRootData > XclExpChRoot::XclExpChRootDataRef
private

Definition at line 158 of file xechart.hxx.

Constructor & Destructor Documentation

XclExpChRoot::XclExpChRoot ( const XclExpRoot rRoot,
XclExpChChart rChartData 
)
explicit

Definition at line 294 of file xechart.cxx.

References make_shared().

XclExpChRoot::~XclExpChRoot ( )
overridevirtual

Definition at line 300 of file xechart.cxx.

XclExpChRoot::XclExpChRoot ( XclExpChRoot const &  )
default
XclExpChRoot::XclExpChRoot ( XclExpChRoot &&  )
default

Member Function Documentation

XclChRectangle XclExpChRoot::CalcChartRectFromHmm ( const css::awt::Rectangle &  rRect) const

Converts the passed rectangle from 1/100 mm to Excel chart units.

Definition at line 362 of file xechart.cxx.

References CalcChartXFromHmm(), CalcChartYFromHmm(), XclChRectangle::mnHeight, XclChRectangle::mnWidth, XclChRectangle::mnX, and XclChRectangle::mnY.

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

sal_Int32 XclExpChRoot::CalcChartXFromHmm ( sal_Int32  nPosX) const

Converts the passed horizontal coordinate from 1/100 mm to Excel chart units.

Definition at line 352 of file xechart.cxx.

References EXC_CHART_TOTALUNITS, limit_cast(), and mxChData.

Referenced by CalcChartRectFromHmm(), and XclExpChLegend::Convert().

sal_Int32 XclExpChRoot::CalcChartYFromHmm ( sal_Int32  nPosY) const

Converts the passed vertical coordinate from 1/100 mm to Excel chart units.

Definition at line 357 of file xechart.cxx.

References EXC_CHART_TOTALUNITS, limit_cast(), and mxChData.

Referenced by CalcChartRectFromHmm(), and XclExpChLegend::Convert().

bool XclExpChRoot::ConvertAreaFormat ( XclChAreaFormat rAreaFmt,
const ScfPropertySet rPropSet,
XclChPropertyMode  ePropMode 
) const

Reads solid area properties from the passed property set.

Returns
true = object contains complex fill properties.

Definition at line 379 of file xechart.cxx.

References XclRoot::GetChartPropSetHelper(), and XclChPropSetHelper::ReadAreaProperties().

Referenced by XclExpChAreaFormat::Convert().

void XclExpChRoot::ConvertEscherFormat ( XclChEscherFormat rEscherFmt,
XclChPicFormat rPicFmt,
const ScfPropertySet rPropSet,
XclChPropertyMode  ePropMode 
) const

Reads gradient or bitmap area properties from the passed property set.

Definition at line 385 of file xechart.cxx.

References XclRoot::GetChartPropSetHelper(), mxChData, and XclChPropSetHelper::ReadEscherProperties().

Referenced by XclExpChEscherFormat::Convert().

sal_uInt16 XclExpChRoot::ConvertFont ( const ScfPropertySet rPropSet,
sal_Int16  nScript 
) const
void XclExpChRoot::ConvertLineFormat ( XclChLineFormat rLineFmt,
const ScfPropertySet rPropSet,
XclChPropertyMode  ePropMode 
) const

Reads all line properties from the passed property set.

Definition at line 372 of file xechart.cxx.

References XclRoot::GetChartPropSetHelper(), mxChData, and XclChPropSetHelper::ReadLineProperties().

Referenced by XclExpChLineFormat::Convert().

sal_uInt16 XclExpChRoot::ConvertPieRotation ( const ScfPropertySet rPropSet)
static

Reads the pie rotation property and returns the converted angle.

Definition at line 400 of file xechart.cxx.

References EXC_CHPROP_STARTINGANGLE, and ScfPropertySet::GetProperty().

Referenced by XclExpChType::Convert(), and XclExpChChart3d::Convert().

void XclExpChRoot::FinalizeFutureRecBlock ( XclExpStream rStrm)
protected

Called from XclExpChGroupBase::Save, finalizes the current future record level.

Definition at line 417 of file xechart.cxx.

References mxChData.

Referenced by XclExpChGroupBase::Save().

void XclExpChRoot::FinishConversion ( ) const

Finishes the API chart document conversion.

Must be called once after all API conversion.

Definition at line 334 of file xechart.cxx.

References mxChData.

Referenced by XclExpChChart::XclExpChChart().

XclExpChChart & XclExpChRoot::GetChartData ( ) const
Reference< XChartDocument > const & XclExpChRoot::GetChartDocument ( ) const

Returns the API Chart document model.

Definition at line 304 of file xechart.cxx.

References mxChData.

Referenced by XclExpChLegend::Convert(), XclExpChAxesSet::Convert(), XclExpChAxesSet::ConvertAxis(), and XclExpChText::ConvertTitle().

const XclChTypeInfo & XclExpChRoot::GetChartTypeInfo ( XclChTypeId  eType) const

Returns chart type info for a unique chart type identifier.

Definition at line 314 of file xechart.cxx.

References mxChData.

Referenced by XclExpChType::Convert().

const XclChTypeInfo & XclExpChRoot::GetChartTypeInfo ( const OUString &  rServiceName) const

Returns the first fitting chart type info for the passed service name.

Definition at line 319 of file xechart.cxx.

References mxChData.

const XclExpChRoot& XclExpChRoot::GetChRoot ( ) const
inline
const XclChFormatInfo & XclExpChRoot::GetFormatInfo ( XclChObjectType  eObjType) const

Returns an info struct about auto formatting for the passed object type.

Definition at line 324 of file xechart.cxx.

References mxChData.

Referenced by XclExpChLineFormat::Convert(), XclExpChAreaFormat::Convert(), XclExpChEscherFormat::Convert(), XclExpChFrameBase::ConvertFrameBase(), XclExpChFrame::IsDefault(), and XclExpChFrame::IsDeleteable().

void XclExpChRoot::InitConversion ( css::uno::Reference< css::chart2::XChartDocument > const &  xChartDoc,
const tools::Rectangle rChartRect 
) const

Starts the API chart document conversion.

Must be called once before all API conversion.

Definition at line 329 of file xechart.cxx.

References XclExpRoot::GetRoot(), and mxChData.

Referenced by XclExpChChart::XclExpChChart().

void XclExpChRoot::InitializeFutureRecBlock ( XclExpStream rStrm)
protected

Called from XclExpChFutureRecordBase::Save, Initializes the current future record level.

Definition at line 412 of file xechart.cxx.

References mxChData.

Referenced by XclExpChFutureRecordBase::Save().

bool XclExpChRoot::IsSystemColor ( const Color rColor,
sal_uInt16  nSysColorIdx 
) const

Returns true, if the passed color equals to the specified system color.

Definition at line 339 of file xechart.cxx.

References XclDefaultPalette::GetDefColor(), XclExpRoot::GetPalette(), and XclDefaultPalette::IsSystemColor().

Referenced by XclExpChLineFormat::Convert(), XclExpChAreaFormat::Convert(), and SetSystemColor().

XclExpChRoot& XclExpChRoot::operator= ( XclExpChRoot const &  )
delete
XclExpChRoot& XclExpChRoot::operator= ( XclExpChRoot &&  )
delete
void XclExpChRoot::RegisterFutureRecBlock ( const XclChFrBlock rFrBlock)
protected

Called from XclExpChGroupBase::Save, registers a new future record level.

Definition at line 407 of file xechart.cxx.

References mxChData.

Referenced by XclExpChGroupBase::Save().

void XclExpChRoot::SetSystemColor ( Color rColor,
sal_uInt32 &  rnColorId,
sal_uInt16  nSysColorIdx 
) const

Sets a system color and the respective color identifier.

Definition at line 345 of file xechart.cxx.

References XclExpPalette::GetColorIdFromIndex(), XclDefaultPalette::GetDefColor(), XclExpRoot::GetPalette(), and IsSystemColor().

Referenced by XclExpChLineFormat::Convert(), and XclExpChAreaFormat::Convert().

Member Data Documentation

XclExpChRootDataRef XclExpChRoot::mxChData
private

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