\reentrant More...

#include <qtextformat.h>

Inheritance diagram for QTextListFormat:

Collaboration diagram for QTextListFormat:

Public Types
enum	Style { ListDisc = -1 , ListCircle = -2 , ListSquare = -3 , ListDecimal = -4 , ListLowerAlpha = -5 , ListUpperAlpha = -6 , ListLowerRoman = -7 , ListUpperRoman = -8 , ListStyleUndefined = 0 }
	This enum describes the symbols used to decorate list items: More...

Public Types inherited from QTextFormat
enum	FormatType { InvalidFormat = -1 , BlockFormat = 1 , CharFormat = 2 , ListFormat = 3 , FrameFormat = 5 , UserFormat = 100 }
	This enum describes the text item a QTextFormat object is formatting. More...

enum	Property { ObjectIndex = 0x0 , CssFloat = 0x0800 , LayoutDirection = 0x0801 , OutlinePen = 0x810 , BackgroundBrush = 0x820 , ForegroundBrush = 0x821 , BackgroundImageUrl = 0x823 , BlockAlignment = 0x1010 , BlockTopMargin = 0x1030 , BlockBottomMargin = 0x1031 , BlockLeftMargin = 0x1032 , BlockRightMargin = 0x1033 , TextIndent = 0x1034 , TabPositions = 0x1035 , BlockIndent = 0x1040 , LineHeight = 0x1048 , LineHeightType = 0x1049 , BlockNonBreakableLines = 0x1050 , BlockTrailingHorizontalRulerWidth = 0x1060 , HeadingLevel = 0x1070 , BlockQuoteLevel = 0x1080 , BlockCodeLanguage = 0x1090 , BlockCodeFence = 0x1091 , BlockMarker = 0x10A0 , FirstFontProperty = 0x1FE0 , FontCapitalization = FirstFontProperty , FontLetterSpacing = 0x1FE1 , FontWordSpacing = 0x1FE2 , FontStyleHint = 0x1FE3 , FontStyleStrategy = 0x1FE4 , FontKerning = 0x1FE5 , FontHintingPreference = 0x1FE6 , FontFamilies = 0x1FE7 , FontStyleName = 0x1FE8 , FontLetterSpacingType = 0x1FE9 , FontStretch = 0x1FEA , FontPointSize = 0x2001 , FontSizeAdjustment = 0x2002 , FontSizeIncrement = FontSizeAdjustment , FontWeight = 0x2003 , FontItalic = 0x2004 , FontUnderline = 0x2005 , FontOverline = 0x2006 , FontStrikeOut = 0x2007 , FontFixedPitch = 0x2008 , FontPixelSize = 0x2009 , LastFontProperty = FontPixelSize , TextUnderlineColor = 0x2020 , TextVerticalAlignment = 0x2021 , TextOutline = 0x2022 , TextUnderlineStyle = 0x2023 , TextToolTip = 0x2024 , TextSuperScriptBaseline = 0x2025 , TextSubScriptBaseline = 0x2026 , TextBaselineOffset = 0x2027 , IsAnchor = 0x2030 , AnchorHref = 0x2031 , AnchorName = 0x2032 , OldFontLetterSpacingType = 0x2033 , OldFontStretch = 0x2034 , OldTextUnderlineColor = 0x2010 , OldFontFamily = 0x2000 , ObjectType = 0x2f00 , ListStyle = 0x3000 , ListIndent = 0x3001 , ListNumberPrefix = 0x3002 , ListNumberSuffix = 0x3003 , ListStart = 0x3004 , FrameBorder = 0x4000 , FrameMargin = 0x4001 , FramePadding = 0x4002 , FrameWidth = 0x4003 , FrameHeight = 0x4004 , FrameTopMargin = 0x4005 , FrameBottomMargin = 0x4006 , FrameLeftMargin = 0x4007 , FrameRightMargin = 0x4008 , FrameBorderBrush = 0x4009 , FrameBorderStyle = 0x4010 , TableColumns = 0x4100 , TableColumnWidthConstraints = 0x4101 , TableCellSpacing = 0x4102 , TableCellPadding = 0x4103 , TableHeaderRowCount = 0x4104 , TableBorderCollapse = 0x4105 , TableCellRowSpan = 0x4810 , TableCellColumnSpan = 0x4811 , TableCellTopPadding = 0x4812 , TableCellBottomPadding = 0x4813 , TableCellLeftPadding = 0x4814 , TableCellRightPadding = 0x4815 , TableCellTopBorder = 0x4816 , TableCellBottomBorder = 0x4817 , TableCellLeftBorder = 0x4818 , TableCellRightBorder = 0x4819 , TableCellTopBorderStyle = 0x481a , TableCellBottomBorderStyle = 0x481b , TableCellLeftBorderStyle = 0x481c , TableCellRightBorderStyle = 0x481d , TableCellTopBorderBrush = 0x481e , TableCellBottomBorderBrush = 0x481f , TableCellLeftBorderBrush = 0x4820 , TableCellRightBorderBrush = 0x4821 , ImageName = 0x5000 , ImageTitle = 0x5001 , ImageAltText = 0x5002 , ImageWidth = 0x5010 , ImageHeight = 0x5011 , ImageQuality = 0x5014 , ImageMaxWidth = 0x5015 , FullWidthSelection = 0x06000 , PageBreakPolicy = 0x7000 , UserProperty = 0x100000 }
	This enum describes the different properties a format can have. More...

