KDChart::TextAttributes Class Reference

#include <KDChartTextAttributes.h>

List of all members.

---

Detailed Description

A set of text attributes.

TextAttributes encapsulates settings that have to do with text. This includes font, fontsize, color, whether the text is rotated, etc

Definition at line 50 of file KDChartTextAttributes.h.

Public Member Functions
bool	autoRotate () const
	Returns: Whether text is automatically rotated when space is constrained.
bool	autoShrink () const
	Returns: Whether text is automatically shrunk if space is constraint.
const QFont	calculatedFont (const QObject *autoReferenceArea, KDChartEnums::MeasureOrientation autoReferenceOrientation) const
	Returns the font in the size that is used at drawing time.
const qreal	calculatedFontSize (const QObject *autoReferenceArea, KDChartEnums::MeasureOrientation autoReferenceOrientation) const
	Returns the font size that is used at drawing time.
QFont	font () const
	Returns: The font that is used for rendering text.
Measure	fontSize () const
	Returns: The measure used for the font size.
bool	hasAbsoluteFontSize () const
	Returns: Whether the text has an absolute font size set.
bool	isVisible () const
	Returns: Whether the text is visible.
Measure	minimalFontSize () const
	Returns: The measure used for the minimal font size.
bool	operator!= (const TextAttributes &other) const
TextAttributes &	operator= (const TextAttributes &)
bool	operator== (const TextAttributes &) const
QPen	pen () const
	Returns: The pen used for rendering the text.
int	rotation () const
	Returns: The rotation angle used for rendering the text.
void	setAutoRotate (bool autoRotate)
	Set whether the text should be automatically rotated as needed when space is constraint.
void	setAutoShrink (bool autoShrink)
	Set whether the text should automatically be shrunk, if space is constraint.
void	setFont (const QFont &font)
	Set the font to be used for rendering the text.
void	setFontSize (const Measure &measure)
	Set the size of the font used for rendering text.
void	setMinimalFontSize (const Measure &measure)
	Set the minimal size of the font used for rendering text.
void	setPen (const QPen &pen)
	Set the pen to use for rendering the text.
void	setRotation (int rotation)
	Set the rotation angle to use for the text.
void	setVisible (bool visible)
	Set whether the text is to be rendered at all.
	TextAttributes (const TextAttributes &)
	TextAttributes ()
	~TextAttributes ()

---

Constructor & Destructor Documentation

TextAttributes::TextAttributes

(

)

Definition at line 62 of file KDChartTextAttributes.cpp.

References setAutoRotate(), setAutoShrink(), setFont(), setPen(), setRotation(), and setVisible().

    : _d( new Private() )
{
    setVisible( true );
    setFont( QApplication::font() );
    setAutoRotate( false );
    setAutoShrink( false );
    setRotation( 0 );
    setPen( QPen( Qt::black ) );
}

TextAttributes::TextAttributes

(

const TextAttributes &

r

)

Definition at line 73 of file KDChartTextAttributes.cpp.

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

}

TextAttributes::~TextAttributes

(

)

Definition at line 89 of file KDChartTextAttributes.cpp.

{
    delete _d; _d = 0;
}

---

Member Function Documentation

bool TextAttributes::autoRotate

(

)

const

Returns:

Whether text is automatically rotated when space is constrained.

Definition at line 207 of file KDChartTextAttributes.cpp.

References d.

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

{
    return d->autoRotate;
}

bool TextAttributes::autoShrink

(

)

const

Returns:

Whether text is automatically shrunk if space is constraint.

Definition at line 217 of file KDChartTextAttributes.cpp.

References d.

Referenced by operator<<(), operator==(), and KDChart::TextLayoutItem::paint().

{
    return d->autoShrink;
}

const QFont TextAttributes::calculatedFont	(	const QObject *	autoReferenceArea,
		KDChartEnums::MeasureOrientation	autoReferenceOrientation
	)			const

Returns the font in the size that is used at drawing time.

This method is called at drawing time. It returns the font as it is used for rendering text, taking into account any measures that were set via setFontSize and/or setMinimalFontSize.

Definition at line 187 of file KDChartTextAttributes.cpp.

References calculatedFontSize(), and d.

Referenced by KDChart::LeveyJenningsDiagram::iconRect().

{
    const qreal size = calculatedFontSize( autoReferenceArea, autoReferenceOrientation );
    //qDebug() << "TextAttributes::calculatedFont() has   d->cachedFontSize" << d->cachedFontSize << "  calculatedFontSize" << size;
    if( size > 0.0 && d->cachedFontSize != size ){
        //qDebug() << "new into the cache:" << size;
        d->cachedFontSize = size;
        d->cachedFont.setPointSizeF( d->cachedFontSize );
    }
    return d->cachedFont;
}

