Incluir imágenes

Los comandos gráficos permiten incluir imágenes en la documentación. Las imágenes pueden presentarse como párrafos separados o dentro de texto corrido.

\image

El comando \image se expande a la imagen especificada por su primer argumento y la muestra centrada como un párrafo separado.

El comando recibe dos argumentos. El primero es el nombre del archivo de imagen. El segundo argumento es una descripción de lo que contiene la imagen, y se utiliza para el atributo HTML alt. Su contenido es leído en voz alta por los lectores de pantalla, por lo que su uso es muy recomendable a efectos de accesibilidad. También puede ser utilizado por navegadores que no soportan imágenes, como el navegador de texto Lynx. También puede establecer la variable usealttextastitle para hacer que QDoc genere un atributo de título para la imagen, que los navegadores de texto gráfico suelen mostrar como información sobre herramientas cuando el usuario pasa el ratón por encima de la imagen.

Aunque QDoc es bastante indulgente, debe encerrar el nombre del archivo y la descripción entre llaves, como se muestra a continuación:

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

Esta sintaxis es la más explícita y debería dar siempre el resultado esperado. Si no es así, asegúrese de poner un salto de línea después del nombre del archivo o de la descripción. Las llaves son necesarias si el argumento de la descripción abarca varias líneas. Si la descripción está entre comillas dobles, QDoc las eliminará antes de generar la salida. Los caracteres especiales pueden sustituirse por el código de entidad HTML correspondiente en la salida 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.
*/

Véase también \inlineimage y \caption.

\inlineimage

El comando \inlineimage se expande a la imagen especificada por su argumento. La imagen se muestra en línea con el resto del texto.

El comando recibe dos argumentos. El primero es el nombre del archivo de imagen. El segundo argumento es opcional y es una simple descripción de la imagen entre llaves {}, equivalente al HTML alt="" en una etiqueta de imagen. La descripción se utiliza para los tooltips, y para cuando un navegador no soporta imágenes, como el navegador de texto Lynx.

El uso más común del comando \inlineimage es en listas y tablas. He aquí un ejemplo de inclusión de imágenes en línea en una lista:

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

Este es un ejemplo de inclusión de imágenes en línea en una tabla:

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

El comando también puede utilizarse para insertar una imagen en línea con el texto.

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

Véase también \image y \caption.

\caption

El comando \caption proporciona un pie de foto para una imagen.

El comando toma todo el texto hasta el final del párrafo para que sea el pie de foto. Experimente hasta obtener el efecto deseado.

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

Véase también \image y \inlineimage