18aeafcbc0
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@24161 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
86 lines
2.7 KiB
TeX
86 lines
2.7 KiB
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.
|
|
|
|
|