const qreal TextAttributes::calculatedFontSize	(	const QObject *	autoReferenceArea,
		KDChartEnums::MeasureOrientation	autoReferenceOrientation
	)			const

Returns the font size that is used at drawing time.

This method is called at drawing time. It returns the font size as it is used for rendering text, taking into account any measures that were set via setFontSize and/or setMinimalFontSize.

Definition at line 176 of file KDChartTextAttributes.cpp.

References KDChart::Measure::calculatedValue(), fontSize(), and minimalFontSize().

Referenced by calculatedFont(), and KDChart::TextLayoutItem::realFontSize().

{
    const qreal normalSize  = fontSize().calculatedValue(        autoReferenceArea, autoReferenceOrientation );
    const qreal minimalSize = minimalFontSize().calculatedValue( autoReferenceArea, autoReferenceOrientation );
    //qDebug() << "TextAttributes::calculatedFontSize() finds" << normalSize << "and" << minimalSize;
    return qMax( normalSize, minimalSize );
}

QFont TextAttributes::font

(

)

const

Returns:

The font that is used for rendering text.

Definition at line 141 of file KDChartTextAttributes.cpp.

References d.

Referenced by operator<<(), operator==(), and KDChart::TextLayoutItem::setTextAttributes().

{
    return d->font;
}

Measure TextAttributes::fontSize

(

)

const

Returns:

The measure used for the font size.

Definition at line 151 of file KDChartTextAttributes.cpp.

References d.

Referenced by calculatedFontSize(), operator<<(), operator==(), and KDChart::CartesianAxis::titleTextAttributes().

{
    return d->fontSize;
}

bool TextAttributes::hasAbsoluteFontSize

(

)

const

Returns:

Whether the text has an absolute font size set.

Definition at line 166 of file KDChartTextAttributes.cpp.

References d, and KDChartEnums::MeasureCalculationModeAbsolute.

{
    return d->fontSize.calculationMode() == KDChartEnums::MeasureCalculationModeAbsolute
        && d->minimalFontSize.calculationMode() == KDChartEnums::MeasureCalculationModeAbsolute;
}

bool TextAttributes::isVisible

(

)

const

Returns:

Whether the text is visible.

Definition at line 128 of file KDChartTextAttributes.cpp.

References d.

Referenced by operator<<(), operator==(), KDChart::LeveyJenningsAxis::paintAsAbscissa(), KDChart::LeveyJenningsAxis::paintAsOrdinate(), and KDChart::CartesianAxis::paintCtx().

{
    return d->visible;
}

Measure TextAttributes::minimalFontSize

(

)

const

Returns:

The measure used for the minimal font size.

Definition at line 161 of file KDChartTextAttributes.cpp.

References d.

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

{
    return d->minimalFontSize;
}

bool KDChart::TextAttributes::operator!=

(

const TextAttributes &

other

)

const

Definition at line 57 of file KDChartTextAttributes.h.

References KDGantt::operator==().

  { return !operator==(other); }

TextAttributes & TextAttributes::operator=

(

const TextAttributes &

r

)

Definition at line 79 of file KDChartTextAttributes.cpp.

References d.

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

    *d = *r.d;

    return *this;
}

bool TextAttributes::operator==

(

const TextAttributes &

r

)

const

Definition at line 95 of file KDChartTextAttributes.cpp.

References autoRotate(), autoShrink(), font(), fontSize(), isVisible(), minimalFontSize(), pen(), and rotation().

{
    // the following works around a bug in gcc 4.3.2
    // causing StyleHint to be set to Zero when copying a QFont
    const QFont myFont( font() );
    QFont r_font( r.font() );
    r_font.setStyleHint( myFont.styleHint(), myFont.styleStrategy() );
    /*
    qDebug() << "\nTextAttributes::operator== :" << ( isVisible() == r.isVisible())
            << " font:"<<(myFont == r_font)
            << " fontSize:"<<(fontSize() == r.fontSize())
            << " minimalFontSize:"<<(minimalFontSize() == r.minimalFontSize())
            << (autoRotate() == r.autoRotate())
            << (autoShrink() == r.autoShrink())
            << (rotation() == rotation())
            << (pen() == r.pen());
    */
    return ( isVisible() == r.isVisible() &&
            myFont == r_font &&
            fontSize() == r.fontSize() &&
            minimalFontSize() == r.minimalFontSize() &&
            autoRotate() == r.autoRotate() &&
            autoShrink() == r.autoShrink() &&
            rotation() == r.rotation() &&
            pen() == r.pen() );
}

