KWordWrap
#include <KWordWrap>
Public Types | |
enum | { FadeOut = 0x10000000 , Truncate = 0x20000000 } |
Public Member Functions | |
KWordWrap (const KWordWrap &other) | |
~KWordWrap () | |
QRect | boundingRect () const |
void | drawText (QPainter *painter, int x, int y, int flags=Qt::AlignLeft) const |
KWordWrap & | operator= (const KWordWrap &other) |
QString | truncatedString (bool dots=true) const |
QString | wrappedString () const |
Static Public Member Functions | |
static void | drawFadeoutText (QPainter *p, int x, int y, int maxW, const QString &t) |
static void | drawTruncateText (QPainter *p, int x, int y, int maxW, const QString &t) |
static KWordWrap | formatText (QFontMetrics &fm, const QRect &r, int flags, const QString &str, int len=-1) |
Detailed Description
Word-wrap algorithm that takes into account beautifulness ;)
That means:
- not letting a letter alone on the last line,
- breaking at punctuation signs (not only at spaces)
- improved handling of (), [] and {}
- improved handling of '/' (e.g. 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.
Definition at line 42 of file kwordwrap.h.
Member Enumeration Documentation
◆ anonymous enum
anonymous enum |
Use this flag in drawText() if you want to fade out the text if it does not fit into the constraining rectangle.
Definition at line 49 of file kwordwrap.h.
Constructor & Destructor Documentation
◆ ~KWordWrap()
KWordWrap::~KWordWrap | ( | ) |
Destructor.
Definition at line 145 of file kwordwrap.cpp.
◆ KWordWrap()
KWordWrap::KWordWrap | ( | const KWordWrap & | other | ) |
Copy constructor.
Definition at line 149 of file kwordwrap.cpp.
Member Function Documentation
◆ boundingRect()
QRect KWordWrap::boundingRect | ( | ) | const |
- 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 302 of file kwordwrap.cpp.
◆ drawFadeoutText()
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
Definition at line 196 of file kwordwrap.cpp.
◆ drawText()
void KWordWrap::drawText | ( | QPainter * | painter, |
int | x, | ||
int | y, | ||
int | flags = Qt::AlignLeft ) 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 249 of file kwordwrap.cpp.
◆ drawTruncateText()
Draws the string t
at the given coordinates, if it does not fit
into maxW
the text will be truncated.
- Parameters
-
p the painter to use x the horizontal position of the text y the vertical position of the text maxW the maximum width of the text (including the '...') t the text to draw
Definition at line 243 of file kwordwrap.cpp.
◆ formatText()
|
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 28 of file kwordwrap.cpp.
◆ operator=()
Assignment operator.
Definition at line 154 of file kwordwrap.cpp.
◆ truncatedString()
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 176 of file kwordwrap.cpp.
◆ wrappedString()
QString KWordWrap::wrappedString | ( | ) | const |
- Returns
- the original string, with '
' inserted where the text is broken by the wordwrap algorithm.
Definition at line 160 of file kwordwrap.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:02:23 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.