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

Public constructors

new QTextCharFormatnewConstructor QTextCharFormat::QTextCharFormat()

Public methods

voidanchor=(bool anchor)Method void QTextCharFormat::setAnchor(bool anchor)
[const]stringanchorHrefMethod QString QTextCharFormat::anchorHref()
voidanchorHref=(string value)Method void QTextCharFormat::setAnchorHref(const QString &value)
[const]stringanchorNameMethod QString QTextCharFormat::anchorName()
voidanchorName=(string name)Method void QTextCharFormat::setAnchorName(const QString &name)
[const]string[]anchorNamesMethod QStringList QTextCharFormat::anchorNames()
voidanchorNames=(string[] names)Method void QTextCharFormat::setAnchorNames(const QStringList &names)
[const]voidassign(const QTextCharFormat other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QTextCharFormatdupCreates a copy of self
[const]QFontfontMethod QFont QTextCharFormat::font()
voidfont=(const QFont font)Method void QTextCharFormat::setFont(const QFont &font)
[const]QFont_CapitalizationfontCapitalizationMethod QFont::Capitalization QTextCharFormat::fontCapitalization()
voidfontCapitalization=(const QFont_Capitalization capitalization)Method void QTextCharFormat::setFontCapitalization(QFont::Capitalization capitalization)
[const]stringfontFamilyMethod QString QTextCharFormat::fontFamily()
voidfontFamily=(string family)Method void QTextCharFormat::setFontFamily(const QString &family)
[const]boolfontFixedPitchMethod bool QTextCharFormat::fontFixedPitch()
voidfontFixedPitch=(bool fixedPitch)Method void QTextCharFormat::setFontFixedPitch(bool fixedPitch)
[const]boolfontItalicMethod bool QTextCharFormat::fontItalic()
voidfontItalic=(bool italic)Method void QTextCharFormat::setFontItalic(bool italic)
[const]boolfontKerningMethod bool QTextCharFormat::fontKerning()
voidfontKerning=(bool enable)Method void QTextCharFormat::setFontKerning(bool enable)
[const]doublefontLetterSpacingMethod double QTextCharFormat::fontLetterSpacing()
voidfontLetterSpacing=(double spacing)Method void QTextCharFormat::setFontLetterSpacing(double spacing)
[const]boolfontOverlineMethod bool QTextCharFormat::fontOverline()
voidfontOverline=(bool overline)Method void QTextCharFormat::setFontOverline(bool overline)
[const]doublefontPointSizeMethod double QTextCharFormat::fontPointSize()
voidfontPointSize=(double size)Method void QTextCharFormat::setFontPointSize(double size)
[const]boolfontStrikeOutMethod bool QTextCharFormat::fontStrikeOut()
voidfontStrikeOut=(bool strikeOut)Method void QTextCharFormat::setFontStrikeOut(bool strikeOut)
[const]QFont_StyleHintfontStyleHintMethod QFont::StyleHint QTextCharFormat::fontStyleHint()
[const]QFont_StyleStrategyfontStyleStrategyMethod QFont::StyleStrategy QTextCharFormat::fontStyleStrategy()
voidfontStyleStrategy=(const QFont_StyleStrategy strategy)Method void QTextCharFormat::setFontStyleStrategy(QFont::StyleStrategy strategy)
[const]boolfontUnderlineMethod bool QTextCharFormat::fontUnderline()
voidfontUnderline=(bool underline)Method void QTextCharFormat::setFontUnderline(bool underline)
[const]intfontWeightMethod int QTextCharFormat::fontWeight()
voidfontWeight=(int weight)Method void QTextCharFormat::setFontWeight(int weight)
[const]doublefontWordSpacingMethod double QTextCharFormat::fontWordSpacing()
voidfontWordSpacing=(double spacing)Method void QTextCharFormat::setFontWordSpacing(double spacing)
[const]boolisAnchorMethod bool QTextCharFormat::isAnchor()
[const]boolisAnchor?Method bool QTextCharFormat::isAnchor()
[const]boolisValidMethod bool QTextCharFormat::isValid()
[const]boolisValid?Method bool QTextCharFormat::isValid()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
voidsetAnchor(bool anchor)Method void QTextCharFormat::setAnchor(bool anchor)
voidsetAnchorHref(string value)Method void QTextCharFormat::setAnchorHref(const QString &value)
voidsetAnchorName(string name)Method void QTextCharFormat::setAnchorName(const QString &name)
voidsetAnchorNames(string[] names)Method void QTextCharFormat::setAnchorNames(const QStringList &names)
voidsetFont(const QFont font)Method void QTextCharFormat::setFont(const QFont &font)
voidsetFontCapitalization(const QFont_Capitalization capitalization)Method void QTextCharFormat::setFontCapitalization(QFont::Capitalization capitalization)
voidsetFontFamily(string family)Method void QTextCharFormat::setFontFamily(const QString &family)
voidsetFontFixedPitch(bool fixedPitch)Method void QTextCharFormat::setFontFixedPitch(bool fixedPitch)
voidsetFontItalic(bool italic)Method void QTextCharFormat::setFontItalic(bool italic)
voidsetFontKerning(bool enable)Method void QTextCharFormat::setFontKerning(bool enable)
voidsetFontLetterSpacing(double spacing)Method void QTextCharFormat::setFontLetterSpacing(double spacing)
voidsetFontOverline(bool overline)Method void QTextCharFormat::setFontOverline(bool overline)
voidsetFontPointSize(double size)Method void QTextCharFormat::setFontPointSize(double size)
voidsetFontStrikeOut(bool strikeOut)Method void QTextCharFormat::setFontStrikeOut(bool strikeOut)
voidsetFontStyleHint(const QFont_StyleHint hint)Method void QTextCharFormat::setFontStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy)
voidsetFontStyleHint(const QFont_StyleHint hint,
const QFont_StyleStrategy strategy)
Method void QTextCharFormat::setFontStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy)
voidsetFontStyleStrategy(const QFont_StyleStrategy strategy)Method void QTextCharFormat::setFontStyleStrategy(QFont::StyleStrategy strategy)
voidsetFontUnderline(bool underline)Method void QTextCharFormat::setFontUnderline(bool underline)
voidsetFontWeight(int weight)Method void QTextCharFormat::setFontWeight(int weight)
voidsetFontWordSpacing(double spacing)Method void QTextCharFormat::setFontWordSpacing(double spacing)
voidsetTableCellColumnSpan(int tableCellColumnSpan)Method void QTextCharFormat::setTableCellColumnSpan(int tableCellColumnSpan)
voidsetTableCellRowSpan(int tableCellRowSpan)Method void QTextCharFormat::setTableCellRowSpan(int tableCellRowSpan)
voidsetTextOutline(const QPen pen)Method void QTextCharFormat::setTextOutline(const QPen &pen)
voidsetToolTip(string tip)Method void QTextCharFormat::setToolTip(const QString &tip)
voidsetUnderlineColor(const QColor color)Method void QTextCharFormat::setUnderlineColor(const QColor &color)
voidsetUnderlineStyle(const QTextCharFormat_UnderlineStyle style)Method void QTextCharFormat::setUnderlineStyle(QTextCharFormat::UnderlineStyle style)
voidsetVerticalAlignment(const QTextCharFormat_VerticalAlignment alignment)Method void QTextCharFormat::setVerticalAlignment(QTextCharFormat::VerticalAlignment alignment)
[const]inttableCellColumnSpanMethod int QTextCharFormat::tableCellColumnSpan()
voidtableCellColumnSpan=(int tableCellColumnSpan)Method void QTextCharFormat::setTableCellColumnSpan(int tableCellColumnSpan)
[const]inttableCellRowSpanMethod int QTextCharFormat::tableCellRowSpan()
voidtableCellRowSpan=(int tableCellRowSpan)Method void QTextCharFormat::setTableCellRowSpan(int tableCellRowSpan)
[const]QPentextOutlineMethod QPen QTextCharFormat::textOutline()
voidtextOutline=(const QPen pen)Method void QTextCharFormat::setTextOutline(const QPen &pen)
[const]stringtoolTipMethod QString QTextCharFormat::toolTip()
voidtoolTip=(string tip)Method void QTextCharFormat::setToolTip(const QString &tip)
[const]QColorunderlineColorMethod QColor QTextCharFormat::underlineColor()
voidunderlineColor=(const QColor color)Method void QTextCharFormat::setUnderlineColor(const QColor &color)
[const]QTextCharFormat_UnderlineStyleunderlineStyleMethod QTextCharFormat::UnderlineStyle QTextCharFormat::underlineStyle()
voidunderlineStyle=(const QTextCharFormat_UnderlineStyle style)Method void QTextCharFormat::setUnderlineStyle(QTextCharFormat::UnderlineStyle style)
[const]QTextCharFormat_VerticalAlignmentverticalAlignmentMethod QTextCharFormat::VerticalAlignment QTextCharFormat::verticalAlignment()
voidverticalAlignment=(const QTextCharFormat_VerticalAlignment alignment)Method void QTextCharFormat::setVerticalAlignment(QTextCharFormat::VerticalAlignment alignment)

