Bilder einfügen

Mit den Grafikbefehlen lassen sich Bilder in die Dokumentation einfügen. Die Bilder können als separate Absätze oder innerhalb des Fließtextes dargestellt werden.

\image

Der Befehl „ \image “ wird zu dem durch sein erstes Argument angegebenen Bild erweitert und rendert dieses zentriert als separaten Absatz.

Der Befehl benötigt zwei Argumente. Das erste Argument ist der Name der Bilddatei. Das zweite Argument ist eine Beschreibung des Bildinhalts und wird für das HTML-Attribut ` alt ` verwendet. Sein Inhalt wird von Bildschirmleseprogrammen vorgelesen, weshalb seine Verwendung aus Gründen der Barrierefreiheit dringend empfohlen wird. Er kann auch von Browsern verwendet werden, die keine Bilder unterstützen, wie beispielsweise dem Textbrowser Lynx. Sie können außerdem die Variable `usealttextastitle` setzen, damit QDoc ein `title` -Attribut für das Bild generiert, das von grafischen Textbrowsern üblicherweise als Tooltip angezeigt wird, wenn der Benutzer mit der Maus über das Bild fährt.

Obwohl QDoc recht tolerant ist, sollten Sie sowohl den Dateinamen als auch die Beschreibung in geschweifte Klammern setzen, etwa so:

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

Diese Syntax ist am eindeutigsten und sollte immer das erwartete Ergebnis liefern. Falls nicht, stellen Sie sicher, dass auf den Dateinamen oder die Beschreibung ein Zeilenumbruch folgt. Geschweifte Klammern sind erforderlich, wenn das Argument „description“ mehrere Zeilen umfasst. Wenn die Beschreibung in doppelte Anführungszeichen gesetzt ist, entfernt QDoc diese vor der Ausgabe. Sonderzeichen werden in der HTML-Ausgabe von QDoc möglicherweise durch den entsprechenden HTML-Entity-Code ersetzt.

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

Siehe auch \inlineimage und \caption.

\inlineimage

Der Befehl „ \inlineimage “ wird zu dem durch sein Argument angegebenen Bild erweitert. Das Bild wird inline mit dem restlichen Text dargestellt.

Der Befehl nimmt zwei Argumente entgegen. Das erste Argument ist der Name der Bilddatei. Das zweite Argument ist optional und stellt eine kurze Beschreibung des Bildes in geschweiften Klammern {} dar, vergleichbar mit dem HTML-Attribut alt="" in einem Bild-Tag. Die Beschreibung wird für Tooltips verwendet und kommt zum Einsatz, wenn ein Browser keine Bilder unterstützt, wie beispielsweise der Textbrowser Lynx.

Am häufigsten wird der Befehl „ \inlineimage “ in Listen und Tabellen verwendet. Hier ist ein Beispiel für die Einbindung von Inline-Bildern in eine 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
*/

Hier ist ein Beispiel für die Einbindung von Inline-Bildern in eine Tabelle:

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

Der Befehl kann auch verwendet werden, um ein Bild inline in den Text einzufügen.

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

Siehe auch \image und \caption.

\caption

Der Befehl „ \caption “ fügt eine Bildunterschrift zu einem Bild hinzu.

Der Befehl verwendet den gesamten Text bis zum Ende des Absatzes als Bildunterschrift. Experimentieren Sie, bis Sie das gewünschte Ergebnis erzielen.

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

Siehe auch \image und \inlineimage