KLayout Manual: Main Index » Class Index » API reference - Class QTextCharFormat

API reference - Class QTextCharFormat

Notation used in Ruby API documentation

Description: Binding of QTextCharFormat

Class hierarchy: QTextCharFormat » QTextFormat

Sub-classes: UnderlineStyle, VerticalAlignment

• Public constructors
• Public methods
• Public static methods and constants
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QTextCharFormat_VerticalAlignment ptr AlignBottom

Description: Enum constant QTextCharFormat::AlignBottom

[static,const] new QTextCharFormat_VerticalAlignment ptr AlignMiddle

Description: Enum constant QTextCharFormat::AlignMiddle

[static,const] new QTextCharFormat_VerticalAlignment ptr AlignNormal

Description: Enum constant QTextCharFormat::AlignNormal

[static,const] new QTextCharFormat_VerticalAlignment ptr AlignSubScript

Description: Enum constant QTextCharFormat::AlignSubScript

[static,const] new QTextCharFormat_VerticalAlignment ptr AlignSuperScript

Description: Enum constant QTextCharFormat::AlignSuperScript

[static,const] new QTextCharFormat_VerticalAlignment ptr AlignTop

Description: Enum constant QTextCharFormat::AlignTop

[static,const] new QTextCharFormat_UnderlineStyle ptr DashDotDotLine

Description: Enum constant QTextCharFormat::DashDotDotLine

[static,const] new QTextCharFormat_UnderlineStyle ptr DashDotLine

Description: Enum constant QTextCharFormat::DashDotLine

[static,const] new QTextCharFormat_UnderlineStyle ptr DashUnderline

Description: Enum constant QTextCharFormat::DashUnderline

[static,const] new QTextCharFormat_UnderlineStyle ptr DotLine

Description: Enum constant QTextCharFormat::DotLine

[static,const] new QTextCharFormat_UnderlineStyle ptr NoUnderline

Description: Enum constant QTextCharFormat::NoUnderline

[static,const] new QTextCharFormat_UnderlineStyle ptr SingleUnderline

Description: Enum constant QTextCharFormat::SingleUnderline

[static,const] new QTextCharFormat_UnderlineStyle ptr SpellCheckUnderline

Description: Enum constant QTextCharFormat::SpellCheckUnderline

[static,const] new QTextCharFormat_UnderlineStyle ptr WaveUnderline

Description: Enum constant QTextCharFormat::WaveUnderline

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

[const] bool anchor

Description: Method bool QTextCharFormat::isAnchor()

Python specific notes:

The object exposes a readable attribute 'anchor'. This is the getter.

void anchor=(bool anchor)

Description: Method void QTextCharFormat::setAnchor(bool anchor)

Python specific notes:

The object exposes a writable attribute 'anchor'. This is the setter.

[const] string anchorHref

Description: Method QString QTextCharFormat::anchorHref()

Python specific notes:

The object exposes a readable attribute 'anchorHref'. This is the getter.

void anchorHref=(string value)

Description: Method void QTextCharFormat::setAnchorHref(const QString &value)

Python specific notes:

The object exposes a writable attribute 'anchorHref'. This is the setter.

[const] string anchorName

Description: Method QString QTextCharFormat::anchorName()

Python specific notes:

The object exposes a readable attribute 'anchorName'. This is the getter.

void anchorName=(string name)

Description: Method void QTextCharFormat::setAnchorName(const QString &name)

Python specific notes:

The object exposes a writable attribute 'anchorName'. This is the setter.

[const] string[] anchorNames

Description: Method QStringList QTextCharFormat::anchorNames()

Python specific notes:

The object exposes a readable attribute 'anchorNames'. This is the getter.

void anchorNames=(string[] names)

Description: Method void QTextCharFormat::setAnchorNames(const QStringList &names)

Python specific notes:

The object exposes a writable attribute 'anchorNames'. This is the setter.

void assign(const QTextCharFormat other)

Description: Assigns another object to self

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] new QTextCharFormat ptr dup

Description: Creates a copy of self

[const] QFont font

Description: Method QFont QTextCharFormat::font()

Python specific notes:

The object exposes a readable attribute 'font'. This is the getter.

void font=(const QFont font)

Description: Method void QTextCharFormat::setFont(const QFont &font)

Python specific notes:

The object exposes a writable attribute 'font'. This is the setter.

[const] QFont_Capitalization fontCapitalization

Description: Method QFont::Capitalization QTextCharFormat::fontCapitalization()

Python specific notes:

The object exposes a readable attribute 'fontCapitalization'. This is the getter.

void fontCapitalization=(const QFont_Capitalization capitalization)

Description: Method void QTextCharFormat::setFontCapitalization(QFont::Capitalization capitalization)

Python specific notes:

