merged new and updated translations from WX_2_2_BRANCH.

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 6a2a9f46c7079d3bf1ee31976623bcc7bcece092..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$
 // Purpose:     Event classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c)
+// Copyright:   (c) wxWindows team

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // 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_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,
     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,


@@ -293,6 +293,7 @@ enum
 
     /* Help events */
     wxEVT_HELP = wxEVT_FIRST + 1050,
 
     /* Help events */
     wxEVT_HELP = wxEVT_FIRST + 1050,

+    wxEVT_DETAILED_HELP,

 
     wxEVT_USER_FIRST = wxEVT_FIRST + 2000
 };
 
     wxEVT_USER_FIRST = wxEVT_FIRST + 2000
 };


@@ -876,7 +877,7 @@ public:
 
 #if defined(__WXDEBUG__) && defined(__WXMSW__)
     // see comments in src/msw/dcclient.cpp where g_isPainting is defined
 
 #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
 #endif // debug
 
 class WXDLLEXPORT wxPaintEvent : public wxEvent


@@ -1403,24 +1404,43 @@ public:
     wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
 };
 
     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_HELP

- Sent when the user clicks on a window in context-help mode.
- The cursor position is in screen coordinates.
- */
+ wxEVT_DETAILED_HELP
+*/

 
 class WXDLLEXPORT wxHelpEvent : public wxCommandEvent
 {
 
 class WXDLLEXPORT wxHelpEvent : public wxCommandEvent
 {

-    DECLARE_DYNAMIC_CLASS(wxHelpEvent)
-

 public:
 public:

-  wxHelpEvent(wxEventType type = wxEVT_NULL, wxWindowID id = 0, const wxPoint& pt = wxPoint(0, 0))
-      { m_eventType = type; m_id = id; m_pos = pt; }
+    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; }

 
 

-  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; }

 
 

-  wxPoint   m_pos;
+    // 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
 };
 
 #endif // wxUSE_GUI


@@ -1533,7 +1553,7 @@ public:
                   wxObjectEventFunction func = NULL,
                   wxObject *userData = (wxObject *) NULL )
         { return Disconnect(id, -1, eventType, func, userData); }
                   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 );
     // implementation from now on
     virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
     bool SearchDynamicEventTable( wxEvent& event );


@@ -1849,6 +1869,12 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_HELP_RANGE(id1, id2, func) \
  { wxEVT_HELP, id1, id2, (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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Global data
 // ----------------------------------------------------------------------------