|Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions|
The QStyleSheet class is a collection of styles for rich text rendering and a generator of tags. More...
List of all member functions.
By creating QStyleSheetItem objects for a style sheet you build a definition of a set of tags. This definition will be used by the internal rich text rendering system to parse and display text documents to which the style sheet applies. Rich text is normally visualized in a QTextEdit or a QTextBrowser. However, QLabel, QWhatsThis and QMessageBox also support it, and other classes are likely to follow. With QSimpleRichText it is possible to use the rich text renderer for custom widgets as well.
The default QStyleSheet object has the following style bindings, sorted by structuring bindings, anchors, character style bindings (i.e. inline styles), special elements such as horizontal lines or images, and other tags. In addition, rich text supports simple HTML tables.
The structuring tags are
|<qt>...</qt>||A Qt rich text document. It understands the following
|<h1>...</h1>||A top-level heading.|
|<h2>...</h2>||A sublevel heading.|
|<h3>...</h3>||A sub-sublevel heading.|
|<h4>...</h4> <h5>...</h5>||Headings of lesser importance.|
|<p>...</p>||A left-aligned paragraph. Adjust the alignment with the align attribute. Possible values are left, right and center.|
|A centered paragraph.|
|An indented paragraph that is useful for quotes.|
|<ul>...</ul>||An unordered list. You can also pass a type argument to define the bullet style. The default is type=disc; other types are circle and square.|
|<ol>...</ol>||An ordered list. You can also pass a type argument to define the enumeration label style. The default is type="1"; other types are "a" and "A".|
|<li>...</li>||A list item. This tag can be used only within the context of <ol> or <ul>.|
|<dl>...</dl>||A list of definitions, consisting of terms and descriptions.|
|<dt>...</dt>||A term in a list of definitions. This tag can be used only in the context of <dl>...</dl>.|
|<dd>...</dd>||A description in a list of definitions. This tag can be used only in the context of <dl>...</dl>.|
|<pre>...</pre>||For larger chunks of code. Whitespaces in the contents are preserved. For small bits of code use the inline-style code.|
|<div>...</div> and <span>...</span>||Block grouping elements. These are used to structure the document, and are often used to provide hints about the intended presentation of the document.|
Anchors and links are done with a single tag:
|<a>...</a>||An anchor or link.
The default character style bindings are
|<em>...</em>||Emphasized. By default this is the same as <i>...</i> (italic).|
|<strong>...</strong>||Strong. By default this is the same as <b>...</b> (bold).|
|<i>...</i>||Italic font style.|
|<b>...</b>||Bold font style.|
|<u>...</u>||Underlined font style.|
|<s>...</s>||Strike out font style.|
|<big>...</big>||A larger font size.|
|<small>...</small>||A smaller font size.|
|<code>...</code>||Indicates code. By default this is the same as <tt>...</tt> (typewriter). For larger chunks of code use the block-tag <pre>.|
|<tt>...</tt>||Typewriter font style.|
|<font>...</font>||Customizes the font size, family and text color. The tag
understands the following attributes:
Special elements are:
|<img>||An image. The image name for the mime source factory is
given in the source attribute, for example
<img src="qt.xpm"> The image tag also understands the
attributes width and height that determine the size
of the image. If the pixmap does not fit the specified
size it will be scaled automatically (by using
The align attribute determines where the image is placed. By default, an image is placed inline just like a normal character. Specify left or right to place the image at the respective side.
|<hr>||A horizontal line.|
|<br>||A line break.|
|<nobr>...</nobr>||No break. Prevents word wrap.|
In addition, rich text supports simple HTML tables. A table consists of one or more rows each of which contains one or more cells. Cells are either data cells or header cells, depending on their content. Cells which span rows and columns are supported.
|<table>...</table>||A table. Tables support the following attributes:
|<tr>...</tr>||A table row. This is only valid within a table. Rows
support the following attribute:
|<th>...</th>||A table header cell. Similar to td, but defaults to center alignment and a bold font.|
|<td>...</td>||A table data cell. This is only valid within a tr.
Cells support the following attributes:
See also Graphics Classes, Help System, and Text Related Classes.
By default the style sheet has the tag definitions defined above.
mode defines the whitespace mode. Possible values are QStyleSheetItem::WhiteSpacePre (no wrapping, all whitespaces preserved) and QStyleSheetItem::WhiteSpaceNormal (wrapping, simplified whitespaces).
See also escape().
Examples: action/application.cpp, application/application.cpp, and mdi/application.cpp.
See also setDefaultSheet().
This virtual function is called when an error occurs when processing rich text. Reimplement it if you need to catch error messages.
Errors might occur if some rich text strings contain tags that are not understood by the stylesheet, if some tags are nested incorrectly, or if tags are not closed properly.
msg is the error message.
See also convertFromPlainText().
Returns the style called name or 0 if there is no such style (const version)
This function uses a fast and therefore simple heuristic. It mainly checks whether there is something that looks like a tag before the first line break. Although the result may be correct for common cases, there is no guarantee.
When calling this function, font has a point size corresponding to the logical font size 3.
Logical font sizes range from 1 to 7, with 1 being the smallest.
See also QStyleSheetItem::logicalFontSize(), QStyleSheetItem::logicalFontSizeStep(), and QFont::setPointSize().
See also defaultSheet().
This function is under development and is subject to change.
Generates an internal object for the tag called name, given the attributes attr, and using additional information provided by the mime source factory factory.
context is the optional context of the document, i.e. the path to look for relative links. This becomes important if the text contains relative references, for example within image tags. QSimpleRichText always uses the default mime source factory (see QMimeSourceFactory::defaultFactory()) to resolve these references. The context will then be used to calculate the absolute path. See QMimeSourceFactory::makeAbsolute() for details.
emptyTag and doc are for internal use only.
This function should not be used in application code.
This file is part of the Qt toolkit. Copyright © 1995-2007 Trolltech. All Rights Reserved.