From ea318d1431c89e647598c510c4245c6571aa5f46 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Thu, 26 Jan 2012 23:32:43 -0600 Subject: Update to latest tqt3 automated conversion --- doc/html/qstylesheet.html | 383 ---------------------------------------------- 1 file changed, 383 deletions(-) delete mode 100644 doc/html/qstylesheet.html (limited to 'doc/html/qstylesheet.html') diff --git a/doc/html/qstylesheet.html b/doc/html/qstylesheet.html deleted file mode 100644 index d79b47af8..000000000 --- a/doc/html/qstylesheet.html +++ /dev/null @@ -1,383 +0,0 @@ - - - - - -TQStyleSheet Class - - - - - - - -
- -Home - | -All Classes - | -Main Classes - | -Annotated - | -Grouped Classes - | -Functions -

TQStyleSheet Class Reference

- -

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

#include <qstylesheet.h> -

Inherits TQObject. -

List of all member functions. -

Public Members

- -

Static Public Members

- -

Detailed Description

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

- -

By creating TQStyleSheetItem 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 TQTextEdit or a TQTextBrowser. However, TQLabel, -TQWhatsThis and TQMessageBox also support it, and other classes are -likely to follow. With TQSimpleRichText it is possible to use the -rich text renderer for custom widgets as well. -

The default TQStyleSheet 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 TQt rich text document. It understands the following -attributes: -
    -
  • title -- The caption of the document. This attribute is -easily accessible with TQTextEdit::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, TQTextBrowser will then keep -the current page and display the new document in a small -popup similar to TQWhatsThis. 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 TQMimeSourceFactory(). -
  • 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. -
<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. -
<center>...
</center> -		A centered paragraph. -
<blockquote>...
</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>. -
<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: -

-
Anchor tags Notes -
<a>...</a> -An anchor or link. -
    -
  • A link is created by using an href -attribute, for example -
    <a href="target.qml">Link Text</a>. Links to -targets within a document are achieved in the same way -as for HTML, e.g. -
    <a href="target.qml#subtitle">Link Text</a>. -
  • A target is created by using a name -attribute, for example -
    <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 -TQImage::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 -- Alignment; possible values are left, right, and center. The default is left. -
  • valign -- Vertical alignment; possible values are top, middle, and bottom. The default is middle. -
-
-

See also Graphics Classes, Help System, and Text Related Classes. - -

Member Function Documentation

-

TQStyleSheet::TQStyleSheet ( TQObject * parent = 0, const char * name = 0 ) -

-Creates a style sheet called name, with parent parent. Like -any TQObject 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. - -

TQStyleSheet::~TQStyleSheet () [virtual] -

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

TQString TQStyleSheet::convertFromPlainText ( const TQString & plain, TQStyleSheetItem::WhiteSpaceMode mode = TQStyleSheetItem::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 TQStyleSheetItem::WhiteSpacePre (no wrapping, all whitespaces -preserved) and TQStyleSheetItem::WhiteSpaceNormal (wrapping, -simplified whitespaces). -

See also escape(). - -

Examples: action/application.cpp, application/application.cpp, and mdi/application.cpp. -

TQStyleSheet * TQStyleSheet::defaultSheet () [static] -

-Returns the application-wide default style sheet. This style sheet -is used by rich text rendering classes such as TQSimpleRichText, -TQWhatsThis and TQMessageBox 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, TQTextEdit -and TQTextBrowser. -

See also setDefaultSheet(). - -

void TQStyleSheet::error ( const TQString & 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. - -

TQString TQStyleSheet::escape ( const TQString & 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(). - -

TQStyleSheetItem * TQStyleSheet::item ( const TQString & name ) -

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

const TQStyleSheetItem * TQStyleSheet::item ( const TQString & name ) const -

-This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -

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

bool TQStyleSheet::mightBeRichText ( const TQString & 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 TQStyleSheet::scaleFont ( TQFont & 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 TQStyleSheetItem::logicalFontSize(), TQStyleSheetItem::logicalFontSizeStep(), and TQFont::setPointSize(). - -

void TQStyleSheet::setDefaultSheet ( TQStyleSheet * sheet ) [static] -

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

See also defaultSheet(). - -

TQTextCustomItem * TQStyleSheet::tag ( const TQString & name, const TQMap<TQString, TQString> & attr, const TQString & context, const TQMimeSourceFactory & factory, bool emptyTag, TQTextDocument * doc ) const [virtual] -

-

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. -TQSimpleRichText always uses the default mime source factory (see -TQMimeSourceFactory::defaultFactory()) to resolve these -references. The context will then be used to calculate the -absolute path. See TQMimeSourceFactory::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 TQt toolkit. -Copyright © 1995-2007 -Trolltech. All Rights Reserved.

- -
Copyright © 2007 -TrolltechTrademarks -
TQt 3.3.8
-
- -- cgit v1.2.1