Tablas y listas

Estos comandos permiten crear listas y tablas. Una lista se muestra alineada a la izquierda como un párrafo separado. Una tabla se muestra centrada como un párrafo independiente. La anchura de la tabla depende de la anchura de su contenido.

\table

Los comandos \table y \endtable delimitan el contenido de una tabla.

El comando acepta un único argumento que especifica la anchura de la tabla como porcentaje de la anchura de la página:

/*!
   \table 100 %

      ...

   \endtable
*/

El código anterior garantiza que la tabla ocupará todo el espacio disponible. Si la anchura de la tabla es inferior al 100 %, la tabla aparecerá centrada en la documentación generada.

Una tabla puede contener cabeceras, filas y columnas. Una fila comienza con un \row y se compone de celdas, cada una de las cuales comienza con un comando \li comando. También existe un \header que es un tipo especial de fila con un formato especial.

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

También puede hacer que las celdas abarquen varias filas y columnas. Por ejemplo:

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

Véase también \header, \row y \li.

\header

El comando \header indica que las siguientes celdas de la tabla son las cabeceras de columna de la tabla actual.

Este comando sólo puede utilizarse dentro de los comandos \table... \endtable. Una cabecera puede contener varias celdas. Una celda se crea con el comando \li comando.

El texto de una celda de encabezado se centra dentro de la celda de la tabla y se muestra en negrita.

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

Véase también \table, \row y \li.

\row

El comando \row inicia una nueva fila en una tabla. Los elementos\li que pertenecen a la nueva fila seguirán inmediatamente a los \row.

Este comando sólo puede utilizarse dentro de los comandos \table. ..\endtable. Una fila puede contener varias celdas. Una celda se crea con el comando \li comando.

El color de fondo de la celda de cada fila alterna entre dos tonos de gris, lo que facilita distinguir las filas entre sí. El contenido de las celdas se alinea a la izquierda.

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

Véase también \table, \headery \li.

\value

El comando \value inicia la documentación de un elemento enum de C++.

El primer argumento del comando es el nombre del valor. El nombre del valor puede ir precedido de una cláusula opcional since entre corchetes. La descripción del valor sigue al nombre del valor. La descripción termina en la siguiente línea en blanco o en \value. Los argumentos se muestran en una tabla.

Sin una cláusula since, un comando \value podría tener este aspecto:

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

El mismo comando con una cláusula since se vería así:

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

La documentación se encontrará en la documentación de la clase, archivo de cabecera o espacio de nombres asociado. Véase la \enum para ver un ejemplo.

Véase también \enum y \omitvalue.

\omitvalue

El comando \omitvalue excluye un elemento enum de C++ de la documentación.

El único argumento obligatorio de la orden es el nombre del elemento enum que se omitirá. Si el elemento enum va seguido de una descripción de una sola línea, también se omitirá.

Consulte la \enum para ver un ejemplo.

Véase también \enum y \value \since

\list

Los comandos \list y \endlist delimitan una lista de elementos.

Cree cada elemento de la lista con el comando \li . Una lista siempre contiene uno o más elementos. Las listas pueden estar anidadas. Por ejemplo:

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

El comando \list toma un argumento opcional que proporciona apariencias alternativas para los elementos de la lista.

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

Si proporciona 'A' como argumento al comando \list, las viñetas se sustituyen por caracteres en orden alfabético:

1. Cómo aprender Qt
2. Instalación
3. Tutorial y ejemplos

Si sustituyes 'A' por '1', los elementos de la lista se numeran en orden ascendente:

1. Cómo aprender Qt
2. Instalación
3. Tutorial y Ejemplos

Si proporciona 'i' como argumento, las viñetas se sustituyen por números romanos:

1. Cómo aprender Qt
2. Instalación
3. Tutorial y ejemplos

Por último, puede hacer que los elementos de la lista aparezcan con números romanos a continuación en orden ascendente si proporciona 'I' como argumento opcional:

1. Cómo aprender Qt
2. Instalación
3. Tutorial y Ejemplos

También puede hacer que el listado comience en cualquier carácter o número simplemente proporcionando el número o carácter en el que desea comenzar. Por ejemplo:

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

Véase también \li.

\li (celda de tabla, elemento de lista)

El comando \li marca una celda de tabla o un elemento de lista. Este comando sólo se utiliza en tablas y listas.

Considera todo como argumento hasta el siguiente comando \li, hasta el siguiente comando \endtableo \endlist siguiente. Véase \table y \list para ver ejemplos.

Si el comando se utiliza dentro de una tabla, también puede especificar cuántas filas o columnas debe abarcar el elemento.

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

Si no se especifica, el elemento abarcará una columna y una fila.

Véase también \table, \headery \list.