QtGui.QTextListFormat Class Reference

The QTextListFormat class provides formatting information for lists in a QTextDocument. More...

Inheritance diagram for QtGui.QTextListFormat:

Collaboration diagram for QtGui.QTextListFormat:

Public Types
enum	Style {   ListCircle = -2, ListDecimal = -4, ListDisc = -1, ListLowerAlpha = -5,   ListLowerRoman = -7, ListSquare = -3, ListStyleUndefined = 0, ListUpperAlpha = -6,   ListUpperRoman = -8 }
	More...
Public Types inherited from QtGui.QTextFormat
enum	FormatType {   BlockFormat = 1, CharFormat = 2, FrameFormat = 5, InvalidFormat = -1,   ListFormat = 3, TableFormat = 4, UserFormat = 100 }
	More...
enum	ObjectTypes {   ImageObject = 1, NoObject = 0, TableCellObject = 3, TableObject = 2,   UserObject = 4096 }
	More...
enum	PageBreakFlag { PageBreak_AlwaysAfter = 16, PageBreak_AlwaysBefore = 1, PageBreak_Auto = 0 }
	More...
enum	Property {   AnchorHref = 8241, AnchorName = 8242, BackgroundBrush = 2080, BackgroundImageUrl = 2083,   BlockAlignment = 4112, BlockBottomMargin = 4145, BlockIndent = 4160, BlockLeftMargin = 4146,   BlockNonBreakableLines = 4176, BlockRightMargin = 4147, BlockTopMargin = 4144, BlockTrailingHorizontalRulerWidth = 4192,   CssFloat = 2048, FirstFontProperty = 8160, FontCapitalization = 8160, FontFamily = 8192,   FontFixedPitch = 8200, FontHintingPreference = 8166, FontItalic = 8196, FontKerning = 8165,   FontLetterSpacing = 8161, FontOverline = 8198, FontPixelSize = 8201, FontPointSize = 8193,   FontSizeAdjustment = 8194, FontSizeIncrement = 8194, FontStrikeOut = 8199, FontStyleHint = 8163,   FontStyleStrategy = 8164, FontUnderline = 8197, FontWeight = 8195, FontWordSpacing = 8162,   ForegroundBrush = 2081, FrameBorder = 16384, FrameBorderBrush = 16393, FrameBorderStyle = 16400,   FrameBottomMargin = 16390, FrameHeight = 16388, FrameLeftMargin = 16391, FrameMargin = 16385,   FramePadding = 16386, FrameRightMargin = 16392, FrameTopMargin = 16389, FrameWidth = 16387,   FullWidthSelection = 24576, ImageHeight = 20497, ImageName = 20480, ImageWidth = 20496,   IsAnchor = 8240, LastFontProperty = 8201, LayoutDirection = 2049, LineHeight = 4168,   LineHeightType = 4169, ListIndent = 12289, ListNumberPrefix = 12290, ListNumberSuffix = 12291,   ListStyle = 12288, ObjectIndex = 0, ObjectType = 12032, OutlinePen = 2064,   PageBreakPolicy = 28672, TabPositions = 4149, TableCellBottomPadding = 18451, TableCellColumnSpan = 18449,   TableCellLeftPadding = 18452, TableCellPadding = 16643, TableCellRightPadding = 18453, TableCellRowSpan = 18448,   TableCellSpacing = 16642, TableCellTopPadding = 18450, TableColumnWidthConstraints = 16641, TableColumns = 16640,   TableHeaderRowCount = 16644, TextIndent = 4148, TextOutline = 8226, TextToolTip = 8228,   TextUnderlineColor = 8208, TextUnderlineStyle = 8227, TextVerticalAlignment = 8225, UserProperty = 1048576 }
	More...

Public Member Functions
	QTextListFormat ()
	QTextListFormat (QTextListFormat copy)
override void	CreateProxy ()
new bool	IsValid ()
new void	Dispose ()
Public Member Functions inherited from QtGui.QTextFormat
override bool	Equals (object o)
override int	GetHashCode ()
	QTextFormat ()
	QTextFormat (QTextFormat rhs)
	QTextFormat (int type)
new bool	BoolProperty (int propertyId)
new QBrush	BrushProperty (int propertyId)
new void	ClearBackground ()
new void	ClearForeground ()
new void	ClearProperty (int propertyId)
new QColor	ColorProperty (int propertyId)
new double	DoubleProperty (int propertyId)
new bool	HasProperty (int propertyId)
new int	IntProperty (int propertyId)
new bool	IsBlockFormat ()
new bool	IsCharFormat ()
new bool	IsFrameFormat ()
new bool	IsImageFormat ()
new bool	IsListFormat ()
new bool	IsTableCellFormat ()
new bool	IsTableFormat ()
new bool	IsValid ()
new QTextLength	LengthProperty (int propertyId)
new System.Collections.Generic.List < QTextLength >	LengthVectorProperty (int propertyId)
new void	Merge (QTextFormat other)
new QPen	PenProperty (int propertyId)
new System.Collections.Generic.Dictionary < System.Int32, System.Object >	Properties ()
new object	property (int propertyId)
new int	PropertyCount ()
new void	SetProperty (int propertyId, object value)
new void	SetProperty (int propertyId, System.Collections.Generic.List< QTextLength > lengths)
new string	StringProperty (int propertyId)
new QTextBlockFormat	ToBlockFormat ()
new QTextCharFormat	ToCharFormat ()
new QTextFrameFormat	ToFrameFormat ()
new QTextImageFormat	ToImageFormat ()
new QTextListFormat	ToListFormat ()
new QTextTableCellFormat	ToTableCellFormat ()
new QTextTableFormat	ToTableFormat ()
new int	Type ()
new void	Dispose ()

