Version: 3.1.1
wxListEvent Class Reference

#include <wx/listctrl.h>

+ Inheritance diagram for wxListEvent:

Detailed Description

A list event holds information about events associated with wxListCtrl objects.

Events using this class

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

void handlerFuncName(wxListEvent& event)

Event macros:

  • EVT_LIST_BEGIN_DRAG(id, func):
    Begin dragging with the left mouse button.
  • EVT_LIST_BEGIN_RDRAG(id, func):
    Begin dragging with the right mouse button.
  • EVT_LIST_BEGIN_LABEL_EDIT(id, func):
    Begin editing a label. This can be prevented by calling Veto().
  • EVT_LIST_END_LABEL_EDIT(id, func):
    Finish editing a label. This can be prevented by calling Veto().
  • EVT_LIST_DELETE_ITEM(id, func):
    Delete an item.
  • EVT_LIST_DELETE_ALL_ITEMS(id, func):
    Delete all items.
  • EVT_LIST_ITEM_SELECTED(id, func):
    The item has been selected.
  • EVT_LIST_ITEM_DESELECTED(id, func):
    The item has been deselected.
  • EVT_LIST_ITEM_ACTIVATED(id, func):
    The item has been activated (ENTER or double click).
  • EVT_LIST_ITEM_FOCUSED(id, func):
    The currently focused item has changed.
  • EVT_LIST_ITEM_MIDDLE_CLICK(id, func):
    The middle mouse button has been clicked on an item.
  • EVT_LIST_ITEM_RIGHT_CLICK(id, func):
    The right mouse button has been clicked on an item.
  • EVT_LIST_KEY_DOWN(id, func):
    A key has been pressed. GetIndex() may be -1 if no item is selected.
  • EVT_LIST_INSERT_ITEM(id, func):
    An item has been inserted.
  • EVT_LIST_COL_CLICK(id, func):
    A column (m_col) has been left-clicked.
  • EVT_LIST_COL_RIGHT_CLICK(id, func):
    A column (m_col) (which can be -1 if the click occurred outside any column) has been right-clicked.
  • EVT_LIST_COL_BEGIN_DRAG(id, func):
    The user started resizing a column - can be vetoed.
  • EVT_LIST_COL_DRAGGING(id, func):
    The divider between columns is being dragged.
  • EVT_LIST_COL_END_DRAG(id, func):
    A column has been resized by the user.
  • EVT_LIST_CACHE_HINT(id, func):
    Prepare cache for a virtual list control
  • EVT_LIST_ITEM_CHECKED(id, func):
    The item has been checked (new since wxWidgets 3.1.0).
  • EVT_LIST_ITEM_UNCHECKED(id, func):
    The item has been unchecked (new since wxWidgets 3.1.0).

Library:  wxCore
Category:  Events
See also
wxListCtrl

Public Member Functions

 wxListEvent (wxEventType commandType=wxEVT_NULL, int id=0)
 Constructor. More...
 
long GetCacheFrom () const
 For EVT_LIST_CACHE_HINT event only: return the first item which the list control advises us to cache. More...
 
long GetCacheTo () const
 For EVT_LIST_CACHE_HINT event only: return the last item (inclusive) which the list control advises us to cache. More...
 
int GetColumn () const
 The column position: it is only used with COL events. More...
 
wxUIntPtr GetData () const
 The data. More...
 
int GetImage () const
 The image. More...
 
long GetIndex () const
 The item index. More...
 
const wxListItemGetItem () const
 An item object, used by some events. More...
 
int GetKeyCode () const
 Key code if the event is a keypress event. More...
 
const wxStringGetLabel () const
 The (new) item label for EVT_LIST_END_LABEL_EDIT event. More...
 
long GetMask () const
 The mask. More...
 
wxPoint GetPoint () const
 The position of the mouse pointer if the event is a drag event. More...
 
const wxStringGetText () const
 The text. More...
 
