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

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

#include <xichart.hxx>

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

Public Member Functions

 XclImpChRoot (const XclImpRoot &rRoot, XclImpChChart &rChartData)
 
virtual ~XclImpChRoot () override
 
 XclImpChRoot (XclImpChRoot const &)=default
 
 XclImpChRoot (XclImpChRoot &&)=default
 
XclImpChRootoperator= (XclImpChRoot const &)=delete
 
XclImpChRootoperator= (XclImpChRoot &&)=delete
 
const XclImpChRootGetChRoot () const
 Returns this root instance - for code readability in derived classes. More...
 
XclImpChChartGetChartData () 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 (sal_uInt16 nRecId) const
 Returns the first fitting chart type info for an Excel chart type record identifier. More...
 
const XclChFormatInfoGetFormatInfo (XclChObjectType eObjType) const
 Returns an info struct about auto formatting for the passed object type. More...
 
Color GetFontAutoColor () const
 Returns the default text color for charts. More...
 
Color GetSeriesLineAutoColor (sal_uInt16 nFormatIdx) const
 Returns the automatic line color of linear series. More...
 
Color GetSeriesFillAutoColor (sal_uInt16 nFormatIdx) const
 Returns the automatic fill color of filled series. More...
 
void InitConversion (const css::uno::Reference< css::chart2::XChartDocument > &xChartDoc, const tools::Rectangle &rChartRect) const
 Starts the API chart document conversion. More...
 
void FinishConversion (XclImpDffConverter &rDffConv) const
 Finishes the API chart document conversion. More...
 
css::uno::Reference< css::chart2::data::XDataProvider > GetDataProvider () const
 Returns the data provider for the chart document. More...
 
css::uno::Reference< css::drawing::XShape > GetTitleShape (const XclChTextKey &rTitleKey) const
 Returns the drawing shape interface of the specified title object. More...
 
sal_Int32 CalcHmmFromChartX (sal_Int32 nPosX) const
 Converts the passed horizontal coordinate from Excel chart units into 1/100 mm. More...
 
sal_Int32 CalcHmmFromChartY (sal_Int32 nPosY) const
 Converts the passed vertical coordinate from Excel chart units into 1/100 mm. More...
 
css::awt::Rectangle CalcHmmFromChartRect (const XclChRectangle &rRect) const
 Converts the passed rectangle from Excel chart units into 1/100 mm. More...
 
double CalcRelativeFromHmmX (sal_Int32 nPosX) const
 Converts the passed horizontal coordinate from 1/100 mm into a relative position. More...
 
double CalcRelativeFromHmmY (sal_Int32 nPosY) const
 Converts the passed vertical coordinate from 1/100 mm into a relative position. More...
 
double CalcRelativeFromChartX (sal_Int32 nPosX) const
 Converts the passed horizontal coordinate from Excel chart units into a relative position. More...
 
double CalcRelativeFromChartY (sal_Int32 nPosY) const
 Converts the passed vertical coordinate from Excel chart units into a relative position. More...
 
void ConvertLineFormat (ScfPropertySet &rPropSet, const XclChLineFormat &rLineFmt, XclChPropertyMode ePropMode) const
 Writes all line properties to the passed property set. More...
 
void ConvertAreaFormat (ScfPropertySet &rPropSet, const XclChAreaFormat &rAreaFmt, XclChPropertyMode ePropMode) const
 Writes solid area properties to the passed property set. More...
 
void ConvertEscherFormat (ScfPropertySet &rPropSet, const XclChEscherFormat &rEscherFmt, const XclChPicFormat *pPicFmt, sal_uInt32 nDffFillType, XclChPropertyMode ePropMode) const
 Writes gradient or bitmap area properties to the passed property set. More...
 
void ConvertFont (ScfPropertySet &rPropSet, sal_uInt16 nFontIdx, const Color *pFontColor=nullptr) const
 Writes font properties to the passed property set. More...
 
- Public 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 ()
 
- 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 void ConvertPieRotation (ScfPropertySet &rPropSet, sal_uInt16 nAngle)
 Writes the pie rotation property for the passed angle. More...
 
- Static Public 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 Public Member Functions inherited from XclRoot
static const OUStringLiteral & GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 

Private Types