The object exposes a writable attribute 'fontCapitalization'. This is the setter.

[const] string fontFamily

Description: Method QString QTextCharFormat::fontFamily()

Python specific notes:

The object exposes a readable attribute 'fontFamily'. This is the getter.

void fontFamily=(string family)

Description: Method void QTextCharFormat::setFontFamily(const QString &family)

Python specific notes:

The object exposes a writable attribute 'fontFamily'. This is the setter.

[const] bool fontFixedPitch

Description: Method bool QTextCharFormat::fontFixedPitch()

Python specific notes:

The object exposes a readable attribute 'fontFixedPitch'. This is the getter.

void fontFixedPitch=(bool fixedPitch)

Description: Method void QTextCharFormat::setFontFixedPitch(bool fixedPitch)

Python specific notes:

The object exposes a writable attribute 'fontFixedPitch'. This is the setter.

[const] bool fontItalic

Description: Method bool QTextCharFormat::fontItalic()

Python specific notes:

The object exposes a readable attribute 'fontItalic'. This is the getter.

void fontItalic=(bool italic)

Description: Method void QTextCharFormat::setFontItalic(bool italic)

Python specific notes:

The object exposes a writable attribute 'fontItalic'. This is the setter.

[const] bool fontKerning

Description: Method bool QTextCharFormat::fontKerning()

Python specific notes:

The object exposes a readable attribute 'fontKerning'. This is the getter.

void fontKerning=(bool enable)

Description: Method void QTextCharFormat::setFontKerning(bool enable)

Python specific notes:

The object exposes a writable attribute 'fontKerning'. This is the setter.

[const] double fontLetterSpacing

Description: Method double QTextCharFormat::fontLetterSpacing()

Python specific notes:

The object exposes a readable attribute 'fontLetterSpacing'. This is the getter.

void fontLetterSpacing=(double spacing)

Description: Method void QTextCharFormat::setFontLetterSpacing(double spacing)

Python specific notes:

The object exposes a writable attribute 'fontLetterSpacing'. This is the setter.

[const] bool fontOverline

Description: Method bool QTextCharFormat::fontOverline()

Python specific notes:

The object exposes a readable attribute 'fontOverline'. This is the getter.

void fontOverline=(bool overline)

Description: Method void QTextCharFormat::setFontOverline(bool overline)

Python specific notes:

The object exposes a writable attribute 'fontOverline'. This is the setter.

[const] double fontPointSize

Description: Method double QTextCharFormat::fontPointSize()

Python specific notes:

The object exposes a readable attribute 'fontPointSize'. This is the getter.

void fontPointSize=(double size)

Description: Method void QTextCharFormat::setFontPointSize(double size)

Python specific notes:

The object exposes a writable attribute 'fontPointSize'. This is the setter.

[const] bool fontStrikeOut

Description: Method bool QTextCharFormat::fontStrikeOut()

Python specific notes:

The object exposes a readable attribute 'fontStrikeOut'. This is the getter.

void fontStrikeOut=(bool strikeOut)

Description: Method void QTextCharFormat::setFontStrikeOut(bool strikeOut)

Python specific notes:

The object exposes a writable attribute 'fontStrikeOut'. This is the setter.

[const] QFont_StyleHint fontStyleHint

Description: Method QFont::StyleHint QTextCharFormat::fontStyleHint()

Python specific notes:

The object exposes a readable attribute 'fontStyleHint'. This is the getter.

[const] QFont_StyleStrategy fontStyleStrategy

Description: Method QFont::StyleStrategy QTextCharFormat::fontStyleStrategy()

Python specific notes:

The object exposes a readable attribute 'fontStyleStrategy'. This is the getter.

void fontStyleStrategy=(const QFont_StyleStrategy strategy)

Description: Method void QTextCharFormat::setFontStyleStrategy(QFont::StyleStrategy strategy)

Python specific notes:

The object exposes a writable attribute 'fontStyleStrategy'. This is the setter.

[const] bool fontUnderline

Description: Method bool QTextCharFormat::fontUnderline()

Python specific notes:

The object exposes a readable attribute 'fontUnderline'. This is the getter.

void fontUnderline=(bool underline)

Description: Method void QTextCharFormat::setFontUnderline(bool underline)

Python specific notes:

The object exposes a writable attribute 'fontUnderline'. This is the setter.

[const] int fontWeight

Description: Method int QTextCharFormat::fontWeight()

Python specific notes:

The object exposes a readable attribute 'fontWeight'. This is the getter.

void fontWeight=(int weight)

Description: Method void QTextCharFormat::setFontWeight(int weight)

Python specific notes:

The object exposes a writable attribute 'fontWeight'. This is the setter.

[const] double fontWordSpacing

Description: Method double QTextCharFormat::fontWordSpacing()

