表とリスト
これらのコマンドはリストと表を作成することができます。リストは独立した段落として左揃えで表示されます。表は独立した段落として中央揃えで表示されます。表の幅は内容の幅に依存します。
\テーブル
テーブルの内容を区切ります。
このコマンドは、テーブルの幅をページ幅に対するパーセンテージで指定する引数を1つ受け取る：
/*!
\table 100 %
...
\endtable
*/上記のコードは、テーブルが利用可能なスペースをすべて埋めるようにします。テーブルの幅が100%より小さい場合、生成されるドキュメントではテーブルが中央に配置されます。
テーブルは、ヘッダー、行、列を含むことができます。行は「row」コマンドで始まり、「li」コマンドで始まるセルで構成されます。また、特別な書式を持つ特別な種類の行である"header "コマンドもあります。
/*!
\table
\header
\li Qt Core Feature
\li Brief Description
\row
\li \l {Signal and Slots}
\li Signals and slots are used for communication
between objects.
\row
\li \l {Layout Management}
\li The Qt layout system provides a simple
and powerful way of specifying the layout
of child widgets.
\row
\li \l {Drag and Drop}
\li Drag and drop provides a simple visual
mechanism which users can use to transfer
information between and within applications.
\endtable
*/セルを複数の行や列にまたがるようにすることもできます。例えば
/*!
\table
\header
\li {3,1} This header cell spans three columns,
but only one row.
\row
\li {2, 1} This table cell spans two columns,
but only one row
\li {1, 2} This table cell spans only one column,
but two rows.
\row
\li A regular table cell
\li A regular table cell
\endtable
*/\ヘッダー
heederコマンドは、以下のテーブルセルが現在のテーブルの列ヘッダであることを示します。
このコマンドは、"◆table...◆endtable"コマンド内でのみ使用できます。ヘッダには複数のセルを含めることができます。セルは "li "コマンドで作成します。
ヘッダー・セルのテキストはテーブル・セル内の中央に配置され、太字フォントを使用してレンダリングされます。
/*!
\table
\header
\li Qt Core Feature
\li Brief Description
\row
\li \l {Signal and Slots}
\li Signals and slots are used for communication
between objects.
\endtable
*/を参照してください。
\行
rowコマンドはテーブルに新しい行を開始します。新しい行に属している項目は、すぐに
このコマンドは "endtable "コマンド内でのみ使用できます。行は複数のセルを含むことができます。セルを作成するには、"li "コマンドを使用します。
各行の背景セルの色は、2 つのグレーの間で交互に変わり、行を互いに区別しやすくなります。セルの内容は左揃えです。
/*!
\table
\header
\li Qt Core Feature
\li Brief Description
\row
\li \l {Signal and Slots}
\li Signals and slots are used for communication
between objects.
\row
\li \l {Layout Management}
\li The Qt layout system provides a simple
and powerful way of specifying the layout
of child widgets.
\row
\li \l {Drag and Drop}
\li Drag and drop provides a simple visual
mechanism which users can use to transfer
information between and within applications.
\endtable
*/を参照してください。
\値
C++のenum項目のドキュメントを開始します。
このコマンドの最初の引数は値名です。値名の前には、角括弧で囲まれたオプションのsince節を付けることができます。値の説明は値名の後に続く。説明文は次の空行で終わるか、"value "で終わります。引数は表で表示されます。
注意: ￤値の説明に画像を含めるには、￤inlineimageコマンドを使用します。
since句がない場合、"value "コマンドは以下のようになります：
since句がある同じコマンドは次のようになります：
ドキュメントは、関連するクラス、ヘッダーファイル、またはネームスペースのドキュメンテーションにあります。例として、the\enumdocumentationを参照してください。
注意: Qt 5.4以降、"value "コマンドは"enum "トピックの外でも使用できま す。この場合、QDocは定数名(最初の引数からそのまま取 得)とその説明をリストした2列の表を表示します。これは、例えば、QML列挙プロパティの受け入れ可能な値を文書化するために、"enum"トピックで使用することができます。
enumと omitvalueも参照してください。
\を参照してください。
C++のenum項目をドキュメントから除外します。
このコマンドの唯一の必須引数は、省略される列挙項目の名前です。enum項目の後に1行の説明がある場合は、それも省略されます。
例については、enumドキュメントを参照してください。
を参照してください。
\リスト
を参照してください。
各リスト項目を作成するには、"li "コマンドを使用します。リストは常に1つ以上の項目を含みます。リストは入れ子にすることができます。例えば
/*!
\list
\li Qt Reference Documentation: Getting Started
\list
\li How to Learn Qt
\li Installation
\list
\li Qt/X11
\li Qt/Windows
\li Qt/Mac
\li Qt/Embedded
\endlist
\li Tutorial and Examples
\endlist
\endlist
*/リストは常に1つ以上の項目を含む。
/*!
\list
\li How to Learn Qt
\li Installation
\li Tutorial and Examples
\endlist
*/'A'を引数として与えると、箇条書きはアルファベット順の文字に置き換えられます：
- Qtの学び方
- インストール
- チュートリアルとサンプル
A'を'1'に置き換えると、リスト項目の番号は昇順になります：
- Qt の学び方
- インストール
- チュートリアルとサンプル
引数に 'i' を指定すると、箇条書きはローマ数字に置き換えられます：
- Qt の学び方
- インストール
- チュートリアルとサンプル
最後に、オプション引数として'I'を指定すると、リスト項目を昇順に続くローマ数字で表示させることができます：
- Qt の学び方
- インストール
- チュートリアルとサンプル
また、リストの開始位置を任意の文字や数字にすることもできます。例えば
/*!
\list G
\li How to Learn Qt
\li Installation
\li Tutorial and Examples
\endlist
*/を参照。
\li (テーブル・セル、リスト・アイテム)
このコマンドは、表とリストにのみ使用されます。このコマンドは表と リストでのみ使用されます。
このコマンドはテーブルとリストでのみ使用され、次の ∕liコマンドまで、または次の∕endtable 、∕endlistコマンドま で、すべてを引数と見なします。例については、"endtable"と "endlist "を参照してください。
このコマンドをテーブル内で使用する場合、項目が何行または何列にまたがるかを指定することもできます。
/*!
\table
\header
\li {3,1} This header cell spans three columns
but only one row.
\row
\li {2, 1} This table item spans two columns
but only one row
\li {1, 2} This table item spans only one column,
but two rows.
\row
\li A regular table item
\li A regular table item
\endtable
*/指定しない場合、項目は1列と1行にまたがります。
このドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3の条件の下でライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