Public static methods and constants

QTextCharFormat_VerticalAlignmentAlignBottomEnum constant enum QTextCharFormat::AlignBottom
QTextCharFormat_VerticalAlignmentAlignMiddleEnum constant enum QTextCharFormat::AlignMiddle
QTextCharFormat_VerticalAlignmentAlignNormalEnum constant enum QTextCharFormat::AlignNormal
QTextCharFormat_VerticalAlignmentAlignSubScriptEnum constant enum QTextCharFormat::AlignSubScript
QTextCharFormat_VerticalAlignmentAlignSuperScriptEnum constant enum QTextCharFormat::AlignSuperScript
QTextCharFormat_VerticalAlignmentAlignTopEnum constant enum QTextCharFormat::AlignTop
QTextCharFormat_UnderlineStyleDashDotDotLineEnum constant enum QTextCharFormat::DashDotDotLine
QTextCharFormat_UnderlineStyleDashDotLineEnum constant enum QTextCharFormat::DashDotLine
QTextCharFormat_UnderlineStyleDashUnderlineEnum constant enum QTextCharFormat::DashUnderline
QTextCharFormat_UnderlineStyleDotLineEnum constant enum QTextCharFormat::DotLine
QTextCharFormat_UnderlineStyleNoUnderlineEnum constant enum QTextCharFormat::NoUnderline
QTextCharFormat_UnderlineStyleSingleUnderlineEnum constant enum QTextCharFormat::SingleUnderline
QTextCharFormat_UnderlineStyleSpellCheckUnderlineEnum constant enum QTextCharFormat::SpellCheckUnderline
QTextCharFormat_UnderlineStyleWaveUnderlineEnum constant enum QTextCharFormat::WaveUnderline