Python specific notes:

The object exposes a readable attribute 'fontWordSpacing'. This is the getter.

void fontWordSpacing=(double spacing)

Description: Method void QTextCharFormat::setFontWordSpacing(double spacing)

Python specific notes:

The object exposes a writable attribute 'fontWordSpacing'. This is the setter.

[const] bool isAnchor?

Description: Method bool QTextCharFormat::isAnchor()

Python specific notes:

The object exposes a readable attribute 'anchor'. This is the getter.

[const] bool isValid?

Description: Method bool QTextCharFormat::isValid()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[static] new QTextCharFormat new

Description: Constructor QTextCharFormat::QTextCharFormat()

This method creates an object of class QTextCharFormat.

Python specific notes:

This method is the default initializer of the object

void setAnchor(bool anchor)

Description: Method void QTextCharFormat::setAnchor(bool anchor)

Python specific notes:

The object exposes a writable attribute 'anchor'. This is the setter.

void setAnchorHref(string value)

Description: Method void QTextCharFormat::setAnchorHref(const QString &value)

Python specific notes:

The object exposes a writable attribute 'anchorHref'. This is the setter.

void setAnchorName(string name)

Description: Method void QTextCharFormat::setAnchorName(const QString &name)

Python specific notes:

The object exposes a writable attribute 'anchorName'. This is the setter.

void setAnchorNames(string[] names)

Description: Method void QTextCharFormat::setAnchorNames(const QStringList &names)

Python specific notes:

The object exposes a writable attribute 'anchorNames'. This is the setter.

void setFont(const QFont font)

Description: Method void QTextCharFormat::setFont(const QFont &font)

Python specific notes:

The object exposes a writable attribute 'font'. This is the setter.

void setFontCapitalization(const QFont_Capitalization capitalization)

Description: Method void QTextCharFormat::setFontCapitalization(QFont::Capitalization capitalization)

Python specific notes:

The object exposes a writable attribute 'fontCapitalization'. This is the setter.

void setFontFamily(string family)

Description: Method void QTextCharFormat::setFontFamily(const QString &family)

Python specific notes:

The object exposes a writable attribute 'fontFamily'. This is the setter.

void setFontFixedPitch(bool fixedPitch)

Description: Method void QTextCharFormat::setFontFixedPitch(bool fixedPitch)

Python specific notes:

The object exposes a writable attribute 'fontFixedPitch'. This is the setter.

void setFontItalic(bool italic)

Description: Method void QTextCharFormat::setFontItalic(bool italic)

Python specific notes:

The object exposes a writable attribute 'fontItalic'. This is the setter.

void setFontKerning(bool enable)

Description: Method void QTextCharFormat::setFontKerning(bool enable)

Python specific notes:

The object exposes a writable attribute 'fontKerning'. This is the setter.

void setFontLetterSpacing(double spacing)

Description: Method void QTextCharFormat::setFontLetterSpacing(double spacing)

Python specific notes:

The object exposes a writable attribute 'fontLetterSpacing'. This is the setter.

void setFontOverline(bool overline)

Description: Method void QTextCharFormat::setFontOverline(bool overline)

Python specific notes:

The object exposes a writable attribute 'fontOverline'. This is the setter.

void setFontPointSize(double size)

Description: Method void QTextCharFormat::setFontPointSize(double size)

Python specific notes:

The object exposes a writable attribute 'fontPointSize'. This is the setter.

void setFontStrikeOut(bool strikeOut)

Description: Method void QTextCharFormat::setFontStrikeOut(bool strikeOut)

Python specific notes:

The object exposes a writable attribute 'fontStrikeOut'. This is the setter.

void setFontStyleHint(const QFont_StyleHint hint,const QFont_StyleStrategy strategy = QFont::PreferDefault)

Description: Method void QTextCharFormat::setFontStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy)

void setFontStyleStrategy(const QFont_StyleStrategy strategy)

Description: Method void QTextCharFormat::setFontStyleStrategy(QFont::StyleStrategy strategy)

Python specific notes:

The object exposes a writable attribute 'fontStyleStrategy'. This is the setter.

void setFontUnderline(bool underline)

Description: Method void QTextCharFormat::setFontUnderline(bool underline)

Python specific notes:

The object exposes a writable attribute 'fontUnderline'. This is the setter.

void setFontWeight(int weight)

Description: Method void QTextCharFormat::setFontWeight(int weight)

Python specific notes:

The object exposes a writable attribute 'fontWeight'. This is the setter.

void setFontWordSpacing(double spacing)

Description: Method void QTextCharFormat::setFontWordSpacing(double spacing)

Python specific notes:

The object exposes a writable attribute 'fontWordSpacing'. This is the setter.

void setTableCellColumnSpan(int tableCellColumnSpan)

