QTextFormat 类

成员函数文档

QTextFormat::QTextFormat()

创建一个具有InvalidFormat的新文本格式。

另请参阅FormatType

[显式] QTextFormat::QTextFormat(int type)

创建具有给定type的新文本格式。

另请参阅FormatType

QTextFormat::QTextFormat(const QTextFormat &other)

创建一个与other文本格式具有相同属性的新文本格式。

[noexcept] QTextFormat::~QTextFormat()

销毁此文本格式。

QBrush QTextFormat::background() const

返回用于绘制文档背景的画笔。

另请参阅setBackground()，clearBackground()，以及foreground()

bool QTextFormat::boolProperty(int propertyId) const

返回由propertyId指定的属性的值。如果属性不是QTextFormat::Bool类型，则返回false。

另请参阅setProperty()，intProperty()，doubleProperty()，stringProperty()，colorProperty()，lengthProperty()，lengthVectorProperty()，以及Property

QBrush QTextFormat::brushProperty(int propertyId) const

返回由 propertyId 指定的属性的值；如果属性不是 QMetaType::QBrush 类型，则返回 Qt::NoBrush。

另请参阅 setProperty()，boolProperty()，intProperty()，doubleProperty()，stringProperty()，lengthProperty()，lengthVectorProperty()，以及 Property。

void QTextFormat::clearBackground()

清除用于绘制文档背景的画刷。将使用默认画刷。

另请参阅 background()，setBackground()，以及 clearForeground。

void QTextFormat::clearForeground()

清除用于绘制文档前景的画刷。将使用默认画刷。

另请参阅 foreground()，setForeground()，以及 clearBackground。

void QTextFormat::clearProperty(int propertyId)

清除由 propertyId 指定的属性的值。

另请参阅 Property。

QColor QTextFormat::colorProperty(int propertyId) const

返回由 propertyId 指定的属性的值；如果属性不是 QMetaType::QColor 类型，则返回一个无效的颜色。

另请参阅 setProperty()，boolProperty()，intProperty()，doubleProperty()，stringProperty()，lengthProperty()，lengthVectorProperty()，以及 Property。

qreal QTextFormat::doubleProperty(int propertyId) const

返回由 propertyId 指定的属性的值。如果属性不是 QMetaType::Double 或 QMetaType::Float 类型，则返回 0。

另请参阅 setProperty()，boolProperty()，intProperty()，stringProperty()，colorProperty()，lengthProperty()，lengthVectorProperty()，以及 Property。

QBrush QTextFormat::foreground() const

返回用于渲染前景细节（如文本、框架轮廓和表格边框）的画刷。

另请参阅 setForeground()，clearForeground()，以及 background。

bool QTextFormat::hasProperty(int propertyId) const

如果文本格式具有给定 propertyId 的属性，则返回 true；否则返回 false。

另请参阅 properties() 和 Property。

int QTextFormat::intProperty(int propertyId) const

返回由 propertyId 指定的属性的值。如果属性不是 QTextFormat::Integer 类型，则返回 0。

另请参阅setProperty()，boolProperty()，doubleProperty()，stringProperty()，colorProperty()，lengthProperty()，lengthVectorProperty() 和 Property。

bool QTextFormat::isBlockFormat() const

如果此文本格式是 BlockFormat，则返回 true；否则返回 false。

bool QTextFormat::isCharFormat() const

如果此文本格式是 CharFormat，则返回 true；否则返回 false。

bool QTextFormat::isEmpty() const

如果格式未存储任何属性，则返回 true；否则返回 false。

另请参阅propertyCount() 和 properties()。

bool QTextFormat::isFrameFormat() const

如果此文本格式是 FrameFormat，则返回 true；否则返回 false。

bool QTextFormat::isImageFormat() const

如果此文本格式是图像格式，则返回 true；否则返回 false。

bool QTextFormat::isListFormat() const

如果此文本格式是 ListFormat，则返回 true；否则返回 false。

bool QTextFormat::isTableCellFormat() const

如果此文本格式是 TableCellFormat，则返回 true；否则返回 false。

bool QTextFormat::isTableFormat() const

如果此文本格式是 TableFormat，则返回 true；否则返回 false。

bool QTextFormat::isValid() const

如果格式有效（即不是 InvalidFormat），则返回 true；否则返回 false。

Qt::LayoutDirection QTextFormat::layoutDirection() const

返回文档的布局方向。

另请参阅setLayoutDirection。

