GAMBAS-BUCH 3.19.5

Das Steuerelement TreeView implementiert eine Baum-Ansicht einer Struktur.

Die Klasse _TreeView ist die interne Basis-Klasse für das Steuerelement TreeView, aber auch für die Steuerelemente ListView und ColumnView. TreeView ist nicht mehr in gb.qt4, sondern in gb.gui.base implementiert. Die Dokumentation unter → http://gambaswiki.org/wiki/comp/gb.qt4/treeview listet das TreeView trotzdem in gb.qt4 auf, weil gb.gui.base eine versteckte Komponente ist, die Steuerelemente sammelt, die in Gambas geschrieben werden können und zwischen gb.gtk* und gb.qt* geteilt werden sollen. TreeView ist in Gambas geschrieben und deshalb hat man die Möglichkeit den Quelltext des Steuerelements einzusehen.

• Die Elemente der Baum-Ansicht werden durch einen Schlüssel indiziert. Sie zeigen einen Text und optional ein Symbol für jedes Element. Jeder Eintrag bekommt einen eindeutigen Schlüssel, wenn er zur TreeView hinzugefügt wird.
• Das Steuerelement verfügt über einen internen Zeiger. Verwenden Sie die unterschiedlichen Move-Methoden, um den internen Zeiger zu bewegen und die Item-Eigenschaft, um auf das aktuelle Element zuzugreifen.
• Wenn Sie den internen Zeiger auf ein bestimmtes Element setzen wollen, dann müssen Sie die Methode MoveTo(Key) benutzen.
• Um den sichtbaren Zeiger – als Auswahl eines bestimmten Eintrags – zu setzen, weisen Sie der Key-Eigenschaft eines Elements der TreeView den Schlüssel des zu markierenden Eintrags zu.

Mit den verschiedenen Move-Methoden können Sie den internen Zeiger verschieben. MoveParent() zum Beispiel setzt den internen Zeiger auf sein Parent-Element – wenn es ein Parent-Element gibt. Beachten Sie, dass diese Move-Methoden den Wert True zurück geben, wenn die Bewegung des internen Zeigers nicht ausgeführt werden konnte, weil:

• es kein Parent-Element gibt (bei MoveParent),
• es kein nächstes Element gibt (bei MoveNext) oder
• der interne Zeiger kein Kind-Element besitzt (zum Beispiel MoveChild).

Die Klasse TreeView verfügt u.a. über diese Eigenschaften:

Die virtuelle Klasse _TreeView_Item repräsentiert einen Eintrag in einer TreeView.

Tabelle 17.9.0.3.1 : Ausgewählte Eigenschaften der virtuellen Klasse _TreeView_Item

Methode	Rückgabetyp	Beschreibung
Clear()	-	Löscht alle Child-Elemente
Delete()	-	Löscht das (aktuelle) Element.
MoveAfter( [ Key As String ] )	-	Bewegt das Element direkt hinter das Element, dessen Schlüssel als Parameter angegeben ist. Die beiden Elemente müssen das gleiche Parent-Element haben. Wenn der optionale Parameter 'Key' nicht angegeben ist, so wird das Element das erste Child-Element im Parent-Element.
MoveBefore ( [ Key As String ] )	-	Bewegt das Element direkt vor das Element, dessen Schlüssel als Parameter angegeben ist. Die beiden Elemente müssen das gleiche Parent-Element haben. Wenn der optionale Parameter 'Key' nicht angegeben ist, so wird das Element das letzte Child-Element im Parent-Element.
MoveFirst()	-	Verschiebt das Element, so dass es das erste Child-Element im Parent-Element wird.
MoveLast()	-	Verschiebt das Element, so dass es das letzte Child-Element im Parent-Element wird.
Rename()	-	Startet das Umbenennen des Elements.

Tabelle 17.9.0.4.1 : Ausgewählte Methoden der virtuellen Klasse _TreeView_Item

Die Klasse TreeView besitzt u.a. diese Methoden:

Tabelle 17.9.0.5.1 : Ausgewählte Methoden der Klasse TreeView

Die Add(…)-Methode fügt ein neues Element in die TreeView ein:

Function Add ( Key As String, Text As String [ , Picture As Picture, Parent As String, After As String ] ) 
               As _TreeView_Item 

• Key ist der Schlüssel für das neue Element.
• Text ist der angezeigte Text auf dem neuen Element.
• Picture ist das Bild, das neben dem Text angezeigt wird. Standardmäßig wird kein Bild angezeigt.
• Parent ist der Schlüssel des übergeordneten Elements, in das das Element eingefügt werden soll. Standardmäßig ist das neue Element ein Root-Element.
• After ist der Schlüssel von dem Element, nach dem das neue Element eingefügt wird. Dieses Element und das neue Element müssen das gleiche Parent-Element haben. Standardmäßig wird das neue Element als letztes Element des Parent-Elements eingefügt.

Beispiel aus dem Projekt POP3-Client → Kapitel 24.5.4:

  For Each sElement In aAccounts
    TreeView1.Add(sElement, sElement, Picture["icon:/32/mail"])
    TreeView1.Add(sElement & "SMTP", "SMTP", Picture["Icons/smtp.png"], sElement)
    TreeView1.Add(sElement & "POP3", "POP3", Picture["Icons/pop3.png"], sElement)
  Next

Für drei EMail-Konten ergibt sich dann die folgende Ansicht in der TreeView:

Abbildung 17.9.0.5.1: TreeView mit markiertem Eintrag

Die Klasse TreeView besitzt ferner die folgenden Ereignisse:

Ereignis	Beschreibung
Click()	Das Ereignis wird ausgelöst, wenn auf ein Element in der TreeView geklickt wird.
Select()	Das Ereignis wird ausgelöst, wenn sich die Auswahl in der TreeView ändert. Beachten Sie: Click() wird bei jedem Klick auf ein Element in der TreeView geklickt ausgelöst – also zum Beispiel auch dann, wenn man nur einen Eintrag auf- oder einklappen will. Select() dagegen wird nur dann ausgelöst, wenn sich die Auswahl ändert.
Compare ( Key As String, OtherKey As String )	Dieses Ereignis wird ausgelöst, wenn zwei Elemente in der TreeView verglichen werden. Das Ergebnis des Vergleichs wird in der Compare-Eigenschaft gespeichert.

Tabelle 17.9.0.6.1 : Ausgewählte Ereignisse der Klasse TreeView

Eine Anwendung der Klasse TreeView nutzen Sie immer dann ausführlich, wenn Sie die IDE von Gambas starten. Dort wird die physische Struktur des Projekt-Verzeichnisses auf eine logische Struktur in einer TreeView abgebildet:

Abbildung 17.9.0.6.1: TreeView in der Gambas-IDE