QTextCharFormat Class

QTextCharFormat クラスは、QTextDocument の文字の書式情報を提供します

ヘッダー #include <QTextCharFormat>
CMake: find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
を継承する: QTextFormat
によって継承される:

QTextImageFormat そしてQTextTableCellFormat

注意:このクラスの関数はすべてリエントラントです。

パブリック型

enum FontPropertiesInheritanceBehavior { FontPropertiesSpecifiedOnly, FontPropertiesAll }
enum UnderlineStyle { NoUnderline, SingleUnderline, DashUnderline, DotLine, DashDotLine, …, SpellCheckUnderline }
enum VerticalAlignment { AlignNormal, AlignSuperScript, AlignSubScript, AlignMiddle, AlignBottom, …, AlignBaseline }

パブリック関数

QTextCharFormat()
QString anchorHref() const
QStringList anchorNames() const
(since 6.0) qreal baselineOffset() const
QFont font() const
QFont::Capitalization fontCapitalization() const
QVariant fontFamilies() const
bool fontFixedPitch() const
QFont::HintingPreference fontHintingPreference() const
bool fontItalic() const
bool fontKerning() const
qreal fontLetterSpacing() const
QFont::SpacingType fontLetterSpacingType() const
bool fontOverline() const
qreal fontPointSize() const
int fontStretch() const
bool fontStrikeOut() const
QFont::StyleHint fontStyleHint() const
QVariant fontStyleName() const
QFont::StyleStrategy fontStyleStrategy() const
bool fontUnderline() const
int fontWeight() const
qreal fontWordSpacing() const
bool isAnchor() const
bool isValid() const
void setAnchor(bool anchor)
void setAnchorHref(const QString &value)
void setAnchorNames(const QStringList &names)
(since 6.0) void setBaselineOffset(qreal baseline)
void setFont(const QFont &font, QTextCharFormat::FontPropertiesInheritanceBehavior behavior = FontPropertiesAll)
void setFontCapitalization(QFont::Capitalization capitalization)
void setFontFamilies(const QStringList &families)
void setFontFixedPitch(bool fixedPitch)
void setFontHintingPreference(QFont::HintingPreference hintingPreference)
void setFontItalic(bool italic)
void setFontKerning(bool enable)
void setFontLetterSpacing(qreal spacing)
void setFontLetterSpacingType(QFont::SpacingType letterSpacingType)
void setFontOverline(bool overline)
void setFontPointSize(qreal size)
void setFontStretch(int factor)
void setFontStrikeOut(bool strikeOut)
void setFontStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy = QFont::PreferDefault)
void setFontStyleName(const QString &styleName)
void setFontStyleStrategy(QFont::StyleStrategy strategy)
void setFontUnderline(bool underline)
void setFontWeight(int weight)
void setFontWordSpacing(qreal spacing)
(since 6.0) void setSubScriptBaseline(qreal baseline)
(since 6.0) void setSuperScriptBaseline(qreal baseline)
void setTextOutline(const QPen &pen)
void setToolTip(const QString &text)
void setUnderlineColor(const QColor &color)
void setUnderlineStyle(QTextCharFormat::UnderlineStyle style)
void setVerticalAlignment(QTextCharFormat::VerticalAlignment alignment)
(since 6.0) qreal subScriptBaseline() const
(since 6.0) qreal superScriptBaseline() const
QPen textOutline() const
QString toolTip() const
QColor underlineColor() const
QTextCharFormat::UnderlineStyle underlineStyle() const
QTextCharFormat::VerticalAlignment verticalAlignment() const

詳細説明

文書内のテキストの文字書式は、テキストの視覚的な特性や、ハイパーテキスト文書内での役割に関する情報を指定します。

setFont() 関数にフォントを与えることで、使用するフォントを設定することができ、外観の各側面を調整することで、望ましい効果を与えることができます。setFontFamilies() とsetFontPointSize() は、フォントのファミリ (Times など) と印字サイズを定義します。setFontWeight() とsetFontItalic() は、フォントのスタイルを制御します。setFontUnderline()、setFontOverline()、setFontStrikeOut()、setFontFixedPitch()は、テキストの追加効果を提供します。

色はsetForeground() で設定します。テキストを(ハイパーリンクの)アンカーとして使用する場合は、setAnchor() で有効にできます。setAnchorHref() およびsetAnchorNames() 関数を使用して、ハイパーリンクのリンク先とアンカー名の情報を指定します。

