A class representing a text. More...
#include <qwt_text.h>
Public Types | |
enum | TextFormat { AutoText = 0, PlainText, RichText, MathMLText, TeXText, OtherFormat = 100 } |
enum | PaintAttribute { PaintUsingTextFont = 1, PaintUsingTextColor = 2, PaintBackground = 4 } |
enum | LayoutAttribute { MinimumLayout = 1 } |
Public Member Functions | |
QwtText (const QString &=QString::null, TextFormat textFormat=AutoText) | |
QwtText (const QwtText &) | |
~QwtText () | |
QwtText & | operator= (const QwtText &) |
int | operator== (const QwtText &) const |
int | operator!= (const QwtText &) const |
void | setText (const QString &, QwtText::TextFormat textFormat=AutoText) |
QString | text () const |
bool | isNull () const |
bool | isEmpty () const |
void | setFont (const QFont &) |
QFont | font () const |
QFont | usedFont (const QFont &) const |
void | setRenderFlags (int flags) |
int | renderFlags () const |
void | setColor (const QColor &) |
QColor | color () const |
QColor | usedColor (const QColor &) const |
void | setBackgroundPen (const QPen &) |
QPen | backgroundPen () const |
void | setBackgroundBrush (const QBrush &) |
QBrush | backgroundBrush () const |
void | setPaintAttribute (PaintAttribute, bool on=true) |
bool | testPaintAttribute (PaintAttribute) const |
void | setLayoutAttribute (LayoutAttribute, bool on=true) |
bool | testLayoutAttribute (LayoutAttribute) const |
int | heightForWidth (int width, const QFont &=QFont()) const |
QSize | textSize (const QFont &=QFont()) const |
void | draw (QPainter *painter, const QRect &rect) const |
Static Public Member Functions | |
static const QwtTextEngine * | textEngine (const QString &text, QwtText::TextFormat=AutoText) |
static const QwtTextEngine * | textEngine (QwtText::TextFormat) |
static void | setTextEngine (QwtText::TextFormat, QwtTextEngine *) |
A class representing a text.
A QwtText is a text including a set of attributes how to render it.
Layout Attributes.
The layout attributes affects some aspects of the layout of the text.
Paint Attributes.
Font and color and background are optional attributes of a QwtText. The paint attributes hold the information, if they are set.
enum QwtText::TextFormat |
Text format.
The text format defines the QwtTextEngine, that is used to render the text.
QwtText::QwtText | ( | const QString & | text = QString::null , |
|
QwtText::TextFormat | textFormat = AutoText | |||
) |
Constructor
text | Text content | |
textFormat | Text format |
QwtText::QwtText | ( | const QwtText & | other | ) |
Copy constructor.
QwtText::~QwtText | ( | ) |
Destructor.
QBrush QwtText::backgroundBrush | ( | ) | const |
QPen QwtText::backgroundPen | ( | ) | const |
QColor QwtText::color | ( | ) | const |
Return the pen color, used for painting the text.
void QwtText::draw | ( | QPainter * | painter, | |
const QRect & | rect | |||
) | const |
Draw a text into a rectangle
painter | Painter | |
rect | Rectangle |
QFont QwtText::font | ( | ) | const |
Return the font.
int QwtText::heightForWidth | ( | int | width, | |
const QFont & | defaultFont = QFont() | |||
) | const |
Find the height for a given width
defaultFont | Font, used for the calculation if the text has no font | |
width | Width |
int QwtText::operator!= | ( | const QwtText & | other | ) | const |
Relational operator.
int QwtText::operator== | ( | const QwtText & | other | ) | const |
Relational operator.
int QwtText::renderFlags | ( | ) | const |
void QwtText::setBackgroundBrush | ( | const QBrush & | brush | ) |
Set the background brush
brush | Background brush |
void QwtText::setBackgroundPen | ( | const QPen & | pen | ) |
Set the background pen
pen | Background pen |
void QwtText::setColor | ( | const QColor & | color | ) |
Set the pen color used for painting the text.
color | Color |
void QwtText::setFont | ( | const QFont & | font | ) |
Set the font.
font | Font |
void QwtText::setLayoutAttribute | ( | LayoutAttribute | attribute, | |
bool | on = true | |||
) |
Change a layout attribute
attribute | Layout attribute | |
on | On/Off |
void QwtText::setPaintAttribute | ( | PaintAttribute | attribute, | |
bool | on = true | |||
) |
Change a paint attribute
attribute | Paint attribute | |
on | On/Off |
void QwtText::setRenderFlags | ( | int | renderFlags | ) |
Change the render flags.
The default setting is Qt::AlignCenter
renderFlags | Bitwise OR of the flags used like in QPainter::drawText |
void QwtText::setText | ( | const QString & | text, | |
QwtText::TextFormat | textFormat = AutoText | |||
) |
void QwtText::setTextEngine | ( | QwtText::TextFormat | format, | |
QwtTextEngine * | engine | |||
) | [static] |
Assign/Replace a text engine for a text format
With setTextEngine it is possible to extend Qwt with other types of text formats.
Owner of a commercial Qt license can build the qwtmathml library, that is based on the MathML renderer, that is included in MML Widget component of the Qt solutions package.
For QwtText::PlainText it is not allowed to assign a engine == NULL.
format | Text format | |
engine | Text engine |
bool QwtText::testLayoutAttribute | ( | LayoutAttribute | attribute | ) | const |
Test a layout attribute
attribute | Layout attribute |
bool QwtText::testPaintAttribute | ( | PaintAttribute | attribute | ) | const |
Test a paint attribute
attribute | Paint attribute |
QString QwtText::text | ( | ) | const |
Return the text.
const QwtTextEngine * QwtText::textEngine | ( | QwtText::TextFormat | format | ) | [static] |
Find the text engine for a text format.
textEngine can be used to find out if a text format is supported. F.e, if one wants to use MathML labels, the MathML renderer from the commercial Qt solutions package might be required, that is not available in Qt Open Source Edition environments.
format | Text format |
const QwtTextEngine * QwtText::textEngine | ( | const QString & | text, | |
QwtText::TextFormat | format = AutoText | |||
) | [static] |
Find the text engine for a text format
In case of QwtText::AutoText the first text engine (beside QwtPlainTextEngine) is returned, where QwtTextEngine::mightRender returns true. If there is none QwtPlainTextEngine is returnd.
If no text engine is registered for the format QwtPlainTextEngine is returnd.
text | Text, needed in case of AutoText | |
format | Text format |
QSize QwtText::textSize | ( | const QFont & | defaultFont = QFont() |
) | const |
Find the height for a given width
defaultFont | Font, used for the calculation if the text has no font |
Returns the size, that is needed to render text
defaultFont | Font of the text |
QColor QwtText::usedColor | ( | const QColor & | defaultColor | ) | const |
Return the color of the text, if it has one. Otherwise return defaultColor.
defaultColor | Default color |