added (MSW/GTK) and documented new frame and dialog flags

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 1a594944db5f7af2424f554568ce285cc60d47b6..334cb8915ad70854ad9688533660c05c1ed5bb25 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        event.h
+// Name:        wx/event.h
 // Purpose:     Event classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c)
+// Copyright:   (c) wxWindows team
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -283,7 +283,7 @@ enum
     wxEVT_PLOT_AREA_SEL_CREATED = wxEVT_FIRST + 1015,
     wxEVT_PLOT_AREA_SEL_CHANGING = wxEVT_FIRST + 1016,
     wxEVT_PLOT_AREA_SEL_CHANGED = wxEVT_FIRST + 1017,
-    wxEVT_PLOT_BEGIN_X_LABEL_EDIT = wxEVT_FIRST + 1020,  
+    wxEVT_PLOT_BEGIN_X_LABEL_EDIT = wxEVT_FIRST + 1020,
     wxEVT_PLOT_END_X_LABEL_EDIT = wxEVT_FIRST + 1021,
     wxEVT_PLOT_BEGIN_Y_LABEL_EDIT = wxEVT_FIRST + 1022,
     wxEVT_PLOT_END_Y_LABEL_EDIT = wxEVT_FIRST + 1023,
@@ -291,6 +291,10 @@ enum
     wxEVT_PLOT_END_TITLE_EDIT = wxEVT_FIRST + 1025,
     wxEVT_PLOT_AREA_CREATE = wxEVT_FIRST + 1026,
 
+    /* Help events */
+    wxEVT_HELP = wxEVT_FIRST + 1050,
+    wxEVT_DETAILED_HELP,
+
     wxEVT_USER_FIRST = wxEVT_FIRST + 2000
 };
 
@@ -443,7 +447,7 @@ public:
     wxString GetString() const { return m_commandString; }
 
     // Get checkbox value
-    bool Checked() const { return (m_commandInt != 0); }
+    bool IsChecked() const { return m_commandInt != 0; }
 
     // TRUE if the listbox event was a selection.
     bool IsSelection() const { return (m_extraLong != 0); }
@@ -456,6 +460,10 @@ public:
 
     void CopyObject(wxObject& obj) const;
 
+#ifdef WXWIN_COMPATIBILITY_2
+    bool Checked() const { return IsChecked(); }
+#endif // WXWIN_COMPATIBILITY_2
+
 public:
     wxString          m_commandString; // String event argument
     int               m_commandInt;
@@ -869,7 +877,7 @@ public:
 
 #if defined(__WXDEBUG__) && defined(__WXMSW__)
     // see comments in src/msw/dcclient.cpp where g_isPainting is defined
-    extern int g_isPainting;
+    extern WXDLLEXPORT int g_isPainting;
 #endif // debug
 
 class WXDLLEXPORT wxPaintEvent : public wxEvent
@@ -1396,6 +1404,45 @@ public:
     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
 };
 
+// A help event is sent when the user clicks on a window in context-help mode.
+/*
+ wxEVT_HELP
+ wxEVT_DETAILED_HELP
+*/
+
+class WXDLLEXPORT wxHelpEvent : public wxCommandEvent
+{
+public:
+    wxHelpEvent(wxEventType type = wxEVT_NULL,
+                wxWindowID id = 0,
+                const wxPoint& pt = wxDefaultPosition)
+    {
+        m_eventType = type;
+        m_id = id;
+        m_pos = pt;
+    }
+
+    // Position of event (in screen coordinates)
+    const wxPoint& GetPosition() const { return m_pos; }
+    void SetPosition(const wxPoint& pos) { m_pos = pos; }
+
+    // Optional link to further help
+    const wxString& GetLink() const { return m_link; }
+    void SetLink(const wxString& link) { m_link = link; }
+
+    // Optional target to display help in. E.g. a window specification
+    const wxString& GetTarget() const { return m_target; }
+    void SetTarget(const wxString& target) { m_target = target; }
+
+protected:
+    wxPoint   m_pos;
+    wxString  m_target;
+    wxString  m_link;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxHelpEvent)
+};
+
 #endif // wxUSE_GUI
 
 // Idle event
@@ -1506,7 +1553,7 @@ public:
                   wxObjectEventFunction func = NULL,
                   wxObject *userData = (wxObject *) NULL )
         { return Disconnect(id, -1, eventType, func, userData); }
-       
+
     // implementation from now on
     virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
     bool SearchDynamicEventTable( wxEvent& event );
@@ -1599,6 +1646,7 @@ typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
 typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
 typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
 typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
+typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
 #endif // wxUSE_GUI
 
 // N.B. In GNU-WIN32, you *have* to take the address of a member function
@@ -1802,15 +1850,30 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
  { wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
  { wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
  { wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
- { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
+ { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
 
 // Idle event
 #define EVT_IDLE(func) \
- { wxEVT_IDLE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) & func, (wxObject *) NULL },\
+ { wxEVT_IDLE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) & func, (wxObject *) NULL },
 
 // Update UI event
 #define EVT_UPDATE_UI(id, func) \
- { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\
+ { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },
+#define EVT_UPDATE_UI_RANGE(id1, id2, func) \
+ { wxEVT_UPDATE_UI, id1, id2, (wxObjectEventFunction)(wxEventFunction)(wxUpdateUIEventFunction)&func, (wxObject *) NULL },
+
+// Help events
+#define EVT_HELP(id, func) \
+ { wxEVT_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL },
+
+#define EVT_HELP_RANGE(id1, id2, func) \
+ { wxEVT_HELP, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL },
+
+#define EVT_DETAILED_HELP(id, func) \
+ { wxEVT_DETAILED_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL },
+
+#define EVT_DETAILED_HELP_RANGE(id1, id2, func) \
+ { wxEVT_DETAILED_HELP, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL },
 
 // ----------------------------------------------------------------------------
 // Global data