QTextFormatQTextBlockFormatQTextTableFormatQTextListFormatも参照

メンバ型ドキュメント

enum QTextCharFormat::FontPropertiesInheritanceBehavior

この列挙型は、setFont() 関数が未設定のフォントプロパティに対してどのように振る舞うべきかを指定します。

定数説明
QTextCharFormat::FontPropertiesSpecifiedOnly0プロパティが明示的に設定されていない場合、テキスト書式のプロパティ値を変更しない。
QTextCharFormat::FontPropertiesAll1プ ロパテ ィ が明示的に設定 さ れていない と き は、 テ キ ス ト 書式のプ ロパテ ィ をデ フ ォ ル ト 値で上書 き し ます。

setFont()も参照してください

enum QTextCharFormat::UnderlineStyle

この列挙型は、テキストに下線を引くさまざまな方法を記述します。

定数説明
QTextCharFormat::NoUnderline0テキストは下線装飾なしで描画されます。
QTextCharFormat::SingleUnderline1線はQt::SolidLine を用いて描画されます。
QTextCharFormat::DashUnderline2ダッシュはQt::DashLine を使って描画されます。
QTextCharFormat::DotLine3ドットはQt::DotLine を使用して描画されます;
QTextCharFormat::DashDotLine4ダッシュとドットはQt::DashDotLine を使って描かれます。
QTextCharFormat::DashDotDotLine5下線はQt::DashDotDotLine を使って引かれます。
QTextCharFormat::WaveUnderline6テキストには波型の下線が引かれます。
QTextCharFormat::SpellCheckUnderline7下線は QPlatformTheme の SpellCheckUnderlineStyle テーマヒントに依存して描画されます。デフォルトではWaveUnderlineにマップされ、macOSではDotLineにマップされます。

Qt::PenStyleも参照してください

enum QTextCharFormat::VerticalAlignment

この列挙型は、隣接する文字を縦に揃える方法を記述する。

定数説明
QTextCharFormat::AlignNormal0隣接する文字は、使用中の書記体系のテキストの標準的な方法で配置される。
QTextCharFormat::AlignSuperScript1文字は、通常のテキストではベースラインより上に配置される。
QTextCharFormat::AlignSubScript2通常のテキストでは、文字はベースラインより下に配置されます。
QTextCharFormat::AlignMiddle3オブジェクトの中心はベースラインと垂直に揃えられる。現在のところ、これはインラインオブジェクトにのみ実装されています。
QTextCharFormat::AlignBottom5オブジェクトの下端はベースラインに垂直に揃えられる。
QTextCharFormat::AlignTop4オブジェクトの上辺はベースラインと垂直に揃えられる。
QTextCharFormat::AlignBaseline6文字のベースラインは揃えられる。

メンバ関数ドキュメント

QTextCharFormat::QTextCharFormat()

新しい文字書式オブジェクトを構築します。

QString QTextCharFormat::anchorHref() const

テキストフォーマットのハイパーテキストリンクを返します。

setAnchorHref()も参照 ください。

QStringList QTextCharFormat::anchorNames() const

このテキストフォーマットに関連付けられたアンカー名を返すか、何も設定されていない場合は空の文字列リストを返す。アンカー名が設定されていれば、この形式のテキストをハイパーテキストリンクの宛先にすることができます。

setAnchorNames()も参照 ください。

[since 6.0] qreal QTextCharFormat::baselineOffset() const

ベースラインオフセットを % で返します。

この関数は Qt 6.0 で導入されました。

setBaselineOffset(),setSubScriptBaseline(),subScriptBaseline(),setSuperScriptBaseline(),superScriptBaseline()も参照してください

QFont QTextCharFormat::font() const

この文字書式に対応するフォントを返します。

setFont()も参照

QFont::Capitalization QTextCharFormat::fontCapitalization() const

フォントの現在の大文字小文字の種類を返します。

setFontCapitalization()も参照 ください。

QVariant QTextCharFormat::fontFamilies() const

テキストフォーマットのフォントファミリーを返します。

注意: この関数は歴史的な理由によりQVariant を返します。Qt 7 ではQStringList を返すように修正される予定です。このバリアントにはQStringList オブジェクトが含まれており、toStringList() を呼び出すことで取り出すことができます。

setFontFamilies() およびfont()も参照してください

bool QTextCharFormat::fontFixedPitch() const

テキストフォーマットのフォントが固定ピッチの場合はtrue を返し、そうでない場合はfalse を返す。

setFontFixedPitch() およびfont()も参照

