QTextOption Class Reference
[QtGui module]

Detailed Description

The QTextOption class provides a description of general rich text properties.

QTextOption is used to encapsulate common rich text properties in a single object. It contains information about text alignment, layout direction, word wrapping, and other standard properties associated with text rendering and layout.

See also QTextEdit, QTextDocument, and QTextCursor.

Member Type Documentation

enum QTextOption::Flag
flags QTextOption::Flags

The Flags type is a typedef for QFlags<Flag>. It stores an OR combination of Flag values.

enum QTextOption::TabType

This enum holds the different types of tabulator

This enum was introduced in Qt 4.4.

enum QTextOption::WrapMode

This enum describes how text is wrapped in a document.

Member Function Documentation

QTextOption::QTextOption ()

Constructs a text option with default properties for text.

QTextOption::QTextOption ( Qt::Alignment alignment )

Constructs a text option with the given alignment for text.

QTextOption::QTextOption ( const QTextOption & other )

Construct a copy of the other text option.

QTextOption::~QTextOption ()

Destroys the text option.

Qt::Alignment QTextOption::alignment () const

Returns the text alignment defined by the option.

See also setAlignment().

Flags QTextOption::flags () const

Returns the flags associated with the option.

See also setFlags().

void QTextOption::setAlignment ( Qt::Alignment alignment )

Sets the option's text alignment to the specified alignment.

See also alignment().

void QTextOption::setFlags ( Flags flags )

Sets the flags associated with the option to the given flags.

See also flags().

void QTextOption::setTabArray ( QList<qreal> tabStops )

Sets the tab positions for the text layout to those specified by tabStops.

See also tabArray(), setTabStop(), and setTabs().

void QTextOption::setTabStop ( qreal tabStop )

Sets the default distance in device units between tab stops to the value specified by tabStop.

See also tabStop(), setTabArray(), setTabs(), and tabs().

void QTextOption::setTabs ( QList<Tab> tabStops )

Set the Tab properties to tabStops.

See also tabStop() and tabs().

void QTextOption::setTextDirection ( Qt::LayoutDirection direction )

Sets the direction of the text layout defined by the option to the given direction.

See also textDirection().

void QTextOption::setUseDesignMetrics ( bool enable )

If enable is true then the layout will use design metrics; otherwise it will use the metrics of the paint device (which is the default behavior).

See also useDesignMetrics().

void QTextOption::setWrapMode ( WrapMode mode )

Sets the option's text wrap mode to the given mode.

See also wrapMode().

QList<qreal> QTextOption::tabArray () const

Returns a list of tab positions defined for the text layout.

See also setTabArray() and tabStop().

qreal QTextOption::tabStop () const

Returns the distance in device units between tab stops. Convenient function for the above method

See also setTabStop(), tabArray(), setTabs(), and tabs().

QList<Tab> QTextOption::tabs () const

Returns a list of tab positions defined for the text layout.

This function was introduced in Qt 4.4.

See also tabStop(), setTabs(), and setTabStop().

Qt::LayoutDirection QTextOption::textDirection () const

Returns the direction of the text layout defined by the option.

See also setTextDirection().

bool QTextOption::useDesignMetrics () const

Returns true if the layout uses design rather than device metrics; otherwise returns false.

See also setUseDesignMetrics().

WrapMode QTextOption::wrapMode () const

Returns the text wrap mode defined by the option.

See also setWrapMode().

QTextOption & QTextOption::operator= ( const QTextOption & other )

Returns true if the text option is the same as the other text option; otherwise returns false.