]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/taskbar.tex
More const bool (sigh)
[wxWidgets.git] / docs / latex / wx / taskbar.tex
index c5a1bb6d252423bb1ffdb16b8b87052196186e37..ce5a5dfe372b132cdb179bc1231857e832634c0c 100644 (file)
@@ -1,9 +1,6 @@
 \section{\class{wxTaskBarIcon}}\label{wxtaskbaricon}
 
-This class represents a taskbar icon, appearing in the `system tray' and
-responding to mouse clicks. An icon has an optional tooltip. This class is only
-supported under Windows 95/NT and in X Window System ports (wxGTK, wxMotif,
-wxX11). 
+This class represents a taskbar icon. 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.
 
 \wxheading{X Window System Note}
 
@@ -54,17 +51,21 @@ wxEVT\_TASKBAR\_RIGHT\_UP event.}
 wxEVT\_TASKBAR\_LEFT\_DCLICK event.}
 \twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_DCLICK(func)}}{Process a
 wxEVT\_TASKBAR\_RIGHT\_DCLICK event.}
+\twocolitem{{\bf EVT\_TASKBAR\_CLICK(func)}}{This is a synonym for either
+EVT\_TASKBAR\_RIGHT\_DOWN or UP depending on the platform, use this event macro
+to catch the event which should result in the menu being displayed on the
+current platform.}
 \end{twocollist}%
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxTaskBarIcon::wxTaskBarIcon}\label{wxtaskbariconconstr}
+\membersection{wxTaskBarIcon::wxTaskBarIcon}\label{wxtaskbariconctor}
 
 \func{}{wxTaskBarIcon}{\void}
 
 Default constructor.
 
-\membersection{wxTaskBarIcon::\destruct{wxTaskBarIcon}}
+\membersection{wxTaskBarIcon::\destruct{wxTaskBarIcon}}\label{wxtaskbaricondtor}
 
 \func{}{\destruct{wxTaskBarIcon}}{\void}
 
@@ -78,7 +79,7 @@ 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 CreatePopupIcon returns NULL (this happens by default),
+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.
@@ -105,7 +106,7 @@ a class derived from wxTaskBarIcon.
 \wxheading{Note}
 
 It is recommended to override
-\helpref{CreatePopupIcon}{wxtaskbariconcreatepopupmenu}
+\helpref{CreatePopupMenu}{wxtaskbariconcreatepopupmenu}
 callback instead of calling this method from event handler, because some
 ports (e.g. wxCocoa) may not implement PopupMenu and mouse click events at all.