From 72eb74051ed8f1b7696041e241ab99df3af5b08d Mon Sep 17 00:00:00 2001 From: leseb Date: Mon, 15 Jul 2002 23:22:50 +0000 Subject: Sync with Qt 3.0.5 --- (limited to 'noncore/apps/opie-write/qstylesheet.cpp') diff --git a/noncore/apps/opie-write/qstylesheet.cpp b/noncore/apps/opie-write/qstylesheet.cpp index 7ab9ec6..67cd828 100644 --- a/noncore/apps/opie-write/qstylesheet.cpp +++ b/noncore/apps/opie-write/qstylesheet.cpp @@ -54,6 +54,7 @@ public: QStyleSheetItem::DisplayMode disp; int fontitalic; int fontunderline; + int fontstrikeout; int fontweight; int fontsize; int fontsizelog; @@ -78,66 +79,74 @@ public: } /*! - \class QStyleSheetItem qstylesheet.h - \ingroup text - \brief The QStyleSheetItem class provides an encapsulation of a set of text styles. - - A style sheet item consists of a name and a set of attributes that - specifiy its font, color, etc. When used in a \link QStyleSheet - style sheet\endlink (see styleSheet()), items define the name() of a - rich text tag and the display property changes associated with it. - - The \link QStyleSheetItem::DisplayMode display mode\endlink - attribute indicates whether the item is a block, an inline element - or a list element; see setDisplayMode(). The treatment of whitespace - is controlled by the \link QStyleSheetItem::WhiteSpaceMode white - space mode\endlink; see setWhiteSpaceMode(). An item's margins are - set with setMargin(), and line spacing is set with setLineSpacing(). - In the case of list items, the list style is set with - setListStyle(). An item may be a hypertext link anchor; see - setAnchor(). Other attributes are set with setAlignment(), - setVerticalAlignment(), setFontFamily(), setFontSize(), - setFontWeight(), setFontItalic(), setFontUnderline() and setColor(). + \class QStyleSheetItem qstylesheet.h + \brief The QStyleSheetItem class provides an encapsulation of a set of text styles. + + \ingroup text + + A style sheet item consists of a name and a set of attributes that + specifiy its font, color, etc. When used in a \link QStyleSheet + style sheet\endlink (see styleSheet()), items define the name() of + a rich text tag and the display property changes associated with + it. + + The \link QStyleSheetItem::DisplayMode display mode\endlink + attribute indicates whether the item is a block, an inline element + or a list element; see setDisplayMode(). The treatment of + whitespace is controlled by the \link + QStyleSheetItem::WhiteSpaceMode white space mode\endlink; see + setWhiteSpaceMode(). An item's margins are set with setMargin(), + In the case of list items, the list style is set with + setListStyle(). An item may be a hypertext link anchor; see + setAnchor(). Other attributes are set with setAlignment(), + setVerticalAlignment(), setFontFamily(), setFontSize(), + setFontWeight(), setFontItalic(), setFontUnderline(), + setFontStrikeOut and setColor(). */ /*! \enum QStyleSheetItem::AdditionalStyleValues \internal */ -/*! \enum QStyleSheetItem::WhiteSpaceMode +/*! + \enum QStyleSheetItem::WhiteSpaceMode - This enum defines the ways in which QStyleSheet can treat whitespace. There are three values at present: + This enum defines the ways in which QStyleSheet can treat + whitespace. - \value WhiteSpaceNormal any sequence of whitespace (including - line-breaks) is equivalent to a single space. + \value WhiteSpaceNormal any sequence of whitespace (including + line-breaks) is equivalent to a single space. - \value WhiteSpacePre whitespace must be output exactly as given - in the input. + \value WhiteSpacePre whitespace must be output exactly as given + in the input. - \value WhiteSpaceNoWrap multiple spaces are collapsed as with - WhiteSpaceNormal, but no automatic line-breaks occur. To break lines manually, - use the \c{
} tag. + \value WhiteSpaceNoWrap multiple spaces are collapsed as with + WhiteSpaceNormal, but no automatic line-breaks occur. To break + lines manually, use the \c{
} tag. */ -/*! \enum QStyleSheetItem::Margin - - \value MarginLeft left margin - \value MarginRight right margin - \value MarginTop top margin - \value MarginBottom bottom margin - \value MarginAll all margins (left, right, top and bottom) - \value MarginVertical top and bottom margins - \value MarginHorizontal left and right margins - \value MarginFirstLine margin (indentation) of the first line of a paragarph (in addition to the MarginLeft of the paragraph) +/*! + \enum QStyleSheetItem::Margin + + \value MarginLeft left margin + \value MarginRight right margin + \value MarginTop top margin + \value MarginBottom bottom margin + \value MarginAll all margins (left, right, top and bottom) + \value MarginVertical top and bottom margins + \value MarginHorizontal left and right margins + \value MarginFirstLine margin (indentation) of the first line of + a paragarph (in addition to the MarginLeft of the paragraph) */ /*! - Constructs a new style named \a name for the stylesheet \a parent. + Constructs a new style called \a name for the stylesheet \a + parent. - All properties in QStyleSheetItem are initially in the "do not change" state, - except \link QStyleSheetItem::DisplayMode display mode\endlink, which defaults - to \c DisplayInline. + All properties in QStyleSheetItem are initially in the "do not + change" state, except \link QStyleSheetItem::DisplayMode display + mode\endlink, which defaults to \c DisplayInline. */ QStyleSheetItem::QStyleSheetItem( QStyleSheet* parent, const QString& name ) { @@ -150,9 +159,9 @@ QStyleSheetItem::QStyleSheetItem( QStyleSheet* parent, const QString& name ) } /*! - Copy constructor. Constructs a copy of \a other that is - not bound to any style sheet. - */ + Copy constructor. Constructs a copy of \a other that is not bound + to any style sheet. +*/ QStyleSheetItem::QStyleSheetItem( const QStyleSheetItem & other ) { d = new QStyleSheetItemData; @@ -161,9 +170,9 @@ QStyleSheetItem::QStyleSheetItem( const QStyleSheetItem & other ) /*! - Destroys the style. Note that QStyleSheetItem objects become owned - by QStyleSheet when they are created. - */ + Destroys the style. Note that QStyleSheetItem objects become + owned by QStyleSheet when they are created. +*/ QStyleSheetItem::~QStyleSheetItem() { delete d; @@ -172,8 +181,8 @@ QStyleSheetItem::~QStyleSheetItem() /*! - Returns the style sheet this item is in. - */ + Returns the style sheet this item is in. +*/ QStyleSheet* QStyleSheetItem::styleSheet() { return d->sheet; @@ -181,8 +190,9 @@ QStyleSheet* QStyleSheetItem::styleSheet() /*! \overload - Returns the style sheet this item is in. - */ + + Returns the style sheet this item is in. +*/ const QStyleSheet* QStyleSheetItem::styleSheet() const { return d->sheet; @@ -198,6 +208,7 @@ void QStyleSheetItem::init() d->fontitalic = Undefined; d->fontunderline = Undefined; + d->fontstrikeout = Undefined; d->fontweight = Undefined; d->fontsize = Undefined; d->fontsizelog = Undefined; @@ -212,14 +223,14 @@ void QStyleSheetItem::init() d->margin[2] = Undefined; d->margin[3] = Undefined; d->margin[4] = Undefined; - d->list = QStyleSheetItem::ListDisc; - d->whitespacemode = QStyleSheetItem::WhiteSpaceNormal; + d->list = (ListStyle) Undefined; + d->whitespacemode = (WhiteSpaceMode) Undefined; d->selfnest = TRUE; d->lineSpacing = Undefined; } /*! - Returns the name of the style item. + Returns the name of the style item. */ QString QStyleSheetItem::name() const { @@ -227,36 +238,37 @@ QString QStyleSheetItem::name() const } /*! - Returns the \link QStyleSheetItem::DisplayMode display mode\endlink - of the style. + Returns the \link QStyleSheetItem::DisplayMode display + mode\endlink of the style. - \sa setDisplayMode() - */ + \sa setDisplayMode() +*/ QStyleSheetItem::DisplayMode QStyleSheetItem::displayMode() const { return d->disp; } -/*! \enum QStyleSheetItem::DisplayMode +/*! + \enum QStyleSheetItem::DisplayMode - This enum type defines the way adjacent elements are displayed. The possible values are: + This enum type defines the way adjacent elements are displayed. - \value DisplayBlock elements are displayed as a rectangular block - (e.g. \c{

...

}). + \value DisplayBlock elements are displayed as a rectangular block + (e.g. \c{

...

}). - \value DisplayInline elements are displayed in a horizontally flowing - sequence (e.g. \c{...}). + \value DisplayInline elements are displayed in a horizontally + flowing sequence (e.g. \c{...}). - \value DisplayListItem elements are displayed in a vertical sequence - (e.g. \c{
  • ...
    • }). + \value DisplayListItem elements are displayed in a vertical + sequence (e.g. \c{
  • ...
    • }). - \value DisplayNone elements are not displayed at all. + \value DisplayNone elements are not displayed at all. */ /*! - Sets the display mode of the style to \a m. + Sets the display mode of the style to \a m. - \sa displayMode() + \sa displayMode() */ void QStyleSheetItem::setDisplayMode(DisplayMode m) { @@ -265,24 +277,25 @@ void QStyleSheetItem::setDisplayMode(DisplayMode m) /*! - Returns the alignment of this style. Possible values are AlignAuto, AlignLeft, - AlignRight, AlignCenter and AlignJustify. + Returns the alignment of this style. Possible values are \c + AlignAuto, \c AlignLeft, \c AlignRight, \c AlignCenter or \c + AlignJustify. - \sa setAlignment(), Qt::AlignmentFlags - */ + \sa setAlignment(), Qt::AlignmentFlags +*/ int QStyleSheetItem::alignment() const { return d->align; } /*! - Sets the alignment to \a f. This only makes sense for styles with a - \link QStyleSheetItem::DisplayMode display mode\endlink of - DisplayBlock. Possible values are AlignAuto, AlignLeft, AlignRight, - AlignCenter and AlignJustify. + Sets the alignment to \a f. This only makes sense for styles with + a \link QStyleSheetItem::DisplayMode display mode\endlink of + DisplayBlock. Possible values are \c AlignAuto, \c AlignLeft, + \c AlignRight, \c AlignCenter or \c AlignJustify. - \sa alignment(), displayMode(), Qt::AlignmentFlags - */ + \sa alignment(), displayMode(), Qt::AlignmentFlags +*/ void QStyleSheetItem::setAlignment( int f ) { d->align = f; @@ -290,40 +303,41 @@ void QStyleSheetItem::setAlignment( int f ) /*! - Returns the vertical alignment of the style. Possible values are - VAlignBaseline, VAlignSub and VAlignSuper. + Returns the vertical alignment of the style. Possible values are + \c VAlignBaseline, \c VAlignSub or \c VAlignSuper. - psa setVerticalAlignment() - */ + \sa setVerticalAlignment() +*/ QStyleSheetItem::VerticalAlignment QStyleSheetItem::verticalAlignment() const { return d->valign; } -/*! \enum QStyleSheetItem::VerticalAlignment +/*! + \enum QStyleSheetItem::VerticalAlignment - This enum type defines the way elements are aligned vertically. This - is supported for text elements only. The possible values are: + This enum type defines the way elements are aligned vertically. + This is only supported for text elements. - \value VAlignBaseline align the baseline of the element (or the - bottom, if the element doesn't have a baseline) with the baseline of - the parent + \value VAlignBaseline align the baseline of the element (or the + bottom, if the element doesn't have a baseline) with the + baseline of the parent - \value VAlignSub subscript the element + \value VAlignSub subscript the element - \value VAlignSuper superscript the element + \value VAlignSuper superscript the element */ /*! - Sets the vertical alignment to \a valign. Possible values are - VAlignBaseline, VAlignSub and VAlignSuper. + Sets the vertical alignment to \a valign. Possible values are + \c VAlignBaseline, \c VAlignSub or \c VAlignSuper. - The vertical alignment property is not inherited. + The vertical alignment property is not inherited. - \sa verticalAlignment() - */ + \sa verticalAlignment() +*/ void QStyleSheetItem::setVerticalAlignment( VerticalAlignment valign ) { d->valign = valign; @@ -331,10 +345,11 @@ void QStyleSheetItem::setVerticalAlignment( VerticalAlignment valign ) /*! - Returns TRUE if the style sets an italic font; otherwise returns FALSE. + Returns TRUE if the style sets an italic font; otherwise returns + FALSE. - \sa setFontItalic(), definesFontItalic() - */ + \sa setFontItalic(), definesFontItalic() +*/ bool QStyleSheetItem::fontItalic() const { return d->fontitalic > 0; @@ -344,51 +359,54 @@ bool QStyleSheetItem::fontItalic() const If \a italic is TRUE sets italic for the style; otherwise sets upright. - \sa fontItalic(), definesFontItalic() - */ + \sa fontItalic(), definesFontItalic() +*/ void QStyleSheetItem::setFontItalic(bool italic) { d->fontitalic = italic?1:0; } /*! - Returns whether the style defines a font shape. A style - does not define any shape until setFontItalic() is called. + Returns TRUE if the style defines a font shape; otherwise returns + FALSE. A style does not define any shape until setFontItalic() is + called. - \sa setFontItalic(), fontItalic() - */ + \sa setFontItalic(), fontItalic() +*/ bool QStyleSheetItem::definesFontItalic() const { return d->fontitalic != Undefined; } /*! - Returns TRUE if the style sets an underlined font; otherwise returns FALSE. + Returns TRUE if the style sets an underlined font; otherwise + returns FALSE. - \sa setFontUnderline(), definesFontUnderline() - */ + \sa setFontUnderline(), definesFontUnderline() +*/ bool QStyleSheetItem::fontUnderline() const { return d->fontunderline > 0; } /*! - If \a underline is TRUE sets underline for the style; otherwise sets - no underline. + If \a underline is TRUE, sets underline for the style; otherwise + sets no underline. - \sa fontUnderline(), definesFontUnderline() - */ + \sa fontUnderline(), definesFontUnderline() +*/ void QStyleSheetItem::setFontUnderline(bool underline) { d->fontunderline = underline?1:0; } /*! - Returns whether the style defines a setting for the underline - property of the font. A style does not define this until - setFontUnderline() is called. + Returns TRUE if the style defines a setting for the underline + property of the font; otherwise returns FALSE. A style does not + define this until setFontUnderline() is called. - \sa setFontUnderline(), fontUnderline() */ + \sa setFontUnderline(), fontUnderline() +*/ bool QStyleSheetItem::definesFontUnderline() const { return d->fontunderline != Undefined; @@ -396,33 +414,68 @@ bool QStyleSheetItem::definesFontUnderline() const /*! - Returns the font weight setting of the style. This is either a - valid QFont::Weight or the value QStyleSheetItem::Undefined. + Returns TRUE if the style sets a strike out font; otherwise + returns FALSE. - \sa setFontWeight(), QFont - */ + \sa setFontStrikeOut(), definesFontStrikeOut() +*/ +bool QStyleSheetItem::fontStrikeOut() const +{ + return d->fontstrikeout > 0; +} + +/*! + If \a strikeOut is TRUE, sets strike out for the style; otherwise + sets no strike out. + + \sa fontStrikeOut(), definesFontStrikeOut() +*/ +void QStyleSheetItem::setFontStrikeOut(bool strikeOut) +{ + d->fontstrikeout = strikeOut?1:0; +} + +/*! + Returns TRUE if the style defines a setting for the strikeOut + property of the font; otherwise returns FALSE. A style does not + define this until setFontStrikeOut() is called. + + \sa setFontStrikeOut(), fontStrikeOut() +*/ +bool QStyleSheetItem::definesFontStrikeOut() const +{ + return d->fontstrikeout != Undefined; +} + + +/*! + Returns the font weight setting of the style. This is either a + valid \c QFont::Weight or the value \c QStyleSheetItem::Undefined. + + \sa setFontWeight(), QFont +*/ int QStyleSheetItem::fontWeight() const { return d->fontweight; } /*! - Sets the font weight setting of the style to \a w. Valid values are - those defined by QFont::Weight. + Sets the font weight setting of the style to \a w. Valid values + are those defined by \c QFont::Weight. - \sa QFont, fontWeight() - */ + \sa QFont, fontWeight() +*/ void QStyleSheetItem::setFontWeight(int w) { d->fontweight = w; } /*! - Returns the logical font size setting of the style. This is either a valid - size between 1 and 7 or QStyleSheetItem::Undefined. + Returns the logical font size setting of the style. This is either + a valid size between 1 and 7 or \c QStyleSheetItem::Undefined. - \sa setLogicalFontSize(), setLogicalFontSizeStep(), QFont::pointSize(), QFont::setPointSize() - */ + \sa setLogicalFontSize(), setLogicalFontSizeStep(), QFont::pointSize(), QFont::setPointSize() +*/ int QStyleSheetItem::logicalFontSize() const { return d->fontsizelog; @@ -430,34 +483,34 @@ int QStyleSheetItem::logicalFontSize() const /*! - Sets the logical font size setting of the style to \a s. - Valid logical sizes are 1 to 7. + Sets the logical font size setting of the style to \a s. Valid + logical sizes are 1 to 7. - \sa logicalFontSize(), QFont::pointSize(), QFont::setPointSize() - */ + \sa logicalFontSize(), QFont::pointSize(), QFont::setPointSize() +*/ void QStyleSheetItem::setLogicalFontSize(int s) { d->fontsizelog = s; } /*! - Returns the logical font size step of this style. + Returns the logical font size step of this style. - The default is 0. Tags such as \c big define \c +1; \c small defines - \c -1. + The default is 0. Tags such as \c big define \c +1; \c small + defines \c -1. - \sa setLogicalFontSizeStep() - */ + \sa setLogicalFontSizeStep() +*/ int QStyleSheetItem::logicalFontSizeStep() const { return d->fontsizestep; } /*! - Sets the logical font size step of this style to \a s. + Sets the logical font size step of this style to \a s. - \sa logicalFontSizeStep() - */ + \sa logicalFontSizeStep() +*/ void QStyleSheetItem::setLogicalFontSizeStep( int s ) { d->fontsizestep = s; @@ -466,21 +519,21 @@ void QStyleSheetItem::setLogicalFontSizeStep( int s ) /*! - Sets the font size setting of the style to \a s points. + Sets the font size setting of the style to \a s points. - \sa fontSize(), QFont::pointSize(), QFont::setPointSize() - */ + \sa fontSize(), QFont::pointSize(), QFont::setPointSize() +*/ void QStyleSheetItem::setFontSize(int s) { d->fontsize = s; } /*! - Returns the font size setting of the style. This is either a valid - point size or QStyleSheetItem::Undefined. + Returns the font size setting of the style. This is either a valid + point size or \c QStyleSheetItem::Undefined. - \sa setFontSize(), QFont::pointSize(), QFont::setPointSize() - */ + \sa setFontSize(), QFont::pointSize(), QFont::setPointSize() +*/ int QStyleSheetItem::fontSize() const { return d->fontsize; @@ -488,21 +541,21 @@ int QStyleSheetItem::fontSize() const /*! - Returns the font family setting of the style. This is either a valid - font family or QString::null if no family has been set. + Returns the font family setting of the style. This is either a + valid font family or QString::null if no family has been set. - \sa setFontFamily(), QFont::family(), QFont::setFamily() - */ + \sa setFontFamily(), QFont::family(), QFont::setFamily() +*/ QString QStyleSheetItem::fontFamily() const { return d->fontfamily; } /*! - Sets the font family setting of the style to \a fam. + Sets the font family setting of the style to \a fam. - \sa fontFamily(), QFont::family(), QFont::setFamily() - */ + \sa fontFamily(), QFont::family(), QFont::setFamily() +*/ void QStyleSheetItem::setFontFamily( const QString& fam) { d->fontfamily = fam; @@ -522,7 +575,7 @@ int QStyleSheetItem::numberOfColumns() const /*!\obsolete - Sets the number of columns for this style. Elements in the style + Sets the number of columns for this style. Elements in the style are divided into columns. This makes sense only if the style uses a block display mode @@ -538,43 +591,43 @@ void QStyleSheetItem::setNumberOfColumns(int ncols) /*! - Returns the text color of this style or an invalid color - if no color has been set. + Returns the text color of this style or an invalid color if no + color has been set. - \sa setColor() QColor::isValid() - */ + \sa setColor() QColor::isValid() +*/ QColor QStyleSheetItem::color() const { return d->col; } /*! - Sets the text color of this style to \a c. + Sets the text color of this style to \a c. - \sa color() - */ + \sa color() +*/ void QStyleSheetItem::setColor( const QColor &c) { d->col = c; } /*! - Returns whether this style is an anchor. + Returns whether this style is an anchor. - \sa setAnchor() - */ + \sa setAnchor() +*/ bool QStyleSheetItem::isAnchor() const { return d->anchor; } /*! - If \a anc is TRUE sets this style to be an anchor (hypertext link); - otherwise sets it to not be an anchor. Elements in this style have - connections to other documents or anchors. + If \a anc is TRUE, sets this style to be an anchor (hypertext + link); otherwise sets it to not be an anchor. Elements in this + style link to other documents or anchors. - \sa isAnchor() - */ + \sa isAnchor() +*/ void QStyleSheetItem::setAnchor(bool anc) { d->anchor = anc; @@ -582,19 +635,20 @@ void QStyleSheetItem::setAnchor(bool anc) /*! - Returns the whitespace mode. + Returns the whitespace mode. - \sa setWhiteSpaceMode() WhiteSpaceMode - */ + \sa setWhiteSpaceMode() WhiteSpaceMode +*/ QStyleSheetItem::WhiteSpaceMode QStyleSheetItem::whiteSpaceMode() const { return d->whitespacemode; } /*! - Sets the whitespace mode to \a m. - \sa WhiteSpaceMode - */ + Sets the whitespace mode to \a m. + + \sa WhiteSpaceMode +*/ void QStyleSheetItem::setWhiteSpaceMode(WhiteSpaceMode m) { d->whitespacemode = m; @@ -602,14 +656,14 @@ void QStyleSheetItem::setWhiteSpaceMode(WhiteSpaceMode m) /*! - Returns the width of margin \a m in pixels. + Returns the width of margin \a m in pixels. - The margin, \a m, can be \c MarginLeft, \c MarginRight, - \c MarginTop, \c MarginBottom, \c MarginAll, \c MarginVertical or \c - MarginHorizontal. + The margin, \a m, can be \c MarginLeft, \c MarginRight, \c + MarginTop, \c MarginBottom, \c MarginAll, \c MarginVertical or \c + MarginHorizontal. - \sa setMargin() Margin - */ + \sa setMargin() Margin +*/ int QStyleSheetItem::margin(Margin m) const { return d->margin[m]; @@ -617,14 +671,14 @@ int QStyleSheetItem::margin(Margin m) const /*! - Sets the width of margin \a m to \a v pixels. + Sets the width of margin \a m to \a v pixels. - The margin, \a m, can be \c MarginLeft, \c MarginRight, - \c MarginTop, \c MarginBottom, \c MarginAll, \c MarginVertical or \c - MarginHorizontal. The value \a v must be >= 0. + The margin, \a m, can be \c MarginLeft, \c MarginRight, \c + MarginTop, \c MarginBottom, \c MarginAll, \c MarginVertical or \c + MarginHorizontal. The value \a v must be >= 0. - \sa margin() - */ + \sa margin() +*/ void QStyleSheetItem::setMargin(Margin m, int v) { if (m == MarginAll ) { @@ -646,71 +700,74 @@ void QStyleSheetItem::setMargin(Margin m, int v) /*! - Returns the list style of the style. + Returns the list style of the style. - \sa setListStyle() ListStyle + \sa setListStyle() ListStyle */ QStyleSheetItem::ListStyle QStyleSheetItem::listStyle() const { return d->list; } -/*! \enum QStyleSheetItem::ListStyle +/*! + \enum QStyleSheetItem::ListStyle - This enum type defines how the items in a list are prefixed when - displayed. The currently defined values are: + This enum type defines how the items in a list are prefixed when + displayed. - \value ListDisc a filled circle (i.e. a bullet) - \value ListCircle an unfilled circle - \value ListSquare a filled square - \value ListDecimal an integer in base 10: \e 1, \e 2, \e 3, ... - \value ListLowerAlpha a lowercase letter: \e a, \e b, \e c, ... - \value ListUpperAlpha an uppercase letter: \e A, \e B, \e C, ... + \value ListDisc a filled circle (i.e. a bullet) + \value ListCircle an unfilled circle + \value ListSquare a filled square + \value ListDecimal an integer in base 10: \e 1, \e 2, \e 3, ... + \value ListLowerAlpha a lowercase letter: \e a, \e b, \e c, ... + \value ListUpperAlpha an uppercase letter: \e A, \e B, \e C, ... */ + /*! - Sets the list style of the style to \a s. + Sets the list style of the style to \a s. - This is used by nested elements that have a display mode of - \c DisplayListItem. + This is used by nested elements that have a display mode of \c + DisplayListItem. - \sa listStyle() DisplayMode ListStyle - */ + \sa listStyle() DisplayMode ListStyle +*/ void QStyleSheetItem::setListStyle(ListStyle s) { d->list=s; } -/*! Returns a space-separated list of names of styles that may - contain elements of this style. If nothing has been set, contexts() - returns an empty string, which indicates that this style can be - nested everywhere. +/*! + Returns a space-separated list of names of styles that may contain + elements of this style. If nothing has been set, contexts() + returns an empty string, which indicates that this style can be + nested everywhere. - \sa setContexts() - */ + \sa setContexts() +*/ QString QStyleSheetItem::contexts() const { return d->contxt; } /*! - Sets a space-separated list of names of styles that may contain - elements of this style. If \a c is empty, the style can be nested - everywhere. + Sets a space-separated list of names of styles that may contain + elements of this style. If \a c is empty, the style can be nested + everywhere. - \sa contexts() - */ + \sa contexts() +*/ void QStyleSheetItem::setContexts( const QString& c) { d->contxt = QChar(' ') + c + QChar(' '); } /*! - Returns TRUE if this style can be nested into an element - of style \a s; otherwise returns FALSE. + Returns TRUE if this style can be nested into an element of style + \a s; otherwise returns FALSE. - \sa contexts(), setContexts() - */ + \sa contexts(), setContexts() +*/ bool QStyleSheetItem::allowedInContext( const QStyleSheetItem* s) const { if ( d->contxt.isEmpty() ) @@ -720,38 +777,50 @@ bool QStyleSheetItem::allowedInContext( const QStyleSheetItem* s) const /*! - Returns TRUE if this style has self-nesting enabled; otherwise - returns FALSE. + Returns TRUE if this style has self-nesting enabled; otherwise + returns FALSE. - \sa setSelfNesting() - */ + \sa setSelfNesting() +*/ bool QStyleSheetItem::selfNesting() const { return d->selfnest; } /*! - Sets the self-nesting property for this style to \a nesting. + Sets the self-nesting property for this style to \a nesting. - In order to support "dirty" HTML, paragraphs \c{

    } and list items - \c{

  • } are not self-nesting. This means that starting a new - paragraph or list item automatically closes the previous one. + In order to support "dirty" HTML, paragraphs \c{

    } and list + items \c{

  • } are not self-nesting. This means that starting a + new paragraph or list item automatically closes the previous one. - \sa selfNesting() - */ + \sa selfNesting() +*/ void QStyleSheetItem::setSelfNesting( bool nesting ) { d->selfnest = nesting; } -/*! Sets the linespacing to be \a ls pixels */ +/* + Sets the linespacing to be at least \a ls pixels. + + For compatibility with previous Qt releases, small values get + treated differently: If \a ls is smaller than the default font + line spacing in pixels at parse time, the resulting line spacing + is the sum of the default line spacing plus \a ls. We recommend + not relying on this behavior. +*/ void QStyleSheetItem::setLineSpacing( int ls ) { d->lineSpacing = ls; } -/*! Returns the linespacing */ +/*! + \obsolete + + Returns the linespacing +*/ int QStyleSheetItem::lineSpacing() const { @@ -767,224 +836,222 @@ int QStyleSheetItem::lineSpacing() const /*! - \class QStyleSheet qstylesheet.h - \ingroup text - \brief The QStyleSheet class is a collection of styles for rich text - rendering and a generator of tags. - - \ingroup graphics - \ingroup helpsystem - - 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. 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 QStyleSheet 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 - \list - \i \c{}...\c{} - - A Qt rich text document. It understands the following attributes: - \list - \i title - - The caption of the document. This attribute is easily accessible with - QTextView::documentTitle(). - \i type - - The type of the document. The default type is \c page . It - indicates that the document is displayed in a page of its - own. Another style is \c detail, which can be used to - explain certain expressions in more detail 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 - \c{...}. - \i bgcolor - - The background color, for example \c bgcolor="yellow" or \c - bgcolor="#0000FF". - \i background - - The background pixmap, for example \c - background="granit.xpm". The pixmap name will be resolved by - a QMimeSourceFactory(). - \i text - - The default text color, for example \c text="red". - \i link - - The link color, for example \c link="green". - \endlist - \i \c{

    ...

    } - - A top-level heading. - \i \c{

    ...

    } - - A sublevel heading. - \i \c{

    ...

    } - - A sub-sublevel heading. - \i \c{

    ...

    } - - A left-aligned paragraph. Adjust the alignment with - the \c align attribute. Possible values are - \c left, \c right and \c center. - \i \c{
    ...
    } - - A centered paragraph. - \i \c{
    ...
    } - - An indented paragraph that is useful for quotes. - \i \c{} - - An unordered list. You can also pass a type argument to - define the bullet style. The default is \c type=disc; other - types are \c circle and \c square. - \i \c{
      ...
    } - - An ordered list. You can also pass a type argument to define - the enumeration label style. The default is \c type="1"; other - types are \c "a" and \c "A". - \i <li>...</li> - - A list item. This tag can be used only within the context of - \c ol or \c ul. - \i \c{
    ...
    } - - For larger chunks of code. Whitespaces in the contents are preserved. - For small bits of code use the inline-style \c code. - \endlist - - Anchors and links are done with a single tag: - \list - \i \c{...} - - An anchor or link. The reference target is defined in the \c - href attribute of the tag as in \c{...}. You can also specify an - additional anchor within the specified target document, for - example \c{...}. If \c a is - meant to be an anchor, the reference source is given in the - \c name attribute. - \endlist - - The default character style bindings are - \list - \i \c{...} - - Emphasized. By default this is the same as - \c{...} (italic). - \i \c{...} - - Strong. By default this is the same as - \c{...} (bold). - \i \c{...} - - Italic font style. - \i \c{...} - - Bold font style. - \i \c{...} - - Underlined font style. - \i \c{...} - - A larger font size. - \i \c{...} - - A smaller font size. - \i \c{...} - - Indicates code. By default this is the same as - \c{...} (typewriter). For - larger junks of code use the block-tag \c pre. - \i \c{...} - - Typewriter font style. - \i \c{...} - - Customizes the font size, family and text color. The tag understands - the following attributes: - \list - \i color - - The text color, for example \c color="red" or \c color="#FF0000". - \i size - - The logical size of the font. Logical sizes 1 to 7 are supported. - The value may either be absolute (for example, - \c size=3) or relative (\c size=-2). In the latter case the sizes - are simply added. - \i face - - The family of the font, for example \c face=times. - \endlist - \endlist - - Special elements are: - \list - \i \c{} - - An image. The image name for the mime source - factory is given in the source attribute, for example - \c{} - The image tag also understands the attributes \c width and \c - 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 \c align attribute determines where the image is - placed. By default, an image is placed inline just like a - normal character. Specify \c left or \c right to place the - image at the respective side. - \i \c{
    } - - A horizonal line. - \i \c{
    } - - A line break. - \endlist - - Another tag not in any of the above cathegories is - \list - \i \c{...} - - No break. Prevents word wrap. - \endlist - - 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. - - \list - \i \c{...
    } - - A table. Tables support the following attributes: - \list - \i bgcolor - - The background color. - \i width - - The table width. This is either an absolute pixel width or a relative - percentage of the table's width, for example \c width=80%. - \i border - - The width of the table border. The default is 0 (= no border). - \i cellspacing - - Additional space around the table cells. The default is 2. - \i cellpadding - - Additional space around the contents of table cells. The default is 1. - \endlist - \i \c{...} - - A table row. This is only valid within a \c table. Rows support - the following attribute: - \list - \i bgcolor - - The background color. - \endlist - \i \c{...} - - A table header cell. Similar to \c td, but defaults to center alignment - and a bold font. - \i \c{...} - - A table data cell. This is only valid within a \c tr. Cells - support the following attributes: - \list - \i bgcolor - - The background color. - \i width - - The cell width. This is either an absolute pixel width or a relative - percentage of table's width, for example \c width=50%. - \i colspan - - Specifies how many columns this cell spans. The default is 1. - \i rowspan - - Specifies how many rows this cell spans. The default is 1. - \i align - - Alignment; possible values are \c left, \c right, and \c center. The - default is left. - \endlist - \endlist -*/ - -/*! - Creates a style sheet with parent \a parent and name \a name. 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. + \class QStyleSheet qstylesheet.h + \ingroup text + \brief The QStyleSheet class is a collection of styles for rich text + rendering and a generator of tags. + + \ingroup graphics + \ingroup helpsystem + + 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. 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 QStyleSheet 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 + \table + \header \i Structuring tags \i Notes + \row \i \c{}...\c{} + \i A Qt rich text document. It understands the following + attributes: + \list + \i \c title -- The caption of the document. This attribute is + easily accessible with QTextView::documentTitle(). + \i \c type -- The type of the document. The default type is \c + page. It indicates that the document is displayed in a + page of its own. Another style is \c detail, which can be + used to explain certain expressions in more detail in a + few sentences. For \c 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 \c{...}. + \i \c bgcolor -- The background color, for example \c + bgcolor="yellow" or \c bgcolor="#0000FF". + \i \c background -- The background pixmap, for example \c + background="granite.xpm". The pixmap name will be resolved + by a QMimeSourceFactory(). + \i \c text -- The default text color, for example \c text="red". + \i \c link -- The link color, for example \c link="green". + \endlist + \row \i \c{

    ...

    } + \i A top-level heading. + \row \i \c{

    ...

    } + \i A sublevel heading. + \row \i \c{

    ...

    } + \i A sub-sublevel heading. + \row \i \c{

    ...

    } + \i A left-aligned paragraph. Adjust the alignment with the \c + align attribute. Possible values are \c left, \c right and + \c center. + \row \i \c{
    ...}
    \c{
    } + \i A centered paragraph. + \row \i \c{
    ...}
    \c{
    } + \i An indented paragraph that is useful for quotes. + \row \i \c{} + \i An unordered list. You can also pass a type argument to + define the bullet style. The default is \c type=disc; + other types are \c circle and \c square. + \row \i \c{
      ...
    } + \i An ordered list. You can also pass a type argument to + define the enumeration label style. The default is \c + type="1"; other types are \c "a" and \c "A". + \row \i \c{
  • ...
    • } + \i A list item. This tag can be used only within the context + of \c{
      } or \c{