typedef std::shared_ptr< XclImpChRootDataXclImpChRootDataRef
 

Private Attributes

XclImpChRootDataRef mxChData
 

Detailed Description

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

Definition at line 80 of file xichart.hxx.

Member Typedef Documentation

typedef std::shared_ptr< XclImpChRootData > XclImpChRoot::XclImpChRootDataRef
private

Definition at line 170 of file xichart.hxx.

Constructor & Destructor Documentation

XclImpChRoot::XclImpChRoot ( const XclImpRoot rRoot,
XclImpChChart rChartData 
)
explicit

Definition at line 215 of file xichart.cxx.

References make_shared().

XclImpChRoot::~XclImpChRoot ( )
overridevirtual

Definition at line 221 of file xichart.cxx.

XclImpChRoot::XclImpChRoot ( XclImpChRoot const &  )
default
XclImpChRoot::XclImpChRoot ( XclImpChRoot &&  )
default

Member Function Documentation

css::awt::Rectangle XclImpChRoot::CalcHmmFromChartRect ( const XclChRectangle rRect) const

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

Definition at line 320 of file xichart.cxx.

References CalcHmmFromChartX(), CalcHmmFromChartY(), XclChRectangle::mnHeight, XclChRectangle::mnWidth, XclChRectangle::mnX, and XclChRectangle::mnY.

Referenced by XclImpChChart::Convert().

sal_Int32 XclImpChRoot::CalcHmmFromChartX ( sal_Int32  nPosX) const

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

Definition at line 310 of file xichart.cxx.

References mxChData.

Referenced by CalcHmmFromChartRect(), CalcRelativeFromChartX(), and XclImpChText::ConvertTitlePosition().

sal_Int32 XclImpChRoot::CalcHmmFromChartY ( sal_Int32  nPosY) const

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

Definition at line 315 of file xichart.cxx.

References mxChData.

Referenced by CalcHmmFromChartRect(), CalcRelativeFromChartY(), and XclImpChText::ConvertTitlePosition().

double XclImpChRoot::CalcRelativeFromChartX ( sal_Int32  nPosX) const

Converts the passed horizontal coordinate from Excel chart units into a relative position.

Definition at line 345 of file xichart.cxx.

References CalcHmmFromChartX(), and CalcRelativeFromHmmX().

Referenced by XclImpChLegend::CreateLegend().

double XclImpChRoot::CalcRelativeFromChartY ( sal_Int32  nPosY) const

Converts the passed vertical coordinate from Excel chart units into a relative position.

Definition at line 350 of file xichart.cxx.

References CalcHmmFromChartY(), and CalcRelativeFromHmmY().

Referenced by XclImpChLegend::CreateLegend().

double XclImpChRoot::CalcRelativeFromHmmX ( sal_Int32  nPosX) const

Converts the passed horizontal coordinate from 1/100 mm into a relative position.

Definition at line 329 of file xichart.cxx.

References mxChData.

Referenced by CalcRelativeFromChartX(), and XclImpChLegend::CreateLegend().

double XclImpChRoot::CalcRelativeFromHmmY ( sal_Int32  nPosY) const

Converts the passed vertical coordinate from 1/100 mm into a relative position.

Definition at line 337 of file xichart.cxx.

References mxChData.

Referenced by CalcRelativeFromChartY(), and XclImpChLegend::CreateLegend().

void XclImpChRoot::ConvertAreaFormat ( ScfPropertySet rPropSet,
const XclChAreaFormat rAreaFmt,
XclChPropertyMode  ePropMode 
) const

Writes solid area properties to the passed property set.

Definition at line 362 of file xichart.cxx.

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

Referenced by XclImpChAreaFormat::Convert().

void XclImpChRoot::ConvertEscherFormat ( ScfPropertySet rPropSet,
const XclChEscherFormat rEscherFmt,
const XclChPicFormat pPicFmt,
sal_uInt32  nDffFillType,
XclChPropertyMode  ePropMode 
) const

Writes gradient or bitmap area properties to the passed property set.

Definition at line 368 of file xichart.cxx.

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

Referenced by XclImpChEscherFormat::Convert().

void XclImpChRoot::ConvertFont ( ScfPropertySet rPropSet,
sal_uInt16  nFontIdx,
const Color pFontColor = nullptr 
) const

