Tableaux et listes

Ces commandes permettent de créer des listes et des tableaux. Une liste s'affiche alignée à gauche, sous forme de paragraphe distinct. Un tableau s'affiche centré, sous forme de paragraphe distinct. 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 occupera tout l'espace disponible. Si la largeur du tableau est inférieure à 100 %, celui-ci 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 la \row commande et se compose de cellules, dont chacune commence par une \li commande. Il existe également une \header commande qui correspond à un type particulier de ligne dotée d’un format spécifique.

/*!
   \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 des cellules s'étendent sur plusieurs lignes et colonnes. Par exemple :

/*!
   \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 du tableau suivantes constituent les en-têtes de colonnes du tableau actuel.

Cette commande ne peut être utilisée qu’au sein des commandes « \table …\endtable ». Un en-tête peut contenir plusieurs cellules. Une cellule est créée à l’aide de la \li commande.

Le texte d'une cellule d'en-tête est centré dans la cellule du tableau et s'affiche 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 » permet de commencer une nouvelle ligne dans un tableau. Les éléments «\li » qui doivent figurer dans cette nouvelle ligne suivront immédiatement la commande « \row ».

Cette commande ne peut être utilisée qu'au sein des commandes « \table...\endtable ». Une ligne peut contenir plusieurs cellules. Une cellule est créée à l'aide de la \li commande.

La couleur de fond de chaque ligne alterne entre deux nuances 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. Ce nom peut être précédé d’une clause « since » facultative placée entre crochets. La description de la valeur suit le nom de la valeur. La description se termine à la ligne blanche suivante ou à la commande « \value ». Les arguments sont présentés sous forme de tableau.

Sans clause « since », une commande « \value » pourrait se présenter comme suit :

\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 trouvera dans la classe, le fichier d'en-tête ou la documentation de l'espace de noms associés. Consultez la \enum documentation pour un exemple.

Voir aussi \enum et \omitvalue.

\omitvalue

La commande « \omitvalue » exclut un élément d'énumération C++ de la documentation.

Le seul argument obligatoire de la commande est le nom de l'élément d'énumération à omettre. Si l'élément d'énumération est suivi d'une description sur une seule ligne, celle-ci est également omise.

Consultez la \enum documentation pour un exemple.

Voir également \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 à l'aide de la \li commande. Une liste contient toujours un ou plusieurs éléments. Les listes peuvent être imbriquées. Par exemple :

/*!
    \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 ` accepte un argument facultatif permettant de définir d'autres styles d'affichage pour les éléments de la liste.

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

Si vous passez « A » comme argument à la commande \list, les puces sont remplacées par des caractères classés par 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 par ordre croissant :

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

Si vous passez « i » en argument, les puces sont remplacées par des chiffres romains :

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

Enfin, vous pouvez afficher les éléments de la liste accompagnés de chiffres romains par ordre croissant en fournissant « I » comme argument facultatif :

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

Vous pouvez également faire en sorte que l’affichage commence à n’importe quel caractère ou chiffre en indiquant simplement le chiffre ou le caractère à partir duquel vous souhaitez commencer. Par exemple :

/*!
   \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 » permet de marquer une cellule de tableau ou un élément de liste. Cette commande ne s'utilise que dans les tableaux et les listes.

Elle considère tout ce qui suit comme son argument jusqu’à la prochaine commande « \li », jusqu’à la prochaine \endtable, ou \endlist . Voir \table et \list pour des exemples.

Si la commande est utilisée au sein d'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 aucune valeur n’est spécifiée, l’élément s’étendra sur une colonne et une ligne.

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