QFont::HintingPreference QTextCharFormat::fontHintingPreference() const

このテキスト形式に設定されているヒンティングの優先順位を返します。

setFontHintingPreference()、font() およびQFont::hintingPreference()も参照 ください。

bool QTextCharFormat::fontItalic() const

テキストフォーマットのフォントがイタリック体の場合はtrue を返し、そうでない場合はfalse を返す。

setFontItalic() およびfont()も参照

bool QTextCharFormat::fontKerning() const

フォントのカーニングが有効な場合はtrue を返す。

setFontKerning() およびfont()も参照

qreal QTextCharFormat::fontLetterSpacing() const

現在の文字間隔を返す。

setFontLetterSpacing()、setFontLetterSpacingType() およびfontLetterSpacingType()も参照

QFont::SpacingType QTextCharFormat::fontLetterSpacingType() const

この書式の文字間隔の種類を返します。

setFontLetterSpacingType()、setFontLetterSpacing() およびfontLetterSpacing()も参照

bool QTextCharFormat::fontOverline() const

テキストフォーマットのフォントがオーバーラインされている場合はtrue を返し、そうでない場合はfalse を返す。

setFontOverline() およびfont()も参照

qreal QTextCharFormat::fontPointSize() const

このフォーマットでテキストを表示する際に使用するフォントサイズを返します。

setFontPointSize() およびfont()も参照 ください。

int QTextCharFormat::fontStretch() const

現在のフォントのストレッチを返します。

setFontStretch()も参照 ください。

bool QTextCharFormat::fontStrikeOut() const

テ キ ス ト 書式の フ ォ ン ト が取り消 し 線 (横線が引かれている) の場合はtrue を返し、 それ以外の場合はfalse を返す。

setFontStrikeOut() およびfont()も参照

QFont::StyleHint QTextCharFormat::fontStyleHint() const

フォントスタイルのヒントを返します。

setFontStyleHint() およびfont()も参照 ください。

QVariant QTextCharFormat::fontStyleName() const

テキストフォーマットのフォントスタイル名を返します。

注意: この関数は歴史的な理由によりQVariant を返します。Qt 7 ではQStringList を返すように修正されます。このバリアントにはQStringList オブジェクトが含まれており、toStringList() を呼び出すことで取り出すことができます。

setFontStyleName()、font()、QFont::styleName()も参照してください

QFont::StyleStrategy QTextCharFormat::fontStyleStrategy() const

現在のフォントスタイル戦略を返します。

setFontStyleStrategy() およびfont()も参照 ください。

bool QTextCharFormat::fontUnderline() const

テキスト書式のフォントに下線が引かれている場合はtrue を返し、そうでない場合はfalse を返す。

setFontUnderline() およびfont()も参照

int QTextCharFormat::fontWeight() const

テキスト書式のフォントの太さを返します。

setFontWeight()、font() およびQFont::Weightも参照

qreal QTextCharFormat::fontWordSpacing() const

現在のワード間隔値を返す。

setFontWordSpacing()も参照

bool QTextCharFormat::isAnchor() const

テキストがアンカーとしてフォーマットされている場合はtrue を返し、そうでない場合はfalse を返す。

setAnchor(),setAnchorHref(),setAnchorNames()も参照

bool QTextCharFormat::isValid() const

この文字フォーマットが有効な場合はtrue を返し、そうでない場合は false を返す。

void QTextCharFormat::setAnchor(bool anchor)

anchor が true なら、 この書式を持つテキストはアンカーを表し、 適切な書式になります。(アンカーとはハイパーリンクのことで、しばしば下線が引かれ、プレーンテキストとは異なる色で表示されます)。

テキストがどのように表示されるかは、その書式に有効なアンカーが定義されているかどうかとは無関係です。ハイパーテキストリンクを作成するには、setAnchorHref ()、およびオプションでsetAnchorNames ()を使用します。

isAnchor()も参照してください

void QTextCharFormat::setAnchorHref(const QString &value)

テキストフォーマットのハイパーテキストリンクを、与えられたvalue に設定する。これは通常 "http://example.com/index.html "のようなURLである。

アンカーは、value を表示テキストとして表示される。別のテキストを表示したい場合は、setAnchorNames() を呼ぶ。

テキストをハイパーテキスト・リンクとしてフォーマットするには、setAnchor() を使用する。

anchorHref()も参照

void QTextCharFormat::setAnchorNames(const QStringList &names)

