Tableaux et listes

Ces commandes permettent de créer des listes et des tableaux. Une liste est alignée à gauche comme un paragraphe séparé. Un tableau est centré dans un paragraphe séparé. La largeur du tableau dépend de la largeur de son contenu.

\table

Les commandes \table et \endtable délimitent le contenu d'un tableau.

La commande accepte un seul argument spécifiant la largeur du tableau en pourcentage de la largeur de la page :

/*!
   \table 100 %

      ...

   \endtable
*/

Le code ci-dessus garantit que le tableau remplira tout l'espace disponible. Si la largeur du tableau est inférieure à 100 %, le tableau sera centré dans la documentation générée.

Un tableau peut contenir des en-têtes, des lignes et des colonnes. Une ligne commence par une commande \row et se compose de cellules, chacune d'entre elles commençant par une commande \li commande. Il existe également une \header qui est un type particulier de ligne ayant un format spécial.

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

Vous pouvez également faire en sorte que les cellules s'étendent sur plusieurs lignes et plusieurs colonnes. Par exemple, les cellules peuvent s'étendre sur plusieurs lignes et plusieurs colonnes :

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

Voir aussi \header, \row et \li.

\header

La commande \header indique que les cellules suivantes du tableau sont les en-têtes de colonne du tableau actuel.

Cette commande ne peut être utilisée qu'à l'intérieur des commandes \table... \endtable. Un en-tête peut contenir plusieurs cellules. Une cellule est créée avec la commande \li avec la commande

Le texte d'une cellule d'en-tête est centré dans la cellule du tableau et affiché en caractères gras.

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

Voir aussi \table, \row et \li.

\row

La commande \row commence une nouvelle ligne dans un tableau. Les éléments\li qui appartiennent à la nouvelle ligne suivront immédiatement les éléments \row.

Cette commande ne peut être utilisée qu'à l'intérieur des commandes \table... \endtable. Une ligne peut contenir plusieurs cellules. Une cellule est créée avec la commande \li commande.

La couleur d'arrière-plan des cellules de chaque ligne alterne entre deux tons de gris, ce qui permet de distinguer plus facilement les lignes les unes des autres. Le contenu des cellules est aligné à gauche.

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

Voir aussi \table, \header, et \li.

\value

La commande \value lance la documentation d'un élément d'énumération C++.

Le premier argument de la commande est le nom de la valeur. Le nom de la valeur peut être précédé d'une clause optionnelle since entre crochets. La description de la valeur suit le nom de la valeur. La description se termine à la ligne vierge suivante ou à \value. Les arguments sont présentés dans un tableau.

Sans la clause since, une commande \value pourrait ressembler à ceci :

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

La même commande avec une clause since ressemblerait à ceci :

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

La documentation se trouve dans la documentation de la classe associée, du fichier d'en-tête ou de l'espace de noms. Voir la documentation de la classe, du fichier d'en-tête ou de l'espace de noms associé. \enum pour un exemple.

Voir aussi \enum et \omitvalue.

\omitvalue

La commande \omitvalue permet d'exclure un élément d'énumération C++ de la documentation.

Le seul argument obligatoire de la commande est le nom de l'élément enum qui sera omis. Si l'élément enum est suivi d'une description sur une seule ligne, celle-ci est également omise.

Voir la documentation de la \enum pour un exemple.

Voir aussi \enum et \value \since

\list

Les commandes \list et \endlist délimitent une liste d'éléments.

Créez chaque élément de la liste avec la commande \li pour créer chaque élément de la liste. Une liste contient toujours un ou plusieurs éléments. Les listes peuvent être imbriquées. Par exemple, les listes peuvent être imbriquées :

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

La commande \list prend un argument facultatif qui fournit des apparences alternatives pour les éléments de la liste.

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

Si vous fournissez 'A' comme argument à la commande \list, les puces sont remplacées par des caractères dans l'ordre alphabétique :

1. Comment apprendre Qt
2. Installation
3. Tutoriel et exemples

Si vous remplacez "A" par "1", les éléments de la liste sont numérotés dans l'ordre croissant :

1. Comment apprendre Qt
2. Installation de Qt
3. Tutoriel et exemples

Si vous donnez 'i' comme argument, les puces sont remplacées par des chiffres romains :

1. Comment apprendre Qt
2. Installation
3. Tutoriel et exemples

Enfin, vous pouvez faire apparaître les éléments de la liste avec des nombres romains dans l'ordre croissant si vous fournissez 'I' comme argument optionnel :

1. Comment apprendre Qt
2. Installation
3. Tutoriel et exemples

Vous pouvez également faire commencer la liste à n'importe quel caractère ou nombre en indiquant simplement le nombre ou le caractère à partir duquel vous souhaitez commencer. Par exemple, il suffit d'indiquer le numéro ou le caractère à partir duquel vous souhaitez que la liste commence :

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

Voir aussi \li.

\li (cellule de tableau, élément de liste)

La commande \li marque une cellule de tableau ou un élément de liste. Cette commande n'est utilisée que dans les tableaux et les listes.

Elle considère tout comme son argument jusqu'à la prochaine commande \li, jusqu'à la prochaine commande \endtableou \endlist suivante. Voir \table et \list pour des exemples.

Si la commande est utilisée dans un tableau, vous pouvez également spécifier le nombre de lignes ou de colonnes que l'élément doit couvrir.

/*!
   \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 vous ne le précisez pas, l'élément s'étendra sur une colonne et une ligne.

Voir aussi \table, \header, et \list.