MLabel provides functionality for displaying text. More...

Inheritance diagram for MLabel:

Collaboration diagram for MLabel:

Public Slots
void	setText (const QString &text)
Signals
void	linkActivated (const QString &link)
Public Member Functions
	MLabel (QGraphicsItem parent=0, MLabelModel model=0)
	MLabel (QString const &text, QGraphicsItem *parent=0)
virtual	~MLabel ()
void	setAlignment (Qt::Alignment alignment)
Qt::Alignment	alignment () const
QTextOption::WrapMode	wrapMode () const
void	setWrapMode (QTextOption::WrapMode wrapMode)
void	setWordWrap (bool wrap)
bool	wordWrap () const
QString	text () const
void	setTextElide (bool elide)
bool	textElide () const
void	setFont (const QFont &font)
QFont	font () const
void	setColor (const QColor &color)
QColor	color () const
void	addHighlighter (MLabelHighlighter *highlighter)
void	removeHighlighter (MLabelHighlighter *highlighter)
void	removeAllHighlighters ()
void	setTextFormat (Qt::TextFormat textFormat)
Qt::TextFormat	textFormat () const
Properties
Qt::Alignment	alignment
bool	wordWrap
QTextOption::WrapMode	wrapMode
bool	textElide
QString	text
QColor	color
Qt::TextFormat	textFormat

Detailed Description

MLabel provides functionality for displaying text.

Overview

MLabel provides functionality for displaying text. It can display plain text as well as rich text. The positioning of the text can be changed using setAlignment(). The appearance of the text can be tweaked using setTextDirection(), setWordWrap() and setTextElide().

Following list summarizes the functionality of MLabel:

Text direction can be set.
Support for auto wrapping and manual line changes for rich text. Use "<br>" to do a manual line change.
Support for automatic text eliding. If the label is not fitting into the given area, the label is truncated, and elision marks "..." are added in the end of the label. For truncation, the label has to be at least 4 characters long.
Rich label supports HTML tags and CSS styling for text formatting (such as bold, color, font, italics). See Supported HTML Subset for more details.
Rich label supports highlighting and execution of links/anchors. linkActivated() signal is emitted when a link is clicked.

Usage guidelines

Simple label is used for plain text on one line such as device buttons.
Rich label is used when text styling and formatting are needed.
Application decides:
- Position of the label in the view.
- Content of the label.
- Available area for the label.
- Check that left alignment is OK for the your design, otherwise override the alignment. For instance in button the text needs to be center aligned.

Variants

Default view. Supports both simple and rich text.

Open issues

requirements of localizations:
- bi-directional languages - do we need to swap the label order in the same component?
- bi-directional languages - aligning from left edge to right edge.
- bi-directional languages - role of wrapping.
- different label sub variations required by the localization - do we need to have two sub label types per language, one which is optimized for the space and another one that uses the whole available space.
- Layouting in whole UI - to which extent our navigation and transitions do take into account the localization.

Examples

Simple label:

            //simple label with text
            MLabel* label = new MLabel("Simple label");

            //set/change the text of label
            label->setText("Text");

Rich label:

            //rich label with bold text.
            MLabel* label = new MLabel("Rich <b>bold</b> label");

            //manual line changes in rich label
            label->setText("row1<br><i>row2</i><br>row3");

Rich label with custom text color:

            QString styledText = "<style>red{color:#FF0000;}</style> <red>Rich</red> label can be <red>styled</red>.";
            MLabel* label = new MLabel(styledText);

Links in rich label:

            //create label with a link
            QString text = "Rich label can contain <a href=\"http://www.nokia.com\"> links </a>.";
            MLabel* label = new MLabel(styledText);

            //connect to signal to receive notification when user clicks a link in label
            connect(label, SIGNAL(linkActivated(QString)), this, SLOT(linkActivated(QString)));

See also:: MLabelModel MLabelStyle Supported HTML Subset

