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

Base class for record groups containing frame formatting. More...

#include <xichart.hxx>

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

Public Member Functions

 XclImpChFrameBase ()
 Creates a new frame object without internal formatting objects. More...
 
 XclImpChFrameBase (const XclChFormatInfo &rFmtInfo)
 Creates a new frame object with specific default formatting. More...
 
virtual void ReadSubRecord (XclImpStream &rStrm) override
 Reads a frame formatting record (called by base class). More...
 
bool IsAutoLine () const
 Returns true, if the line format is set to automatic. More...
 
bool HasLine () const
 Returns true, if the line style is set to something visible. More...
 
sal_Int16 GetLineWeight () const
 Returns the line weight used for this frame. More...
 
bool IsAutoArea () const
 Returns true, if the area format is set to automatic. 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...
 

Protected Member Functions

void ConvertLineBase (const XclImpChRoot &rRoot, ScfPropertySet &rPropSet, XclChObjectType eObjType, sal_uInt16 nFormatIdx=EXC_CHDATAFORMAT_UNKNOWN) const
 Converts and writes the contained line formatting to the passed property set. More...
 
void ConvertAreaBase (const XclImpChRoot &rRoot, ScfPropertySet &rPropSet, XclChObjectType eObjType, sal_uInt16 nFormatIdx=EXC_CHDATAFORMAT_UNKNOWN, bool bUsePicFmt=false) const
 Converts and writes the contained area formatting to the passed property set. More...
 
void ConvertFrameBase (const XclImpChRoot &rRoot, ScfPropertySet &rPropSet, XclChObjectType eObjType, sal_uInt16 nFormatIdx=EXC_CHDATAFORMAT_UNKNOWN, bool bUsePicFmt=false) const
 Converts and writes the contained data to the passed property set. More...
 

Protected Attributes

XclImpChLineFormatRef mxLineFmt
 
XclImpChAreaFormatRef mxAreaFmt
 Line format (CHLINEFORMAT record). More...
 
XclImpChEscherFormatRef mxEscherFmt
 Area format (CHAREAFORMAT record). 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...
 

Detailed Description

Base class for record groups containing frame formatting.

Frame formatting can be part of several record groups, e.g. CHFRAME, CHDATAFORMAT, CHDROPBAR. It consists of CHLINEFORMAT, CHAREAFORMAT, and CHESCHERFORMAT group.

Definition at line 321 of file xichart.hxx.

Constructor & Destructor Documentation

◆ XclImpChFrameBase() [1/2]

XclImpChFrameBase::XclImpChFrameBase ( )
inlineexplicit

Creates a new frame object without internal formatting objects.

Definition at line 325 of file xichart.hxx.

◆ XclImpChFrameBase() [2/2]

XclImpChFrameBase::XclImpChFrameBase ( const XclChFormatInfo rFmtInfo)
explicit

Member Function Documentation

◆ ConvertAreaBase()

void XclImpChFrameBase::ConvertAreaBase ( const XclImpChRoot rRoot,
ScfPropertySet rPropSet,
XclChObjectType  eObjType,
sal_uInt16  nFormatIdx = EXC_CHDATAFORMAT_UNKNOWN,
bool  bUsePicFmt = false 
) const
protected

Converts and writes the contained area formatting to the passed property set.

Definition at line 618 of file xichart.cxx.

References XclImpChRoot::GetFormatInfo(), XclChFormatInfo::mbIsFrame, mxAreaFmt, and mxEscherFmt.

Referenced by XclImpChDataFormat::ConvertArea(), and ConvertFrameBase().

◆ ConvertFrameBase()

void XclImpChFrameBase::ConvertFrameBase ( const XclImpChRoot rRoot,
ScfPropertySet rPropSet,
XclChObjectType  eObjType,
sal_uInt16  nFormatIdx = EXC_CHDATAFORMAT_UNKNOWN,
bool  bUsePicFmt = false 
) const
protected

Converts and writes the contained data to the passed property set.

Definition at line 631 of file xichart.cxx.

References ConvertAreaBase(), and ConvertLineBase().

Referenced by XclImpChDropBar::Convert(), XclImpChFrame::Convert(), and XclImpChDataFormat::Convert().

◆ ConvertLineBase()

void XclImpChFrameBase::ConvertLineBase ( const XclImpChRoot rRoot,
ScfPropertySet rPropSet,
XclChObjectType  eObjType,
sal_uInt16  nFormatIdx = EXC_CHDATAFORMAT_UNKNOWN 
) const
protected

Converts and writes the contained line formatting to the passed property set.

Definition at line 611 of file xichart.cxx.

References mxLineFmt.

Referenced by ConvertFrameBase(), and XclImpChDataFormat::ConvertLine().

◆ GetLineWeight()

sal_Int16 XclImpChFrameBase::GetLineWeight ( ) const
inline

Returns the line weight used for this frame.

Definition at line 337 of file xichart.hxx.

References EXC_CHLINEFORMAT_SINGLE, and mxLineFmt.

Referenced by XclImpChDataFormat::Convert().

◆ HasLine()

bool XclImpChFrameBase::HasLine ( ) const
inline

Returns true, if the line style is set to something visible.

Definition at line 335 of file xichart.hxx.

References IsAutoLine(), and mxLineFmt.

Referenced by XclImpChDataFormat::Convert().

◆ IsAutoArea()

bool XclImpChFrameBase::IsAutoArea ( ) const
inline

Returns true, if the area format is set to automatic.

Definition at line 340 of file xichart.hxx.

References mxAreaFmt, and mxEscherFmt.

Referenced by XclImpChDataFormat::UpdatePointFormat().

◆ IsAutoLine()

bool XclImpChFrameBase::IsAutoLine ( ) const
inline

Returns true, if the line format is set to automatic.

Definition at line 333 of file xichart.hxx.

References mxLineFmt.

Referenced by HasLine(), and XclImpChDataFormat::UpdatePointFormat().

◆ ReadSubRecord()

void XclImpChFrameBase::ReadSubRecord ( XclImpStream rStrm)
overridevirtual

Reads a frame formatting record (called by base class).

Implements XclImpChGroupBase.

Reimplemented in XclImpChDataFormat.

Definition at line 592 of file xichart.cxx.

References EXC_ID_CHAREAFORMAT, EXC_ID_CHESCHERFORMAT, EXC_ID_CHLINEFORMAT, mxAreaFmt, mxEscherFmt, mxLineFmt, and rStrm.

Referenced by XclImpChDataFormat::ReadSubRecord().

Member Data Documentation

◆ mxAreaFmt

XclImpChAreaFormatRef XclImpChFrameBase::mxAreaFmt
protected

◆ mxEscherFmt

XclImpChEscherFormatRef XclImpChFrameBase::mxEscherFmt
protected

◆ mxLineFmt

XclImpChLineFormatRef XclImpChFrameBase::mxLineFmt
protected

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