clear up wxStringBuffer docs a bit

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

diff --git a/include/wx/taskbar.h b/include/wx/taskbar.h
index de482f4dcd0da3f918ab4ea5c36a1460417fdec7..97f912ceb8d3defe342ec2d2a002e6e778b223ea 100644 (file)
--- a/include/wx/taskbar.h
+++ b/include/wx/taskbar.h
@@ -7,16 +7,32 @@
 
 #include "wx/event.h"
 
 
 #include "wx/event.h"
 

+class WXDLLIMPEXP_ADV wxTaskBarIconEvent;
+

 // ----------------------------------------------------------------------------
 // wxTaskBarIconBase: define wxTaskBarIcon interface
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxTaskBarIconBase: define wxTaskBarIcon interface
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxTaskBarIconBase : public wxEvtHandler
+class WXDLLIMPEXP_ADV wxTaskBarIconBase : public wxEvtHandler

 {
 public:
     wxTaskBarIconBase() { }
 
 {
 public:
     wxTaskBarIconBase() { }
 

+    // Operations:
+    virtual bool SetIcon(const wxIcon& icon,
+                         const wxString& tooltip = wxEmptyString) = 0;
+    virtual bool RemoveIcon() = 0;
+    virtual bool PopupMenu(wxMenu *menu) = 0;
+
+protected:
+    // creates menu to be displayed when user clicks on the icon
+    virtual wxMenu *CreatePopupMenu() { return NULL; }
+

 private:
 private:

+    // default events handling, calls CreatePopupMenu:
+    void OnRightButtonDown(wxTaskBarIconEvent& event);
+
+    DECLARE_EVENT_TABLE()

     DECLARE_NO_COPY_CLASS(wxTaskBarIconBase)
 };
 
     DECLARE_NO_COPY_CLASS(wxTaskBarIconBase)
 };
 


@@ -25,21 +41,27 @@ private:
 // now include the actual class declaration
 // ----------------------------------------------------------------------------
 
 // now include the actual class declaration
 // ----------------------------------------------------------------------------
 

-#if defined(__WXMSW__)
+#if defined(__PALMOS__)
+    #include "wx/palmos/taskbar.h"
+#elif defined(__WXMSW__)

     #include "wx/msw/taskbar.h"
 #elif defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__)
     #include "wx/unix/taskbarx11.h"
     #include "wx/msw/taskbar.h"
 #elif defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__)
     #include "wx/unix/taskbarx11.h"

+#elif defined (__WXMAC__) && defined(__WXMAC_OSX__)
+    #include "wx/mac/taskbarosx.h"
+#elif defined (__WXCOCOA__)
+    #include "wx/cocoa/taskbar.h"

 #endif
 
 // ----------------------------------------------------------------------------
 // wxTaskBarIcon events
 // ----------------------------------------------------------------------------
 
 #endif
 
 // ----------------------------------------------------------------------------
 // wxTaskBarIcon events
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxTaskBarIconEvent : public wxEvent
+class WXDLLIMPEXP_ADV wxTaskBarIconEvent : public wxEvent

 {
 public:
     wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon)
 {
 public:
     wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon)

-        : wxEvent(-1, evtType)
+        : wxEvent(wxID_ANY, evtType)

     {
         SetEventObject(tbIcon);
     }
     {
         SetEventObject(tbIcon);
     }


@@ -47,26 +69,28 @@ public:
     virtual wxEvent *Clone() const { return new wxTaskBarIconEvent(*this); }
 
 private:
     virtual wxEvent *Clone() const { return new wxTaskBarIconEvent(*this); }
 
 private:

-    DECLARE_NO_COPY_CLASS(wxTaskBarIconEvent)
+    DECLARE_NO_ASSIGN_CLASS(wxTaskBarIconEvent)

 };
 
 };
 

+typedef void (wxEvtHandler::*wxTaskBarIconEventFunction)(wxTaskBarIconEvent&);
+

 BEGIN_DECLARE_EVENT_TYPES()
 BEGIN_DECLARE_EVENT_TYPES()

-    DECLARE_EVENT_TYPE( wxEVT_TASKBAR_MOVE, 1550 )
-    DECLARE_EVENT_TYPE( wxEVT_TASKBAR_LEFT_DOWN, 1551 )
-    DECLARE_EVENT_TYPE( wxEVT_TASKBAR_LEFT_UP, 1552 )
-    DECLARE_EVENT_TYPE( wxEVT_TASKBAR_RIGHT_DOWN, 1553 )
-    DECLARE_EVENT_TYPE( wxEVT_TASKBAR_RIGHT_UP, 1554 )
-    DECLARE_EVENT_TYPE( wxEVT_TASKBAR_LEFT_DCLICK, 1555 )
-    DECLARE_EVENT_TYPE( wxEVT_TASKBAR_RIGHT_DCLICK, 1556 )
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV,wxEVT_TASKBAR_MOVE,1550)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV,wxEVT_TASKBAR_LEFT_DOWN,1551)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV,wxEVT_TASKBAR_LEFT_UP,1552)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV,wxEVT_TASKBAR_RIGHT_DOWN,1553)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV,wxEVT_TASKBAR_RIGHT_UP,1554)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV,wxEVT_TASKBAR_LEFT_DCLICK,1555)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV,wxEVT_TASKBAR_RIGHT_DCLICK,1556)

 END_DECLARE_EVENT_TYPES()
 
 END_DECLARE_EVENT_TYPES()
 

-#define EVT_TASKBAR_MOVE(fn)         DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_LEFT_DOWN(fn)    DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_LEFT_UP(fn)      DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_RIGHT_DOWN(fn)   DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_RIGHT_UP(fn)     DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_LEFT_DCLICK(fn)  DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_RIGHT_DCLICK(fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
+#define EVT_TASKBAR_MOVE(fn)         DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_MOVE, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxTaskBarIconEventFunction, &fn ), NULL),
+#define EVT_TASKBAR_LEFT_DOWN(fn)    DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_LEFT_DOWN, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxTaskBarIconEventFunction, &fn ), NULL),
+#define EVT_TASKBAR_LEFT_UP(fn)      DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_LEFT_UP, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxTaskBarIconEventFunction, &fn ), NULL),
+#define EVT_TASKBAR_RIGHT_DOWN(fn)   DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_RIGHT_DOWN, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxTaskBarIconEventFunction, &fn ), NULL),
+#define EVT_TASKBAR_RIGHT_UP(fn)     DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_RIGHT_UP, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxTaskBarIconEventFunction, &fn ), NULL),
+#define EVT_TASKBAR_LEFT_DCLICK(fn)  DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_LEFT_DCLICK, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxTaskBarIconEventFunction, &fn ), NULL),
+#define EVT_TASKBAR_RIGHT_DCLICK(fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_RIGHT_DCLICK, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxTaskBarIconEventFunction, &fn ), NULL),

 
 #endif
     // wxHAS_TASK_BAR_ICON
 
 #endif
     // wxHAS_TASK_BAR_ICON