No docs yet, just the bare interace so we can get XML for Phoenix.

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

diff --git a/interface/wx/taskbar.h b/interface/wx/taskbar.h
index 3c17db5f76d4857697981c9c14694ffd70e5ded8..5ad254afafccfe7137e68f691f215a0a40839010 100644 (file)
--- a/interface/wx/taskbar.h
+++ b/interface/wx/taskbar.h
@@ -3,9 +3,29 @@
 // Purpose:     interface of wxTaskBarIcon
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxTaskBarIcon
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+
+/**
+    @class wxTaskBarIconEvent
+
+    The event class used by wxTaskBarIcon.
+    For a list of the event macros meant to be used with wxTaskBarIconEvent,
+    please look at wxTaskBarIcon description.
+
+    @library{wxadv}
+    @category{events}
+*/
+class wxTaskBarIconEvent : public wxEvent
+{
+public:
+    /**
+        Constructor.
+    */
+    wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon);
+};
+

 /**
     @class wxTaskBarIcon
 
 /**
     @class wxTaskBarIcon
 


@@ -13,9 +33,11 @@
     A taskbar icon is an icon that appears in the 'system tray' and responds to
     mouse clicks, optionally with a tooltip above it to help provide information.
 
     A taskbar icon is an icon that appears in the 'system tray' and responds to
     mouse clicks, optionally with a tooltip above it to help provide information.
 

+

     @section taskbaricon_xnote X Window System Note
     @section taskbaricon_xnote X Window System Note

+

     Under X Window System, the window manager must support either the
     Under X Window System, the window manager must support either the

-    @link http://freedesktop.org/wiki/Specifications/systemtray-spec "System Tray Protocol"
+    "System Tray Protocol" (see http://freedesktop.org/wiki/Specifications/systemtray-spec)

     by freedesktop.org (WMs used by modern desktop environments such as GNOME >= 2,
     KDE >= 3 and XFCE >= 4 all do) or the older methods used in GNOME 1.2 and KDE 1 and 2.
 
     by freedesktop.org (WMs used by modern desktop environments such as GNOME >= 2,
     KDE >= 3 and XFCE >= 4 all do) or the older methods used in GNOME 1.2 and KDE 1 and 2.
 


@@ -26,7 +48,7 @@
     The user should be required to explicitly enable the taskbar icon on Unix,
     it shouldn't be on by default.
 
     The user should be required to explicitly enable the taskbar icon on Unix,
     it shouldn't be on by default.
 

-    @beginEventTable{wxTaskBarIconEvent}
+    @beginEventEmissionTable{wxTaskBarIconEvent}

     Note that not all ports are required to send these events and so it's better
     to override wxTaskBarIcon::CreatePopupMenu() if all that the application does
     is that it shows a popup menu in reaction to mouse click.
     Note that not all ports are required to send these events and so it's better
     to override wxTaskBarIcon::CreatePopupMenu() if all that the application does
     is that it shows a popup menu in reaction to mouse click.


@@ -66,19 +88,6 @@ public:
     */
     virtual ~wxTaskBarIcon();
 
     */
     virtual ~wxTaskBarIcon();
 

-    /**
-        This method is called by the library when the user requests popup menu
-        (on Windows and Unix platforms, this is when the user right-clicks the icon).
-
-        Override this function in order to provide popup menu associated with the icon.
-        If CreatePopupMenu() returns @NULL (this happens by default), no menu is shown,
-        otherwise the menu is displayed and then deleted by the library as soon as the
-        user dismisses it.
-
-        The events can be handled by a class derived from wxTaskBarIcon.
-    */
-    virtual wxMenu* CreatePopupMenu();
-

     /**
         This method is similar to wxWindow::Destroy and can be used to schedule
         the task bar icon object for the delayed destruction: it will be deleted
     /**
         This method is similar to wxWindow::Destroy and can be used to schedule
         the task bar icon object for the delayed destruction: it will be deleted


@@ -116,7 +125,8 @@ public:
     /**
         Sets the icon, and optional tooltip text.
     */
     /**
         Sets the icon, and optional tooltip text.
     */

-    bool SetIcon(const wxIcon& icon, const wxString& tooltip);
+    virtual bool SetIcon(const wxIcon& icon,
+                         const wxString& tooltip = wxEmptyString);

 
     /**
         Returns true if system tray is available in the desktop environment the
 
     /**
         Returns true if system tray is available in the desktop environment the


@@ -140,5 +150,20 @@ public:
         @since 2.9.0
     */
     static bool IsAvailable();
         @since 2.9.0
     */
     static bool IsAvailable();

+
+protected:
+
+    /**
+        This method is called by the library when the user requests popup menu
+        (on Windows and Unix platforms, this is when the user right-clicks the icon).
+
+        Override this function in order to provide popup menu associated with the icon.
+        If CreatePopupMenu() returns @NULL (this happens by default), no menu is shown,
+        otherwise the menu is displayed and then deleted by the library as soon as the
+        user dismisses it.
+
+        The events can be handled by a class derived from wxTaskBarIcon.
+    */
+    virtual wxMenu* CreatePopupMenu();

 };
 
 };