KDChart::DataValueAttributes Class Reference

#include <KDChartDataValueAttributes>

List of all members.

---

Detailed Description

Diagram attributes dealing with data value labels.

The DataValueAttributes group all properties that can be set wrt data value labels and if and how they are displayed. This includes things like the text attributes (font, color), what markers are used, howmany decimal digits are displayed, etc.

Definition at line 58 of file KDChartDataValueAttributes.h.

Public Member Functions
BackgroundAttributes	backgroundAttributes () const
	Returns: The background attributes used for painting the data value labels area.
QString	dataLabel () const
	Returns the string displayed instead of the data value label.
	DataValueAttributes (const DataValueAttributes &)
	DataValueAttributes ()
int	decimalDigits () const
	Returns: The number of decimal digits displayed.
FrameAttributes	frameAttributes () const
	Returns: The frame attributes used for painting the data value labels area.
bool	isVisible () const
	Returns: Whether data value labels should be displayed.
MarkerAttributes	markerAttributes () const
	Returns: The marker attributes used for decorating the data values.
const RelativePosition	negativePosition () const
	Return the relative positioning of the data value labels.
bool	operator!= (const DataValueAttributes &other) const
DataValueAttributes &	operator= (const DataValueAttributes &)
bool	operator== (const DataValueAttributes &) const
const RelativePosition	position (bool positive) const
const RelativePosition	positivePosition () const
	Return the relative positioning of the data value labels.
int	powerOfTenDivisor () const
QString	prefix () const
	Returns the string used as a prefix to the data value text.
void	setBackgroundAttributes (const BackgroundAttributes &a)
	Set the background attributes to use for the data value labels area.
void	setDataLabel (const QString label)
	display a string label instead of the original data value label Supports HTML code.
void	setDecimalDigits (int digits)
	Set how many decimal digits to display when rendering the data value labels.
void	setFrameAttributes (const FrameAttributes &a)
	Set the frame attributes to use for the data value labels area.
void	setMarkerAttributes (const MarkerAttributes &a)
	Set the marker attributes to use for the data values.
void	setNegativePosition (const RelativePosition &relPosition)
	Defines the relative positioning of the data value labels for negative values.
void	setPositivePosition (const RelativePosition &relPosition)
	Defines the relative position of the data value labels for positive values.
void	setPowerOfTenDivisor (int powerOfTenDivisor)
	These method are planned for future versions of KD Chart, so they are not part of the documented API yet.
void	setPrefix (const QString prefix)
	Prepend a prefix string to the data value label.
void	setShowOverlappingDataLabels (bool showOverlappingDataLabels)
	Set whether data value texts overlapping other data value texts of the same diagram should be drawn.
void	setShowRepetitiveDataLabels (bool showRepetitiveDataLabels)
	Set whether data value labels not different from their predecessors should be drawn.
void	setSuffix (const QString suffix)
	Append a suffix string to the data value label.
void	setTextAttributes (const TextAttributes &a)
	Set the text attributes to use for the data value labels.
void	setVisible (bool visible)
	Set whether data value labels should be displayed.
bool	showOverlappingDataLabels () const
	Returns: Whether data value texts overlapping other data value texts of the same diagram are drawn.
bool	showRepetitiveDataLabels () const
	Returns: Whether data values not different from their predecessors are drawn.
QString	suffix () const
	Returns the string used as a suffix to the data value text.
TextAttributes	textAttributes () const
	Returns: The text attributes used for painting data value labels.
	~DataValueAttributes ()
Static Public Member Functions
static const DataValueAttributes &	defaultAttributes ()
static const QVariant &	defaultAttributesAsVariant ()

---

Constructor & Destructor Documentation

DataValueAttributes::DataValueAttributes

(

)

Definition at line 111 of file KDChartDataValueAttributes.cpp.

    : _d( new Private() )
{
}

DataValueAttributes::DataValueAttributes

(

const DataValueAttributes &

r

)

Definition at line 116 of file KDChartDataValueAttributes.cpp.

    : _d( new Private( *r.d ) )
{
}

DataValueAttributes::~DataValueAttributes

(

)

Definition at line 131 of file KDChartDataValueAttributes.cpp.

{
    delete _d; _d = 0;
}

---

Member Function Documentation

BackgroundAttributes DataValueAttributes::backgroundAttributes

(

)

const

Returns:

The background attributes used for painting the data value labels area.

See also:

BackgroundAttributes

Definition at line 224 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->backgroundAttributes;
}

QString DataValueAttributes::dataLabel

(

)

const

Returns the string displayed instead of the data value label.

See also:

setDataLabel

Definition at line 275 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator==().

{
    return d->dataLabel;
}

int DataValueAttributes::decimalDigits

(

)

const

Returns:

The number of decimal digits displayed.

Definition at line 245 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->decimalDigits;
}

const DataValueAttributes & DataValueAttributes::defaultAttributes

(

)

[static]

Definition at line 175 of file KDChartDataValueAttributes.cpp.

Referenced by defaultAttributesAsVariant().

