QtGui.QTextOption Class Reference

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

Inheritance diagram for QtGui.QTextOption:

Collaboration diagram for QtGui.QTextOption:

Classes
class	Tab

Public Types
enum	Flag {   AddSpaceForLineAndParagraphSeparators = 4, IncludeTrailingSpaces = -2147483648, ShowLineAndParagraphSeparators = 2, ShowTabsAndSpaces = 1,   SuppressColors = 8 }
enum	TabType { CenterTab = 2, DelimiterTab = 3, LeftTab = 0, RightTab = 1 }
	More...
enum	WrapMode {   ManualWrap = 2, NoWrap = 0, WordWrap = 1, WrapAnywhere = 3,   WrapAtWordBoundaryOrAnywhere = 4 }
	More...

Public Member Functions
	QTextOption ()
	QTextOption (QTextOption o)
	QTextOption (Qt.AlignmentFlag alignment)
virtual void	CreateProxy ()
new void	Dispose ()

Protected Member Functions
	QTextOption (System.Type dummy)

Protected Attributes
SmokeInvocation	interceptor

Properties
new Qt.AlignmentFlag	Alignment [get, set]
new QTextOption.Flag	Flags [get, set]
new System.Collections.Generic.List < System.Double >	TabArray [get, set]
new double	TabStop [get, set]
new System.Collections.Generic.List < QTextOption.Tab >	Tabs [get, set]
new Qt.LayoutDirection	TextDirection [get, set]
new bool	UseDesignMetrics [get, set]
new QTextOption.WrapMode	wrapMode [get, set]
virtual System.IntPtr	SmokeObject [get, set]

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 Enumeration Documentation

enum QtGui.QTextOption.Flag

Enumerator:

AddSpaceForLineAndParagraphSeparators	While determining the line-break positions take into account the space added for drawing a separator character.
IncludeTrailingSpaces	When this option is set, QTextLine::naturalTextWidth() and naturalTextRect() will return a value that includes the width of trailing spaces in the text; otherwise this width is excluded.
ShowLineAndParagraphSeparators	Visualize line and paragraph separators with appropriate symbol characters.
ShowTabsAndSpaces	Visualize spaces with little dots, and tabs with little arrows.
SuppressColors	Suppress all color changes in the character formats (except the main selection).

enum QtGui.QTextOption.TabType

This enum holds the different types of tabulator

This enum was introduced or modified in Qt 4.4.

Enumerator:

CenterTab	A centered-tab
DelimiterTab	A tab stopping at a certain delimiter-character
LeftTab	A left-tab
RightTab	A right-tab

enum QtGui.QTextOption.WrapMode

This enum describes how text is wrapped in a document.

Enumerator:

ManualWrap	Same as QTextOption::NoWrap
NoWrap	Text is not wrapped at all.
WordWrap	Text is wrapped at word boundaries.
WrapAnywhere	Text can be wrapped at any point on a line, even if it occurs in the middle of a word.
WrapAtWordBoundaryOrAnywhere	If possible, wrapping occurs at a word boundary; otherwise it will occur at the appropriate point on the line, even in the middle of a word.

Constructor & Destructor Documentation

QtGui.QTextOption.QTextOption ( System.Type  dummy )

protected

QtGui.QTextOption.QTextOption

(

)

Constructs a text option with default properties for text. The text alignment property is set to Qt::AlignLeft. The word wrap property is set to QTextOption::WordWrap. The using of design metrics flag is set to false.

QtGui.QTextOption.QTextOption

(

QTextOption

o

)

Construct a copy of the other text option.

QtGui.QTextOption.QTextOption

(

Qt.AlignmentFlag

alignment

)

Constructs a text option with default properties for text. The text alignment property is set to Qt::AlignLeft. The word wrap property is set to QTextOption::WordWrap. The using of design metrics flag is set to false.

Member Function Documentation

virtual void QtGui.QTextOption.CreateProxy ( )

virtual

new void QtGui.QTextOption.Dispose

(

)

Member Data Documentation

SmokeInvocation QtGui.QTextOption.interceptor

protected

Property Documentation

new Qt.AlignmentFlag QtGui.QTextOption.Alignment

getset

Returns the text alignment defined by the option.

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

new QTextOption.Flag QtGui.QTextOption.Flags

getset

Returns the flags associated with the option.

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

virtual System.IntPtr QtGui.QTextOption.SmokeObject

getset

new System.Collections.Generic.List<System.Double> QtGui.QTextOption.TabArray

getset

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

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

new System.Collections.Generic.List<QTextOption.Tab> QtGui.QTextOption.Tabs

getset

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

This function was introduced in Qt 4.4.

Set the Tab properties to tabStops.

new double QtGui.QTextOption.TabStop

getset

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

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

new Qt.LayoutDirection QtGui.QTextOption.TextDirection

getset

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

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

new bool QtGui.QTextOption.UseDesignMetrics

getset

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

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).

new QTextOption.WrapMode QtGui.QTextOption.wrapMode

getset

Returns the text wrap mode defined by the option.

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