enum	ObjectTypes { NoObject , ImageObject , TableObject , TableCellObject , UserObject = 0x1000 }
	This enum describes what kind of QTextObject this format is associated with. More...

enum	PageBreakFlag { PageBreak_Auto = 0 , PageBreak_AlwaysBefore = 0x001 , PageBreak_AlwaysAfter = 0x010 }

Public Member Functions
	QTextListFormat ()
	Constructs a new list format object.

bool	isValid () const
	Returns `true` if this list format is valid; otherwise returns `false`.

void	setStyle (Style style)
	Sets the list format's style.

Style	style () const
	Returns the list format's style.

void	setIndent (int indent)
	Sets the list format's indentation.

int	indent () const
	Returns the list format's indentation.

void	setNumberPrefix (const QString &numberPrefix)

QString	numberPrefix () const

void	setNumberSuffix (const QString &numberSuffix)

QString	numberSuffix () const

void	setStart (int indent)

int	start () const

Public Member Functions inherited from QTextFormat
	QTextFormat ()
	Creates a new text format with an `InvalidFormat`.

	QTextFormat (int type)
	Creates a new text format of the given type.

	QTextFormat (const QTextFormat &rhs)
	Creates a new text format with the same attributes as the other text format.

QTextFormat &	operator= (const QTextFormat &rhs)
	Assigns the other text format to this text format, and returns a reference to this text format.

	~QTextFormat ()
	Destroys this text format.

void	swap (QTextFormat &other)

void	merge (const QTextFormat &other)
	Merges the other format with this format; where there are conflicts the other format takes precedence.