Description: Method void QTextCharFormat::setTableCellColumnSpan(int tableCellColumnSpan)

Python specific notes:

The object exposes a writable attribute 'tableCellColumnSpan'. This is the setter.

void setTableCellRowSpan(int tableCellRowSpan)

Description: Method void QTextCharFormat::setTableCellRowSpan(int tableCellRowSpan)

Python specific notes:

The object exposes a writable attribute 'tableCellRowSpan'. This is the setter.

void setTextOutline(const QPen pen)

Description: Method void QTextCharFormat::setTextOutline(const QPen &pen)

Python specific notes:

The object exposes a writable attribute 'textOutline'. This is the setter.

void setToolTip(string tip)

Description: Method void QTextCharFormat::setToolTip(const QString &tip)

Python specific notes:

The object exposes a writable attribute 'toolTip'. This is the setter.

void setUnderlineColor(const QColor color)

Description: Method void QTextCharFormat::setUnderlineColor(const QColor &color)

Python specific notes:

The object exposes a writable attribute 'underlineColor'. This is the setter.

void setUnderlineStyle(const QTextCharFormat_UnderlineStyle style)

Description: Method void QTextCharFormat::setUnderlineStyle(QTextCharFormat::UnderlineStyle style)

Python specific notes:

The object exposes a writable attribute 'underlineStyle'. This is the setter.

void setVerticalAlignment(const QTextCharFormat_VerticalAlignment alignment)

Description: Method void QTextCharFormat::setVerticalAlignment(QTextCharFormat::VerticalAlignment alignment)

Python specific notes:

The object exposes a writable attribute 'verticalAlignment'. This is the setter.

[const] int tableCellColumnSpan

Description: Method int QTextCharFormat::tableCellColumnSpan()

Python specific notes:

The object exposes a readable attribute 'tableCellColumnSpan'. This is the getter.

void tableCellColumnSpan=(int tableCellColumnSpan)

Description: Method void QTextCharFormat::setTableCellColumnSpan(int tableCellColumnSpan)

Python specific notes:

The object exposes a writable attribute 'tableCellColumnSpan'. This is the setter.

[const] int tableCellRowSpan

Description: Method int QTextCharFormat::tableCellRowSpan()

Python specific notes:

The object exposes a readable attribute 'tableCellRowSpan'. This is the getter.

void tableCellRowSpan=(int tableCellRowSpan)

Description: Method void QTextCharFormat::setTableCellRowSpan(int tableCellRowSpan)

Python specific notes:

The object exposes a writable attribute 'tableCellRowSpan'. This is the setter.

[const] QPen textOutline

Description: Method QPen QTextCharFormat::textOutline()

Python specific notes:

The object exposes a readable attribute 'textOutline'. This is the getter.

void textOutline=(const QPen pen)

Description: Method void QTextCharFormat::setTextOutline(const QPen &pen)

Python specific notes:

The object exposes a writable attribute 'textOutline'. This is the setter.

[const] string toolTip

Description: Method QString QTextCharFormat::toolTip()

Python specific notes:

The object exposes a readable attribute 'toolTip'. This is the getter.

void toolTip=(string tip)

Description: Method void QTextCharFormat::setToolTip(const QString &tip)

Python specific notes:

The object exposes a writable attribute 'toolTip'. This is the setter.

[const] QColor underlineColor

Description: Method QColor QTextCharFormat::underlineColor()

Python specific notes:

The object exposes a readable attribute 'underlineColor'. This is the getter.

void underlineColor=(const QColor color)

Description: Method void QTextCharFormat::setUnderlineColor(const QColor &color)

Python specific notes:

The object exposes a writable attribute 'underlineColor'. This is the setter.

[const] QTextCharFormat_UnderlineStyle underlineStyle

Description: Method QTextCharFormat::UnderlineStyle QTextCharFormat::underlineStyle()

Python specific notes:

The object exposes a readable attribute 'underlineStyle'. This is the getter.

void underlineStyle=(const QTextCharFormat_UnderlineStyle style)

Description: Method void QTextCharFormat::setUnderlineStyle(QTextCharFormat::UnderlineStyle style)

Python specific notes:

The object exposes a writable attribute 'underlineStyle'. This is the setter.

[const] QTextCharFormat_VerticalAlignment verticalAlignment

Description: Method QTextCharFormat::VerticalAlignment QTextCharFormat::verticalAlignment()

Python specific notes:

The object exposes a readable attribute 'verticalAlignment'. This is the getter.

void verticalAlignment=(const QTextCharFormat_VerticalAlignment alignment)

Description: Method void QTextCharFormat::setVerticalAlignment(QTextCharFormat::VerticalAlignment alignment)

Python specific notes:

The object exposes a writable attribute 'verticalAlignment'. This is the setter.