En esta página

Tablas y listas

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

\table

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

El comando admite un único argumento que especifica el ancho de la tabla como porcentaje del ancho de la página:

/*!
   \table 100%

      ...

   \endtable
*/

El código anterior garantiza que la tabla ocupe todo el espacio disponible. Si el ancho de la tabla es inferior al 100 %, la tabla se centrará en la documentación generada.

Una tabla puede contener encabezados, filas y columnas. Una fila comienza con el \row y está formada por celdas, cada una de las cuales comienza con un \li comando. También existe un \header que es un tipo especial de fila con un formato específico.

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

El comando « \header » indica que las siguientes celdas de la tabla son los encabezados de columna de la tabla actual.

El comando solo se puede utilizar dentro de los comandos «\table...» y « \endtable ». Un encabezado puede contener varias celdas. Una celda se crea con el \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 irán inmediatamente después de « \row ».

El comando solo se puede utilizar dentro de los comandos «\table...\endtable ». Una fila puede contener varias celdas. Una celda se crea con el \li comando.

El color de fondo de las celdas de cada fila alterna entre dos tonos de gris, lo que facilita la distinción entre unas filas y otras. 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, \header, y \li.

\value

El comando « \value » inicia la documentación de un elemento de la enumeración de C++.

El primer argumento del comando es el nombre del valor. El nombre del valor puede ir precedido de una cláusula «since» opcional 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.

Nota: Para incluir imágenes en la descripción de « \value », utiliza el \inlineimage comando.

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» tendría este aspecto:

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

La documentación se encontrará en la clase asociada, en el archivo de cabecera o en la documentación del espacio de nombres. Consulta la \enum documentación para ver un ejemplo.

Nota: Desde Qt 5.4, el comando « \value » también se puede utilizar fuera del \enum tema. En este caso, QDoc genera una tabla de dos columnas en la que se enumeran el nombre de la constante (tomado tal cual del primer argumento) y su descripción. Esto se puede utilizar, por ejemplo, en \qmlproperty tema para documentar los valores aceptables de una propiedad de enumeración de QML.

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

\omitvalue

El comando « \omitvalue » excluye un elemento de la enumeración de C++ de la documentación.

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

Consulte la \enum documentación para ver un ejemplo.

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

\list

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

Crea cada elemento de la lista con el \li comando. Una lista siempre contiene uno o más elementos. Las listas pueden anidarse. 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 ` admite un argumento opcional que proporciona estilos alternativos para los elementos de la lista.

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

Si se introduce «A» como argumento del 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 numerarán en orden ascendente:

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

Si se 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, puedes hacer que los elementos de la lista aparezcan con números romanos en orden ascendente si indicas «I» como argumento opcional:

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

También puedes hacer que el listado comience en cualquier carácter o número simplemente indicando el número o el carácter desde el que quieres que empiece. 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 solo se utiliza en tablas y listas.

Considera todo lo que hay a continuación como su argumento hasta el siguiente comando « \li », hasta el siguiente \endtableo \endlist . Véase \table y \list para ver ejemplos.

Si el comando se utiliza dentro de una tabla, también puedes 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 ocupará una columna y una fila.

Véase también \table, \header, y \list.

© 2026 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.