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

Represents the CHLEGEND record group describing the chart legend. More...

#include <xichart.hxx>

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

Public Member Functions

 XclImpChLegend (const XclImpChRoot &rRoot)
 
virtual void ReadHeaderRecord (XclImpStream &rStrm) override
 Reads the CHLEGEND record (called by base class). More...
 
virtual void ReadSubRecord (XclImpStream &rStrm) override
 Reads a record from the CHLEGEND group (called by base class). More...
 
void Finalize ()
 Final processing after reading the entire chart. More...
 
css::uno::Reference< css::chart2::XLegend > CreateLegend () const
 Creates a new legend object. More...
 
- Public Member Functions inherited from XclImpChGroupBase
 XclImpChGroupBase ()=default
 
 XclImpChGroupBase (XclImpChGroupBase const &)=default
 
 XclImpChGroupBase (XclImpChGroupBase &&)=default
 
XclImpChGroupBaseoperator= (XclImpChGroupBase const &)=default
 
XclImpChGroupBaseoperator= (XclImpChGroupBase &&)=default
 
virtual ~XclImpChGroupBase ()
 
void ReadRecordGroup (XclImpStream &rStrm)
 Reads the entire record group. More...
 
virtual void ReadHeaderRecord (XclImpStream &rStrm)=0
 Derived classes implement to read the group header record. More...
 
virtual void ReadSubRecord (XclImpStream &rStrm)=0
 Derived classes implement to read a record from the group. More...
 

Private Attributes

XclChLegend maData
 
XclImpChFramePosRef mxFramePos
 Contents of the CHLEGEND record. More...
 
XclImpChTextRef mxText
 Legend frame position (CHFRAMEPOS record). More...
 
XclImpChFrameRef mxFrame
 Legend text format (CHTEXT group). More...
 

Additional Inherited Members

- Static Public Member Functions inherited from XclImpChGroupBase
static void SkipBlock (XclImpStream &rStrm)
 Helper to skip a CHBEGIN/CHEND block, includes nested blocks. More...
 
- Protected Member Functions inherited from XclImpChRoot
 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...
 
- Protected 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 ()
 
- 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 XclImpChRoot
static void ConvertPieRotation (ScfPropertySet &rPropSet, sal_uInt16 nAngle)
 Writes the pie rotation property for the passed angle. More...
 
- Static Protected 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 Protected Member Functions inherited from XclRoot
static OUString GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 

Detailed Description

Represents the CHLEGEND record group describing the chart legend.

The CHLEGEND group consists of: CHLEGEND, CHBEGIN, CHFRAMEPOS, CHFRAME group, CHTEXT group, CHEND.

Definition at line 926 of file xichart.hxx.

Constructor & Destructor Documentation

◆ XclImpChLegend()

XclImpChLegend::XclImpChLegend ( const XclImpChRoot rRoot)
explicit

Definition at line 2511 of file xichart.cxx.

Member Function Documentation

◆ CreateLegend()

Reference< XLegend > XclImpChLegend::CreateLegend ( ) const

◆ Finalize()

void XclImpChLegend::Finalize ( )

Final processing after reading the entire chart.

Definition at line 2552 of file xichart.cxx.

References EXC_CHOBJTYPE_LEGEND, EXC_CHTEXTTYPE_LEGEND, XclImpChRoot::GetChartData(), XclImpChRoot::GetChRoot(), mxFrame, and mxText.

◆ ReadHeaderRecord()

void XclImpChLegend::ReadHeaderRecord ( XclImpStream rStrm)
overridevirtual

◆ ReadSubRecord()

void XclImpChLegend::ReadSubRecord ( XclImpStream rStrm)
overridevirtual

Reads a record from the CHLEGEND group (called by base class).

Implements XclImpChGroupBase.

Definition at line 2533 of file xichart.cxx.

References EXC_CHOBJTYPE_LEGEND, EXC_ID_CHFRAME, EXC_ID_CHFRAMEPOS, EXC_ID_CHTEXT, XclImpChRoot::GetChRoot(), mxFrame, mxFramePos, mxText, and rStrm.

Member Data Documentation

◆ maData

XclChLegend XclImpChLegend::maData
private

Definition at line 943 of file xichart.hxx.

Referenced by CreateLegend(), and ReadHeaderRecord().

◆ mxFrame

XclImpChFrameRef XclImpChLegend::mxFrame
private

Legend text format (CHTEXT group).

Definition at line 946 of file xichart.hxx.

Referenced by CreateLegend(), Finalize(), and ReadSubRecord().

◆ mxFramePos

XclImpChFramePosRef XclImpChLegend::mxFramePos
private

Contents of the CHLEGEND record.

Definition at line 944 of file xichart.hxx.

Referenced by CreateLegend(), and ReadSubRecord().

◆ mxText

XclImpChTextRef XclImpChLegend::mxText
private

Legend frame position (CHFRAMEPOS record).

Definition at line 945 of file xichart.hxx.

Referenced by CreateLegend(), Finalize(), and ReadSubRecord().


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