Illustrate usage of wxDataViewListCtrl

[wxWidgets.git] / interface / wx / event.h

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 638b86223180d6433d807c3eb55eb6f5adc82fcc..5a4a49bc2f5937fb045d45fe03e10bea5e2b3720 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -60,8 +60,8 @@ public:
         Returns a copy of the event.
 
         Any event that is posted to the wxWidgets event system for later action
         Returns a copy of the event.
 
         Any event that is posted to the wxWidgets event system for later action

-        (via wxEvtHandler::AddPendingEvent or wxPostEvent()) must implement
-        this method.
+        (via wxEvtHandler::AddPendingEvent, wxEvtHandler::QueueEvent or wxPostEvent())
+        must implement this method.

 
         All wxWidgets events fully implement this method, but any derived events
         implemented by the user should also implement this method just in case they
 
         All wxWidgets events fully implement this method, but any derived events
         implemented by the user should also implement this method just in case they


@@ -1428,6 +1428,12 @@ public:
     parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
     mouse leaves the window entirely but also when it enters one of its children.
 
     parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
     mouse leaves the window entirely but also when it enters one of its children.
 

+    The position associated with a mouse event is expressed in the window
+    coordinates of the window which generated the event, you can use
+    wxWindow::ClientToScreen() to convert it to screen coordinates and possibly
+    call wxWindow::ScreenToClient() next to convert it to window coordinates of
+    another window.
+

     @note Note that under Windows CE mouse enter and leave events are not natively
           supported by the system but are generated by wxWidgets itself. This has several
           drawbacks: the LEAVE_WINDOW event might be received some time after the mouse
     @note Note that under Windows CE mouse enter and leave events are not natively
           supported by the system but are generated by wxWidgets itself. This has several
           drawbacks: the LEAVE_WINDOW event might be received some time after the mouse


@@ -1876,71 +1882,71 @@ public:
         Process a command for a range of window identifiers, supplying the minimum and
         maximum window identifiers, command event identifier, and member function.
     @event{EVT_BUTTON(id, func)}
         Process a command for a range of window identifiers, supplying the minimum and
         maximum window identifiers, command event identifier, and member function.
     @event{EVT_BUTTON(id, func)}

-        Process a wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
+        Process a @c wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.

     @event{EVT_CHECKBOX(id, func)}
     @event{EVT_CHECKBOX(id, func)}

-        Process a wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
+        Process a @c wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.

     @event{EVT_CHOICE(id, func)}
     @event{EVT_CHOICE(id, func)}

-        Process a wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
+        Process a @c wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.

     @event{EVT_COMBOBOX(id, func)}
     @event{EVT_COMBOBOX(id, func)}

-        Process a wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
+        Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.

     @event{EVT_LISTBOX(id, func)}
     @event{EVT_LISTBOX(id, func)}

-        Process a wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
+        Process a @c wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.

     @event{EVT_LISTBOX_DCLICK(id, func)}
     @event{EVT_LISTBOX_DCLICK(id, func)}

-        Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
+        Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.

     @event{EVT_MENU(id, func)}
     @event{EVT_MENU(id, func)}

-        Process a wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
+        Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.

     @event{EVT_MENU_RANGE(id1, id2, func)}
     @event{EVT_MENU_RANGE(id1, id2, func)}

-        Process a wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
+        Process a @c wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.

     @event{EVT_CONTEXT_MENU(func)}
         Process the event generated when the user has requested a popup menu to appear by
         pressing a special keyboard key (under Windows) or by right clicking the mouse.
     @event{EVT_RADIOBOX(id, func)}
     @event{EVT_CONTEXT_MENU(func)}
         Process the event generated when the user has requested a popup menu to appear by
         pressing a special keyboard key (under Windows) or by right clicking the mouse.
     @event{EVT_RADIOBOX(id, func)}

-        Process a wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
+        Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.

     @event{EVT_RADIOBUTTON(id, func)}
     @event{EVT_RADIOBUTTON(id, func)}

-        Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
+        Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.

     @event{EVT_SCROLLBAR(id, func)}
     @event{EVT_SCROLLBAR(id, func)}

-        Process a wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar
+        Process a @c wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar

         control. This is provided for compatibility only; more specific scrollbar event macros
         should be used instead (see wxScrollEvent).
     @event{EVT_SLIDER(id, func)}
         control. This is provided for compatibility only; more specific scrollbar event macros
         should be used instead (see wxScrollEvent).
     @event{EVT_SLIDER(id, func)}

-        Process a wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
+        Process a @c wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.

     @event{EVT_TEXT(id, func)}
     @event{EVT_TEXT(id, func)}

-        Process a wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
+        Process a @c wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.

     @event{EVT_TEXT_ENTER(id, func)}
     @event{EVT_TEXT_ENTER(id, func)}

-        Process a wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.
+        Process a @c wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.

         Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
         to generate such events.
     @event{EVT_TEXT_MAXLEN(id, func)}
         Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
         to generate such events.
     @event{EVT_TEXT_MAXLEN(id, func)}

-        Process a wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
+        Process a @c wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control

         when the user tries to enter more characters into it than the limit previously set
         with SetMaxLength().
     @event{EVT_TOGGLEBUTTON(id, func)}
         when the user tries to enter more characters into it than the limit previously set
         with SetMaxLength().
     @event{EVT_TOGGLEBUTTON(id, func)}

-        Process a wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
+        Process a @c wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.

     @event{EVT_TOOL(id, func)}
     @event{EVT_TOOL(id, func)}

-        Process a wxEVT_COMMAND_TOOL_CLICKED event (a synonym for wxEVT_COMMAND_MENU_SELECTED).
+        Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c wxEVT_COMMAND_MENU_SELECTED).

         Pass the id of the tool.
     @event{EVT_TOOL_RANGE(id1, id2, func)}
         Pass the id of the tool.
     @event{EVT_TOOL_RANGE(id1, id2, func)}

-        Process a wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
+        Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.

     @event{EVT_TOOL_RCLICKED(id, func)}
     @event{EVT_TOOL_RCLICKED(id, func)}

-        Process a wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool.
+        Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool.

     @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
     @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}

-        Process a wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools.
+        Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools.

     @event{EVT_TOOL_ENTER(id, func)}
     @event{EVT_TOOL_ENTER(id, func)}

-        Process a wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
+        Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.

         The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
         has moved off a tool.
     @event{EVT_COMMAND_LEFT_CLICK(id, func)}
         The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
         has moved off a tool.
     @event{EVT_COMMAND_LEFT_CLICK(id, func)}

-        Process a wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
+        Process a @c wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
     @event{EVT_COMMAND_LEFT_DCLICK(id, func)}

-        Process a wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
+        Process a @c wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
     @event{EVT_COMMAND_RIGHT_CLICK(id, func)}

-        Process a wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
+        Process a @c wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_SET_FOCUS(id, func)}
     @event{EVT_COMMAND_SET_FOCUS(id, func)}

-        Process a wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
+        Process a @c wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_KILL_FOCUS(id, func)}
     @event{EVT_COMMAND_KILL_FOCUS(id, func)}

-        Process a wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
+        Process a @c wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).

     @event{EVT_COMMAND_ENTER(id, func)}
     @event{EVT_COMMAND_ENTER(id, func)}

-        Process a wxEVT_COMMAND_ENTER command, which is generated by a control.
+        Process a @c wxEVT_COMMAND_ENTER command, which is generated by a control.

     @endEventTable
 
     @library{wxcore}
     @endEventTable
 
     @library{wxcore}


@@ -2992,7 +2998,7 @@ public:
     these do not include menu command events, which are
     handled using wxCommandEvent objects.
 
     these do not include menu command events, which are
     handled using wxCommandEvent objects.
 

-    The default handler for wxEVT_MENU_HIGHLIGHT displays help
+    The default handler for @c wxEVT_MENU_HIGHLIGHT displays help

     text in the first field of the status bar.
 
     @beginEventTable{wxMenuEvent}
     text in the first field of the status bar.
 
     @beginEventTable{wxMenuEvent}


@@ -3276,9 +3282,15 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_events */
+/** @addtogroup group_funcmacro_events */

 //@{
 
 //@{
 

+/**
+    A special event type usually used to indicate that some wxEvent has yet
+    no type assigned.
+*/
+wxEventType wxEVT_NULL;
+

 /**
     Each wxEvent-derived class has an @e event-type associated.
     See the macro DEFINE_EVENT_TYPE() for more info.
 /**
     Each wxEvent-derived class has an @e event-type associated.
     See the macro DEFINE_EVENT_TYPE() for more info.