QTextCharFormat Class
QTextCharFormatクラスは、QTextDocument...続きを読む
Header: | #include <QTextCharFormat> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
qmake: | QT += gui |
Inherits: | QTextFormat |
Inherited By: |
- 継承したメンバを含むすべてのメンバの一覧
- 非推奨メンバー
- QTextCharFormatは、リッチテキスト処理APIおよび暗黙的に共有されるクラスの一部です。
注意:このクラスの関数はすべてリエントラントです。
パブリック型
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() 関数を使用して、ハイパーリンクのリンク先とアンカー名の情報を指定します。
QTextFormat 、QTextBlockFormat 、QTextTableFormat 、QTextListFormatも参照 。
メンバ型ドキュメント
enum QTextCharFormat::FontPropertiesInheritanceBehavior
この列挙型は、未設定のフォント・プロパティに対するsetFont() 関数の振る舞いを指定します。
定数 | 値 | 説明 |
---|---|---|
QTextCharFormat::FontPropertiesSpecifiedOnly | 0 | プロパティが明示的に設定されていない場合、テキスト書式のプロパティ値を変更しない。 |
QTextCharFormat::FontPropertiesAll | 1 | プ ロパテ ィ が明示的に設定 さ れていない と き は、 テ キ ス ト 書式のプ ロパテ ィ をデ フ ォ ル ト 値で上書 き し ます。 |
setFont()も参照 。
enum QTextCharFormat::UnderlineStyle
この列挙型は、テキストに下線を引くさまざまな方法を記述します。
定数 | 値 | 説明 |
---|---|---|
QTextCharFormat::NoUnderline | 0 | テキストは下線装飾なしで描画されます。 |
QTextCharFormat::SingleUnderline | 1 | 線はQt::SolidLine を用いて描画されます。 |
QTextCharFormat::DashUnderline | 2 | ダッシュはQt::DashLine を使って描画されます。 |
QTextCharFormat::DotLine | 3 | ドットはQt::DotLine を使用して描画されます; |
QTextCharFormat::DashDotLine | 4 | ダッシュとドットはQt::DashDotLine を使用して描画されます。 |
QTextCharFormat::DashDotDotLine | 5 | 下線はQt::DashDotDotLine を使って引かれます。 |
QTextCharFormat::WaveUnderline | 6 | テキストには波型の下線が引かれます。 |
QTextCharFormat::SpellCheckUnderline | 7 | 下線は QPlatformTheme の SpellCheckUnderlineStyle テーマヒントに依存して描画されます。デフォルトではWaveUnderlineにマップされ、macOSではDotLineにマップされます。 |
Qt::PenStyleも参照してください 。
enum QTextCharFormat::VerticalAlignment
この列挙型は、隣接する文字を縦に揃える方法を記述します。
定数 | 値 | 説明 |
---|---|---|
QTextCharFormat::AlignNormal | 0 | 隣接する文字は、使用中の書記体系のテキストの標準的な方法で配置されます。 |
QTextCharFormat::AlignSuperScript | 1 | 文字は、通常のテキストではベースラインより上に配置される。 |
QTextCharFormat::AlignSubScript | 2 | 通常のテキストでは、文字はベースラインより下に配置されます。 |
QTextCharFormat::AlignMiddle | 3 | オブジェ ク ト の中心はベース ラ イ ン と 垂直整列 し ます。現在のところ、これはインラインオブジェクトにのみ実装されています。 |
QTextCharFormat::AlignBottom | 5 | オブジェクトの下端はベースラインに垂直に揃えられる。 |
QTextCharFormat::AlignTop | 4 | オブジェクトの上辺はベースラインと垂直に揃えられる。 |
QTextCharFormat::AlignBaseline | 6 | 文字のベースラインは揃えられる。 |
メンバ関数 ドキュメント
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 が真の場合、この書式を持つテキストはアンカーを表し、適切な方法でフォーマットされます。(アンカーとはハイパーリンクのことで、しばしば下線が引かれ、プレーンテキストとは異なる色で表示されます)。
テキストがどのように表示されるかは、その書式に有効なアンカーが定義されているかどうかとは無関係です。ハイパーテキストリンクを作成するには、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 を設定します。
behavior がQTextCharFormat::FontPropertiesAll の場合、 明示的に設定されていないフォント・プロパティは、デフォルト値で設定されているのと同様に扱われます。behavior がQTextCharFormat::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 が true の場合は、テキスト書式のフォントを固定ピッチに設定します。そうでない場合は、非固定ピッチフォントを使用します。
fontFixedPitch() およびsetFont() も参照 。
void QTextCharFormat::setFontHintingPreference(QFont::HintingPreference hintingPreference)
テキスト書式のフォントのヒンティング優先度をhintingPreference に設定する。
fontHintingPreference()、setFont() およびQFont::setHintingPreference() も参照 。
void QTextCharFormat::setFontItalic(bool italic)
italic が true の場合、テキスト書式のフォントをイタリック体に設定します。
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 は、 文字が取るスペー ス量を 2 倍に し ます。
fontLetterSpacing(),setFontLetterSpacingType(),fontLetterSpacingType()も参照 。
void QTextCharFormat::setFontLetterSpacingType(QFont::SpacingType letterSpacingType)
このフォーマットの文字間隔タイプをletterSpacingType に設定する。
fontLetterSpacingType()、setFontLetterSpacing() およびfontLetterSpacing() も参照 。
void QTextCharFormat::setFontOverline(bool overline)
overline が true の場合、テキスト書式のフォントを上書きに設定します。そうでない場合、フォントは上書きをせずに表示されます。
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)
フォントスタイルhint およびstrategy を設定します。
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 で導入されました。
この関数は 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() も参照 ください。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。