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

Common properties for a group of sparklines. More...

#include <SparklineAttributes.hxx>

Collaboration diagram for sc::SparklineAttributes:
[legend]

Classes

class  Implementation
 Holder of sparkline attributes. More...
 

Public Member Functions

 SparklineAttributes ()
 
 ~SparklineAttributes ()
 
 SparklineAttributes (const SparklineAttributes &rOther)
 
 SparklineAttributes (SparklineAttributes &&rOther)
 
SparklineAttributes & operator= (const SparklineAttributes &rOther)
 
SparklineAttributes & operator= (SparklineAttributes &&rOther)
 
bool operator== (const SparklineAttributes &rOther) const
 
bool operator!= (const SparklineAttributes &rOther) const
 
Color getColorSeries () const
 
void setColorSeries (Color aColorSeries)
 
Color getColorNegative () const
 
void setColorNegative (Color aColorSeries)
 
Color getColorAxis () const
 
void setColorAxis (Color aColorSeries)
 
Color getColorMarkers () const
 
void setColorMarkers (Color aColorSeries)
 
Color getColorFirst () const
 
void setColorFirst (Color aColorSeries)
 
Color getColorLast () const
 
void setColorLast (Color aColorSeries)
 
Color getColorHigh () const
 
void setColorHigh (Color aColorSeries)
 
Color getColorLow () const
 
void setColorLow (Color aColorSeries)
 
AxisType getMinAxisType () const
 
void setMinAxisType (AxisType eAxisType)
 
AxisType getMaxAxisType () const
 
void setMaxAxisType (AxisType eAxisType)
 
double getLineWeight () const
 Line weight or width in points. More...
 
void setLineWeight (double nWeight)
 
SparklineType getType () const
 
void setType (SparklineType eType)
 
bool isDateAxis () const
 
void setDateAxis (bool bValue)
 
DisplayEmptyCellsAs getDisplayEmptyCellsAs () const
 
void setDisplayEmptyCellsAs (DisplayEmptyCellsAs eValue)
 
bool isMarkers () const
 
void setMarkers (bool bValue)
 
bool isHigh () const
 
void setHigh (bool bValue)
 
bool isLow () const
 
void setLow (bool bValue)
 
bool isFirst () const
 
void setFirst (bool bValue)
 
bool isLast () const
 
void setLast (bool bValue)
 
bool isNegative () const
 
void setNegative (bool bValue)
 
bool shouldDisplayXAxis () const
 
void setDisplayXAxis (bool bValue)
 
bool shouldDisplayHidden () const
 
void setDisplayHidden (bool bValue)
 
bool isRightToLeft () const
 
void setRightToLeft (bool bValue)
 
std::optional< double > getManualMax () const
 
void setManualMax (std::optional< double > aValue)
 
std::optional< double > getManualMin () const
 
void setManualMin (std::optional< double > aValue)
 

Private Attributes

o3tl::cow_wrapper< Implementation > m_aImplementation
 

Detailed Description

Common properties for a group of sparklines.

Definition at line 46 of file SparklineAttributes.hxx.

Constructor & Destructor Documentation

◆ SparklineAttributes() [1/3]

sc::SparklineAttributes::SparklineAttributes ( )
default

◆ ~SparklineAttributes()

sc::SparklineAttributes::~SparklineAttributes ( )
default

◆ SparklineAttributes() [2/3]

sc::SparklineAttributes::SparklineAttributes ( const SparklineAttributes &  rOther)
default

◆ SparklineAttributes() [3/3]

sc::SparklineAttributes::SparklineAttributes ( SparklineAttributes &&  rOther)
default

Member Function Documentation

◆ getColorAxis()

Color sc::SparklineAttributes::getColorAxis ( ) const

Definition at line 163 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsExport::addSparklineGroupAttributes(), xcl::exp::SparklineExt::addSparklineGroupColors(), sc::SparklineRenderer::drawColumn(), and sc::SparklineRenderer::drawLine().

◆ getColorFirst()

Color sc::SparklineAttributes::getColorFirst ( ) const