Definition at line 122 of file corelib/widgets/mlabel.h.

Constructor & Destructor Documentation

MLabel::MLabel	(	QGraphicsItem *	parent = `0`,
		MLabelModel *	model = `0`
	)

Constructs label widget.

Parameters:

	parent	optional parent.
	model	optional model.

Definition at line 32 of file mlabel.cpp.

                                                        :
    MWidgetController(new MLabelPrivate, model == NULL ? new MLabelModel : model, parent)
{
    grabGesture(Qt::TapAndHoldGesture);
}

MLabel::MLabel	(	QString const &	text,
		QGraphicsItem *	parent = `0`
	)			`[explicit]`

Constructs a label with a text.

Parameters:

	text	Label text.
	parent	Optional parent.

Definition at line 38 of file mlabel.cpp.

                                                         :
    MWidgetController(new MLabelPrivate, new MLabelModel, parent)
{
    grabGesture(Qt::TapAndHoldGesture);
    setText(text);
}

Here is the call graph for this function:

MLabel::~MLabel ( ) [virtual]

Destructs label widget.

Definition at line 45 of file mlabel.cpp.

{
}

Member Function Documentation

void MLabel::addHighlighter ( MLabelHighlighter * highlighter )

Add highlighter object to mlabel.

See also:: MLabelHighlighter

Definition at line 165 of file mlabel.cpp.

{
    model()->addHighlighter(highlighter);
}

Here is the call graph for this function:

Qt::Alignment MLabel::alignment ( ) const

Returns the current alignmentation.

Returns:: alignment

QColor MLabel::color ( ) const

Returns the color previously set with setColor().

Returns:: current color

QFont MLabel::font ( ) const

Return the current font.

The current font is either a font previously set with setFont() or if nothing has been manually set the one that has been defined in css for this particular label.

Overrides QGraphicsWidget::font() const.

Returns:: current font

Definition at line 132 of file mlabel.cpp.

{
    if (!model()->useModelFont()) {
        if (view())
            return view()->font();
    }
    return model()->font();
}

Here is the call graph for this function:

void MLabel::linkActivated ( const QString & link ) [signal]

A signal which is emitted when an anchor in the label is clicked.

link contains the clicked link. The signal is only emitted when the link is defined using anchor "<a href=\"http://www.nokia.com"> nokia " html tag.

void MLabel::removeAllHighlighters ( )

Remove all highlighter objects from mlabel.

See also:: MLabelHighlighter

Definition at line 175 of file mlabel.cpp.

{
    model()->setHighlighters(QList<MLabelHighlighter *>());
}

Here is the call graph for this function:

void MLabel::removeHighlighter ( MLabelHighlighter * highlighter )

Remove highlighter object from mlabel.

See also:: MLabelHighlighter

Definition at line 170 of file mlabel.cpp.

{
    model()->removeHighlighter(highlighter);
}

Here is the call graph for this function:

void MLabel::setAlignment ( Qt::Alignment alignment )

Set an alignmentation for the text.

See also:: Qt::Alignment

Definition at line 80 of file mlabel.cpp.

{
    model()->setAlignment(alignment);
}

Here is the call graph for this function:

void MLabel::setColor ( const QColor & color )

Set the text color for the MLabel.

By default MLabel uses color defined in the css file. This method can be used to change the color from code. Giving invalid color (QColor()) takes font in the css back to use.

Definition at line 141 of file mlabel.cpp.

{
    model()->setColor(color);
}

Here is the call graph for this function:

void MLabel::setFont ( const QFont & font )

Set the font used in MLabel.

By default MLabel uses font defined in the css file. This method can be used to change the font from code.

Overrides QGraphicsWidget::setFont(const QFont &font)

Definition at line 125 of file mlabel.cpp.

{
    model()->setUseModelFont(true);
    model()->setFont(font);
    QGraphicsWidget::setFont(font);
}

Here is the call graph for this function:

