STree

Ein TreeView-Control. [Mehr ...]

Vererbung

Basisklassen(n)   abgeleitete Klassen
  SWindow
SControl
SControlPositioned
SControlPredefined
SControlLoaded
STree  

Attribute

public:

Attribut Typ Beschreibung
orgWndProcTree WNDPROC Standard-Behandlungsroutine des Controls

protected:

Attribut Typ Beschreibung
pLabel SLabel* Zeiger auf das Label.

Operationen

public:

Name Parameter Rückgabewert Beschreibung
addLabel const SString& text,
int xOffset=0,
int yOffset=-20
void Fügt ein Label hinzu.
deleteAllChildItems int hItemParent BOOL Löscht alle Items unterhalb des angegebenen.
deleteAllItems void Löscht alle Items aus dem Tree.
deleteItem int hItem BOOL Löscht ein Item aus dem Tree.
getAllItems SNumList& allItems,
int startWithItem=0,
BOOL dontClearBevoreList=false
int Listet alle Handel der Items im Tree auf. Das übergebene Start-Item wird nicht mit gelistet.
getCount int Gibt die Anzahl der Items im Tree zurück.
getFirstChild int hItemParent int Ermittelt das erste untergeordnete Item.
getItemData int hItem int Gibt den zugeordneten Daten-Wert eines Items zurück. Bei Fehler wird 0 zurückgegeben.
getItemText int hItem SString Gibt den Text eines Items zurück. Bei Fehler wird ein leerer String zurückgegeben.
getNextChild int hItemPrevious int Ermittelt das nächste Item in der gleichen Ebene.
getParent int hItemChild int Ermittelt das übergeordnete Item.
getPrevChild int hItemNext int Ermittelt das vorangegangene Item in der gleichen Ebene.
getRoot int Ermittelt das Root-Item.
getSelected int Ermittelt das selektierte Item.
getState int hItem int Gibt den Status eines Items zurück.
insertItem SString text,
DWORD value=0,
int parent=0,
int after=0
int Fügt ein Item ein.
isSelected int hItem BOOL Ermittelt, ob ein Item selektiert ist.
selectFirstVisible int hItem BOOL Selectiert das angegeben Item und scrollt es wenn möglich an oberste Stelle im Fenster.
selectItem int hItem BOOL Selectiert das angegeben Item.
sort int hParentItem=STREE_ROOT,
BOOL recursive=true
void Sortiert die Childs eines Eintrages oder den gesamten Baum ab dem Eintrag.
treeClose int hItem void Klappt den Baum an diesem Item zu.
treeExpand int hItem void Klappt den Baum an diesem Item auf.
treeToggle int hItem void Klappt den Baum an diesem Item zu wenn er auf war und auf wenn er zu war.
winProcCtrlTree HWND hwnd,
UINT message,
WPARAM wParam,
LPARAM lParam
LRESULT CALLBACK Behandlungsroutine für Windows-Nachrichten

protected:

Name Parameter Rückgabewert Beschreibung
onNotifySelf int notifyCode,
LPNMHDR pNotify
LRESULT Dieses Ereignis wird ausgelöst, wenn eine Notify-Message an den Parent gesendet wurde.
onPostCreateCtrl void Wird nach dem Erstellen und vor dem ersten Anzeigen ausgelöst.
onSelChanged void Wird ausgelöst wenn ein anderes Item selektiert wird.

Detailbeschreibung STree

Ein TreeView-Control.


TreeView-Controls dienen der hierarchischen Darstellung von Informationen. Einzelne Einträge können erweitert werden, um untergeordnete Informationen anzuzeigen bzw. auszublenden.

Funktionsbeschreibungen

addLabel(const SString& text, int xOffset=0, int yOffset=-20) void

Fügt ein Label hinzu.

Parameter:

text Text des Labels
xOffset X-Position des Labels, relatv zur Listbox
yOffset Y-Position des Labels, relatv zur Listbox

deleteAllChildItems(int hItemParent) BOOL

Löscht alle Items unterhalb des angegebenen.

Parameter:

hItemParent Handle des Items unter dem alle Items gelöscht werden sollen.

deleteAllItems() void

Löscht alle Items aus dem Tree.

deleteItem(int hItem) BOOL

Löscht ein Item aus dem Tree.

Parameter:

hItem Handle des zu löschenden Items.

getAllItems(SNumList& allItems, int startWithItem=0, BOOL dontClearBevoreList=false) int

Listet alle Handel der Items im Tree auf. Das übergebene Start-Item wird nicht mit gelistet.

Parameter:

allItems zu füllendes Feld
startWithItem (wenn angegeben) das Item, ab dem der Baum nach unten abgesucht werden soll.
dontClearBevoreList true -> SNumList wird nicht vor dem füllen geleert

