.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxListEvent 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxListEvent \- 
  A list control event
 
.SH DESCRIPTION

  


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

  wxNotifyEvent
   
  wxCommandEvent
   
  wxEvent
   
  wxObject
 
.SH "INCLUDE FILES"
wx/listctrl.h
.SH MEMBERS

  
.SS  wxListEvent (WXTYPE commandType = 0int id = 0)

     


      Constructor.
     
    
   
  
.SS long GetCacheFrom ()

     


      For
      EVT_LIST_CACHE_HINT
      event only: return the first item which the list control advises us to
      cache.
     
    
   
  
.SS long GetCacheTo ()

     


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

     


      Key code if the event is a keypress event.
     
    
   
  
.SS long GetIndex ()

     


      The item index.
     
    
   
  
.SS int GetColumn ()

     


      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.
     
    
   
  
.SS wxPoint GetPoint ()

     


      The position of the mouse pointer if the event is a drag event.
     
    
   
  
.SS const wxString& GetLabel ()

     


      The (new) item label for
      EVT_LIST_END_LABEL_EDIT
      event.
     
    
   
  
.SS const wxString& GetText ()

     


      The text.
     
    
   
  
.SS int GetImage ()

     


      The image.
     
    
   
  
.SS long GetData ()

     


      The data.
     
    
   
  
.SS long GetMask ()

     


      The mask.
     
    
   
  
.SS const wxListItem& GetItem ()

     


      An item object, used by some events. See also
      wxListCtrl::SetItem
      .
     
    
   
  
.SS bool IsEditCancelled ()

     


      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).
     
    
 
.SH EVENTS

.SS EVT_LIST_BEGIN_DRAG(id, func)

   Begin dragging with the left mouse button.
  
.SS EVT_LIST_BEGIN_RDRAG(id, func)

   Begin dragging with the right mouse button.
  
.SS EVT_LIST_BEGIN_LABEL_EDIT(id, func)

   Begin editing a label. This can be prevented by calling 
   Veto()
   .
  
.SS EVT_LIST_END_LABEL_EDIT(id, func)

   Finish editing a label. This can be prevented by calling 
   Veto()
   .
  
.SS EVT_LIST_DELETE_ITEM(id, func)

   Delete an item.
  
.SS EVT_LIST_DELETE_ALL_ITEMS(id, func)

   Delete all items.
  
.SS EVT_LIST_ITEM_SELECTED(id, func)

   The item has been selected.
  
.SS EVT_LIST_ITEM_DESELECTED(id, func)

   The item has been deselected.
  
.SS EVT_LIST_ITEM_ACTIVATED(id, func)

   The item has been activated (ENTER or double click).
  
.SS EVT_LIST_ITEM_FOCUSED(id, func)

   The currently focused item has changed.
  
.SS EVT_LIST_ITEM_MIDDLE_CLICK(id, func)

   The middle mouse button has been clicked on an item.
  
.SS EVT_LIST_ITEM_RIGHT_CLICK(id, func)

   The right mouse button has been clicked on an item.
  
.SS EVT_LIST_KEY_DOWN(id, func)

   A key has been pressed.
  
.SS EVT_LIST_INSERT_ITEM(id, func)

   An item has been inserted.
  
.SS EVT_LIST_COL_CLICK(id, func)

   A column (
   
    m_col
   
   ) has been left-clicked.
  
.SS 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.
  
.SS EVT_LIST_COL_BEGIN_DRAG(id, func)

   The user started resizing a column - can be vetoed.
  
.SS EVT_LIST_COL_DRAGGING(id, func)

   The divider between columns is being dragged.
  
.SS EVT_LIST_COL_END_DRAG(id, func)

   A column has been resized by the user.
  
.SS EVT_LIST_CACHE_HINT(id, func)

   Prepare cache for a virtual list control
  
.SH "SEE ALSO"

  wxNotifyEvent
   
  wxCommandEvent
   
  wxEvent
   
  wxObject
 
  wxListCtrl
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.