void MLabel::setText ( const QString & text ) [slot]

Set text for the label.

Definition at line 75 of file mlabel.cpp.

{
    model()->setText(text);
}

Here is the call graph for this function:

void MLabel::setTextElide ( bool elide )

Enable/disable automatic text eliding.

If the label doesn't have enough space to show the full text on one line, the will be elided with three dots.

See also:: Qt::TextElideMode

Definition at line 115 of file mlabel.cpp.

{
    model()->setTextElide(elide);
}

Here is the call graph for this function:

void MLabel::setTextFormat ( Qt::TextFormat textFormat )

Set text format.

This function sets the format in which the label text is displayed. Calling this function with Qt::PlainText or Qt::RichText is used to turn off auto-recognition of text format, calling with Qt::AutoText turns auto-recognition back on.

Definition at line 155 of file mlabel.cpp.

{
    model()->setTextFormat(textFormat);
}

Here is the call graph for this function:

void MLabel::setWordWrap ( bool wrap )

Enable/disable automatic word wrapping.

If true, wrapping is done according to the mode set with setWrapMode.

Definition at line 95 of file mlabel.cpp.

{
    model()->setWordWrap(wrap);
}

Here is the call graph for this function:

void MLabel::setWrapMode ( QTextOption::WrapMode wrapMode )

Set word wrapping mode.

See also:: wrapMode

Definition at line 90 of file mlabel.cpp.

{
    model()->setWrapMode(wrapMode);
}

Here is the call graph for this function:

QString MLabel::text ( ) const

Returns the current text.

Returns:: text

bool MLabel::textElide ( ) const

Returns the elide mode of the label.

Returns:: elide mode of the label

See also:: Qt::TextElideMode

Qt::TextFormat MLabel::textFormat ( ) const

Returns the text format.

This method returns the format in which MLabel displays its text. Note that this function does not give information about the actual format of the label text string, only about the way it is displayed.

Returns:: text format

bool MLabel::wordWrap ( ) const

Returns whether the text in label will be wrapped or not.

If the label doesn't have enough space to show the full text on one line, the text will be wrapped to multiple lines.

Returns:: wrap mode

QTextOption::WrapMode MLabel::wrapMode ( ) const

Returns wrapping mode for the text in the label.

If the label doesn't have enough space to show the full text on one line, the text will be wrapped to multiple lines if a mode with wrapping behavior is active.

Returns:: wrap mode

Property Documentation

MLabel::alignment [read, write]

Alignmentation of the label.

See MLabelModel::alignment for details.

Definition at line 133 of file corelib/widgets/mlabel.h.

MLabel::color [read, write]

Color of the label text.

See MLabelModel::color for details.

Definition at line 171 of file corelib/widgets/mlabel.h.

MLabel::text [read, write]

Text of the label.

See MLabelModel::text for details.

Definition at line 163 of file corelib/widgets/mlabel.h.

MLabel::textElide [read, write]

Text eliding mode of the label.

See MLabelModel::textElide for details.

Definition at line 155 of file corelib/widgets/mlabel.h.

MLabel::textFormat [read, write]

Format the label text is displayed in.

This property is used for deciding whether a text string should be interpreted as plain text or rich text. Supported text formats are Qt::PlainText, Qt::RichText and Qt::AutoText. The default format is Qt::AutoText, which causes MLabel to guess the format of the text on a case-by-case basis.

Definition at line 182 of file corelib/widgets/mlabel.h.

MLabel::wordWrap [read, write]

Is word wrapping done or not.

Definition at line 139 of file corelib/widgets/mlabel.h.

QTextOption::WrapMode MLabel::wrapMode [read, write]

Definition at line 147 of file corelib/widgets/mlabel.h.

MLabel Class Reference

Public Slots

Signals

Public Member Functions

Properties

Detailed Description

Overview

Usage guidelines

Variants

Open issues

Examples

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation