Dokument-Navigation
Die Navigationsbefehle dienen dazu, die Seiten eines Dokuments in einer sinnvollen Reihenfolge zu verknüpfen. Nachfolgend finden Sie eine Folge von QDoc-Kommentaren, die eine typische Verwendung der Navigationsbefehle zeigt.
Beispiel
/*!
\page basicqt.html
\nextpage Getting Started
\indexpage Index
\startpage Basic Qt
\title Basic Qt
The Qt toolkit is a C++ class library and a set of tools for
building multiplatform GUI programs using a "write once,
compile anywhere approach".
Table of contents:
\list
\li \l {Getting Started}
\li \l {Creating Dialogs}
\li \l {Creating Main Windows}
\endlist
*/
/*!
\page gettingstarted.html
\previouspage Basic Qt
\nextpage Creating Dialogs
\indexpage Index
\startpage Basic Qt
\title Getting Started
This chapter shows how to combine basic C++ with the
functionality provided by Qt to create a few small graphical
interface (GUI) applications.
*/
/ *!
\page creatingdialogs.html
\previouspage Getting Started
\indexpage Index
\startpage Basic Qt
\title Creating Dialogs
This chapter will teach you how to create dialog boxes using Qt.
*/
/*!
\page index.html
\indexpage Index
\startpage Basic Qt
\title Index
\list
\li \l {Basic Qt}
\li \l {Creating Dialogs}
\li \l {Getting Started}
\endlist
*/Der Befehl \startpage erzeugt einen Link zu der Seite, die der Autor als erste Seite eines mehrseitigen Dokuments wünscht.
Der Link wird in den generierten HTML-Quellcode aufgenommen, hat aber keine visuelle Auswirkung auf die Dokumentation:
<head> ... <link rel="start" href="basicqt.html" /> ... </head>
Befehle
\vorherige Seite
Der Befehl \previouspage verknüpft die aktuelle Seite mit der vorherigen Seite in einer Folge. Der Befehl hat zwei Argumente, die jeweils von geschweiften Klammern umschlossen sind: Das erste ist das Verknüpfungsziel (der Titel der vorherigen Seite), das zweite ist der Verknüpfungstext. Wenn der Titel der Seite mit dem Linktext übereinstimmt, kann das zweite Argument weggelassen werden.
Der Befehl muss für sich allein in einer eigenen Zeile stehen.
\nextpage
Der Befehl \nextpage verknüpft die aktuelle Seite mit der nächsten Seite in einer Folge. Der Befehl folgt der gleichen Syntax und Argumentkonvention wie der Befehl \previouspage.
\startpage
Der Befehl \startpage gibt die erste Seite einer Folge von Seiten an. Der Befehl muss allein in einer eigenen Zeile stehen, und sein einziges Argument ist der Titel des ersten Dokuments.
QDoc erzeugt einen Link auf die Startseite und fügt ihn in die generierte HTML-Datei ein, was jedoch keinen visuellen Effekt auf die Dokumentation hat. Der generierte Link-Typ teilt Browsern und Suchmaschinen mit, welches Dokument vom Autor als Startpunkt der Sammlung angesehen wird.
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