Rückgabe:

allItems beinhaltet alle hItems des Tree
int Anzahl der gefunden Items

getCount() int

Gibt die Anzahl der Items im Tree zurück.

getFirstChild(int hItemParent) int

Ermittelt das erste untergeordnete Item.

Rückgabe:

int NULL wenn kein oder das Handle des ersten Childs.

getItemData(int hItem) int

Gibt den zugeordneten Daten-Wert eines Items zurück. Bei Fehler wird 0 zurückgegeben.

getItemText(int hItem) SString

Gibt den Text eines Items zurück. Bei Fehler wird ein leerer String zurückgegeben.

getNextChild(int hItemPrevious) int

Ermittelt das nächste Item in der gleichen Ebene.

Parameter:

hItemPrevious Item dessen Nachfolger gesucht wird

Rückgabe:

int NULL wenn keines vorhanden oder das Handle des folgenden Items.

getParent(int hItemChild) int

Ermittelt das übergeordnete Item.

Rückgabe:

int NULL wenn nichts übergeordnet oder das Handle des übergeordneten Items.

getPrevChild(int hItemNext) int

Ermittelt das vorangegangene Item in der gleichen Ebene.

Parameter:

hItemNext Item dessen Vorgänger gesucht wird

Rückgabe:

int NULL wenn keines vorhanden oder das Handle des vorhergehenden Items.

getRoot() int

Ermittelt das Root-Item.

Rückgabe:

int NULL wenn nichts vorhanden oder das Handle des Root-Items.

getSelected() int

Ermittelt das selektierte Item.

Rückgabe:

int NULL wenn nichts selectiert oder das Handle des selektierten Items.

getState(int hItem) int

Gibt den Status eines Items zurück.

Parameter:

hItem gesuchtes Item

Rückgabe:

int Eine Kombination aus:
  • TVIS_BOLD,
  • TVIS_CUT,
  • TVIS_DROPHILITED,
  • TVIS_EXPANDED,
  • TVIS_EXPANDEDONCE,
  • TVIS_EXPANDPARTIAL,
  • TVIS_SELECTED,
  • TVIS_OVERLAYMASK,
  • TVIS_STATEIMAGEMASK,
  • TVIS_USERMASK

insertItem(SString text,DWORD value=0,int parent=0, int after=0) int

Fügt ein Item ein.

Parameter:

text darzustellender Text
value ein beliebiger Wert der dem Eintrag zugeordnet ist
parent STREE_ROOT oder Handle des Items, unter dem es eingefügt werden soll
after STREE_FIRST, STREE_LAST, STREE_ROOT, STREE_SORT oder Handle des Items, nach dem es eingefügt werden soll

Rückgabe:

hItem Handle des erzeugten Items, bei Fehler wird NULL zurückgegeben

isSelected(int hItem) BOOL

Ermittelt, ob ein Item selektiert ist.

Parameter:

hItem zu testendes Item

Rückgabe:

BOOL Das Item ist selektiert.

onNotifySelf(int notifyCode, LPNMHDR pNotify) LRESULT

Dieses Ereignis wird ausgelöst, wenn eine Notify-Message an den Parent gesendet wurde.

onPostCreateCtrl() void

Wird nach dem Erstellen und vor dem ersten Anzeigen ausgelöst.

onSelChanged() void

Wird ausgelöst wenn ein anderes Item selektiert wird.

selectFirstVisible(int hItem) BOOL

Selectiert das angegeben Item und scrollt es wenn möglich an oberste Stelle im Fenster.

Parameter:

hItem Item das asgewählt werden soll

Rückgabe:

BOOL true wenn erfolgreich

selectItem(int hItem) BOOL

Selectiert das angegeben Item.

Parameter:

hItem Item das asgewählt werden soll

Rückgabe:

BOOL true wenn erfolgreich

sort(int hParentItem=STREE_ROOT, BOOL recursive=true) void

Sortiert die Childs eines Eintrages oder den gesamten Baum ab dem Eintrag.

Parameter:

hParentItem Start-Item
recursive gesamten Baum sortieren, oder nur diese Ebene

treeClose(int hItem) void

Klappt den Baum an diesem Item zu.

treeExpand(int hItem) void

Klappt den Baum an diesem Item auf.

treeToggle(int hItem) void

Klappt den Baum an diesem Item zu wenn er auf war und auf wenn er zu war.

winProcCtrlTree(HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam) LRESULT CALLBACK

Behandlungsroutine für Windows-Nachrichten

Parameter:

hwndMsg Fenster-Handle des Ziels der Nachricht
message Nachrichten-Nummer
wParam Nachrichten-Parameter
lParam Nachrichten-Parameter

Rückgabe:

LRESULT CALLBACK Bearbeitungsergebnis der Nachricht (von Nachricht abhänig)