Bilder einbinden

Die Grafikbefehle ermöglichen es, Bilder in die Dokumentation einzubinden. Die Bilder können als separate Absätze oder im laufenden Text dargestellt werden.

\Bild

Der Befehl \image expandiert zu dem durch sein erstes Argument angegebenen Bild und stellt es zentriert als separaten Absatz dar.

Der Befehl benötigt zwei Argumente. Das erste Argument ist der Name der Bilddatei. Das zweite Argument ist eine Beschreibung des Inhalts des Bildes und wird für das HTML-Attribut alt verwendet. Sein Inhalt wird von Bildschirmlesegeräten vorgelesen, weshalb seine Verwendung aus Gründen der Barrierefreiheit dringend empfohlen wird. Es kann auch von Browsern verwendet werden, die keine Bilder unterstützen, wie z. B. der Textbrowser Lynx. Sie können auch die Variable usealttextastitle setzen, um QDoc zu veranlassen, ein Titelattribut für das Bild zu generieren, das üblicherweise von grafischen Textbrowsern als Tooltip dargestellt wird, wenn der Benutzer mit der Maus über das Bild fährt.

Obwohl QDoc recht nachsichtig ist, sollten Sie sowohl den Dateinamen als auch die Beschreibung in geschweifte Klammern einschließen, etwa so:

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

Diese Syntax ist die eindeutigste und sollte immer das erwartete Ergebnis liefern. Ist dies nicht der Fall, müssen Sie nach dem Dateinamen oder der Beschreibung einen Zeilenumbruch einfügen. Geschweifte Klammern sind erforderlich, wenn sich das Argument Beschreibung über mehrere Zeilen erstreckt. Wenn die Beschreibung in Anführungszeichen eingeschlossen ist, entfernt QDoc diese, bevor es die Ausgabe erzeugt. Sonderzeichen können in der HTML-Ausgabe von QDoc durch den entsprechenden HTML-Entity-Code ersetzt werden.

/*!
    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 expandiert auf das durch sein Argument angegebene Bild. Das Bild wird inline mit dem restlichen Text gerendert.

Der Befehl benötigt zwei Argumente. Das erste Argument ist der Name der Bilddatei. Das zweite Argument ist optional und besteht aus einer einfachen Beschreibung des Bildes in geschweiften Klammern {}, die dem HTML alt="" in einem Bild-Tag entspricht. Die Beschreibung wird für Tooltips und für den Fall verwendet, dass ein Browser keine Bilder unterstützt, wie z. B. der Textbrowser Lynx.

Am häufigsten wird der Befehl \inlineimage in Listen und Tabellen verwendet. Hier ist ein Beispiel für das Einfügen 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 das Einfügen 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 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 liefert eine Beschriftung für ein Bild.

Der Befehl übernimmt den gesamten Text bis zum Ende des Absatzes als Beschriftung. Experimentieren Sie, bis Sie den gewünschten Effekt 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