some common code moved from wxWindow/wxFrame into files in common subdir

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

diff --git a/include/wx/event.h b/include/wx/event.h
index dc26feec37e02b5b587250dfac488f22e4717fc1..134114c78c7c8372e19ce84dc7649f3048b1f261 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -39,6 +39,7 @@ enum wxEventType {
  wxEVT_COMMAND_TEXT_UPDATED,
  wxEVT_COMMAND_TEXT_ENTER,
  wxEVT_COMMAND_MENU_SELECTED,
+ wxEVT_COMMAND_TOOL_CLICKED = wxEVT_COMMAND_MENU_SELECTED,
  wxEVT_COMMAND_SLIDER_UPDATED,
  wxEVT_COMMAND_RADIOBOX_SELECTED,
  wxEVT_COMMAND_RADIOBUTTON_SELECTED,
@@ -46,7 +47,6 @@ enum wxEventType {
  wxEVT_COMMAND_SCROLLBAR_UPDATED,
  wxEVT_COMMAND_VLBOX_SELECTED,
  wxEVT_COMMAND_COMBOBOX_SELECTED,
- wxEVT_COMMAND_TOOL_CLICKED,
  wxEVT_COMMAND_TOOL_RCLICKED,
  wxEVT_COMMAND_TOOL_ENTER,
  wxEVT_SET_FOCUS,
@@ -82,6 +82,7 @@ enum wxEventType {
 
 /* Character input event type  */
  wxEVT_CHAR,
+ wxEVT_NAVIGATION_KEY,
 
  /*
   * Scrollbar event identifiers
@@ -156,6 +157,8 @@ enum wxEventType {
  wxEVT_COMMAND_TREE_SET_INFO,
  wxEVT_COMMAND_TREE_ITEM_EXPANDED,
  wxEVT_COMMAND_TREE_ITEM_EXPANDING,
+ wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
+ wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
  wxEVT_COMMAND_TREE_SEL_CHANGED,
  wxEVT_COMMAND_TREE_SEL_CHANGING,
  wxEVT_COMMAND_TREE_KEY_DOWN,
@@ -179,7 +182,10 @@ enum wxEventType {
  wxEVT_COMMAND_TAB_SEL_CHANGED,
  wxEVT_COMMAND_TAB_SEL_CHANGING,
  wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,
- wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
+ wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,
+
+ /* System misc. */
+ wxEVT_END_PROCESS = wxEVT_FIRST + 300
 };
 
 // Compatibility
@@ -258,7 +264,7 @@ public:
 
   // Can instruct event processor that we wish to ignore this event
   // (treat as if the event table entry had not been found)
-  inline void Skip(const bool skip = TRUE) { m_skipped = skip; }
+  inline void Skip(bool skip = TRUE) { m_skipped = skip; }
   inline bool GetSkipped(void) const { return m_skipped; };
 
 public:
@@ -903,6 +909,33 @@ class WXDLLEXPORT wxSysColourChangedEvent: public wxEvent
      { m_eventType = wxEVT_SYS_COLOUR_CHANGED; }
 };
 
+/*
+ Event generated by dialog navigation keys
+ wxEVT_NAVIGATION_KEY
+ */
+// must derive from command event to be propagated to the parent
+class WXDLLEXPORT wxNavigationKeyEvent : public wxCommandEvent
+{
+  DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent)
+
+public:
+  wxNavigationKeyEvent() : wxCommandEvent(wxEVT_NAVIGATION_KEY) { }
+
+  // direction: forward (true) or backward (false)
+  bool GetDirection() const        { return m_commandInt == 1; }
+  void SetDirection(bool bForward) { m_commandInt = bForward;  }
+
+  // it may be a window change event (MDI, notebook pages...) or a control
+  // change event
+  bool IsWindowChange() const    { return m_extraLong == 1; }
+  void SetWindowChange(bool bIs) { m_extraLong = bIs; }
+
+  // the child which has the focus currently (may be NULL - use 
+  // wxWindow::FindFocus then)
+  wxWindow* GetCurrentFocus() const { return (wxWindow *)m_clientData; }
+  void SetCurrentFocus(wxWindow *win) { m_clientData = (char *)win; }
+};
+
 /* TODO
  wxEVT_POWER,
  wxEVT_CREATE,
@@ -927,9 +960,10 @@ typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
 
 struct WXDLLEXPORT wxEventTableEntry
 {
-       int             m_eventType;            // main event type
-       int             m_id;                       // control/menu/toolbar id
-       int             m_lastId;                       // used for ranges of ids
+    // For some reason, this can't be wxEventType, or VC++ complains.
+       int                     m_eventType;            // main event type
+       int                             m_id;                       // control/menu/toolbar id
+       int                             m_lastId;                       // used for ranges of ids
        wxObjectEventFunction   m_fn;   // function to call: not wxEventFunction, because
                                                    // of dependency problems
        wxObject*       m_callbackUserData;
@@ -961,29 +995,8 @@ class WXDLLEXPORT wxEvtHandler: public wxObject
                                                  // callback function
   // Default behaviour
   virtual long Default(void) { if (GetNextHandler()) return GetNextHandler()->Default(); else return 0; };
-#if WXWIN_COMPATIBILITY
-  virtual void OldOnMenuCommand(int WXUNUSED(cmd));
-  virtual void OldOnMenuSelect(int WXUNUSED(cmd));
-  virtual void OldOnInitMenuPopup(int WXUNUSED(pos));
-  virtual void OldOnScroll(wxCommandEvent& WXUNUSED(event));
-  virtual void OldOnPaint(void);
-  virtual void OldOnSize(int WXUNUSED(width), int WXUNUSED(height));
-  virtual void OldOnMove(int WXUNUSED(x), int WXUNUSED(y));
-  virtual void OldOnMouseEvent(wxMouseEvent& WXUNUSED(event));
-  virtual void OldOnChar(wxKeyEvent& WXUNUSED(event));
-  // Under Windows, we can intercept character input per dialog or frame
-  virtual bool OldOnCharHook(wxKeyEvent& WXUNUSED(event));
-  virtual void OldOnActivate(bool WXUNUSED(active));
-  virtual void OldOnSetFocus(void);
-  virtual void OldOnKillFocus(void);
-  virtual bool OldOnSysColourChange(void);
-  virtual void OldOnDropFiles(int n, char *files[], int x, int y);
-#endif
 
   virtual bool OnClose(void);
-  virtual void OnDefaultAction(wxControl *WXUNUSED(initiatingItem)) {};
-  virtual void OnChangeFocus(wxControl *WXUNUSED(from), wxControl *WXUNUSED(to)) {};
-  virtual bool OnFunctionKey(wxKeyEvent &WXUNUSED(event)) { return FALSE; };
 
   inline char *GetClientData(void) const { return m_clientData; }
   inline void SetClientData(char *clientData) { m_clientData = clientData; }
@@ -991,8 +1004,8 @@ class WXDLLEXPORT wxEvtHandler: public wxObject
   virtual bool ProcessEvent(wxEvent& event);
   virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
   
-  void Connect( const int id, const int lastId,
-                const int eventType, 
+  void Connect( int id, int lastId,
+                int eventType,
                wxObjectEventFunction func,
                wxObject *userData = NULL );
                
@@ -1084,6 +1097,7 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_SHOW(func) { wxEVT_SHOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxShowEventFunction) & func, NULL },
 #define EVT_MAXIMIZE(func) { wxEVT_MAXIMIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMaximizeEventFunction) & func, NULL },
 #define EVT_ICONIZE(func) { wxEVT_ICONIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIconizeEventFunction) & func, NULL },
+#define EVT_NAVIGATION_KEY(func) { wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & func, NULL },
 
 // Mouse events
 #define EVT_LEFT_DOWN(func) { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, NULL },
@@ -1159,6 +1173,7 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_CHECKBOX(id, fn) { wxEVT_COMMAND_CHECKBOX_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_CHOICE(id, fn) { wxEVT_COMMAND_CHOICE_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_LISTBOX(id, fn) { wxEVT_COMMAND_LISTBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
+#define EVT_LISTBOX_DCLICK(id, fn) { wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_TEXT(id, fn) { wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_TEXT_ENTER(id, fn) { wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_MENU(id, fn) { wxEVT_COMMAND_MENU_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
@@ -1171,8 +1186,11 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_VLBOX(id, fn) { wxEVT_COMMAND_VLBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_COMBOBOX(id, fn) { wxEVT_COMMAND_COMBOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_TOOL(id, fn) { wxEVT_COMMAND_TOOL_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
+#define EVT_TOOL_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_CLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_TOOL_RCLICKED(id, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
+#define EVT_TOOL_RCLICKED_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_TOOL_ENTER(id, fn) { wxEVT_COMMAND_TOOL_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
+#define EVT_TOOL_ENTER_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_ENTER, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 #define EVT_CHECKLISTBOX(id, fn) { wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, NULL },
 
 // Generic command events