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

\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 for Windows 95/NT and for
X Window System ports (wxGTK, wxMotif, wxX11), assuming the window manager supports KDE and GNOME 1.2
systray methods.

\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::PopupMenu}\label{wxtaskbariconpopupmenu}

\func{bool}{PopupMenu}{\param{wxMenu*}{ menu}}

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}

\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}
a660d684 KB	2
18aeafcb VS	3	This class represents a 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 and for
	5	X Window System ports (wxGTK, wxMotif, wxX11), assuming the window manager supports KDE and GNOME 1.2
	6	systray methods.
a660d684 KB	7
	8	\wxheading{Derived from}
	9
ea64fd02	10	\helpref{wxEvtHandler}{wxevthandler}\\
a660d684 KB	11	\helpref{wxObject}{wxobject}
a660d684 KB	12
954b8ae6 JS	13	\wxheading{Include files}
	14
	15	<wx/taskbar.h>
	16
ea64fd02 MB	17	\wxheading{Event handling}
	18
	19	To process input from a taskbar icon, use the following event handler macros to direct input to member
	20	functions that take a wxTaskBarIconEvent argument.
	21
	22	\twocolwidtha{7cm}
	23	\begin{twocollist}\itemsep=0pt
	24	\twocolitem{{\bf EVT\_TASKBAR\_MOVE(func)}}{Process a
	25	wxEVT\_TASKBAR\_MOVE event.}
	26	\twocolitem{{\bf EVT\_TASKBAR\_LEFT\_DOWN(func)}}{Process a
	27	wxEVT\_TASKBAR\_LEFT\_DOWN event.}
	28	\twocolitem{{\bf EVT\_TASKBAR\_LEFT\_UP(func)}}{Process a
	29	wxEVT\_TASKBAR\_LEFT\_UP event.}
	30	\twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_DOWN(func)}}{Process a
	31	wxEVT\_TASKBAR\_RIGHT\_DOWN event.}
	32	\twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_UP(func)}}{Process a
	33	wxEVT\_TASKBAR\_RIGHT\_UP event.}
	34	\twocolitem{{\bf EVT\_TASKBAR\_LEFT\_DCLICK(func)}}{Process a
	35	wxEVT\_TASKBAR\_LEFT\_DCLICK event.}
	36	\twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_DCLICK(func)}}{Process a
	37	wxEVT\_TASKBAR\_RIGHT\_DCLICK event.}
	38	\end{twocollist}%
	39
a660d684 KB	40	\latexignore{\rtfignore{\wxheading{Members}}}
	41
	42	\membersection{wxTaskBarIcon::wxTaskBarIcon}\label{wxtaskbariconconstr}
	43
	44	\func{}{wxTaskBarIcon}{\void}
	45
	46	Default constructor.
	47
	48	\membersection{wxTaskBarIcon::\destruct{wxTaskBarIcon}}
	49
	50	\func{}{\destruct{wxTaskBarIcon}}{\void}
	51
	52	Destroys the wxTaskBarIcon object, removing the icon if not already removed.
	53
	54	\membersection{wxTaskBarIcon::IsIconInstalled}\label{wxtaskbariconisiconinstalled}
	55
	56	\func{bool}{IsIconInstalled}{\void}
	57
cc81d32f	58	Returns true if \helpref{SetIcon}{wxtaskbariconseticon} was called with no subsequent \helpref{RemoveIcon}{wxtaskbariconremoveicon}.
a660d684	59
6af507f7	60	\membersection{wxTaskBarIcon::IsOk}\label{wxtaskbariconisok}
a660d684	61
6af507f7	62	\func{bool}{IsOk}{\void}
a660d684	63
cc81d32f	64	Returns true if the object initialized successfully.
a660d684	65
feb68562 JS	66	\membersection{wxTaskBarIcon::PopupMenu}\label{wxtaskbariconpopupmenu}
	67
	68	\func{bool}{PopupMenu}{\param{wxMenu*}{ menu}}
	69
	70	Pops up a menu at the current mouse position. The events can be handled by
	71	a class derived from wxTaskBarIcon.
	72
a660d684 KB	73	\membersection{wxTaskBarIcon::RemoveIcon}\label{wxtaskbariconremoveicon}
	74
	75	\func{bool}{RemoveIcon}{\void}
	76
	77	Removes the icon previously set with \helpref{SetIcon}{wxtaskbariconseticon}.
	78
	79	\membersection{wxTaskBarIcon::SetIcon}\label{wxtaskbariconseticon}
	80
	81	\func{bool}{SetIcon}{\param{const wxIcon\&}{ icon}, \param{const wxString\& }{tooltip}}
	82
	83	Sets the icon, and optional tooltip text.
	84
	85