Insérer des images

Les commandes graphiques permettent d'insérer des images dans la documentation. Les images peuvent être affichées sous forme de paragraphes distincts ou intégrées au corps du texte.

\image

La commande ` \image ` s'affiche sous la forme de l'image spécifiée par son premier argument et l'affiche centrée dans un paragraphe distinct.

La commande prend deux arguments. Le premier argument est le nom du fichier image. Le deuxième argument est une description du contenu de l’image ; il est utilisé pour l’attribut HTML ` alt `. Son contenu est lu à voix haute par les lecteurs d’écran ; son utilisation est donc fortement recommandée à des fins d’accessibilité. Il peut également être utilisé par les navigateurs qui ne prennent pas en charge les images, comme le navigateur texte Lynx. Vous pouvez également définir la variable `usealttextastitle` pour que QDoc génère un attribut `title` pour l’image, qui est généralement affiché par les navigateurs textuels graphiques sous forme d’info-bulle lorsque l’utilisateur passe la souris sur l’image.

Bien que QDoc soit assez tolérant, vous devriez placer le nom du fichier et la description entre accolades, comme ceci :

\image {Bandit.png} {A Golden Retriever holding a bag of coffee in its mouth}

Cette syntaxe est la plus explicite et devrait toujours donner le résultat escompté. Si ce n'est pas le cas, veillez à faire suivre le nom de fichier ou la description d'un saut de ligne. Les accolades sont obligatoires si l'argument « description » s'étend sur plusieurs lignes. Si la description est placée entre guillemets doubles, QDoc les supprimera avant de générer la sortie. Les caractères spéciaux peuvent être remplacés par le code d'entité HTML correspondant dans la sortie HTML de QDoc.

/*!
    Qt is a C++ toolkit for cross-platform GUI application development.

    \image {happyguy.jpg} {Happy guy}

    Qt provides single-source portability across Microsoft
    Windows, macOS, Linux, and all major commercial Unix
    variants. It is also available for embedded devices.
*/

Voir aussi \inlineimage et \caption.

\inlineimage

La commande ` \inlineimage ` s'affiche sous la forme de l'image spécifiée par son argument. L'image est intégrée au reste du texte.

La commande prend deux arguments. Le premier argument est le nom du fichier image. Le deuxième argument est facultatif ; il s'agit d'une description simple de l'image placée entre accolades {}, équivalente à l'attribut HTML alt="" dans une balise image. Cette description est utilisée pour les infobulles et lorsque le navigateur ne prend pas en charge les images, comme le navigateur textuel Lynx.

La commande ` \inlineimage ` est le plus souvent utilisée dans les listes et les tableaux. Voici un exemple d'insertion d'images en ligne dans une liste :

/*!
    \list 1
      \li \inlineimage happy.gif {Oh so happy, I am a caption!}
      \li \inlineimage happy.gif Oh so happy, but I'm not a caption.
    \endlist
*/

Voici un exemple d'insertion d'images en ligne dans un tableau :

/*!
    \table
    \header
        \li Qt
        \li Qt Creator
    \row
        \li \inlineimage happy.gif {Oh so happy!}
        \li \inlineimage happy.gif Oh so happy!
    \row
        \li \inlineimage happy.gif Oh so happy!
        \li \inlineimage happy.gif {Oh so happy!}
    \endtable
*/

Cette commande peut également être utilisée pour insérer une image en ligne avec le texte.

/*!
    \inlineimage training.jpg {Qt Training} The Qt Programming course is
    offered as a five day Open Enrollment Course. The classes are open to
    the public. Although the course is open to anyone who wants to learn,
    attendees should have significant experience in C++ development to
    derive maximum benefit from the course.
*/

Voir aussi \image et \caption.

\caption

La commande « \caption » permet d’ajouter une légende à une image.

La commande considère tout le texte jusqu'à la fin du paragraphe comme la légende. Faites des essais jusqu'à obtenir l'effet souhaité.

/*!
  \table 100%
    \row
      \li \image windows-pushbutton.png
         \caption The QPushButton widget provides a command button.
      \li \image windows-toolbutton.png
         \caption The QToolButton class provides a quick-access button to commands
         or options, usually used inside a QToolBar.
   \endtable
*/

Voir aussi \image et \inlineimage