GAMBAS BOOK 3.15.2

The easiest way to equip your program with a menu (→ Figure 13.2.4) is to use the menu editor. It is a good plan if you record this structure - especially with a complex menu structure - and then map it in a table:

Table 13.2.1: Menu structure (V=Visible, E=Enabled, T=Toogle and C=Checked)

Start the menu editor

• by clicking on the Menu Editor button in the menu bar (above the form),
• with the key combination CTRL+E or
• after clicking the right mouse button on the form in which you activate the menu editor entry from the context menu that opens.

Figure 13.2.1: (partial) view of the menu editor

When you create a menu structure, the following steps have been tried and tested:

• A click on the Insert button in the menu editor creates a new menu entry.Enter the information from your table in the upper and lower part of the menu editor for each menu item → figure 13.2.1 and → figure 13.2.2.You can correct (change or delete) your entries at any time.
• If you leave the text field blank at Caption, a dividing line between two menu entries is automatically created in the menu at runtime. The name of the menu item only appears in the menu editor in light grey.
• Change the level of a menu item by selecting the menu item and then increasing or decreasing the level using the two indent and move buttons. The small dots in front of the menu item indicate the current level. In the menu editor, you can recognize a menu item of level zero by its font style bold.
• You can move a menu item with the two buttons' Move up' and' Move down' in the menu structure. Please make sure that you adjust the names of the menu entries if this name indicates a ranking and sequence.
• Assign a suitable icon from the collection of gambas to the individual menu entries if you want to follow the usual practice with menu entries.
• Check all entries in the menu editor carefully before closing the menu editor.

Figure 13.2.2: (Part) view2 of the menu editor

Confirm all entries or changes in the menu editor with OK. When you close the menu editor although you have made changes, the system asks whether you want to save the changes:

Figure 13.2.3: Save - demand

Entries in the menu editor for Action are only necessary if, for example, you want to use the Action class for synchronization between the menu and an inserted toolbar. The chapter' 13.5 Menu and Toolbar' explains how to implement this synchronization.

Figure 13.2.4: Select 'Exit' menu item

To do this, click on the entry you want to add code as an event handling procedure in the form menu; for example, for the mnu15Close_Click() event:

Public Sub mnu15Close_Click()
  FHelp.Close
  FMain.Close
End ' mnu15Close_Click()

Further procedures (selection):

Public Sub mnu11Open_Click()
  ImageOpen()
  mnu14Print.Enabled = True
End ' mnu11Open_Click()
 
Public Sub mnu15Close_Click()
  FHelp.Close
  FMain.Close
End ' mnu15Close_Click()
 
Public Sub mnu23PreView_Click()
  If mnu23PreView.Checked = True Then
     Message.Info("Vorschau anzeigen oder" & gb.NewLine & "Vorschaubild generieren oder...")
  Endif ' Checked = True
End ' mnu23PreView_Click()
 
Public Sub mnu31Help_Click()
  FHelp.Show
End ' mnu31Help_Click()
 
Public Sub mnu32Web_Click()
  Desktop.Open("http://www.gambas-buch.de/dw/doku.php?id=k13:start")
End ' mnu32Web_Click()

Note that you cannot assign procedures to all menu entries. This applies, for example, to all entries of level 0 as well as to entries that contain further entries as (sub-)menus as in mnu22SelectColor.

Whether you make entries in the Tag text field (data type Variant) depends on whether you later evaluate this entry in the program and react depending on the evaluation result.

In the example FNotepad 3.0.0 in the Gambas examples it is demonstrated that you can also select a menu at runtime of the program via ALT+underlined_letters, if you prefix the selected letter with a & sign in front of the entry' Caption'. For example, the combination ALT+a calls the save dialog:

Figure 13.2.5: (Part) view3 of the menu editor

Die einfachste Art Ihr Programm mit einem Menü (→ Abbildung 13.2.4) auszurüsten besteht darin, den Menü-Editor einzusetzen. Es ist ein guter Plan, wenn Sie sich – vor allem bei einer komplexen Menü-Struktur – diese Struktur aufzeichnen und sie dann in einer Tabelle abbilden:

Tabelle 13.2.1: Menü-Struktur (V=Visible, E=Enabled, T=Toogle und C=Checked)

Den Menü-Editor starten Sie

• über einen Klick auf den Button Menüeditor in der Menüleiste (über dem Formular) ,
• mit der Tastenkombination CTRL + E oder
• nach einem Klick der rechten Maustaste auf das Formular, in dem Sie aus dem sich öffnenden Kontextmenü den Eintrag Menüeditor aktivieren.

Abbildung 13.2.1: (Teil-)Ansicht des Menü-Editors

Beim Anlegen einer Menü-Struktur haben sich folgende Arbeitsschritte bewährt:

• Ein Klick auf die Schaltfläche Einfügen im Menü-Editor erzeugt einen neuen Menüeintrag.
• Tragen Sie in den oberen und unteren Teil des Menüeditors für jeden Menüeintrag die Angaben aus Ihrer Tabelle ein → Abbildung 13.2.1 und → Abbildung 13.2.2.
• Sie können Ihre Eintragungen jederzeit korrigieren (ändern oder löschen).
• Wenn Sie das Textfeld bei Caption frei lassen, wird zur Laufzeit des Programms automatisch im Menü eine Trennlinie zwischen zwei Menüeinträgen erzeugt. Der Name des Menüeintrags erscheint nur im Menü-Editor in der Farbe hellgrau.
• Ändern Sie die Ebene eines Menüeintrags, indem Sie den Menüeintrag markieren und dann mit den beiden Schaltflächen Einrücken und Ausrücken die Ebene erhöhen oder verringern. Die aktuelle Ebene erkennen Sie an den kleinen Punkten vor dem Menüeintrag. Einen Menüeintrag der Ebene Null erkennen Sie im Menüeditor am Schriftstil fett.
• Sie können einen Menüeintrag mit den zwei Schaltflächen 'Nach oben verschieben' und 'Nach unten verschieben' in der Menü-Struktur verschieben. Bitte achten Sie dann darauf, u.U. die Namen der Menüeinträge anzupassen, wenn diese Bezeichnung eine Rang- und Reihenfolge kennzeichnet.
• Ordnen Sie den einzelnen Menüeinträgen ein passendes Icon aus dem Bestand von Gambas zu, wenn Sie der üblichen Praxis bei Menüeinträgen folgen wollen.
• Prüfen Sie alle Eintragungen im Menü-Editor sorgfältig, bevor sie den Menüeditor schließen.

Abbildung 13.2.2: (Teil-)Ansicht2 des Menü-Editors

Quittieren Sie alle Eintragungen oder Änderungen im Menü-Editor mit OK. Wenn Sie den Menü-Editor schließen, obgleich Sie Änderungen vorgenommen haben, dann wird nachgefragt, ob die Änderungen gespeichert werden sollen:

Abbildung 13.2.3: Speichern – Nachfrage

Eintragungen im Menü-Editor bei Action werden nur dann notwendig, wenn Sie zum Beispiel zur Synchronisation zwischen dem Menü und einer eingefügten Symbolleiste die Klasse Action einsetzen wollen. Im Kapitel '13.5 Menü und Symbolleiste (Toolbar) ' erfahren Sie, wie man diese Synchronisation realisiert.

Anschließend müssen Sie zu den einzelnen Menüeinträgen den Programm-Quelltext eingeben, der beim Anklicken eines Menüpunkts ausgeführt werden soll.

Abbildung 13.2.4: Auswahl Menüeintrag 'Beenden'

Klicken Sie dazu im Menü im Formular auf den Eintrag, dem Sie Code als Ereignisbehandlungsprozedur hinzufügen wollen; zum Beispiel für das mnu15Close_Click()-Ereignis:

Public Sub mnu15Close_Click()
  FHelp.Close
  FMain.Close
End ' mnu15Close_Click()

Weitere Prozeduren (Auswahl):

Public Sub mnu11Open_Click()
  ImageOpen()
  mnu14Print.Enabled = True
End ' mnu11Open_Click()
 
Public Sub mnu15Close_Click()
  FHelp.Close
  FMain.Close
End ' mnu15Close_Click()
 
Public Sub mnu23PreView_Click()
  If mnu23PreView.Checked = True Then
     Message.Info("Vorschau anzeigen oder" & gb.NewLine & "Vorschaubild generieren oder...")
  Endif ' Checked = True
End ' mnu23PreView_Click()
 
Public Sub mnu31Help_Click()
  FHelp.Show
End ' mnu31Help_Click()
 
Public Sub mnu32Web_Click()
  Desktop.Open("http://www.gambas-buch.de/dw/doku.php?id=k13:start")
End ' mnu32Web_Click()

Beachten Sie, dass Sie nicht allen Menüeinträgen auch Prozeduren zuordnen können. Das trifft zum Beispiel auf alle Einträge der Ebene 0 zu sowie auf Einträge, die weitere Einträge als (Unter-)Menüs wie bei mnu22SelectColor enthalten.

Ob Sie Eintragungen im Textfeld Tag (Datentyp Variant) vornehmen hängt davon ab, ob Sie diese Eintragung später im Programm auch auswerten und in Abhängigkeit vom Auswertungsergebnis reagieren.

Im Beispiel FNotepad 3.0.0 in den Gambas-Beispielen wird demonstriert, dass Sie zur Laufzeit des Programms die Auswahl eines Menüs auch über ALT+unterstrichener_Buchstabe vornehmen können, wenn Sie beim Eintrag 'Caption' dem ausgewählten Buchstaben ein &-Zeichen voranstellen. Die Kombination ALT+a zum Beispiel ruft den Speichern-Dialog auf:

Abbildung 13.2.5: (Teil-)Ansicht3 des Menü-Editors