QPen TextAttributes::pen

(

)

const

Returns:

The pen used for rendering the text.

Definition at line 237 of file KDChartTextAttributes.cpp.

References d.

Referenced by operator<<(), operator==(), KDChart::TextLayoutItem::paint(), KDChart::LeveyJenningsAxis::paintAsOrdinate(), KDChart::CartesianAxis::paintCtx(), and KDChart::LeveyJenningsAxis::setType().

{
    return d->pen;
}

int TextAttributes::rotation

(

)

const

Returns:

The rotation angle used for rendering the text.

Definition at line 227 of file KDChartTextAttributes.cpp.

References d.

Referenced by KDChart::TextLayoutItem::intersects(), operator<<(), operator==(), KDChart::TextLayoutItem::paint(), KDChart::CartesianAxis::paintCtx(), and KDChart::TextLayoutItem::sizeHintAndRotatedCorners().

{
    return d->rotation;
}

void TextAttributes::setAutoRotate

(

bool

autoRotate

)

Set whether the text should be automatically rotated as needed when space is constraint.

Parameters:

autoRotate

Whether text should be automatically rotated.

Definition at line 202 of file KDChartTextAttributes.cpp.

References d.

Referenced by TextAttributes().

{
    d->autoRotate = autoRotate;
}

void TextAttributes::setAutoShrink

(

bool

autoShrink

)

Set whether the text should automatically be shrunk, if space is constraint.

Parameters:

autoShrink

Whether text should be auto-shrunk.

Definition at line 212 of file KDChartTextAttributes.cpp.

References d.

Referenced by TextAttributes().

{
    d->autoShrink = autoShrink;
}

void TextAttributes::setFont

(

const QFont &

font

)

Set the font to be used for rendering the text.

Note:

All of the font's attributes will be used - except of its size! To specify the size please use setFontSize (or setMinimalFontSize, resp.)

Parameters:

font

The font to use.

See also:

setFontSize, setMinimalFontSize

Definition at line 133 of file KDChartTextAttributes.cpp.

References d.

Referenced by TextAttributes().

{
    d->font       = font;
    d->cachedFont = font; // note: we do not set the font's size here, but in calculatedFont()
    //qDebug() << "resetting cached font size";
    d->cachedFontSize = -1.0;
}

void TextAttributes::setFontSize

(

const Measure &

measure

)

Set the size of the font used for rendering text.

Parameters:

measure

The measure to use.

See also:

Measure

Definition at line 146 of file KDChartTextAttributes.cpp.

References d.

Referenced by KDChart::Chart::addLegend(), KDChart::LeveyJenningsDiagram::iconRect(), and KDChart::CartesianAxis::titleTextAttributes().

{
    d->fontSize = measure;
}

void TextAttributes::setMinimalFontSize

(

const Measure &

measure

)

Set the minimal size of the font used for rendering text.

Parameters:

measure

The measure to use.

See also:

Measure

Definition at line 156 of file KDChartTextAttributes.cpp.

References d.

{
    d->minimalFontSize = measure;
}

void TextAttributes::setPen

(

const QPen &

pen

)

Set the pen to use for rendering the text.

Parameters:

pen

The pen to use.

Definition at line 232 of file KDChartTextAttributes.cpp.

References d.

Referenced by KDChart::LeveyJenningsAxis::setType(), and TextAttributes().

{
    d->pen = pen;
}

void TextAttributes::setRotation

(

int

rotation

)

Set the rotation angle to use for the text.

Note:

For axis titles the rotation angle can be set to one of the following angles: 0, 90, 180, 270 Any other values specified will be replaced by the next smaller one of the allowed values, so no matter what you set the rotation will always be one of these four values.

Parameters:

rotation

The rotation angle.

Definition at line 222 of file KDChartTextAttributes.cpp.

References d.

Referenced by TextAttributes().

{
    d->rotation = rotation;
}

void TextAttributes::setVisible

(

bool

visible

)

Set whether the text is to be rendered at all.

Parameters:

visible

Whether the text is visible.

Definition at line 123 of file KDChartTextAttributes.cpp.

References d.

Referenced by TextAttributes().

{
    d->visible = visible;
}

---

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

• KDChartTextAttributes.h
• KDChartTextAttributes.cpp

---