Hilfefunktionen

Das KDevelop-Programmierhandbuch: Leitfaden zur C++-Anwendungsentwicklung für das K Desktop Environment (KDE) mit Hilfe der KDevelop-IDE in der Version 1.2
Zurück |  | Vor

# Kapitel 8. Hilfefunktionen

Wer Software entwickelt, darf eines nicht vergessen: den zukünftigen Benutzern, wo immer es geht, Hilfe zu bieten. Die meisten Entwickler neigen dazu, dies möglichst weit aufzuschieben. Sie aber sollten sich immer vor Augen halten, dass Ihr Benutzer nicht unbedingt Unix-Experte ist. Er mag von der dunklen Seite der Softwarewelt kommen, wo ihm eingeflüstert wurde, er könne eine Anwendung bedienen, ohne jemals ein Handbuch angefasst zu haben. Um diesen Ansprüchen zu genügen, statten die KDE- und Qt-Bibliotheken Sie mit allen Mitteln aus, um eine Anwendung in den Augen des Durchschnittsusers professionell wirken zu lassen -- z.B. mit vorgefertigten Hilfefunktionen. Innerhalb der Anwendung sind das

- Kurztipps

- Schnellhilfe

- Kurzerklärungen im Statusbalken

- Kontexthilfe-("Was-ist-das?")-Buttons

Zusätzlich sollte die Applikation mit F1, der Standard-Hilfetaste, Zugang zu einem HTML-basierten Online-Handbuch bieten.

Da KDevelop zum einen selbst alle diese Hilfen eingebaut hat, zum anderen der Applikationswizard ein KDE-Framework generiert, das diese schon unterstützt, zeigen wir Ihnen hier, wo und wie Sie Hilfefunktionalität einbauen.

Wichtig bei der Anwendungsentwicklung ist, dass Sie konsistent bleiben. Daher sollten Sie die nötigen Schritte zur Hilfegenerierung zu dem Zeitpunkt einleiten, da Sie Ihren Code erweitern. Das verhindert, dass Sie Ihren Quelltext später noch einmal neu durchdenken müssen, um heraus zu finden, was Ihre Anwendung tut oder was Sie mit Teilen des Codes überhaupt bezwecken.

# 8.1. Kurztipps

Kurztipps leisten auf sehr einfache Art Hilfe. Diese kleinen Mitteilungen erscheinen, wenn der Benutzer mit der Maus über ein entsprechend ausgestattetes Widget fährt, und verschwinden wieder, wenn die Maus weiter bewegt wird. Am populärsten sind sie in Werkzeugleisten , wo sie allerdings so klein wie möglich gehalten werden sollten. Werkzeugleisten lassen sich nämlich so konfigurieren, dass sie ihre Inhalte auf verschiedene Weisen darstellen: entweder sie zeigen den Button, den Button mit dem Text zur Rechten, die Schaltfläche mit dem Tipp darunter oder einfach nur die Mitteilung. Normalerweise sollte der Benutzer die ihm genehmste Darstellungsart wählen können, aber das ist kein Muss. Der Text wird so oder so als Kurztipp angezeigt, und eine Werkzeugleiste besteht normalerweise aus Schaltflächen und anderen Widgets wie Lineedits und Komboboxen. Eine komplette Beschreibung finden Sie in der Klassenreferenz zu `KToolBar` in der KDE-UI-Library.

Sehen wir uns als Beispiel die "Neue Datei"-Schaltfläche einer generischen Anwendung an:

     toolBar()->insertButton(Icon("filenew.xpm"), ID_FILE_NEW, true, i18n("New File") );

Der `i18n("New File")`-Teil erzeugt den Kurztipp. Er wird vom i18n()-Makro aus `kapp.h` in die aktuell eingestellte Sprache (also z.B. zu "Neue Datei") übersetzt.

Kurztipps lassen sich mit den Qt-Klassen `QToolTip` und `QToolTipGroup` zu jedem beliebigen Widget hinzu fügen. Ein Beispiel:

     QToolTip::add( yourwidget, i18n("your Tip") );

Nähere Informationen dazu finden Sie in der Qt-Online-Referenz zur Klasse `QToolTip`.

Zurück | Anfang | Vor
The QPainter Class |  | Schnellhilfe