{
    static const DataValueAttributes theDefaultDataValueAttributes;
    return theDefaultDataValueAttributes;
}

const QVariant & DataValueAttributes::defaultAttributesAsVariant

(

)

[static]

Definition at line 182 of file KDChartDataValueAttributes.cpp.

References defaultAttributes().

Referenced by KDChart::AttributesModel::AttributesModel().

{
    static const QVariant theDefaultDataValueAttributesVariant = qVariantFromValue(defaultAttributes());
    return theDefaultDataValueAttributesVariant;
}

FrameAttributes DataValueAttributes::frameAttributes

(

)

const

Returns:

The frame attributes used for painting the data value labels area.

See also:

FrameAttributes

Definition at line 214 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->frameAttributes;
}

bool DataValueAttributes::isVisible

(

)

const

Returns:

Whether data value labels should be displayed.

Definition at line 194 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), operator==(), and KDChart::AbstractDiagram::paintMarker().

{
    return d->visible;
}

MarkerAttributes DataValueAttributes::markerAttributes

(

)

const

Returns:

The marker attributes used for decorating the data values.

See also:

MarkerAttributes

Definition at line 234 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by KDChart::AbstractDiagram::datasetMarkers(), operator==(), and KDChart::AbstractDiagram::paintMarker().

{
    return d->markerAttributes;
}

const RelativePosition DataValueAttributes::negativePosition

(

)

const

Return the relative positioning of the data value labels.

See also:

setNegativePosition

Definition at line 325 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->negativeRelPos;
}

bool KDChart::DataValueAttributes::operator!=

(

const DataValueAttributes &

other

)

const

Definition at line 65 of file KDChartDataValueAttributes.h.

References KDGantt::operator==().

{ return !operator==(other); }

DataValueAttributes & DataValueAttributes::operator=

(

const DataValueAttributes &

r

)

Definition at line 121 of file KDChartDataValueAttributes.cpp.

References d.

{
    if( this == &r )
        return *this;

    *d = *r.d;

    return *this;
}

bool DataValueAttributes::operator==

(

const DataValueAttributes &

r

)

const

Definition at line 137 of file KDChartDataValueAttributes.cpp.

References backgroundAttributes(), dataLabel(), decimalDigits(), frameAttributes(), isVisible(), markerAttributes(), negativePosition(), positivePosition(), powerOfTenDivisor(), prefix(), showOverlappingDataLabels(), showRepetitiveDataLabels(), suffix(), and textAttributes().

{
    /*
    qDebug() << "DataValueAttributes::operator== finds"
            << "b" << (isVisible() == r.isVisible())
            << "c" << (textAttributes() == r.textAttributes())
            << "d" << (frameAttributes() == r.frameAttributes())
            << "e" << (backgroundAttributes() == r.backgroundAttributes())
            << "f" << (markerAttributes() == r.markerAttributes())
            << "g" << (decimalDigits() == r.decimalDigits())
            << "h" << (prefix() == r.prefix())
            << "i" << (suffix() == r.suffix())
            << "j" << (dataLabel() == r.dataLabel())
            << "k" << (powerOfTenDivisor() == r.powerOfTenDivisor())
            << "l" << (showInfinite() == r.showInfinite())
            << "m" << (negativePosition() == r.negativePosition())
            << "n" << (positivePosition() == r.positivePosition())
            << "o" << (showRepetitiveDataLabels() == r.showRepetitiveDataLabels())
            << "p" << (showOverlappingDataLabels() == r.showOverlappingDataLabels());
    */
    return ( isVisible() == r.isVisible() &&
            textAttributes() == r.textAttributes() &&
            frameAttributes() == r.frameAttributes() &&
            backgroundAttributes() == r.backgroundAttributes() &&
            markerAttributes() == r.markerAttributes() &&
            decimalDigits() == r.decimalDigits() &&
            prefix() == r.prefix() &&
            suffix() == r.suffix() &&
            dataLabel() == r.dataLabel() &&
            powerOfTenDivisor() == r.powerOfTenDivisor() &&
            showInfinite() == r.showInfinite() &&
            negativePosition() == r.negativePosition() &&
            positivePosition() == r.positivePosition() &&
            showRepetitiveDataLabels() == r.showRepetitiveDataLabels() &&
            showOverlappingDataLabels() == r.showOverlappingDataLabels() );
}

const RelativePosition KDChart::DataValueAttributes::position

(

bool

positive

)

const

Definition at line 269 of file KDChartDataValueAttributes.h.

  {
    return positive ? positivePosition() : negativePosition();
  }

const RelativePosition DataValueAttributes::positivePosition

(

)

const

Return the relative positioning of the data value labels.

See also:

setPositivePosition

Definition at line 335 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->positiveRelPos;
}

int DataValueAttributes::powerOfTenDivisor

(

)

const

Definition at line 305 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->powerOfTenDivisor;
}

QString DataValueAttributes::prefix

(

)

const

Returns the string used as a prefix to the data value text.

See also:

setPrefix

Definition at line 255 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator==().

{
    return d->prefix;
}

void DataValueAttributes::setBackgroundAttributes

