QTextFormat Class

成员函数文档

QTextFormat::QTextFormat()

创建一种新的文本格式，其InvalidFormat 。

另请参阅 FormatType 。

[explicit] 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 。前景画笔主要用于渲染文本。

另请参阅 foreground()、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 QList<QTextLength> &value)

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

另请参阅 property(),lengthVectorProperty() 和Property 。

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

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

另请参阅 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 。