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

\section{\class{wxTaskBarIcon}}\label{wxtaskbaricon}

This class represents a Windows 95 taskbar icon, appearing in the `system tray' and responding to
mouse clicks. An icon has an optional tooltip. This class is only supported for Windows 95/NT.

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

\func{}{wxTaskBarIcon}{\void}

Default constructor.

\membersection{wxTaskBarIcon::\destruct{wxTaskBarIcon}}

\func{}{\destruct{wxTaskBarIcon}}{\void}

Destroys the wxTaskBarIcon object, removing the icon if not already removed.

\membersection{wxTaskBarIcon::IsIconInstalled}\label{wxtaskbariconisiconinstalled}

\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.

\membersection{wxTaskBarIcon::OnRButtonUp}\label{wxtaskbaricononrbuttonup}

\func{virtual void}{OnRButtonUp}{\void}

Override this function to intercept right mouse button up events.

\membersection{wxTaskBarIcon::OnMouseMove}\label{wxtaskbaricononmousemove}

\func{virtual void}{OnMouseMove}{\void}

Override this function to intercept mouse move events.

\membersection{wxTaskBarIcon::RemoveIcon}\label{wxtaskbariconremoveicon}

\func{bool}{RemoveIcon}{\void}

Removes the icon previously set with \helpref{SetIcon}{wxtaskbariconseticon}.

\membersection{wxTaskBarIcon::SetIcon}\label{wxtaskbariconseticon}

\func{bool}{SetIcon}{\param{const wxIcon\&}{ icon}, \param{const wxString\& }{tooltip}}

Sets the icon, and optional tooltip text.
Commit	Line	Data
a660d684 KB	1	\section{\class{wxTaskBarIcon}}\label{wxtaskbaricon}
	2
	3	This class represents a Windows 95 taskbar icon, appearing in the `system tray' and responding to
	4	mouse clicks. An icon has an optional tooltip. This class is only supported for Windows 95/NT.
	5
	6	\wxheading{Derived from}
	7
ea64fd02	8	\helpref{wxEvtHandler}{wxevthandler}\\
a660d684 KB	9	\helpref{wxObject}{wxobject}
a660d684 KB	10
954b8ae6 JS	11	\wxheading{Include files}
	12
	13	<wx/taskbar.h>
	14
ea64fd02 MB	15	\wxheading{Event handling}
	16
	17	To process input from a taskbar icon, use the following event handler macros to direct input to member
	18	functions that take a wxTaskBarIconEvent argument.
	19
	20	\twocolwidtha{7cm}
	21	\begin{twocollist}\itemsep=0pt
	22	\twocolitem{{\bf EVT\_TASKBAR\_MOVE(func)}}{Process a
	23	wxEVT\_TASKBAR\_MOVE event.}
	24	\twocolitem{{\bf EVT\_TASKBAR\_LEFT\_DOWN(func)}}{Process a
	25	wxEVT\_TASKBAR\_LEFT\_DOWN event.}
	26	\twocolitem{{\bf EVT\_TASKBAR\_LEFT\_UP(func)}}{Process a
	27	wxEVT\_TASKBAR\_LEFT\_UP event.}
	28	\twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_DOWN(func)}}{Process a
	29	wxEVT\_TASKBAR\_RIGHT\_DOWN event.}
	30	\twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_UP(func)}}{Process a
	31	wxEVT\_TASKBAR\_RIGHT\_UP event.}
	32	\twocolitem{{\bf EVT\_TASKBAR\_LEFT\_DCLICK(func)}}{Process a
	33	wxEVT\_TASKBAR\_LEFT\_DCLICK event.}
	34	\twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_DCLICK(func)}}{Process a
	35	wxEVT\_TASKBAR\_RIGHT\_DCLICK event.}
	36	\end{twocollist}%
	37
a660d684 KB	38	\latexignore{\rtfignore{\wxheading{Members}}}
	39
	40	\membersection{wxTaskBarIcon::wxTaskBarIcon}\label{wxtaskbariconconstr}
	41
	42	\func{}{wxTaskBarIcon}{\void}
	43
	44	Default constructor.
	45
	46	\membersection{wxTaskBarIcon::\destruct{wxTaskBarIcon}}
	47
	48	\func{}{\destruct{wxTaskBarIcon}}{\void}
	49
	50	Destroys the wxTaskBarIcon object, removing the icon if not already removed.
	51
	52	\membersection{wxTaskBarIcon::IsIconInstalled}\label{wxtaskbariconisiconinstalled}
	53
	54	\func{bool}{IsIconInstalled}{\void}
	55
cc81d32f	56	Returns true if \helpref{SetIcon}{wxtaskbariconseticon} was called with no subsequent \helpref{RemoveIcon}{wxtaskbariconremoveicon}.
a660d684 KB	57
	58	\membersection{wxTaskBarIcon::IsOK}\label{wxtaskbariconisok}
	59
	60	\func{bool}{IsOK}{\void}
	61
cc81d32f	62	Returns true if the object initialized successfully.
a660d684 KB	63
	64	\membersection{wxTaskBarIcon::OnLButtonDown}\label{wxtaskbaricononlbuttondown}
	65
	66	\func{virtual void}{OnLButtonDown}{\void}
	67
	68	Override this function to intercept left mouse button down events.
	69
	70	\membersection{wxTaskBarIcon::OnLButtonDClick}\label{wxtaskbaricononlbuttondclick}
	71
	72	\func{virtual void}{OnLButtonDClick}{\void}
	73
	74	Override this function to intercept left mouse button double-click events.
	75
	76	\membersection{wxTaskBarIcon::OnLButtonUp}\label{wxtaskbaricononlbuttonup}
	77
	78	\func{virtual void}{OnLButtonUp}{\void}
	79
	80	Override this function to intercept left mouse button up events.
	81
	82	\membersection{wxTaskBarIcon::OnRButtonDown}\label{wxtaskbaricononrbuttondown}
	83
	84	\func{virtual void}{OnRButtonDown}{\void}
	85
	86	Override this function to intercept right mouse button down events.
	87
	88	\membersection{wxTaskBarIcon::OnRButtonDClick}\label{wxtaskbaricononrbuttondclick}
	89
	90	\func{virtual void}{OnRButtonDClick}{\void}
	91
	92	Override this function to intercept right mouse button double-click events.
	93
	94	\membersection{wxTaskBarIcon::OnRButtonUp}\label{wxtaskbaricononrbuttonup}
	95
	96	\func{virtual void}{OnRButtonUp}{\void}
	97
	98	Override this function to intercept right mouse button up events.
	99
	100	\membersection{wxTaskBarIcon::OnMouseMove}\label{wxtaskbaricononmousemove}
	101
	102	\func{virtual void}{OnMouseMove}{\void}
	103
	104	Override this function to intercept mouse move events.
	105
	106	\membersection{wxTaskBarIcon::RemoveIcon}\label{wxtaskbariconremoveicon}
	107
	108	\func{bool}{RemoveIcon}{\void}
	109
	110	Removes the icon previously set with \helpref{SetIcon}{wxtaskbariconseticon}.
	111
	112	\membersection{wxTaskBarIcon::SetIcon}\label{wxtaskbariconseticon}
	113
	114	\func{bool}{SetIcon}{\param{const wxIcon\&}{ icon}, \param{const wxString\& }{tooltip}}
	115
	116	Sets the icon, and optional tooltip text.
	117
	118