QTextLength QTextFormat::lengthProperty(int propertyId) const

返回由 propertyId 给定的属性的值。

另请参阅 setProperty()，boolProperty()，intProperty()，doubleProperty()，stringProperty()，colorProperty()，lengthVectorProperty()，以及 Property。

QList<QTextLength> QTextFormat::lengthVectorProperty(int propertyId) const

返回由 propertyId 给定的属性的值。如果该属性不是 QTextFormat::LengthVector 类型，则返回一个空列表。

另请参阅 setProperty()，boolProperty()，intProperty()，doubleProperty()，stringProperty()，colorProperty()，lengthProperty()，以及 Property。

void QTextFormat::merge(const QTextFormat &other)

合并 other 格式与此格式；在存在冲突的情况下，other 格式优先。

int QTextFormat::objectIndex() const

返回格式对象的位置索引，如果格式对象无效则返回 -1。

另请参阅 setObjectIndex。

int QTextFormat::objectType() const

返回文本格式的对象类型。

另请参阅 ObjectTypes 和 setObjectType。

QPen QTextFormat::penProperty(int propertyId) const

返回由 propertyId 给定的属性的值；如果该属性不是 QMetaType::QPen 类型，则返回 Qt::NoPen。

另请参阅 setProperty()，boolProperty()，intProperty()，doubleProperty()，stringProperty()，lengthProperty()，lengthVectorProperty()，以及 Property。

QMap<int, QVariant> QTextFormat::properties() const

返回包含此文本格式所有属性的映射。

QVariant QTextFormat::property(int propertyId) const

返回给定 propertyId 指定的属性。

另请参阅 setProperty() 和 Property。

int QTextFormat::propertyCount() const

返回存储在格式中的属性数量。

void QTextFormat::setBackground(const QBrush &brush)

将用于绘制文档背景的画笔设置为指定的 brush。

另请参阅 background，clearBackground，以及 setForeground。

void QTextFormat::setForeground(const QBrush &brush)

设置前景笔刷为指定的brush。前景笔刷主要用于渲染文本。

另请参阅前景()，clearForeground()和setBackground()。

void QTextFormat::setLayoutDirection(Qt::LayoutDirection direction)

设置文档的布局方向为指定的direction。

另请参阅layoutDirection()。

void QTextFormat::setObjectIndex(int index)

设置格式对象的对象index。

另请参阅objectIndex()。

void QTextFormat::setObjectType(int type)

将文本格式对象的类型设置为type。

另请参阅ObjectTypes和objectType()。

void QTextFormat::setProperty(int propertyId, const QVariant &value)

将指定的propertyId属性设置为给定的value。

另请参阅property()和Property。

void QTextFormat::setProperty(int propertyId, const QList<QTextLength> &value)

将propertyId指定的属性值设置为value。

另请参阅lengthVectorProperty()和Property。

QString QTextFormat::stringProperty(int propertyId) const

返回指定propertyId的属性值；如果属性类型不是QMetaType::QString类型，则返回空字符串。

另请参阅setProperty，boolProperty，intProperty，doubleProperty，colorProperty，lengthProperty，lengthVectorProperty和Property。

void QTextFormat::swap(QTextFormat &other)

与other交换文本格式。此函数非常快速且永不失败。

QTextBlockFormat QTextFormat::toBlockFormat() const

将此格式作为块格式返回。

QTextCharFormat QTextFormat::toCharFormat() const

以字符格式返回此格式。

QTextFrameFormat QTextFormat::toFrameFormat() const

以框架格式返回此格式。

QTextImageFormat QTextFormat::toImageFormat() const

以图像格式返回此格式。

QTextListFormat QTextFormat::toListFormat() const

以列表格式返回此格式。

QTextTableCellFormat QTextFormat::toTableCellFormat() const

以表格单元格格式返回此格式。

QTextTableFormat QTextFormat::toTableFormat() const

以表格格式返回此格式。

int QTextFormat::type() const

返回此格式的类型。

另请参阅FormatType

QVariant QTextFormat::operator QVariant() const

将文本格式作为 QVariant 返回。

bool QTextFormat::operator!=(const QTextFormat &other) const

如果此文本格式与 other 文本格式不同，则返回 true。

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

将 other 文本格式赋值给此文本格式，并返回对此文本格式的引用。

bool QTextFormat::operator==(const QTextFormat &other) const

如果此文本格式与 other 文本格式相同，则返回 true。