Detailed description

[static] QTextCharFormat_VerticalAlignment AlignBottom

Description: Enum constant enum QTextCharFormat::AlignBottom

[static] QTextCharFormat_VerticalAlignment AlignMiddle

Description: Enum constant enum QTextCharFormat::AlignMiddle

[static] QTextCharFormat_VerticalAlignment AlignNormal

Description: Enum constant enum QTextCharFormat::AlignNormal

[static] QTextCharFormat_VerticalAlignment AlignSubScript

Description: Enum constant enum QTextCharFormat::AlignSubScript

[static] QTextCharFormat_VerticalAlignment AlignSuperScript

Description: Enum constant enum QTextCharFormat::AlignSuperScript

[static] QTextCharFormat_VerticalAlignment AlignTop

Description: Enum constant enum QTextCharFormat::AlignTop

[static] QTextCharFormat_UnderlineStyle DashDotDotLine

Description: Enum constant enum QTextCharFormat::DashDotDotLine

[static] QTextCharFormat_UnderlineStyle DashDotLine

Description: Enum constant enum QTextCharFormat::DashDotLine

[static] QTextCharFormat_UnderlineStyle DashUnderline

Description: Enum constant enum QTextCharFormat::DashUnderline

[static] QTextCharFormat_UnderlineStyle DotLine

Description: Enum constant enum QTextCharFormat::DotLine

[static] QTextCharFormat_UnderlineStyle NoUnderline

Description: Enum constant enum QTextCharFormat::NoUnderline

[static] QTextCharFormat_UnderlineStyle SingleUnderline

Description: Enum constant enum QTextCharFormat::SingleUnderline

[static] QTextCharFormat_UnderlineStyle SpellCheckUnderline

Description: Enum constant enum QTextCharFormat::SpellCheckUnderline

[static] QTextCharFormat_UnderlineStyle WaveUnderline

Description: Enum constant enum QTextCharFormat::WaveUnderline

void anchor=(bool anchor)

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

[const] string anchorHref

Description: Method QString QTextCharFormat::anchorHref()

void anchorHref=(string value)

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

[const] string anchorName

Description: Method QString QTextCharFormat::anchorName()

void anchorName=(string name)

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

[const] string[] anchorNames

Description: Method QStringList QTextCharFormat::anchorNames()

void anchorNames=(string[] names)

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

[const] void assign(const QTextCharFormat other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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 destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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] QTextCharFormat dup

Description: Creates a copy of self

[const] QFont font

Description: Method QFont QTextCharFormat::font()

void font=(const QFont font)

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

[const] QFont_Capitalization fontCapitalization

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