テキストフォーマットのアンカーnames を設定する。アンカーをハイパーリンクとして動作させるには、setAnchorHref() でリンク先を設定し、setAnchor() でアンカーを有効にする必要があります。

anchorNames()も参照してください

[since 6.0] void QTextCharFormat::setBaselineOffset(qreal baseline)

テキストの基準線 (高さの %) をbaseline に設定します。正の値を指定すると、テキストは対応する%だけ上に移動し、負の値を指定すると下に移動します。デフォルト値は 0 です。

この関数は Qt 6.0 で導入されました。

baselineOffset(),setSubScriptBaseline(),subScriptBaseline(),setSuperScriptBaseline(),superScriptBaseline()も参照してください

void QTextCharFormat::setFont(const QFont &font, QTextCharFormat::FontPropertiesInheritanceBehavior behavior = FontPropertiesAll)

テキストフォーマットのfont を設定する。

behaviorQTextCharFormat::FontPropertiesAll の場合、 明示的に設定されていないフォント・プロパティはデフォルト値で設定されているのと同様に扱われます。behaviorQTextCharFormat::FontPropertiesSpecifiedOnly の場合、 明示的に設定されていないフォント・プロパティは無視され、それぞれのプロパティ値は変更されません。

font()も参照

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

このフォントで表示されるテキストの大文字小文字をcapitalization に設定します。

フォントの大文字化は、選択された大文字化モードでテキストを表示します。

fontCapitalization()も参照

void QTextCharFormat::setFontFamilies(const QStringList &families)

テキスト書式のフォントfamilies を設定する。

fontFamilies() およびsetFont()も参照

void QTextCharFormat::setFontFixedPitch(bool fixedPitch)

fixedPitch が真の場合、テキストフォーマットのフォントを固定ピッチに設定する。

fontFixedPitch() およびsetFont()も参照

void QTextCharFormat::setFontHintingPreference(QFont::HintingPreference hintingPreference)

テキストフォーマットのフォントのヒンティング優先度をhintingPreference に設定する。

fontHintingPreference(),setFont(),QFont::setHintingPreference()も参照

void QTextCharFormat::setFontItalic(bool italic)

italic が真の場合、テキストフォーマットのフォントをイタリック体に設定する。

fontItalic() およびsetFont()も参照

void QTextCharFormat::setFontKerning(bool enable)

こ の フ ォ ン ト に対 し て、 カ ーニ ン グ を有効に し ます (enable が true の場合)。

カーニングを有効にすると、グリフメトリクスは、たとえ欧文テキストであっても、足し合わされなくなります。言い換えれば、 width('a') + width('b') が width("ab") と等しいという仮定は必ずしも正しくない。

fontKerning() およびsetFont()も参照のこと

void QTextCharFormat::setFontLetterSpacing(qreal spacing)

この書式の文字間隔を、与えられたspacing に設定します。この値の意味は、フォントの文字間隔の種類によって異なります。

パーセンテージスペーシングの場合、値 100 はデフォルトのスペーシングを表し、値 200 は文字がとるスペーシングを倍増します。

fontLetterSpacing()、setFontLetterSpacingType()、fontLetterSpacingType()も参照

void QTextCharFormat::setFontLetterSpacingType(QFont::SpacingType letterSpacingType)

この書式の字間タイプをletterSpacingType に設定する。

fontLetterSpacingType()、setFontLetterSpacing()、fontLetterSpacing()も参照

void QTextCharFormat::setFontOverline(bool overline)

overline が真の場合、テキスト書式のフォントを上書きに設定する。それ以外の場合、フォントは上書きをせずに表示される。

fontOverline() およびsetFont()も参照

void QTextCharFormat::setFontPointSize(qreal size)

テキスト書式のフォントsize を設定する。

fontPointSize() およびsetFont()も参照

void QTextCharFormat::setFontStretch(int factor)

フォントのストレッチファクターをfactor に設定します。

ストレッチ・ファクターは、フォント内のすべての文字の幅をファクター・パーセントで変更します。た と えば、factor を 150 に設定す る と 、 フ ォ ン ト 内のすべてのキ ャ ラ ク タ の幅が 1.5 倍 (すなわち 150%)にな り ます。デフォルトのストレッチファクターは 100 です。ストレッチファクターの最小値は 1 で、最大値は 4000 です。

ストレッチファクターはアウトラインフォントにのみ適用されます。伸縮倍率はビ ッ ト マ ッ プ フ ォ ン ト に対 し ては無視 さ れます。

fontStretch()も参照