Writes font properties to the passed property set.

Definition at line 377 of file xichart.cxx.

References EXC_FONTPROPSET_CHART, XclImpRoot::GetFontBuffer(), and XclImpFontBuffer::WriteFontProperties().

Referenced by XclImpChFontBase::ConvertFontBase(), and XclImpChSourceLink::CreateStringSequence().

void XclImpChRoot::ConvertLineFormat ( ScfPropertySet rPropSet,
const XclChLineFormat rLineFmt,
XclChPropertyMode  ePropMode 
) const

Writes all line properties to the passed property set.

Definition at line 355 of file xichart.cxx.

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

Referenced by XclImpChLineFormat::Convert().

void XclImpChRoot::ConvertPieRotation ( ScfPropertySet rPropSet,
sal_uInt16  nAngle 
)
static

Writes the pie rotation property for the passed angle.

Definition at line 383 of file xichart.cxx.

References EXC_CHPROP_STARTINGANGLE, and ScfPropertySet::SetProperty().

Referenced by XclImpChChart3d::Convert(), and XclImpChType::CreateChartType().

void XclImpChRoot::FinishConversion ( XclImpDffConverter rDffConv) const

Finishes the API chart document conversion.

Must be called once after all API conversion.

Definition at line 288 of file xichart.cxx.

References EXC_CHART_PROGRESS_SIZE, mxChData, XclImpDffConverter::Progress(), and xModel.

Referenced by XclImpChChart::Convert().

XclImpChChart & XclImpChRoot::GetChartData ( ) const
const XclChTypeInfo & XclImpChRoot::GetChartTypeInfo ( XclChTypeId  eType) const

Returns chart type info for a unique chart type identifier.

Definition at line 230 of file xichart.cxx.

References mxChData.

Referenced by XclImpChType::Finalize().

const XclChTypeInfo & XclImpChRoot::GetChartTypeInfo ( sal_uInt16  nRecId) const

Returns the first fitting chart type info for an Excel chart type record identifier.

Definition at line 235 of file xichart.cxx.

References mxChData.

const XclImpChRoot& XclImpChRoot::GetChRoot ( ) const
inline
Reference< XDataProvider > XclImpChRoot::GetDataProvider ( ) const

Returns the data provider for the chart document.

Definition at line 300 of file xichart.cxx.

References mxChData.

Referenced by XclImpChSourceLink::CreateDataSequence().

Color XclImpChRoot::GetFontAutoColor ( ) const

Returns the default text color for charts.

Definition at line 245 of file xichart.cxx.

References EXC_COLOR_CHWINDOWTEXT, XclImpPalette::GetColor(), and XclImpRoot::GetPalette().

Referenced by XclImpChText::GetFontColor(), XclImpChTick::GetFontColor(), and XclImpChAxis::GetFontColor().

const XclChFormatInfo & XclImpChRoot::GetFormatInfo ( XclChObjectType  eObjType) const

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

Definition at line 240 of file xichart.cxx.

References mxChData.

Referenced by XclImpChLineFormat::Convert(), XclImpChAreaFormat::Convert(), XclImpChEscherFormat::Convert(), and XclImpChFrameBase::ConvertAreaBase().

Color XclImpChRoot::GetSeriesFillAutoColor ( sal_uInt16  nFormatIdx) const
Color XclImpChRoot::GetSeriesLineAutoColor ( sal_uInt16  nFormatIdx) const
Reference< XShape > XclImpChRoot::GetTitleShape ( const XclChTextKey rTitleKey) const

Returns the drawing shape interface of the specified title object.

Definition at line 305 of file xichart.cxx.

References mxChData.

Referenced by XclImpChText::ConvertTitlePosition().

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

Starts the API chart document conversion.

Must be called once before all API conversion.

Definition at line 263 of file xichart.cxx.

References ScfApiHelper::CreateInstance(), XclRoot::GetDocShell(), SfxObjectShell::GetModel(), XclImpRoot::GetRoot(), mxChData, and SERVICE_CHART2_DATAPROVIDER.

Referenced by XclImpChChart::Convert().

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

Member Data Documentation

XclImpChRootDataRef XclImpChRoot::mxChData
private

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