Version: 2.9.4
Public Member Functions
wxTreeEvent Class Reference

#include </home/zeitlin/src/wx/github/interface/wx/treectrl.h>

Inheritance diagram for wxTreeEvent:

Detailed Description

A tree event holds information about events associated with wxTreeCtrl objects.

To process input from a tree control, use these event handler macros to direct input to member functions that take a wxTreeEvent argument.

Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxTreeEvent& event)

Event macros:

Library:  wxBase
Category:  Events
参照:
wxTreeCtrl

Public Member Functions

 wxTreeEvent (wxEventType commandType, wxTreeCtrl *tree, const wxTreeItemId &item=wxTreeItemId())
 Constructor, used by wxWidgets itself only.
wxTreeItemId GetItem () const
 Returns the item (valid for all events).
int GetKeyCode () const
 Returns the key code if the event is a key event.
const wxKeyEventGetKeyEvent () const
 Returns the key event for EVT_TREE_KEY_DOWN events.
const wxStringGetLabel () const
 Returns the label if the event is a begin or end edit label event.
wxTreeItemId GetOldItem () const
 Returns the old item index (valid for EVT_TREE_ITEM_CHANGING and EVT_TREE_ITEM_CHANGED events).
wxPoint GetPoint () const
 Returns the position of the mouse pointer if the event is a drag or menu-context event.
bool IsEditCancelled () const
 Returns true if the label edit was cancelled.
void SetToolTip (const wxString &tooltip)
 Set the tooltip for the item (valid for EVT_TREE_ITEM_GETTOOLTIP events).

List of all members.


Constructor & Destructor Documentation

wxTreeEvent::wxTreeEvent ( wxEventType  commandType,
wxTreeCtrl tree,
const wxTreeItemId item = wxTreeItemId() 
)

Constructor, used by wxWidgets itself only.


Member Function Documentation

wxTreeItemId wxTreeEvent::GetItem ( ) const

Returns the item (valid for all events).

int wxTreeEvent::GetKeyCode ( ) const

Returns the key code if the event is a key event.

Use GetKeyEvent() to get the values of the modifier keys for this event (i.e. Shift or Ctrl).

const wxKeyEvent& wxTreeEvent::GetKeyEvent ( ) const

Returns the key event for EVT_TREE_KEY_DOWN events.

const wxString& wxTreeEvent::GetLabel ( ) const

Returns the label if the event is a begin or end edit label event.

wxTreeItemId wxTreeEvent::GetOldItem ( ) const

Returns the old item index (valid for EVT_TREE_ITEM_CHANGING and EVT_TREE_ITEM_CHANGED events).

wxPoint wxTreeEvent::GetPoint ( ) const

Returns the position of the mouse pointer if the event is a drag or menu-context event.

In both cases the position is in client coordinates - i.e. relative to the wxTreeCtrl window (so that you can pass it directly to e.g. wxWindow::PopupMenu()).

bool wxTreeEvent::IsEditCancelled ( ) const

Returns true if the label edit was cancelled.

This should be called from within an EVT_TREE_END_LABEL_EDIT handler.

void wxTreeEvent::SetToolTip ( const wxString tooltip)

Set the tooltip for the item (valid for EVT_TREE_ITEM_GETTOOLTIP events).

Windows only.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines