Qt Reference Documentation

# Q3StyleSheet Class Reference

The Q3StyleSheet class is a collection of styles for rich text rendering and a generator of tags. More...

     #include <Q3StyleSheet>

This class is part of the Qt 3 support library. It is provided to keep old source code working. We strongly advise against using it in new code. See Porting to Qt 4 for more information.

Inherits: QObject.

- List of all members, including inherited members

## Public Functions

| Q3StyleSheet ( QObject * parent = 0, const char * name = 0 )
virtual | ~Q3StyleSheet ()
virtual void | error ( const QString & msg ) const
Q3StyleSheetItem * | item ( const QString & name )
const Q3StyleSheetItem * | item ( const QString & name ) const
virtual void | scaleFont ( QFont & font, int logicalSize ) const

- 29 public functions inherited from QObject

## Static Public Members

QString | convertFromPlainText ( const QString & plain, Q3StyleSheetItem::WhiteSpaceMode mode = Q3StyleSheetItem::WhiteSpacePre )
Q3StyleSheet * | defaultSheet ()
QString | escape ( const QString & plain )
bool | mightBeRichText ( const QString & text )
void | setDefaultSheet ( Q3StyleSheet * sheet )

- 7 static public members inherited from QObject

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 1 signal inherited from QObject
- 8 protected functions inherited from QObject

## Detailed Description

The Q3StyleSheet class is a collection of styles for rich text rendering and a generator of tags.

By creating Q3StyleSheetItem 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 Q3StyleSheet 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

Structuring tags | Notes
--- | ---

`<qt>`...`</qt>`

A Qt rich text document. It understands the following attributes:

- `title` -- The caption of the document. This attribute is easily accessible with QTextEdit::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`, which can be used to explain certain expressions in more detail in a few sentences. For `detail`, 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="granite.xpm"`. The pixmap name will be resolved by a Q3MimeSourceFactory().
- `text` -- The default text color, for example `text="red"`.
- `link` -- The link color, for example `link="green"`.

`<h1>...</h1>` | A top-level heading.
`<h2>...</h2>` | A sublevel heading.
`<h3>...</h3>` | A sub-sublevel heading.
`<p>...</p>` | A left-aligned paragraph. Adjust the alignment with the `align` attribute. Possible values are `left`, `right` and `center`.
`<center>...`<br>`</center>` | A centered paragraph.
`<blockquote>...`<br>`</blockquote>` | 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>`.
`<pre>...</pre>` | For larger chunks 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:

Anchor tags | Notes
--- | ---

`<a>...</a>`

An anchor or link.

- A link is created by using an `href` attribute, for example <br>`<a href="target.qml">Link Text</a>`. Links to targets within a document are achieved in the same way as for HTML, e.g. <br>`<a href="target.qml#subtitle">Link Text</a>`.
- A target is created by using a `name` attribute, for example <br>`<a name="subtitle"><h2>Sub Title</h2></a>`.

The default character style bindings are

Style tags | Notes
--- | ---
`<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.
`<sub>...</sub>` | Subscripted text
`<sup>...</sup>` | Superscripted text
`<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:

- `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 (`size=-2`). In the latter case the sizes are simply added.
- `face` -- The family of the font, for example `face=times`.

Special elements are:

Special tags | Notes
--- | ---

`<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 QImage::smoothScale()).

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 tags | Notes
--- | ---

`<table>...</table>`

A table. Tables support the following attributes:

- `bgcolor` -- The background color.
- `width` -- The table width. This is either an absolute pixel width or a relative percentage of the table's 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` -- Additional space around the contents of table cells. The default is 1.

`<tr>...</tr>`

A table row. This is only valid within a `table`. Rows support the following attribute:

- `bgcolor` -- The background color.

`<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:

- `bgcolor` -- The background color.
- `width` -- The cell width. This is either an absolute pixel width or a relative percentage of table's width, for example `width=50%`.
- `colspan` -- Specifies how many columns this cell spans. The default is 1.
- `rowspan` -- Specifies how many rows this cell spans. The default is 1.
- `align` -- Qt::Alignment; possible values are `left`, `right`, and `center`. The default is `left`.
- `valign` -- Qt::Vertical alignment; possible values are `top`, `middle`, and `bottom`. The default is `middle`.

## Member Function Documentation

### Q3StyleSheet::Q3StyleSheet ( QObject * parent = 0, const char * name = 0 )

Creates a style sheet called name, with parent parent. Like any QObject it will be deleted when its parent is destroyed (if the child still exists).

By default the style sheet has the tag definitions defined above.

### Q3StyleSheet::~Q3StyleSheet ()`[virtual]`

Destroys the style sheet. All styles inserted into the style sheet will be deleted.

### QString Q3StyleSheet::convertFromPlainText ( const QString & plain, Q3StyleSheetItem::WhiteSpaceMode mode = Q3StyleSheetItem::WhiteSpacePre )`[static]`

Auxiliary function. Converts the plain text string plain to a rich text formatted paragraph while preserving most of its look.

mode defines the whitespace mode. Possible values are `Q3StyleSheetItem::WhiteSpacePre` (no wrapping, all whitespaces preserved) and Q3StyleSheetItem::WhiteSpaceNormal (wrapping, simplified whitespaces).

See also escape().

### Q3StyleSheet * Q3StyleSheet::defaultSheet ()`[static]`

Returns the application-wide default style sheet. This style sheet is used by rich text rendering classes such as QSimpleRichText, QWhatsThis and QMessageBox to define the rendering style and available tags within rich text documents. It also serves as the initial style sheet for the more complex render widgets, QTextEdit and QTextBrowser.

See also setDefaultSheet().

### void Q3StyleSheet::error ( const QString & msg ) const`[virtual]`

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.

### QString Q3StyleSheet::escape ( const QString & plain )`[static]`

Auxiliary function. Converts the plain text string plain to a rich text formatted string with any HTML meta-characters escaped.

See also convertFromPlainText().

### Q3StyleSheetItem * Q3StyleSheet::item ( const QString & name )

Returns the style called name or 0 if there is no such style.

### const Q3StyleSheetItem * Q3StyleSheet::item ( const QString & name ) const

This is an overloaded function.

Returns the style called name or 0 if there is no such style (const version)

### bool Q3StyleSheet::mightBeRichText ( const QString & text )`[static]`

Returns true if the string text is likely to be rich text; otherwise returns false.

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.

### void Q3StyleSheet::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.

Logical font sizes range from 1 to 7, with 1 being the smallest.

See also Q3StyleSheetItem::logicalFontSize(), Q3StyleSheetItem::logicalFontSizeStep(), and QFont::setPointSize().

### void Q3StyleSheet::setDefaultSheet ( Q3StyleSheet * sheet )`[static]`

Sets the application-wide default style sheet to sheet, deleting any style sheet previously set. The ownership is transferred to Q3StyleSheet.

See also defaultSheet().