bool	isValid () const
	Returns `true` if the format is valid (i.e.

bool	isEmpty () const

int	type () const
	Returns the type of this format.

int	objectIndex () const
	Returns the index of the format object, or -1 if the format object is invalid.

void	setObjectIndex (int object)
	Sets the format object's object index.

QVariant	property (int propertyId) const
	Returns the property specified by the given propertyId.

void	setProperty (int propertyId, const QVariant &value)
	Sets the property specified by the propertyId to the given value.

void	clearProperty (int propertyId)
	Clears the value of the property given by propertyId.

bool	hasProperty (int propertyId) const
	Returns `true` if the text format has a property with the given propertyId; otherwise returns `false`.

bool	boolProperty (int propertyId) const
	Returns the value of the property specified by propertyId.

int	intProperty (int propertyId) const
	Returns the value of the property specified by propertyId.

qreal	doubleProperty (int propertyId) const
	Returns the value of the property specified by propertyId.

QString	stringProperty (int propertyId) const
	Returns the value of the property given by propertyId; if the property isn't of QMetaType::QString type, an empty string is returned instead.

QColor	colorProperty (int propertyId) const
	Returns the value of the property given by propertyId; if the property isn't of QMetaType::QColor type, an invalid color is returned instead.

QPen	penProperty (int propertyId) const
	Returns the value of the property given by propertyId; if the property isn't of QMetaType::QPen type, Qt::NoPen is returned instead.

QBrush	brushProperty (int propertyId) const
	Returns the value of the property given by propertyId; if the property isn't of QMetaType::QBrush type, Qt::NoBrush is returned instead.

QTextLength	lengthProperty (int propertyId) const
	Returns the value of the property given by propertyId.

QList< QTextLength >	lengthVectorProperty (int propertyId) const
	Returns the value of the property given by propertyId.

void	setProperty (int propertyId, const QList< QTextLength > &lengths)
	Sets the value of the property given by propertyId to value.

QMap< int, QVariant >	properties () const
	Returns a map with all properties of this text format.

int	propertyCount () const

void	setObjectType (int type)
	Sets the text format's object type to type.

int	objectType () const
	Returns the text format's object type.

bool	isCharFormat () const
	Returns `true` if this text format is a `CharFormat`; otherwise returns `false`.

bool	isBlockFormat () const
	Returns `true` if this text format is a `BlockFormat`; otherwise returns `false`.

bool	isListFormat () const
	Returns `true` if this text format is a `ListFormat`; otherwise returns `false`.

bool	isFrameFormat () const
	Returns `true` if this text format is a `FrameFormat`; otherwise returns `false`.

bool	isImageFormat () const
	Returns `true` if this text format is an image format; otherwise returns `false`.

bool	isTableFormat () const
	Returns `true` if this text format is a `TableFormat`; otherwise returns `false`.

bool	isTableCellFormat () const

QTextBlockFormat	toBlockFormat () const
	Returns this format as a block format.

QTextCharFormat	toCharFormat () const
	Returns this format as a character format.

QTextListFormat	toListFormat () const
	Returns this format as a list format.

QTextTableFormat	toTableFormat () const
	Returns this format as a table format.

QTextFrameFormat	toFrameFormat () const
	Returns this format as a frame format.

QTextImageFormat	toImageFormat () const
	Returns this format as an image format.

QTextTableCellFormat	toTableCellFormat () const

bool	operator== (const QTextFormat &rhs) const
	Returns `true` if this text format is the same as the other text format.

bool	operator!= (const QTextFormat &rhs) const
	Returns `true` if this text format is different from the other text format.

	operator QVariant () const
	Returns the text format as a QVariant.

void	setLayoutDirection (Qt::LayoutDirection direction)
	Sets the document's layout direction to the specified direction.

Qt::LayoutDirection	layoutDirection () const
	Returns the document's layout direction.

void	setBackground (const QBrush &brush)
	Sets the brush use to paint the document's background to the brush specified.

QBrush	background () const
	Returns the brush used to paint the document's background.

void	clearBackground ()
	Clears the brush used to paint the document's background.

void	setForeground (const QBrush &brush)
	Sets the foreground brush to the specified brush.

QBrush	foreground () const
	Returns the brush used to render foreground details, such as text, frame outlines, and table borders.

void	clearForeground ()
	Clears the brush used to paint the document's foreground.

Protected Member Functions
	QTextListFormat (const QTextFormat &fmt)

Friends
class	QTextFormat

Detailed Description

\reentrant

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

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, unless it has been overridden via setStart().

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

Definition at line 723 of file qtextformat.h.

Member Enumeration Documentation

◆ Style

enum QTextListFormat::Style

This enum describes the symbols used to decorate list items:

\value ListDisc a filled circle \value ListCircle an empty circle \value ListSquare a filled square \value ListDecimal decimal values in ascending order \value ListLowerAlpha lower case Latin characters in alphabetical order \value ListUpperAlpha upper case Latin characters in alphabetical order \value ListLowerRoman lower case roman numerals (supports up to 4999 items only) \value ListUpperRoman upper case roman numerals (supports up to 4999 items only) \omitvalue ListStyleUndefined

Enumerator
ListDisc
ListCircle
ListSquare
ListDecimal
ListLowerAlpha
ListUpperAlpha
ListLowerRoman
ListUpperRoman
ListStyleUndefined

Definition at line 730 of file qtextformat.h.

Constructor & Destructor Documentation

◆ QTextListFormat() [1/2]

QTextListFormat::QTextListFormat ( )

Constructs a new list format object.

Definition at line 2644 of file qtextformat.cpp.

◆ QTextListFormat() [2/2]

QTextListFormat::QTextListFormat ( const QTextFormat & other )

explicitprotected

Creates a new list format with the same attributes as the given text format.

Definition at line 2658 of file qtextformat.cpp.

Member Function Documentation

◆ indent()

int QTextListFormat::indent ( ) const

inline

Returns the list format's indentation.

The indentation is multiplied by the QTextDocument::indentWidth property to get the effective indent in pixels.

See also: setIndent()

Definition at line 747 of file qtextformat.h.

◆ isValid()

bool QTextListFormat::isValid ( ) const

inline

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

Definition at line 728 of file qtextformat.h.

◆ numberPrefix()

QString QTextListFormat::numberPrefix ( ) const

inline

Since: 4.8

Returns the list format's number prefix.

See also: setNumberPrefix()

Definition at line 751 of file qtextformat.h.

◆ numberSuffix()

QString QTextListFormat::numberSuffix ( ) const

inline

Since: 4.8

Returns the list format's number suffix.

See also: setNumberSuffix()

Definition at line 755 of file qtextformat.h.

◆ setIndent()

void QTextListFormat::setIndent ( int indentation )

inline

Sets the list format's indentation.

The indentation is multiplied by the QTextDocument::indentWidth property to get the effective indent in pixels.

See also: indent()

Definition at line 771 of file qtextformat.h.

◆ setNumberPrefix()

void QTextListFormat::setNumberPrefix ( const QString & numberPrefix )

inline

Since: 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.

See also: numberPrefix()

Definition at line 774 of file qtextformat.h.

◆ setNumberSuffix()

void QTextListFormat::setNumberSuffix ( const QString & numberSuffix )

inline

Since: 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 ".".

See also: numberSuffix()

Definition at line 777 of file qtextformat.h.

◆ setStart()

void QTextListFormat::setStart ( int start )

inline

Since: 6.6

Sets the list format's start index.

This allows you to start a list with an index other than 1. This can be used with all sorted list types: for example if the style() is QTextListFormat::ListLowerAlpha and start() is 4, the first list item begins with "d". It does not have any effect on unsorted list types.

The default start is 1.

See also: start()

Definition at line 780 of file qtextformat.h.

◆ setStyle()

void QTextListFormat::setStyle ( Style style )

inline

Sets the list format's style.

See also: style(), Style

Definition at line 768 of file qtextformat.h.

◆ start()

int QTextListFormat::start ( ) const

inline

Since: 6.6

Returns the number to be shown by the first list item, if the style() is QTextListFormat::ListDecimal, or to offset other sorted list types.

See also: setStart()

Definition at line 759 of file qtextformat.h.

◆ style()

Style QTextListFormat::style ( ) const

inline

Returns the list format's style.

See also: setStyle(), Style

Definition at line 743 of file qtextformat.h.

Friends And Related Symbol Documentation

◆ QTextFormat

friend class QTextFormat

friend

Definition at line 763 of file qtextformat.h.

The documentation for this class was generated from the following files:

qtbase/src/gui/text/qtextformat.h (ab2f4ef8fad82fd07dac8768b8dcb94b11b271b6)
qtbase/src/gui/text/qtextformat.cpp (622133ace2533617f294b8d875b5eb749a78571b)

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ Style

Constructor & Destructor Documentation

◆ QTextListFormat() [1/2]

◆ QTextListFormat() [2/2]

Member Function Documentation

◆ indent()

◆ isValid()

◆ numberPrefix()

◆ numberSuffix()

◆ setIndent()

◆ setNumberPrefix()

◆ setNumberSuffix()

◆ setStart()

◆ setStyle()

◆ start()

◆ style()

Friends And Related Symbol Documentation

◆ QTextFormat