void QTextCharFormat::setFontStrikeOut(bool strikeOut)

strikeOut が true の場合、テキスト書式のフォントに取り消し線を有効(水平線で囲む)にして設定する。

fontStrikeOut() およびsetFont()も参照

void QTextCharFormat::setFontStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy = QFont::PreferDefault)

フォントスタイルhintstrategy を設定します。

Qt は X11 でのスタイル・ヒントをサポートしていません。

fontStyleHint(),setFont(),QFont::setStyleHint()も参照してください

void QTextCharFormat::setFontStyleName(const QString &styleName)

テキスト書式のフォントstyleName を設定する。

fontStyleName(),setFont(),QFont::setStyleName()も参照

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

フォント・スタイルstrategy を設定する。

fontStyleStrategy(),setFont(),QFont::setStyleStrategy()も参照

void QTextCharFormat::setFontUnderline(bool underline)

underline が true の場合、テキスト書式のフォントに下線を設定する。

fontUnderline() およびsetFont()も参照

void QTextCharFormat::setFontWeight(int weight)

テ キ ス ト 書式のフ ォ ン ト の太 さ をweight に設定 し ます。

fontWeight(),setFont(),QFont::Weightも参照

void QTextCharFormat::setFontWordSpacing(qreal spacing)

このフォーマットの単語間隔を、与えられたspacing にピクセル単位で設定する。

fontWordSpacing()も参照

[since 6.0] void QTextCharFormat::setSubScriptBaseline(qreal baseline)

下付き文字のベースラインをフォントの高さに対するパーセンテージでbaseline に設定します。 デフォルト値は 16.67% (高さの 1/6) です。

この関数は Qt 6.0 で導入されました。

subScriptBaseline(),setSuperScriptBaseline(),superScriptBaseline(),setBaselineOffset(),baselineOffset()も参照してください

[since 6.0] void QTextCharFormat::setSuperScriptBaseline(qreal baseline)

上付き文字のベースラインをフォントの高さに対するパーセンテージでbaseline に設定します。 デフォルト値は 50% (高さの 1/2) です。

この関数は Qt 6.0 で導入されました。

superScriptBaseline(),setSubScriptBaseline(),subScriptBaseline(),setBaselineOffset(),baselineOffset()も参照してください

void QTextCharFormat::setTextOutline(const QPen &pen)

文字の輪郭を描画するペンを、与えられたpen に設定します。

textOutline()も参照

void QTextCharFormat::setToolTip(const QString &text)

テキストの断片のツールチップを、与えられたtext に設定します。

toolTip()も参照

void QTextCharFormat::setUnderlineColor(const QColor &color)

この書式を持つ文字のアンダーライン、オーバーライン、取り消し線の描画に使われる色を、指定したcolor に設定します。

underlineColor()も参照

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

テキストの下線のスタイルをstyle に設定する。

underlineStyle()も参照

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

この書式で文字に使われる垂直アライメントを指定されたalignment に設定する。

verticalAlignment()も参照

[since 6.0] qreal QTextCharFormat::subScriptBaseline() const

下付き文字のベースラインを、フォントの高さに対するパーセンテージで返します。

この関数は Qt 6.0 で導入されました。

setSubScriptBaseline(),setSuperScriptBaseline(),superScriptBaseline(),setBaselineOffset(),baselineOffset()も参照してください

[since 6.0] qreal QTextCharFormat::superScriptBaseline() const

上付き文字のベースラインをフォントの高さの % で返します。

この関数は Qt 6.0 で導入されました。

setSuperScriptBaseline(),setSubScriptBaseline(),subScriptBaseline(),setBaselineOffset(),baselineOffset()も参照してください

QPen QTextCharFormat::textOutline() const

このフォーマットで文字の輪郭を描画するために使用されるペンを返します。

setTextOutline()も参照 ください。

QString QTextCharFormat::toolTip() const

テキストの断片に対して表示されるツールチップを返します。

setToolTip()も参照してください

QColor QTextCharFormat::underlineColor() const

この書式で文字にアンダーライン、オーバーライン、取り消し線を引くときに使用する色を返します。

setUnderlineColor()も参照 ください。

QTextCharFormat::UnderlineStyle QTextCharFormat::underlineStyle() const

テキストの下線のスタイルを返します。

setUnderlineStyle()も参照

QTextCharFormat::VerticalAlignment QTextCharFormat::verticalAlignment() const

この書式の文字に使われる垂直アライメントを返します。

setVerticalAlignment()も参照

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.