Inclure des images

Les commandes graphiques permettent d'inclure des images dans la documentation. Les images peuvent être présentées sous forme de paragraphes distincts ou dans le texte courant.

\image

La commande \image s'étend à l'image spécifiée par son premier argument et la rend centrée comme un paragraphe séparé.

La commande prend deux arguments. Le premier argument est le nom du fichier image. Le second argument est une description du contenu de l'image, utilisée pour l'attribut HTML alt. Son contenu est lu à haute voix par les lecteurs d'écran, et 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 textuel 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 rendu par les navigateurs graphiques sous forme d'infobulle lorsque l'utilisateur passe la souris sur l'image.

Bien que QDoc soit assez indulgent, vous devez mettre le nom du fichier et la description entre accolades, comme suit :

\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 du fichier ou la description d'un saut de ligne. Les crochets sont nécessaires si l'argument de la description s'étend sur plusieurs lignes. Si la description est entre guillemets, 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'étend à l'image spécifiée par son argument. L'image est affichée en ligne avec le reste du texte.

La commande prend deux arguments. Le premier argument est le nom du fichier image. Le second argument, facultatif, est une simple description de l'image entre accolades {}, équivalente à l'HTML alt="" dans une balise d'image. La description est utilisée pour les infobulles et lorsqu'un navigateur ne prend pas en charge les images, comme le navigateur texte Lynx.

La commande \inlineimage est le plus souvent utilisée dans les listes et les tableaux. Voici un exemple d'inclusion 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'inclusion 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
*/

La 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 de légender une image.

La commande prend tout le texte jusqu'à la fin du paragraphe comme légende. Expérimentez jusqu'à ce que vous obteniez l'effet désiré.

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