(

const BackgroundAttributes &

a

)

Set the background attributes to use for the data value labels area.

Parameters:

a

The background attributes to set.

See also:

BackgroundAttributes

Definition at line 219 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->backgroundAttributes = a;
}

void DataValueAttributes::setDataLabel

(

const QString

label

)

display a string label instead of the original data value label Supports HTML code.

See also:

dataLabel

Definition at line 270 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->dataLabel =  label;
}

void DataValueAttributes::setDecimalDigits

(

int

digits

)

Set how many decimal digits to display when rendering the data value labels.

If there are no decimal digits it will not be displayed.

Parameters:

digits

The number of decimal digits to use.

Definition at line 240 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->decimalDigits = digits;
}

void DataValueAttributes::setFrameAttributes

(

const FrameAttributes &

a

)

Set the frame attributes to use for the data value labels area.

Parameters:

a

The frame attributes to set.

See also:

FrameAttributes

Definition at line 209 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->frameAttributes = a;
}

void DataValueAttributes::setMarkerAttributes

(

const MarkerAttributes &

a

)

Set the marker attributes to use for the data values.

This includes the marker type.

Parameters:

a

The marker attributes to set.

See also:

MarkerAttributes

Definition at line 229 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by KDChart::TernaryLineDiagram::TernaryLineDiagram().

{
    d->markerAttributes = a;
}

void DataValueAttributes::setNegativePosition

(

const RelativePosition &

relPosition

)

Defines the relative positioning of the data value labels for negative values.

The position is specified in relation to the respective data value point, or in releation to the respective data representation area, that's one area segment in a LineDiagram showing areas, or one bar in a BarDiagram, one pie slice ...

See also:

negativePosition

Definition at line 320 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->negativeRelPos = relPosition;
}

void DataValueAttributes::setPositivePosition

(

const RelativePosition &

relPosition

)

Defines the relative position of the data value labels for positive values.

The position is specified in relation to the respective data value point, or in releation to the respective data representation area, that's one area segment in a LineDiagram showing areas, or one bar in a BarDiagram, one pie slice ...

See also:

positivePosition

Definition at line 330 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->positiveRelPos = relPosition;
}

void DataValueAttributes::setPowerOfTenDivisor

(

int

powerOfTenDivisor

)

These method are planned for future versions of KD Chart, so they are not part of the documented API yet.

Definition at line 300 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->powerOfTenDivisor = powerOfTenDivisor;
}

void DataValueAttributes::setPrefix

(

const QString

prefix

)

Prepend a prefix string to the data value label.

See also:

prefix

Definition at line 250 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->prefix = prefixString;
}

void DataValueAttributes::setShowOverlappingDataLabels

(

bool

showOverlappingDataLabels

)

Set whether data value texts overlapping other data value texts of the same diagram should be drawn.

Parameters:

showOverlappingDataLabels

Whether data texts overlapping other data value texts of the same diagram are drawn.

Definition at line 295 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->showOverlappingDataLabels = showOverlappingDataLabels;
}

void DataValueAttributes::setShowRepetitiveDataLabels

(

bool

showRepetitiveDataLabels

)

Set whether data value labels not different from their predecessors should be drawn.

Parameters:

showRepetitiveDataLabels

Whether data value not different from their predecessors are drawn.

Definition at line 285 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->showRepetitiveDataLabels = showRepetitiveDataLabels;
}

void DataValueAttributes::setSuffix

(

const QString

suffix

)

Append a suffix string to the data value label.

See also:

suffix

Definition at line 260 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->suffix  = suffixString;
}

void DataValueAttributes::setTextAttributes

(

const TextAttributes &

a

)

Set the text attributes to use for the data value labels.

Parameters:

a

The text attributes to set.

See also:

TextAttributes

Definition at line 199 of file KDChartDataValueAttributes.cpp.

References d.

{
    d->textAttributes = a;
}

void DataValueAttributes::setVisible

(

bool

visible

)

Set whether data value labels should be displayed.

Parameters:

visible

Whether data value labels should be displayed.

Definition at line 189 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by KDChart::TernaryLineDiagram::TernaryLineDiagram().

{
    d->visible = visible;
}

bool DataValueAttributes::showOverlappingDataLabels

(

)

const

Returns:

Whether data value texts overlapping other data value texts of the same diagram are drawn.

Definition at line 290 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->showOverlappingDataLabels;
}

bool DataValueAttributes::showRepetitiveDataLabels

(

)

const

Returns:

Whether data values not different from their predecessors are drawn.

Definition at line 280 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->showRepetitiveDataLabels;
}

QString DataValueAttributes::suffix

(

)

const

Returns the string used as a suffix to the data value text.

See also:

setSuffix

Definition at line 265 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator==().

{
    return d->suffix;
}

TextAttributes DataValueAttributes::textAttributes

(

)

const

Returns:

The text attributes used for painting data value labels.

Definition at line 204 of file KDChartDataValueAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->textAttributes;
}

---

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

• KDChartDataValueAttributes.h
• KDChartDataValueAttributes.cpp

---