QStyleSheet Class Reference
A collection of styles for rich text rendering and a generator of tags.
More...
#include <qstylesheet.h>
Inherits QObject.
List of all member functions.
Public Members
Static Public Members
Detailed Description
A collection of styles for rich text rendering and a generator of tags.
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 QTextView or a QTextBrowser. But also QLabel,
QWhatsThis and QMessageBox support it for now, with others 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 like 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 attributes
-
title
- the caption of the document. This attribute is easily accessible with
QTextView::documentTitle()
-
type
- The type of the document. The default type is page . It indicates that
the document is displayed in a page of its own. Another style is detail.
It can be used to explain certain expressions more detailed in a few
sentences. The QTextBrowser will then keep the current page and display the
new document in a small popup similar to QWhatsThis. Note that links
will not work in documents with <qt type="detail" >...</qt>
-
bgcolor
- The background color, for example bgcolor="yellow" or bgcolor="#0000FF"
-
background
- The background pixmap, for example background="granit.xpm". The pixmap name
will be resolved by a QMimeSourceFactory().
-
text
- The default text color, for example text="red"
-
link
- The link color, for example link="green"
<title>...</h1>
- The title of the page, equivalent to <qt title="..." >.
<h1>...</h1>
- A top-level heading.
<h2>...</h2>
- A sub-level heading.
<h3>...</h3>
- A sub-sub-level heading.
<p>...</p>
- A left-aligned paragraph. Adjust the alignment with
the align attribute. Possible values are
left, right and center.
<center>...</center>
- A centered paragraph.
<blockquote>...</blockquote>
- An indented paragraph, useful for quotes.
<ul>...</ul>
- An un-ordered 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 only be used within the context of
ol or ul.
<pre>...</pre>
- For larger junks of code. Whitespaces in the contents are preserved.
For small bits of code, use the inline-style code.
Anchors and links are done with a single tag:
<a>...</a>
- An anchor or link. The reference target is defined in the
href attribute of the tag as in <a href="target.qml">...</a>.
You can also specify an additional anchor within the specified target document, for
example <a href="target.qml#123">...</a>. If
a is meant to be an anchor, the reference source is given in
the name attribute.
The default character style bindings are:
<em>...</em>
- Emphasized. As default, this is the same as <i>...</i> (Italic)
<strong>...</strong>
- Strong. As default, this is the same as <bold>...</bold> (bold).
<i>...</i>
- Italic font style.
<b>...</b>
- Bold font style.
<u>...</u>
- Underlined font style.
<big>...</big>
- A larger font size.
<small>...</small>
- A smaller font size.
<code>...</code>
- Indicates Code. As default, this is the same as <tt>...</tt> (typewriter). For
larger junks 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:
-
color
- the text color, for example color="red" or color="#FF0000".
-
size
- the logical size of the font. Logical sizes 1 to 7 are supported.
The value may either be absolute, for example
size=3, or relative like size=-2. In the latter case, the sizes
are simply added.
-
face
- the family of the font, for example face=times.
Special elements are:
Other tags not in any of the above categories are:
<nobr>...</nobr>
- No break. Prevents word wrap.
In addition, rich text supports simple HTML tables. A table consists
of a set of rows where each row contains some number of cells. Cells
are either data cells or header cells, depending on their
content. Usually a cell fills one rectangle in the table grid. It
may, however, also span several rows, columns or both.
<table>...</table>
- A table definition.
The default table is frameless. Specify the boolean attribute
border in order to get a frame. Other attributes are:
bgcolor
- The background color
-
width
- The table width. This is either absolute in pixels or relative
in percent of the column width, for example width=80%
-
border
- The width of the table border. The default is 0 (= no border).
-
cellspacing
- Additional space around the table cells. The default is 2.
-
cellpadding
- Additinal space around the contents of table cells. Default is 1.
<tr>...</tr>
- A table row. Can only be used within table. Understands the attribute
bgcolor
- The background color
<td>...</td>
- A table data cell. Can only be used within tr. Understands the attributes
bgcolor
- The background color
-
width
- The cell width. This is either absolute in pixels or relative
in percent of the entire table width, for example width=50%
-
colspan
- Defines how many columns this cell spans. The default is 1.
-
rowspan
- Defines how many rows this cell spans. The default is 1.
-
align
- Alignment, possible values are left, right and center. The
default is left-aligned.
<th>...</th>
- A table header cell. Like td but defaults to center-alignment
and a bold font.
Member Function Documentation
QStyleSheet::QStyleSheet ( QObject * parent=0, const char * name=0 )
Create a style sheet. Like any QObject, the created object will be
deleted when its parent destructs (if the child still exists then).
By default, the style sheet has the tag definitions defined above.
QStyleSheet::~QStyleSheet () [virtual]
Destructs the style sheet. All styles inserted into the style sheet
will be deleted.
QString QStyleSheet::convertFromPlainText ( const QString & plain ) [static]
Auxiliary function. Converts the plain text string plain to a
rich text formatted string while preserving its look.
QStyleSheet* QStyleSheet::defaultSheet () [static]
Returns the application-wide default style sheet.This style sheet is
used by rich text rendering classes such as QSimpleRichText,
QWhatsThis and also QMessageBox to define the rendering style and
available tags within rich text documents. It serves also as initial
style sheet for the more complex render widgets QTextView and
QTextBrowser.
See also setDefaultSheet().
void QStyleSheet::error ( const QString & msg ) const [virtual]
This virtual function is called when an error occurs when
processing rich text. Reimplement if 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 wrongly or
if tags are not closed properly.
msg is the error message.
Returns the style with name name or 0 if there is no such style.
const QStyleSheetItem* QStyleSheet::item ( const QString & name ) const
Returns the style with name name or 0 if there is no such style (const version).
bool QStyleSheet::mightBeRichText ( const QString & text ) [static]
Returns whether the string text is likely to be rich text
formatted.
Note: The 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. While the result may be correct for
most common cases, there is no guarantee.
void QStyleSheet::scaleFont ( QFont & font, int logicalSize ) const [virtual]
Scales the font font to the appropriate physical point size
corresponding to the logical font size logicalSize.
When calling this function, font has a point size corresponding to
the logical font size 3.
Typical logical font sizes range from 1 to 7, with 1 being the smallest.
See also QStyleSheetItem::logicalFontSize(), QStyleSheetItem::logicalFontSizeStep() and QFont::setPointSize().
void QStyleSheet::setDefaultSheet ( QStyleSheet * sheet ) [static]
Sets the application-wide default style sheet, deleting any style
sheet previously set. The ownership is transferred.
See also defaultSheet().
QTextCustomItem* QStyleSheet::tag ( const QString & name, const QMap<QString, QString> & attr, const QString & context, const QMimeSourceFactory & factory, bool = FALSE ) const [virtual]
Generates an internal object for tag named name, given the
attributes attr, and using additional information provided
by the mime source factory factory .
This function should not (yet) be used in application code.
void QStyleSheet::insert ( QStyleSheetItem * style )
For internal use only.
Search the documentation, FAQ, qt-interest archive and more (uses
www.trolltech.com):
This file is part of the Qt toolkit,
copyright © 1995-2005
Trolltech, all rights reserved.
