QStyleSheetItem Class Reference
The QStyleSheetItem class provides an encapsulation of a set of text styles.
More...
#include <qstylesheet.h>
Inherits Qt.
List of all member functions.
Public Members
enum AdditionalStyleValues { Undefined = -1 }
enum
DisplayMode { DisplayBlock, DisplayInline, DisplayListItem, DisplayNone }
int numberOfColumns () const (obsolete)
void setNumberOfColumns ( int ncols ) (obsolete)
enum
WhiteSpaceMode { WhiteSpaceNormal, WhiteSpacePre, WhiteSpaceNoWrap }
enum
Margin { MarginLeft, MarginRight, MarginTop, MarginBottom, MarginFirstLine, MarginAll, MarginVertical, MarginHorizontal }
enum
ListStyle { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, ListUpperAlpha }
Detailed Description
The QStyleSheetItem class provides an encapsulation of a set of text styles.
A style consists of a name and a set of font, color, and other
display properties. When used in a style
sheet, items define the name of a rich text tag and the
display property changes associated with it.
Member Type Documentation
QStyleSheetItem::DisplayMode
This enum type defines the way adjacent elements are displayed. The possible values are:
- QStyleSheetItem::DisplayBlock - elements are displayed as a rectangular block (e.g.,
<P> ... </P>).
- QStyleSheetItem::DisplayInline - elements are displayed in a horizontally flowing
sequence (e.g., <EM> ... </EM>).
- QStyleSheetItem::DisplayListItem - elements are displayed in a vertical sequence
(e.g., <LI> ... </LI>).
- QStyleSheetItem::DisplayNone - elements are not displayed at all.
QStyleSheetItem::ListStyle
This enum type defines how the items in a list are prefixed when
displayed. The currently defined values are:
- QStyleSheetItem::ListDisc - a filled circle
- QStyleSheetItem::ListCircle - an unfilled circle
- QStyleSheetItem::ListSquare - a filled circle
- QStyleSheetItem::ListDecimal - an integer in base 10: 1, 2, 3, ...
- QStyleSheetItem::ListLowerAlpha - a lowercase letter: a, b, c, ...
- QStyleSheetItem::ListUpperAlpha - an uppercase letter: A, B, C, ...
QStyleSheetItem::Margin
- QStyleSheetItem::MarginLeft - left margin
- QStyleSheetItem::MarginRight - right margin
- QStyleSheetItem::MarginTop - top margin
- QStyleSheetItem::MarginBottom - bottom margin
- QStyleSheetItem::MarginAll - all margins (left, right, top and bottom)
- QStyleSheetItem::MarginVertical - top and bottom margins
- QStyleSheetItem::MarginHorizontal - left and right margins
- QStyleSheetItem::MarginFirstLine - margin (indentation) of the first line of a paragarph (in addition to the MarginLeft of the paragraph)
QStyleSheetItem::WhiteSpaceMode
This enum defines the ways in which QStyleSheet can treat whitespace. There are three values at present:
- QStyleSheetItem::WhiteSpaceNormal - any sequence of whitespace is equivalent
to a single space and is a line-break position.
- QStyleSheetItem::WhiteSpacePre - whitespace must be output exactly as given
in the input.
- QStyleSheetItem::WhiteSpaceNoWrap - multiple spaces are collapsed as with
WhiteSpaceNormal, but no automatic linebreaks occur. To break lines manually,
use the <br> tag.
Member Function Documentation
QStyleSheetItem::QStyleSheetItem ( QStyleSheet * parent, const QString & name )
Constructs a new style named name for the stylesheet parent.
All properties in QStyleSheetItem are initially in the "do not change" state,
except display mode, which defaults
to DisplayInline.
QStyleSheetItem::QStyleSheetItem ( const QStyleSheetItem & other )
Copy constructor. Constructs a copy of other that is
not bound to any style sheet.
QStyleSheetItem::~QStyleSheetItem ()
Destroys the style. Note that QStyleSheetItem objects become owned
by QStyleSheet when they are created.
int QStyleSheetItem::alignment () const
Returns the alignment of this style. Possible values are AlignAuto, AlignLeft,
AlignRight, AlignCenter and AlignJustify.
See also setAlignment() and Qt::AlignmentFlags.
bool QStyleSheetItem::allowedInContext ( const QStyleSheetItem * s ) const
Returns TRUE if this style can be nested into an element
of style s, and FALSE otherwise.
See also contxts() and setContexts().
QColor QStyleSheetItem::color () const
Returns the text color of this style or an invalid color
if no color has been set yet.
See also setColor() and QColor::isValid().
QString QStyleSheetItem::contexts () const
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.
See also setContexts().
bool QStyleSheetItem::definesFontItalic () const
Returns whether the style defines a font shape. A style
does not define any shape until setFontItalic() is called.
See also setFontItalic() and fontItalic().
bool QStyleSheetItem::definesFontUnderline () const
Returns whether the style defines a setting for the underline
property of the font. A style does not define this until
setFontUnderline() is called.
See also setFontUnderline() and fontUnderline().
DisplayMode QStyleSheetItem::displayMode () const
Returns the display mode of the style.
See also setDisplayMode().
QString QStyleSheetItem::fontFamily () 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.
See also setFontFamily(), QFont::family() and QFont::setFamily().
bool QStyleSheetItem::fontItalic () const
Returns whether the style sets an italic or upright font.
See also setFontItalic() and definesFontItalic().
int QStyleSheetItem::fontSize () const
Returns the font size setting of the style. This is either a valid
point size or QStyleSheetItem::Undefined.
See also setFontSize(), QFont::pointSize() and QFont::setPointSize().
bool QStyleSheetItem::fontUnderline () const
Returns whether the style sets an underlined font.
See also setFontUnderline() and definesFontUnderline().
int QStyleSheetItem::fontWeight () const
Returns the font weight setting of the style. This is either a
valid QFont::Weight or the value QStyleSheetItem::Undefined.
See also setFontWeight() and QFont.
bool QStyleSheetItem::isAnchor () const
Returns whether this style is an anchor.
See also setAnchor().
int QStyleSheetItem::lineSpacing () const
Returns the linespacing
ListStyle QStyleSheetItem::listStyle () const
Returns the list style of the style.
See also setListStyle().
int QStyleSheetItem::logicalFontSize () const
Returns the logical font size setting of the style. This is either a valid
size between 1 and 7 or QStyleSheetItem::Undefined.
See also setLogicalFontSize(), setLogicalFontSizeStep(), QFont::pointSize() and QFont::setPointSize().
int QStyleSheetItem::logicalFontSizeStep () const
Returns the logical font size step of this style.
The default is 0. Tags such as big define +1; small defines
-1.
See also setLogicalFontSizeStep().
int QStyleSheetItem::margin ( Margin m ) const
Returns the width of margin m in pixel.
The margin determinator m can be MarginLeft, MarginRight,
MarginTop, MarginBottom, MarginAll, MarginVertical or MarginHorizontal.
See also setMargin().
QString QStyleSheetItem::name () const
Returns the name of style.
int QStyleSheetItem::numberOfColumns () const
This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.
Returns the number of columns for this style.
See also setNumberOfColumns(), displayMode() and setDisplayMode().
bool QStyleSheetItem::selfNesting () const
Returns whether this style has self-nesting enabled.
See also setSelfNesting().
void QStyleSheetItem::setAlignment ( int f )
Sets the alignment. This only makes sense for styles with
display mode
DisplayBlock. Possible values are AlignAuto, AlignLeft, AlignRight,
AlignCenter and AlignJustify.
See also alignment(), displayMode() and Qt::AlignmentFlags.
void QStyleSheetItem::setAnchor ( bool anc )
Sets whether the style is an anchor (link). Elements in this style
have connections to other documents or anchors.
See also isAnchor().
void QStyleSheetItem::setColor ( const QColor & c )
Sets the text color of this style.
See also color().
void QStyleSheetItem::setContexts ( const QString & c )
Sets a space-separated list of names of styles that may contain
elements of this style. If c is empty, the style can be nested
everywhere.
See also contexts().
void QStyleSheetItem::setDisplayMode ( DisplayMode m )
Sets the display mode of the style to m.
See also displayMode().
void QStyleSheetItem::setFontFamily ( const QString & fam )
Sets the font family setting of the style.
See also fontFamily(), QFont::family() and QFont::setFamily().
void QStyleSheetItem::setFontItalic ( bool italic )
Sets italic or upright shape for the style.
See also fontItalic() and definesFontItalic().
void QStyleSheetItem::setFontSize ( int s )
Sets the font size setting of the style in point measures.
See also fontSize(), QFont::pointSize() and QFont::setPointSize().
void QStyleSheetItem::setFontUnderline ( bool underline )
Sets underline for the style.
See also fontUnderline() and definesFontUnderline().
void QStyleSheetItem::setFontWeight ( int w )
Sets the font weight setting of the style. Valid values are
those defined by QFont::Weight.
See also QFont and fontWeight().
void QStyleSheetItem::setLineSpacing ( int ls )
Sets the linespacing to be ls pixels
void QStyleSheetItem::setListStyle ( ListStyle s )
Sets the list style of the style.
This is used by nested elements that have a display mode of
DisplayListItem.
See also listStyle() and DisplayMode.
void QStyleSheetItem::setLogicalFontSize ( int s )
Sets the logical font size setting of the style tp s.
Valid logical sizes are 1 to 7.
See also logicalFontSize(), QFont::pointSize() and QFont::setPointSize().
void QStyleSheetItem::setLogicalFontSizeStep ( int s )
Sets the logical font size step of this style to s.
See also logicalFontSizeStep().
void QStyleSheetItem::setMargin ( Margin m, int v )
Sets the width of margin m to v pixels.
The margin determinator m can be MarginLeft, MarginRight,
MarginTop, MarginBottom, MarginAll, MarginVertical or MarginHorizontal. The value v must be >= 0.
See also margin().
void QStyleSheetItem::setNumberOfColumns ( int ncols )
This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.
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
(see QStyleSheetItem::DisplayMode).
See also numberOfColumns().
void QStyleSheetItem::setSelfNesting ( bool nesting )
Sets the self-nesting property for this style to nesting.
In order to support "dirty" HTML, paragraphs <p> and list items
<li> are not self-nesting. This means that starting a new
paragraph or list item automatically closes the previous one.
See also selfNesting().
void QStyleSheetItem::setWhiteSpaceMode ( WhiteSpaceMode m )
Sets the whitespace mode to m. Possible values are
- WhiteSpaceNormal
- whitespace in the document serves only as separators.
Multiple spaces or indentation are ignored.
- WhiteSpacePre
- whitespace is preserved. This is particulary useful to
display programming code.
- WhiteSpaceNoWrap
- multiple spaces are collapsed as with WhiteSpaceNormal, but no
automatic linebreaks occur. To break lines manually use the
<br> tag.
QStyleSheet * QStyleSheetItem::styleSheet ()
Returns the style sheet this item is in.
const QStyleSheet * QStyleSheetItem::styleSheet () const
Returns the style sheet this item is in.
WhiteSpaceMode QStyleSheetItem::whiteSpaceMode () const
Returns the whitespace mode.
See also setWhiteSpaceMode().
Search the documentation, FAQ, qt-interest archive and more (uses
www.trolltech.com):
This file is part of the Qt toolkit,
copyright © 1995-2001
Trolltech, all rights reserved.
Copyright © 2001 Trolltech | Trademarks
| Qt version 3.0.0-beta1-beta1
|