bool IsEditCancelled () const
 This method only makes sense for EVT_LIST_END_LABEL_EDIT message and returns true if it the label editing has been cancelled by the user (GetLabel() returns an empty string in this case but it doesn't allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string). More...
 
- Public Member Functions inherited from wxNotifyEvent
 wxNotifyEvent (wxEventType eventType=wxEVT_NULL, int id=0)
 Constructor (used internally by wxWidgets only). More...
 
void Allow ()
 This is the opposite of Veto(): it explicitly allows the event to be processed. More...
 
bool IsAllowed () const
 Returns true if the change is allowed (Veto() hasn't been called) or false otherwise (if it was). More...
 
void Veto ()
 Prevents the change announced by this event from happening. More...
 
- Public Member Functions inherited from wxCommandEvent
 wxCommandEvent (wxEventType commandEventType=wxEVT_NULL, int id=0)
 Constructor. More...
 
void * GetClientData () const
 Returns client data pointer for a listbox or choice selection event (not valid for a deselection). More...
 
wxClientDataGetClientObject () const
 Returns client object pointer for a listbox or choice selection event (not valid for a deselection). More...
 
long GetExtraLong () const
 Returns extra information dependent on the event objects type. More...
 
int GetInt () const
 Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox. More...
 
int GetSelection () const
 Returns item index for a listbox or choice selection event (not valid for a deselection). More...
 
wxString GetString () const
 Returns item string for a listbox or choice selection event. More...
 
bool IsChecked () const
 This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one. More...
 
bool IsSelection () const
 For a listbox or similar event, returns true if it is a selection, false if it is a deselection. More...
 
void SetClientData (void *clientData)
 Sets the client data for this event. More...
 
void SetClientObject (wxClientData *clientObject)
 Sets the client object for this event. More...
 
void SetExtraLong (long extraLong)
 Sets the m_extraLong member. More...
 
void SetInt (int intCommand)
 Sets the m_commandInt member. More...
 
void SetString (const wxString &string)
 Sets the m_commandString member. More...
 
- Public Member Functions inherited from wxEvent
 wxEvent (int id=0, wxEventType eventType=wxEVT_NULL)
 Constructor. More...
 
virtual wxEventClone () const =0
 Returns a copy of the event. More...
 
wxObjectGetEventObject () const
 Returns the object (usually a window) associated with the event, if any. More...
 
wxEventType GetEventType () const
 Returns the identifier of the given event type, such as wxEVT_BUTTON. More...
 
virtual wxEventCategory GetEventCategory () const
 Returns a generic category for this event. More...
 
int GetId () const
 Returns the identifier associated with this event, such as a button command id. More...
 
wxObjectGetEventUserData () const
 Return the user data associated with a dynamically connected event handler. More...
 
bool GetSkipped () const
 Returns true if the event handler should be skipped, false otherwise. More...
 
long GetTimestamp () const
 Gets the timestamp for the event. More...
 
bool IsCommandEvent () const
 Returns true if the event is or is derived from wxCommandEvent else it returns false. More...
 
void ResumePropagation (int propagationLevel)
 Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation). More...
 
void SetEventObject (wxObject *object)
 Sets the originating object. More...
 
void SetEventType (wxEventType type)
 Sets the event type. More...
 
void SetId (int id)
 Sets the identifier associated with this event, such as a button command id. More...
 
void SetTimestamp (long timeStamp=0)
 Sets the timestamp for the event. More...
 
bool ShouldPropagate () const
 Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0. More...
 
void Skip (bool skip=true)
 This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns. More...
 
int StopPropagation ()
 Stop the event from propagating to its parent window. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxEvent
int m_propagationLevel
 Indicates how many levels the event can propagate. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

wxListEvent::wxListEvent ( wxEventType  commandType = wxEVT_NULL,
int  id = 0 
)

Constructor.

Member Function Documentation

long wxListEvent::GetCacheFrom ( ) const

For EVT_LIST_CACHE_HINT event only: return the first item which the list control advises us to cache.

long wxListEvent::GetCacheTo ( ) const

For EVT_LIST_CACHE_HINT event only: return the last item (inclusive) which the list control advises us to cache.

int wxListEvent::GetColumn ( ) const

The column position: it is only used with COL events.

For the column dragging events, it is the column to the left of the divider being dragged, for the column click events it may be -1 if the user clicked in the list control header outside any column.

wxUIntPtr wxListEvent::GetData ( ) const

The data.

int wxListEvent::GetImage ( ) const

The image.

long wxListEvent::GetIndex ( ) const

The item index.

const wxListItem& wxListEvent::GetItem ( ) const

An item object, used by some events.

See also wxListCtrl::SetItem.

int wxListEvent::GetKeyCode ( ) const

Key code if the event is a keypress event.

const wxString& wxListEvent::GetLabel ( ) const

The (new) item label for EVT_LIST_END_LABEL_EDIT event.

long wxListEvent::GetMask ( ) const

The mask.

wxPoint wxListEvent::GetPoint ( ) const

The position of the mouse pointer if the event is a drag event.

const wxString& wxListEvent::GetText ( ) const

The text.

bool wxListEvent::IsEditCancelled ( ) const

This method only makes sense for EVT_LIST_END_LABEL_EDIT message and returns true if it the label editing has been cancelled by the user (GetLabel() returns an empty string in this case but it doesn't allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string).