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 。

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 。