表格和列表

这些命令能夠创建列表和表格。列表被渲染为左对齐的独立段落。表格被渲染为中心的独立段落。表格宽度取决于内容宽度。

\table

\table 和 \endtable 命令界定表格的内容。

该命令接受一个参数,指定表格宽度为页面宽度的百分比。

/*!
   \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
*/

另见 \header\row\li

\header 命令指示下面的表格单元格是当前表格的列标题。

该命令只能在 \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
*/

另见 \table、\row 和 \li。

\row

\row 命令开始一个新的表格行。新行中的 \li 元素将紧跟在 \row 命令之后。

该命令只能在 \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.
   \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。

\value

\value 命令开始 C++ 枚举项的文档。

命令的第一个参数是值名称。值名称可能前面有一个可选的用方括号括起来的since子句。值描述跟在值名称后面。描述在下一个空白行或\value处结束。参数以表格形式呈现。

注意:要在\value描述中包含图像,请使用\inlineimage命令。

如果没有since子句,\value命令可能如下所示

\value QtInfoMsg A message generated by the qInfo() function.

带有since子句的相同命令可能如下所示

\value [since 5.5] QtInfoMsg A message generated by the qInfo() function.

文档将位于相关的类、头文件或命名空间文档中。有关示例,请参阅\enum文档。

注意:自Qt 5.4起,\value命令也可以在\enum主题之外使用。在这种情况下,QDoc将显示一个两列表格,列出常量名称(直接从第一个参数中获取)及其描述。这可以用于,例如,在\qmlproperty主题中记录QML枚举属性的可接受值。

另请参阅\enum\omitvalue

\omitvalue

\omitvalue命令将C++枚举项从文档中排除。

该命令的唯一必填参数是要排除的枚举项的名称。如果枚举项后面跟随一行描述,则这也将被排除。

有关示例,请参阅\enum文档。

另请参阅\enum\value \since

\list

\list和\endlist命令定义了项目列表。

使用\li命令创建每个列表项。列表始终包含一个或多个项。列表可以嵌套。例如

/*!
    \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
*/

\list命令接受一个可选参数,提供列表项的替代外观。

/*!
   \list
       \li How to Learn Qt
       \li Installation
       \li Tutorial and Examples
   \endlist
*/

如果将'A'作为\list命令的参数,则将项目符号替换为字母顺序中的字符

  1. 如何学习Qt
  2. 安装
  3. 教程和示例

如果用'1'代替'A',则列表项将按升序编号

  1. 如何学习Qt
  2. 安装
  3. 教程和示例

如果提供'i'作为参数,则项目符号将被罗马数字替换

  1. 如何学习Qt
  2. 安装
  3. 教程和示例

最后,提供'播放'作为可选参数,可以使列表项以罗马数字的升序显示

  1. 如何学习Qt
  2. 安装
  3. 教程和示例

您还可以通过简单地提供要开始的数字或字符来使列表从任何字符或数字开始。例如

/*!
   \list G
       \li How to Learn Qt
       \li Installation
       \li Tutorial and Examples
   \endlist
*/

另请参阅\li

\li (表格单元格,列表项)

\li命令标记一个表格单元格或一个列表项。此命令仅在表格列表中使用。

它将每件东西都视为其参数,直到下一个\li命令,直到下一个\endtable命令或\endlist命令。有关示例,请参阅\table\list

如果在该命令内使用表格,您还可以指定项目应跨越的行数或列数。

/*!
   \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
*/

如果没有指定,则项目将跨越一列和一行。

另见 \table\header\list

© 2024 Qt公司有限公司。本文件中包含的文档贡献属于各自所有者的版权。提供的文档依照由自由软件基金会发布的 GNU自由文档许可 1.3版 的条款许可。Qt以及相关的商标是芬兰以及其他国家/地区的Qt公司有限公司的商标。所有其他商标均为其各自所有者的财产。