added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit

[wxWidgets.git] / docs / latex / wx / taskbar.tex

diff --git a/docs/latex/wx/taskbar.tex b/docs/latex/wx/taskbar.tex
index f6a81a428860ea5344bbf856372eb194da2cfee6..73a78a5ff3d3bd8fc1c34b4d3f8e9ff2ea59a279 100644 (file)
--- a/docs/latex/wx/taskbar.tex
+++ b/docs/latex/wx/taskbar.tex
@@ -5,8 +5,36 @@ mouse clicks. An icon has an optional tooltip. This class is only supported for
 
 \wxheading{Derived from}
 
+\helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/taskbar.h>
+
+\wxheading{Event handling}
+
+To process input from a taskbar icon, use the following event handler macros to direct input to member
+functions that take a wxTaskBarIconEvent argument.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_TASKBAR\_MOVE(func)}}{Process a
+wxEVT\_TASKBAR\_MOVE event.}
+\twocolitem{{\bf EVT\_TASKBAR\_LEFT\_DOWN(func)}}{Process a
+wxEVT\_TASKBAR\_LEFT\_DOWN event.}
+\twocolitem{{\bf EVT\_TASKBAR\_LEFT\_UP(func)}}{Process a
+wxEVT\_TASKBAR\_LEFT\_UP event.}
+\twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_DOWN(func)}}{Process a
+wxEVT\_TASKBAR\_RIGHT\_DOWN event.}
+\twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_UP(func)}}{Process a
+wxEVT\_TASKBAR\_RIGHT\_UP event.}
+\twocolitem{{\bf EVT\_TASKBAR\_LEFT\_DCLICK(func)}}{Process a
+wxEVT\_TASKBAR\_LEFT\_DCLICK event.}
+\twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_DCLICK(func)}}{Process a
+wxEVT\_TASKBAR\_RIGHT\_DCLICK event.}
+\end{twocollist}%
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxTaskBarIcon::wxTaskBarIcon}\label{wxtaskbariconconstr}
@@ -25,55 +53,20 @@ Destroys the wxTaskBarIcon object, removing the icon if not already removed.
 
 \func{bool}{IsIconInstalled}{\void}
 
-Returns TRUE if \helpref{SetIcon}{wxtaskbariconseticon} was called with no subsequent \helpref{RemoveIcon}{wxtaskbariconremoveicon}.
-
-\membersection{wxTaskBarIcon::IsOK}\label{wxtaskbariconisok}
-
-\func{bool}{IsOK}{\void}
-
-Returns TRUE if the object initialized successfully.
-
-\membersection{wxTaskBarIcon::OnLButtonDown}\label{wxtaskbaricononlbuttondown}
-
-\func{virtual void}{OnLButtonDown}{\void}
-
-Override this function to intercept left mouse button down events.
-
-\membersection{wxTaskBarIcon::OnLButtonDClick}\label{wxtaskbaricononlbuttondclick}
-
-\func{virtual void}{OnLButtonDClick}{\void}
-
-Override this function to intercept left mouse button double-click events.
-
-\membersection{wxTaskBarIcon::OnLButtonUp}\label{wxtaskbaricononlbuttonup}
-
-\func{virtual void}{OnLButtonUp}{\void}
-
-Override this function to intercept left mouse button up events.
-
-\membersection{wxTaskBarIcon::OnRButtonDown}\label{wxtaskbaricononrbuttondown}
-
-\func{virtual void}{OnRButtonDown}{\void}
-
-Override this function to intercept right mouse button down events.
-
-\membersection{wxTaskBarIcon::OnRButtonDClick}\label{wxtaskbaricononrbuttondclick}
-
-\func{virtual void}{OnRButtonDClick}{\void}
-
-Override this function to intercept right mouse button double-click events.
+Returns true if \helpref{SetIcon}{wxtaskbariconseticon} was called with no subsequent \helpref{RemoveIcon}{wxtaskbariconremoveicon}.
 
-\membersection{wxTaskBarIcon::OnRButtonUp}\label{wxtaskbaricononrbuttonup}
+\membersection{wxTaskBarIcon::IsOk}\label{wxtaskbariconisok}
 
-\func{virtual void}{OnRButtonUp}{\void}
+\func{bool}{IsOk}{\void}
 
-Override this function to intercept right mouse button up events.
+Returns true if the object initialized successfully.
 
-\membersection{wxTaskBarIcon::OnMouseMove}\label{wxtaskbaricononmousemove}
+\membersection{wxTaskBarIcon::PopupMenu}\label{wxtaskbariconpopupmenu}
 
-\func{virtual void}{OnMouseMove}{\void}
+\func{bool}{PopupMenu}{\param{wxMenu*}{ menu}}
 
-Override this function to intercept mouse move events.
+Pops up a menu at the current mouse position. The events can be handled by
+a class derived from wxTaskBarIcon.
 
 \membersection{wxTaskBarIcon::RemoveIcon}\label{wxtaskbariconremoveicon}