KGuiAddons 5.109.0
Public Types | Public Member Functions | Static Public Member Functions | List of all members
KWordWrap

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

#include <KWordWrap>

Public Types

enum  { FadeOut = 0x10000000 , Truncate = 0x20000000 }
 Use this flag in drawText() if you want to fade out the text if it does not fit into the constraining rectangle. More...
 

Public Member Functions

 KWordWrap (const KWordWrap &other)
 Copy constructor.
 
 ~KWordWrap ()
 Destructor.
 
QRect boundingRect () const
 
void drawText (QPainter *painter, int x, int y, int flags=Qt::AlignLeft) const
 Draw the text that has been previously wrapped, at position x,y.
 
KWordWrapoperator= (const KWordWrap &other)
 Assignment operator.
 
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)
 Draws the string t at the given coordinates, if it does not fit into maxW the text will be faded out.
 
static void drawTruncateText (QPainter *p, int x, int y, int maxW, const QString &t)
 Draws the string t at the given coordinates, if it does not fit into maxW the text will be truncated.
 
static KWordWrap formatText (QFontMetrics &fm, const QRect &r, int flags, const QString &str, int len=-1)
 Main method for wrapping text.
 

Detailed Description

Word-wrap algorithm that takes into account beautifulness ;)

That means:

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.nosp@m.@kde.nosp@m..org

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.

Constructor & Destructor Documentation

◆ ~KWordWrap()

KWordWrap::~KWordWrap ( )

Destructor.

◆ KWordWrap()

KWordWrap::KWordWrap ( const KWordWrap other)

Copy constructor.

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.

◆ drawFadeoutText()

static 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
pthe painter to use. Must have set the pen for the text color and the background for the color to fade out
xthe horizontal position of the text
ythe vertical position of the text
maxWthe maximum width of the text (including the fade-out effect)
tthe text to draw

◆ 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
painterthe QPainter to use.
xthe horizontal position of the text
ythe vertical position of the text
flagsthe 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)

◆ drawTruncateText()

static void KWordWrap::drawTruncateText ( 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 truncated.

Parameters
pthe painter to use
xthe horizontal position of the text
ythe vertical position of the text
maxWthe maximum width of the text (including the '...')
tthe text to draw

◆ formatText()

static KWordWrap KWordWrap::formatText ( QFontMetrics &  fm,
const QRect &  r,
int  flags,
const QString &  str,
int  len = -1 
)
static

Main method for wrapping text.

Parameters
fmFont metrics, for the chosen font. Better cache it, creating a QFontMetrics is expensive.
rConstraining rectangle. Only the width and height matter. With negative height the complete text will be rendered
flagscurrently unused
strThe text to be wrapped.
lenLength of text to wrap (default is -1 for all).
Returns
a KWordWrap instance. The caller is responsible for storing and deleting the result.

◆ operator=()

KWordWrap & KWordWrap::operator= ( const KWordWrap other)

Assignment operator.

◆ 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.

◆ wrappedString()

QString KWordWrap::wrappedString ( ) const
Returns
the original string, with '
' inserted where the text is broken by the wordwrap algorithm.