void fontCapitalization=(const QFont_Capitalization capitalization)

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

[const] string fontFamily

Description: Method QString QTextCharFormat::fontFamily()

void fontFamily=(string family)

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

[const] bool fontFixedPitch

Description: Method bool QTextCharFormat::fontFixedPitch()

void fontFixedPitch=(bool fixedPitch)

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

[const] bool fontItalic

Description: Method bool QTextCharFormat::fontItalic()

void fontItalic=(bool italic)

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

[const] bool fontKerning

Description: Method bool QTextCharFormat::fontKerning()

void fontKerning=(bool enable)

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

[const] double fontLetterSpacing

Description: Method double QTextCharFormat::fontLetterSpacing()

void fontLetterSpacing=(double spacing)

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

[const] bool fontOverline

Description: Method bool QTextCharFormat::fontOverline()

void fontOverline=(bool overline)

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

[const] double fontPointSize

Description: Method double QTextCharFormat::fontPointSize()

void fontPointSize=(double size)

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

[const] bool fontStrikeOut

Description: Method bool QTextCharFormat::fontStrikeOut()

void fontStrikeOut=(bool strikeOut)

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

[const] QFont_StyleHint fontStyleHint

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

[const] QFont_StyleStrategy fontStyleStrategy

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

void fontStyleStrategy=(const QFont_StyleStrategy strategy)

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

[const] bool fontUnderline

Description: Method bool QTextCharFormat::fontUnderline()

void fontUnderline=(bool underline)

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

[const] int fontWeight

Description: Method int QTextCharFormat::fontWeight()

void fontWeight=(int weight)

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

[const] double fontWordSpacing

Description: Method double QTextCharFormat::fontWordSpacing()

void fontWordSpacing=(double spacing)

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

[const] bool isAnchor

Description: Method bool QTextCharFormat::isAnchor()

[const] bool isAnchor?

Description: Method bool QTextCharFormat::isAnchor()

[const] bool isValid

Description: Method bool QTextCharFormat::isValid()

[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

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

[static] new QTextCharFormat new

Description: Constructor QTextCharFormat::QTextCharFormat()

This method creates an object of class QTextCharFormat.

void setAnchor(bool anchor)

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

void setAnchorHref(string value)

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

void setAnchorName(string name)

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

void setAnchorNames(string[] names)

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

void setFont(const QFont font)

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

void setFontCapitalization(const QFont_Capitalization capitalization)

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

void setFontFamily(string family)

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

void setFontFixedPitch(bool fixedPitch)

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

void setFontItalic(bool italic)

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

void setFontKerning(bool enable)

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

void setFontLetterSpacing(double spacing)

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

void setFontOverline(bool overline)

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

void setFontPointSize(double size)

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

void setFontStrikeOut(bool strikeOut)

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

void setFontStyleHint(const QFont_StyleHint hint)

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

void setFontStyleHint(const QFont_StyleHint hint,const QFont_StyleStrategy strategy)

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)

void setFontUnderline(bool underline)

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

void setFontWeight(int weight)

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

void setFontWordSpacing(double spacing)

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

void setTableCellColumnSpan(int tableCellColumnSpan)

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

void setTableCellRowSpan(int tableCellRowSpan)

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

void setTextOutline(const QPen pen)

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

void setToolTip(string tip)

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

void setUnderlineColor(const QColor color)

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

void setUnderlineStyle(const QTextCharFormat_UnderlineStyle style)

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

void setVerticalAlignment(const QTextCharFormat_VerticalAlignment alignment)

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

[const] int tableCellColumnSpan

Description: Method int QTextCharFormat::tableCellColumnSpan()

void tableCellColumnSpan=(int tableCellColumnSpan)

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

[const] int tableCellRowSpan

Description: Method int QTextCharFormat::tableCellRowSpan()

void tableCellRowSpan=(int tableCellRowSpan)

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

[const] QPen textOutline

Description: Method QPen QTextCharFormat::textOutline()

void textOutline=(const QPen pen)

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

[const] string toolTip

Description: Method QString QTextCharFormat::toolTip()

void toolTip=(string tip)

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

[const] QColor underlineColor

Description: Method QColor QTextCharFormat::underlineColor()

void underlineColor=(const QColor color)

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

[const] QTextCharFormat_UnderlineStyle underlineStyle

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

void underlineStyle=(const QTextCharFormat_UnderlineStyle style)

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

[const] QTextCharFormat_VerticalAlignment verticalAlignment

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

void verticalAlignment=(const QTextCharFormat_VerticalAlignment alignment)

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