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

#include <xechart.hxx>

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

Public Member Functions

 XclExpChAreaFormat (const XclExpChRoot &rRoot)
 
bool Convert (const XclExpChRoot &rRoot, const ScfPropertySet &rPropSet, XclChObjectType eObjType)
 Converts area formatting properties from the passed property set. More...
 
void SetAuto (bool bAuto)
 Sets or clears the automatic flag. More...
 
void SetDefault (XclChFrameType eDefFrameType)
 Sets the area format to the specified default type. More...
 
bool IsAuto () const
 Returns true, if the area format is set to automatic. More...
 
bool HasArea () const
 Returns true, if the area style is set to something visible. More...
 
bool IsDefault (XclChFrameType eDefFrameType) const
 Returns true, if the area contains default formatting according to the passed frame type. 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...
 
virtual void Save (XclExpStream &rStrm) override
 Writes the record header and calls WriteBody(). More...
 
- Public Member Functions inherited from XclExpRecordBase
 XclExpRecordBase ()
 
 XclExpRecordBase (XclExpRecordBase const &)
 
 XclExpRecordBase (XclExpRecordBase &&)
 
XclExpRecordBaseoperator= (XclExpRecordBase const &)
 
XclExpRecordBaseoperator= (XclExpRecordBase &&) noexcept
 
virtual ~XclExpRecordBase ()
 
virtual void Save (XclExpStream &rStrm)
 Overwrite this method to do any operation while saving the record. More...
 
virtual void SaveXml (XclExpXmlStream &rStrm)
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Private Member Functions

virtual void WriteBody (XclExpStream &rStrm) override
 Writes the body of the record (without record header). More...
 

Private Attributes

XclChAreaFormat maData
 
sal_uInt32 mnPattColorId
 Contents of the CHAREAFORMAT record. More...
 
sal_uInt32 mnBackColorId
 Pattern color identifier. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void * operator new (std::size_t nSize)
 
static void * operator 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)
 
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 Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

Definition at line 255 of file xechart.hxx.

Constructor & Destructor Documentation

◆ XclExpChAreaFormat()

XclExpChAreaFormat::XclExpChAreaFormat ( const XclExpChRoot rRoot)
explicit

Definition at line 573 of file xechart.cxx.

Member Function Documentation

◆ Convert()

bool XclExpChAreaFormat::Convert ( const XclExpChRoot rRoot,
const ScfPropertySet rPropSet,
XclChObjectType  eObjType 
)

◆ HasArea()

bool XclExpChAreaFormat::HasArea ( ) const
inline

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

Definition at line 272 of file xechart.hxx.

References EXC_PATT_NONE, maData, and XclChAreaFormat::mnPattern.

Referenced by Convert(), and IsDefault().

◆ IsAuto()

bool XclExpChAreaFormat::IsAuto ( ) const
inline

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

Definition at line 270 of file xechart.hxx.

References EXC_CHAREAFORMAT_AUTO, get_flag(), maData, and XclChAreaFormat::mnFlags.

Referenced by IsDefault().

◆ IsDefault()

bool XclExpChAreaFormat::IsDefault ( XclChFrameType  eDefFrameType) const

Returns true, if the area contains default formatting according to the passed frame type.

Definition at line 632 of file xechart.cxx.

References EXC_CHFRAMETYPE_AUTO, EXC_CHFRAMETYPE_INVISIBLE, HasArea(), and IsAuto().

◆ SetAuto()

void XclExpChAreaFormat::SetAuto ( bool  bAuto)
inline

Sets or clears the automatic flag.

Definition at line 265 of file xechart.hxx.

References EXC_CHAREAFORMAT_AUTO, maData, XclChAreaFormat::mnFlags, and set_flag().

Referenced by SetDefault().

◆ SetDefault()

void XclExpChAreaFormat::SetDefault ( XclChFrameType  eDefFrameType)

Sets the area format to the specified default type.

Definition at line 616 of file xechart.cxx.

References EXC_CHFRAMETYPE_AUTO, EXC_CHFRAMETYPE_INVISIBLE, EXC_PATT_NONE, maData, XclChAreaFormat::mnPattern, and SetAuto().

◆ WriteBody()

void XclExpChAreaFormat::WriteBody ( XclExpStream rStrm)
overrideprivatevirtual

Writes the body of the record (without record header).

@descr Usually this method will be overwritten by derived classes.

Reimplemented from XclExpRecord.

Definition at line 639 of file xechart.cxx.

References EXC_BIFF8, XclExpPalette::GetColorIndex(), XclChAreaFormat::maBackColor, maData, XclChAreaFormat::maPattColor, mnBackColorId, XclChAreaFormat::mnFlags, mnPattColorId, XclChAreaFormat::mnPattern, and rStrm.

Member Data Documentation

◆ maData

XclChAreaFormat XclExpChAreaFormat::maData
private

Definition at line 280 of file xechart.hxx.

Referenced by Convert(), HasArea(), IsAuto(), SetAuto(), SetDefault(), and WriteBody().

◆ mnBackColorId

sal_uInt32 XclExpChAreaFormat::mnBackColorId
private

Pattern color identifier.

Definition at line 282 of file xechart.hxx.

Referenced by Convert(), and WriteBody().

◆ mnPattColorId

sal_uInt32 XclExpChAreaFormat::mnPattColorId
private

Contents of the CHAREAFORMAT record.

Definition at line 281 of file xechart.hxx.

Referenced by Convert(), and WriteBody().


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