A collection of styles for rich text rendering and a generator of tags. More...
#include <qstylesheet.h>
Inherits QObject.
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:
<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"
<a>...</a>
- An anchor or link. The reference target is defined in the
href
attribute of the tag as in \c<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.
<font>...</font>
- Customizes the font size and text color. The tag understands two 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. In the latter case, the sizes are simply added.
<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)
<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)
<pre>...</pre>
- For larger junks of code. Whitespaces in the contents are preserved.
<large>...</large>
- Large font size.
<b>...</b>
- style->setFontWeight( QFont::Bold);
Bold font style.
<h1>...</h1>
- A top-level heading.
<h2>...</h2>
- A sub-level heading.
<h3>...</h3>
- A sub-sub-level heading.
<p>...</p>
- A paragraph.
<center>...</center>
- A centered paragraph.
<blockquote>...</blockquote>
- An indented paragraph, useful for quotes.
<multicol cols=n >...</multicol>
- Multicol display with n columns
<twocolumn>...</twocolumn>
- Two-column display.
<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.
<img/>
- An image. The image name for the mime source
factory is given in the source attribute, for example
<img source="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 to the specified
size, it will be scaled automatically ( by using QImage::smoothScale() ).
<br/>
- A line break
<hr/>
- A horizonal line
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.
[virtual]
Destroys the style sheet. All styles inserted into the style sheet will be deleted.
[static]
Auxiliary function. Converts the plain text string plain to a rich text formatted string while preserving its look.
[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().
Examples: qbrowser/main.cpp
[virtual]
This virtual function is called when an error occurs when processsing 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.
For internal use only.
Returns the style with name name or 0 if there is no such style.
Returns the style with name name or 0 if there is no such style (const version).
[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.
[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: logicalFontSize(), logicalFontSizeStep() and QFont::setPointSize().
[static]
Sets the application-wide default style sheet, deleting any style sheet previously set. The ownership is transferred.
See also: defaultSheet().
[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.
Search the documentation, FAQ, qt-interest archive and more (uses
www.troll.no):
This file is part of the Qt toolkit, copyright © 1995-99 Troll Tech, all rights reserved.
Copyright İ 1999 Troll Tech | Trademarks | Qt version 2.0.2
|