kdeui Library API Documentation

KWordWrap Class Reference

Word-wrap algorithm that takes into account beautifulness ;) That means: More...

#include <kwordwrap.h>

List of all members.

Public Types

enum  { FadeOut = 0x10000000 }

Public Methods

QRect boundingRect () const
QString wrappedString () const
QString truncatedString (bool dots=true) const
void drawText (QPainter *painter, int x, int y, int flags=Qt::AlignAuto) const
 ~KWordWrap ()

Static Public Methods

KWordWrap * formatText (QFontMetrics &fm, const QRect &r, int flags, const QString &str, int len=-1)
void drawFadeoutText (QPainter *p, int x, int y, int maxW, const QString &t)


Detailed Description

Word-wrap algorithm that takes into account beautifulness ;) That means:

for paths)

Usage: call the static method, formatText, with the text to wrap and the constraining rectangle etc., it will return an instance of KWordWrap containing internal data, result of the word-wrapping. From that instance you can retrieve the boundingRect, and invoke drawing.

This design allows to call the word-wrap algorithm only when the text changes and not every time we want to know the bounding rect or draw the text.

Author:
David Faure <faure@kde.org>

Definition at line 44 of file kwordwrap.h.


Member Enumeration Documentation

anonymous enum
 

Use this flag in drawText() if you want to fade out the text if it does not fit into the constraining rectangle.

Since:
3.2

Definition at line 52 of file kwordwrap.h.


Constructor & Destructor Documentation

KWordWrap::~KWordWrap  
 

Destructor.

Definition at line 134 of file kwordwrap.cpp.


Member Function Documentation

KWordWrap * KWordWrap::formatText QFontMetrics   fm,
const QRect   r,
int    flags,
const QString   str,
int    len = -1
[static]
 

Main method for wrapping text.

Parameters:
fm  Font metrics, for the chosen font. Better cache it, creating a QFontMetrics is expensive.
r  Constraining rectangle. Only the width and height matter. With negative height the complete text will be rendered
flags  currently unused
str  The text to be wrapped.
len  Length of text to wrap (default is -1 for all).
Returns:
a KWordWrap instance. The caller is responsible for storing and deleting the result.

Definition at line 33 of file kwordwrap.cpp.

References QValueList< int >::append(), QFontMetrics::charWidth(), QFontMetrics::height(), QChar::isPunct(), QChar::isSpace(), QChar::isSymbol(), QString::left(), QString::length(), m_boundingRect, m_breakPositions, m_lineWidths, m_text, QString::remove(), QRect::setRect(), and QRect::width().

QRect KWordWrap::boundingRect   const [inline]
 

Returns:
the bounding rect, calculated by formatText. The width is the width of the widest text line, and never wider than the rectangle given to formatText. The height is the text block. X and Y are always 0.

Definition at line 73 of file kwordwrap.h.

QString KWordWrap::wrappedString   const
 

Returns:
the original string, with '
' inserted where the text is broken by the wordwrap algorithm.

Definition at line 138 of file kwordwrap.cpp.

References QValueList< int >::begin(), KStdAccel::end(), QValueList< int >::end(), and QString::mid().

QString KWordWrap::truncatedString bool    dots = true const
 

Returns:
the original string, truncated to the first line. If dots was set, '...' is appended in case the string was truncated. Bug: Note that the '...' come out of the bounding rect.

Definition at line 154 of file kwordwrap.cpp.

References QValueList< int >::begin(), QValueList< int >::end(), and QString::left().

void KWordWrap::drawText QPainter   painter,
int    x,
int    y,
int    flags = Qt::AlignAuto
const
 

Draw the text that has been previously wrapped, at position x,y.

Flags are for alignment, e.g. Qt::AlignHCenter. Default is Qt::AlignAuto.

Parameters:
painter  the QPainter to use.
x  the horizontal position of the text
y  the vertical position of the text
flags  the ORed text alignment flags from the Qt namespace, ORed with FadeOut if you want the text to fade out if it does not fit (the painter's background must be set accordingly)

Definition at line 207 of file kwordwrap.cpp.

References QFontMetrics::ascent(), QValueList< int >::begin(), drawFadeoutText(), QPainter::drawText(), KStdAccel::end(), QValueList< int >::end(), QPainter::fontMetrics(), QFontMetrics::height(), QString::mid(), and QRect::width().

void KWordWrap::drawFadeoutText QPainter   p,
int    x,
int    y,
int    maxW,
const QString   t
[static]
 

Draws the string t at the given coordinates, if it does not fit into maxW the text will be faded out.

Parameters:
p  the painter to use. Must have set the pen for the text color and the background for the color to fade out
x  the horizontal position of the text
y  the vertical position of the text
maxW  the maximum width of the text (including the fade-out effect)
t  the text to draw
Since:
3.2

Definition at line 175 of file kwordwrap.cpp.

References QString::at(), QPainter::backgroundColor(), QFontMetrics::boundingRect(), QFontMetrics::charWidth(), QPainter::drawText(), QPainter::fontMetrics(), QString::left(), QString::length(), QPainter::pen(), QPainter::setPen(), and QFontMetrics::width().

Referenced by drawText().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun May 16 22:02:23 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003