Definition at line 173 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsExport::addSparklineGroupAttributes(), xcl::exp::SparklineExt::addSparklineGroupColors(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ getColorHigh()

Color sc::SparklineAttributes::getColorHigh ( ) const

Definition at line 179 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsExport::addSparklineGroupAttributes(), xcl::exp::SparklineExt::addSparklineGroupColors(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ getColorLast()

Color sc::SparklineAttributes::getColorLast ( ) const

Definition at line 176 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsExport::addSparklineGroupAttributes(), xcl::exp::SparklineExt::addSparklineGroupColors(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ getColorLow()

Color sc::SparklineAttributes::getColorLow ( ) const

Definition at line 182 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsExport::addSparklineGroupAttributes(), xcl::exp::SparklineExt::addSparklineGroupColors(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ getColorMarkers()

Color sc::SparklineAttributes::getColorMarkers ( ) const

Definition at line 167 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsExport::addSparklineGroupAttributes(), xcl::exp::SparklineExt::addSparklineGroupColors(), sc::SparklineRenderer::drawLine(), and sc::SparklineDialog::setupValues().

◆ getColorNegative()

Color sc::SparklineAttributes::getColorNegative ( ) const

Definition at line 156 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsExport::addSparklineGroupAttributes(), xcl::exp::SparklineExt::addSparklineGroupColors(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ getColorSeries()

Color sc::SparklineAttributes::getColorSeries ( ) const

Definition at line 149 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsExport::addSparklineGroupAttributes(), xcl::exp::SparklineExt::addSparklineGroupColors(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ getDisplayEmptyCellsAs()

DisplayEmptyCellsAs sc::SparklineAttributes::getDisplayEmptyCellsAs ( ) const

Definition at line 209 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), and sc::SparklineDialog::setupValues().

◆ getLineWeight()

double sc::SparklineAttributes::getLineWeight ( ) const

Line weight or width in points.

Definition at line 197 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawLine(), and sc::SparklineDialog::setupValues().

◆ getManualMax()

std::optional< double > sc::SparklineAttributes::getManualMax ( ) const

Definition at line 257 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawColumn(), sc::SparklineRenderer::drawLine(), and sc::SparklineDialog::setupValues().

◆ getManualMin()

std::optional< double > sc::SparklineAttributes::getManualMin ( ) const

Definition at line 266 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawColumn(), sc::SparklineRenderer::drawLine(), and sc::SparklineDialog::setupValues().

◆ getMaxAxisType()

AxisType sc::SparklineAttributes::getMaxAxisType ( ) const

Definition at line 191 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawColumn(), sc::SparklineRenderer::drawLine(), and sc::SparklineDialog::setupValues().

◆ getMinAxisType()

AxisType sc::SparklineAttributes::getMinAxisType ( ) const

Definition at line 185 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawColumn(), sc::SparklineRenderer::drawLine(), and sc::SparklineDialog::setupValues().

◆ getType()

SparklineType sc::SparklineAttributes::getType ( ) const

Definition at line 203 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), and sc::SparklineDialog::setupValues().

◆ isDateAxis()

bool sc::SparklineAttributes::isDateAxis ( ) const

Definition at line 206 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), and sc::SparklineGroupsExport::addSparklineGroupAttributes().

◆ isFirst()

bool sc::SparklineAttributes::isFirst ( ) const

Definition at line 227 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ isHigh()

bool sc::SparklineAttributes::isHigh ( ) const

Definition at line 221 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ isLast()

bool sc::SparklineAttributes::isLast ( ) const

Definition at line 230 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ isLow()

bool sc::SparklineAttributes::isLow ( ) const

Definition at line 224 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ isMarkers()

bool sc::SparklineAttributes::isMarkers ( ) const

Definition at line 218 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawLine(), and sc::SparklineDialog::setupValues().

◆ isNegative()

bool sc::SparklineAttributes::isNegative ( ) const

Definition at line 233 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawLine(), sc::SparklineRenderer::setFillAndLineColor(), and sc::SparklineDialog::setupValues().

◆ isRightToLeft()

bool sc::SparklineAttributes::isRightToLeft ( ) const

Definition at line 251 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), and sc::SparklineDialog::setupValues().

◆ operator!=()

bool sc::SparklineAttributes::operator!= ( const SparklineAttributes &  rOther) const
inline

Definition at line 61 of file SparklineAttributes.hxx.

References operator==().

◆ operator=() [1/2]

SparklineAttributes & sc::SparklineAttributes::operator= ( const SparklineAttributes &  rOther)
default

◆ operator=() [2/2]

SparklineAttributes & sc::SparklineAttributes::operator= ( SparklineAttributes &&  rOther)
default

◆ operator==()

bool sc::SparklineAttributes::operator== ( const SparklineAttributes &  rOther) const

Definition at line 144 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by operator!=().

◆ setColorAxis()

void sc::SparklineAttributes::setColorAxis ( Color  aColorSeries)

Definition at line 165 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setColorFirst()

void sc::SparklineAttributes::setColorFirst ( Color  aColorSeries)

Definition at line 174 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes(), and sc::SparklineDialog::perform().

◆ setColorHigh()

void sc::SparklineAttributes::setColorHigh ( Color  aColorSeries)

Definition at line 180 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes(), and sc::SparklineDialog::perform().

◆ setColorLast()

void sc::SparklineAttributes::setColorLast ( Color  aColorSeries)

Definition at line 177 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes(), and sc::SparklineDialog::perform().

◆ setColorLow()

void sc::SparklineAttributes::setColorLow ( Color  aColorSeries)

Definition at line 183 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes(), and sc::SparklineDialog::perform().

◆ setColorMarkers()

void sc::SparklineAttributes::setColorMarkers ( Color  aColorSeries)

Definition at line 168 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes(), and sc::SparklineDialog::perform().

◆ setColorNegative()

void sc::SparklineAttributes::setColorNegative ( Color  aColorSeries)

Definition at line 158 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes(), and sc::SparklineDialog::perform().

◆ setColorSeries()

void sc::SparklineAttributes::setColorSeries ( Color  aColorSeries)

Definition at line 151 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes(), and sc::SparklineDialog::perform().

◆ setDateAxis()

void sc::SparklineAttributes::setDateAxis ( bool  bValue)

Definition at line 207 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setDisplayEmptyCellsAs()

void sc::SparklineAttributes::setDisplayEmptyCellsAs ( DisplayEmptyCellsAs  eValue)

Definition at line 213 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setDisplayHidden()

void sc::SparklineAttributes::setDisplayHidden ( bool  bValue)

Definition at line 246 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setDisplayXAxis()

void sc::SparklineAttributes::setDisplayXAxis ( bool  bValue)

Definition at line 237 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setFirst()

void sc::SparklineAttributes::setFirst ( bool  bValue)

Definition at line 228 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setHigh()

void sc::SparklineAttributes::setHigh ( bool  bValue)

Definition at line 222 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setLast()

void sc::SparklineAttributes::setLast ( bool  bValue)

Definition at line 231 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setLineWeight()

void sc::SparklineAttributes::setLineWeight ( double  nWeight)

Definition at line 198 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setLow()

void sc::SparklineAttributes::setLow ( bool  bValue)

Definition at line 225 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setManualMax()

void sc::SparklineAttributes::setManualMax ( std::optional< double >  aValue)

Definition at line 261 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setManualMin()

void sc::SparklineAttributes::setManualMin ( std::optional< double >  aValue)

Definition at line 270 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setMarkers()

void sc::SparklineAttributes::setMarkers ( bool  bValue)

Definition at line 219 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setMaxAxisType()

void sc::SparklineAttributes::setMaxAxisType ( AxisType  eAxisType)

Definition at line 192 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setMinAxisType()

void sc::SparklineAttributes::setMinAxisType ( AxisType  eAxisType)

Definition at line 186 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setNegative()

void sc::SparklineAttributes::setNegative ( bool  bValue)

Definition at line 234 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setRightToLeft()

void sc::SparklineAttributes::setRightToLeft ( bool  bValue)

Definition at line 252 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ setType()

void sc::SparklineAttributes::setType ( SparklineType  eType)

Definition at line 204 of file SparklineAttributes.cxx.

References eType, and m_aImplementation.

Referenced by sc::SparklineGroupsImportContext::fillSparklineGroupAttributes().

◆ shouldDisplayHidden()

bool sc::SparklineAttributes::shouldDisplayHidden ( ) const

Definition at line 242 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), and sc::SparklineDialog::setupValues().

◆ shouldDisplayXAxis()

bool sc::SparklineAttributes::shouldDisplayXAxis ( ) const

Definition at line 236 of file SparklineAttributes.cxx.

References m_aImplementation.

Referenced by xcl::exp::SparklineExt::addSparklineGroupAttributes(), sc::SparklineGroupsExport::addSparklineGroupAttributes(), sc::SparklineRenderer::drawColumn(), sc::SparklineRenderer::drawLine(), and sc::SparklineDialog::setupValues().

Member Data Documentation

◆ m_aImplementation

o3tl::cow_wrapper<Implementation> sc::SparklineAttributes::m_aImplementation
private

Definition at line 50 of file SparklineAttributes.hxx.

Referenced by getColorAxis(), getColorFirst(), getColorHigh(), getColorLast(), getColorLow(), getColorMarkers(), getColorNegative(), getColorSeries(), getDisplayEmptyCellsAs(), getLineWeight(), getManualMax(), getManualMin(), getMaxAxisType(), getMinAxisType(), getType(), isDateAxis(), isFirst(), isHigh(), isLast(), isLow(), isMarkers(), isNegative(), isRightToLeft(), operator==(), setColorAxis(), setColorFirst(), setColorHigh(), setColorLast(), setColorLow(), setColorMarkers(), setColorNegative(), setColorSeries(), setDateAxis(), setDisplayEmptyCellsAs(), setDisplayHidden(), setDisplayXAxis(), setFirst(), setHigh(), setLast(), setLineWeight(), setLow(), setManualMax(), setManualMin(), setMarkers(), setMaxAxisType(), setMinAxisType(), setNegative(), setRightToLeft(), setType(), shouldDisplayHidden(), and shouldDisplayXAxis().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:32:07 for LibreOffice Module sc (master) by doxygen 1.9.3