]> icculus.org git repositories - duncan/yast2-qt4.git/blob - doc/richtext.txt
remove automake support now that the spec file should be
[duncan/yast2-qt4.git] / doc / richtext.txt
1 The RichText widget in the Qt UI currently supports the tags listed
2 below. Note that not all of them will make sense for use within YaST.
3 (Most notably all those which refer to files)
4
5      * <qt>...</qt> - A Qt rich text document. It understands the
6        following attributes
7           + title - the caption of the document. This attribute is easily
8             accessible with [25]QTextView::documentTitle()
9           + type - The type of the document. The default type is page .
10             It indicates that the document is displayed in a page of its
11             own. Another style is detail. It can be used to explain
12             certain expressions more detailed in a few sentences. The
13             QTextBrowser will then keep the current page and display the
14             new document in a small popup similar to QWhatsThis. Note
15             that links will not work in documents with <qt type="detail"
16             >...</qt>
17           + bgcolor - The background color, for example bgcolor="yellow"
18             or bgcolor="#0000FF"
19           + background - The background pixmap, for example
20             background="granit.xpm". The pixmap name will be resolved by
21             a [26]QMimeSourceFactory().
22           + text - The default text color, for example text="red"
23           + link - The link color, for example link="green"
24      * <a>...</a> - An anchor or link. The reference target is defined in
25        the href attribute of the tag as in \c<a
26        href="target.qml">...</a>. You can also specify an additional
27        anchor within the specified target document, for example <a
28        href="target.qml#123">...</a>. If a is meant to be an anchor, the
29        reference source is given in the name attribute.
30      * <font>...</font> - Customizes the font size and text color. The
31        tag understands two attributes:
32           + color - the text color, for example color="red" or
33             color="#FF0000".
34           + size - the logical size of the font. Logical sizes 1 to 7 are
35             supported. The value may either be absolute, for example
36             size=3, or relative. In the latter case, the sizes are simply
37             added.
38      * <em>...</em> - Emphasized. As default, this is the same as
39        <i>...</i> (Italic)
40      * <strong>...</strong> - Strong. As default, this is the same as
41        <bold>...</bold> (bold)
42      * <big>...</big> - A larger font size.
43      * <small>...</small> - A smaller font size.
44      * <code>...</code> - Indicates Code. As default, this is the same as
45        <tt>...</tt> (typewriter)
46      * <pre>...</pre> - For larger junks of code. Whitespaces in the
47        contents are preserved.
48      * <large>...</large> - Large font size.
49      * <b>...</b> - Bold font style.
50      * <h1>...</h1> - A top-level heading.
51      * <h2>...</h2> - A sub-level heading.
52      * <h3>...</h3> - A sub-sub-level heading.
53      * <p>...</p> - A paragraph.
54      * <center>...</center> - A centered paragraph.
55      * <blockquote>...</blockquote> - An indented paragraph, useful for
56        quotes.
57      * <multicol cols=n >...</multicol> - Multicol display with n columns
58      * <twocolumn>...</twocolumn> - Two-column display.
59      * <ul>...</ul> - An un-ordered list. You can also pass a type
60        argument to define the bullet style. The default is type=disc,
61        other types are circle and square.
62      * <ol>...</ol> - An ordered list. You can also pass a type argument
63        to define the enumeration label style. The default is type="1",
64        other types are "a" and "A".
65      * <li>...</li> - A list item.
66      * <img/> - An image. The image name for the mime source factory is
67        given in the source attribute, for example <img source="qt.xpm"/>
68        The image tag also understands the attributes width and height
69        that determine the size of the image. If the pixmap does not fit
70        to the specified size, it will be scaled automatically.
71      * <br/> - A line break
72      * <hr/> - A horizonal line