Protected Member Functions
	QTextListFormat (System.Type dummy)
	QTextListFormat (QTextFormat fmt)
Protected Member Functions inherited from QtGui.QTextFormat
	QTextFormat (System.Type dummy)

Properties
new int	Indent [get, set]
new string	NumberPrefix [get, set]
new string	NumberSuffix [get, set]
new QTextListFormat.Style	style [get, set]
Properties inherited from QtGui.QTextFormat
new QBrush	Background [get, set]
new QBrush	Foreground [get, set]
new Qt.LayoutDirection	LayoutDirection [get, set]
new int	ObjectIndex [get, set]
new int	ObjectType [get, set]
virtual System.IntPtr	SmokeObject [get, set]
static new QMetaObject	StaticMetaObject [get]

Additional Inherited Members
Static Public Member Functions inherited from QtGui.QTextFormat
static bool	operator!= (QTextFormat arg1, QTextFormat arg2)
static bool	operator== (QTextFormat arg1, QTextFormat arg2)
Protected Attributes inherited from QtGui.QTextFormat
SmokeInvocation	interceptor

Detailed Description

The QTextListFormat class provides formatting information for lists in a QTextDocument.

A list is composed of one or more items, represented as text blocks. The list's format specifies the appearance of items in the list. In particular, it determines the indentation and the style of each item.

The indentation of the items is an integer value that causes each item to be offset from the left margin by a certain amount. This value is read with indent() and set with setIndent().

The style used to decorate each item is set with setStyle() and can be read with the style() function. The style controls the type of bullet points and numbering scheme used for items in the list. Note that lists that use the decimal numbering scheme begin counting at 1 rather than 0.

Style properties can be set to further configure the appearance of list items; for example, the ListNumberPrefix and ListNumberSuffix properties can be used to customize the numbers used in an ordered list so that they appear as (1), (2), (3), etc.:

QTextListFormat listFormat;

listFormat.setStyle(QTextListFormat::ListDecimal);

listFormat.setNumberPrefix("(");

listFormat.setNumberSuffix(")");

cursor.insertList(listFormat);

See also QTextList.

Member Enumeration Documentation

enum QtGui.QTextListFormat.Style

This enum describes the symbols used to decorate list items:

Enumerator:

ListCircle	An empty circle
ListDecimal	Decimal values in ascending order
ListDisc	A filled circle
ListLowerAlpha	Lower case Latin characters in alphabetical order
ListLowerRoman	Lower case roman numerals (supports up to 4999 items only)
ListSquare	A filled square
ListStyleUndefined
ListUpperAlpha	Upper case Latin characters in alphabetical order
ListUpperRoman	Upper case roman numerals (supports up to 4999 items only)

Constructor & Destructor Documentation

QtGui.QTextListFormat.QTextListFormat ( System.Type  dummy )

protected

QtGui.QTextListFormat.QTextListFormat

(

)

Constructs a new list format object.

QtGui.QTextListFormat.QTextListFormat ( QTextFormat  fmt )

protected

Constructs a new list format object.

QtGui.QTextListFormat.QTextListFormat

(

QTextListFormat

copy

)

Constructs a new list format object.

Member Function Documentation

override void QtGui.QTextListFormat.CreateProxy ( )

virtual

Reimplemented from QtGui.QTextFormat.

new void QtGui.QTextListFormat.Dispose

(

)

new bool QtGui.QTextListFormat.IsValid

(

)

Returns true if this list format is valid; otherwise returns false.

Property Documentation

new int QtGui.QTextListFormat.Indent

getset

Returns the list format's indentation. The indentation is multiplied by the QTextDocument::indentWidth property to get the effective indent in pixels.

Sets the list format's indentation. The indentation is multiplied by the QTextDocument::indentWidth property to get the effective indent in pixels.

new string QtGui.QTextListFormat.NumberPrefix

getset

Returns the list format's number prefix.

This function was introduced in Qt 4.8.

Sets the list format's number prefix to the string specified by numberPrefix. This can be used with all sorted list types. It does not have any effect on unsorted list types.

The default prefix is an empty string.

This function was introduced in Qt 4.8.

new string QtGui.QTextListFormat.NumberSuffix

getset

Returns the list format's number suffix.

This function was introduced in Qt 4.8.

Sets the list format's number suffix to the string specified by numberSuffix. This can be used with all sorted list types. It does not have any effect on unsorted list types.

The default suffix is ".".

This function was introduced in Qt 4.8.

new QTextListFormat.Style QtGui.QTextListFormat.style

getset

Returns the list format's style.

Sets the list format's style.