KChart::TextAttributes

KChart::TextAttributes Class Reference

#include <KChartTextAttributes.h>

Public Member Functions

 TextAttributes (const TextAttributes &)
 
bool autoRotate () const
 
bool autoShrink () const
 
const QFont calculatedFont (const QObject *autoReferenceArea, KChartEnums::MeasureOrientation autoReferenceOrientation) const
 
qreal calculatedFontSize (const QSizeF &referenceSize, KChartEnums::MeasureOrientation autoReferenceOrientation) const
 
qreal calculatedFontSize (const QObject *autoReferenceArea, KChartEnums::MeasureOrientation autoReferenceOrientation) const
 
QFont font () const
 
Measure fontSize () const
 
bool hasAbsoluteFontSize () const
 
bool hasRotation () const
 
bool isVisible () const
 
Measure minimalFontSize () const
 
bool operator!= (const TextAttributes &other) const
 
TextAttributesoperator= (const TextAttributes &)
 
bool operator== (const TextAttributes &) const
 
QPen pen () const
 
void resetRotation ()
 
int rotation () const
 
void setAutoRotate (bool autoRotate)
 
void setAutoShrink (bool autoShrink)
 
void setFont (const QFont &font)
 
void setFontSize (const Measure &measure)
 
void setMinimalFontSize (const Measure &measure)
 
void setPen (const QPen &pen)
 
void setRotation (int rotation)
 
void setTextDocument (QTextDocument *layout)
 
void setVisible (bool visible)
 
QTextDocumenttextDocument () const
 

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 43 of file KChartTextAttributes.h.

Member Function Documentation

bool TextAttributes::autoRotate ( ) const
Returns
Whether text is automatically rotated when space is tight.

Definition at line 216 of file KChartTextAttributes.cpp.

bool TextAttributes::autoShrink ( ) const
Returns
Whether text is automatically shrunk if space is tight.

Definition at line 226 of file KChartTextAttributes.cpp.

const QFont TextAttributes::calculatedFont ( const QObject autoReferenceArea,
KChartEnums::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 182 of file KChartTextAttributes.cpp.

qreal TextAttributes::calculatedFontSize ( const QSizeF referenceSize,
KChartEnums::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 163 of file KChartTextAttributes.cpp.

qreal TextAttributes::calculatedFontSize ( const QObject autoReferenceArea,
KChartEnums::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 174 of file KChartTextAttributes.cpp.

QFont TextAttributes::font ( ) const
Returns
The font that is used for rendering text.

Definition at line 132 of file KChartTextAttributes.cpp.

Measure TextAttributes::fontSize ( ) const
Returns
The measure used for the font size.

Definition at line 142 of file KChartTextAttributes.cpp.

bool TextAttributes::hasAbsoluteFontSize ( ) const
Returns
Whether the text has an absolute font size set.

Definition at line 157 of file KChartTextAttributes.cpp.

bool TextAttributes::isVisible ( ) const
Returns
Whether the text is visible.

Definition at line 120 of file KChartTextAttributes.cpp.

Measure TextAttributes::minimalFontSize ( ) const
Returns
The measure used for the minimal font size.

Definition at line 152 of file KChartTextAttributes.cpp.

QPen TextAttributes::pen ( ) const
Returns
The pen used for rendering the text.

Definition at line 258 of file KChartTextAttributes.cpp.

int TextAttributes::rotation ( ) const
Returns
The rotation angle used for rendering the text.

Definition at line 237 of file KChartTextAttributes.cpp.

void TextAttributes::setAutoRotate ( bool  autoRotate)

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

Parameters
autoRotateWhether text should be automatically rotated.

Definition at line 211 of file KChartTextAttributes.cpp.

void TextAttributes::setAutoShrink ( bool  autoShrink)

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

Parameters
autoShrinkWhether text should be auto-shrunk.

Definition at line 221 of file KChartTextAttributes.cpp.

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
fontThe font to use.
See also
setFontSize, setMinimalFontSize

Definition at line 125 of file KChartTextAttributes.cpp.

void TextAttributes::setFontSize ( const Measure measure)

Set the size of the font used for rendering text.

Parameters
measureThe measure to use.
See also
Measure

Definition at line 137 of file KChartTextAttributes.cpp.

void TextAttributes::setMinimalFontSize ( const Measure measure)

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

Parameters
measureThe measure to use.
See also
Measure

Definition at line 147 of file KChartTextAttributes.cpp.

void TextAttributes::setPen ( const QPen pen)

Set the pen to use for rendering the text.

Parameters
penThe pen to use.

Definition at line 253 of file KChartTextAttributes.cpp.

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
rotationThe rotation angle.

Definition at line 231 of file KChartTextAttributes.cpp.

void TextAttributes::setTextDocument ( QTextDocument layout)

Sets the document to use for the text.

The previous document is deleted.

Definition at line 268 of file KChartTextAttributes.cpp.

void TextAttributes::setVisible ( bool  visible)

Set whether the text is to be rendered at all.

Parameters
visibleWhether the text is visible.

Definition at line 115 of file KChartTextAttributes.cpp.

QTextDocument * TextAttributes::textDocument ( ) const
Returns
The document used for the drawing the text or NULL if the default document is used.

Definition at line 263 of file KChartTextAttributes.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Aug 9 2020 22:38:08 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.