1 \section{\class{wxTaskBarIcon
}}\label{wxtaskbaricon
}
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.
6 \wxheading{Derived from
}
8 \helpref{wxEvtHandler
}{wxevthandler
}\\
9 \helpref{wxObject
}{wxobject
}
11 \wxheading{Include files
}
15 \wxheading{Event handling
}
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.
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.
}
38 \latexignore{\rtfignore{\wxheading{Members
}}}
40 \membersection{wxTaskBarIcon::wxTaskBarIcon
}\label{wxtaskbariconconstr
}
42 \func{}{wxTaskBarIcon
}{\void}
46 \membersection{wxTaskBarIcon::
\destruct{wxTaskBarIcon
}}
48 \func{}{\destruct{wxTaskBarIcon
}}{\void}
50 Destroys the wxTaskBarIcon object, removing the icon if not already removed.
52 \membersection{wxTaskBarIcon::IsIconInstalled
}\label{wxtaskbariconisiconinstalled
}
54 \func{bool
}{IsIconInstalled
}{\void}
56 Returns true if
\helpref{SetIcon
}{wxtaskbariconseticon
} was called with no subsequent
\helpref{RemoveIcon
}{wxtaskbariconremoveicon
}.
58 \membersection{wxTaskBarIcon::IsOk
}\label{wxtaskbariconisok
}
60 \func{bool
}{IsOk
}{\void}
62 Returns true if the object initialized successfully.
64 \membersection{wxTaskBarIcon::OnLButtonDown
}\label{wxtaskbaricononlbuttondown
}
66 \func{virtual void
}{OnLButtonDown
}{\void}
68 Override this function to intercept left mouse button down events.
70 \membersection{wxTaskBarIcon::OnLButtonDClick
}\label{wxtaskbaricononlbuttondclick
}
72 \func{virtual void
}{OnLButtonDClick
}{\void}
74 Override this function to intercept left mouse button double-click events.
76 \membersection{wxTaskBarIcon::OnLButtonUp
}\label{wxtaskbaricononlbuttonup
}
78 \func{virtual void
}{OnLButtonUp
}{\void}
80 Override this function to intercept left mouse button up events.
82 \membersection{wxTaskBarIcon::OnRButtonDown
}\label{wxtaskbaricononrbuttondown
}
84 \func{virtual void
}{OnRButtonDown
}{\void}
86 Override this function to intercept right mouse button down events.
88 \membersection{wxTaskBarIcon::OnRButtonDClick
}\label{wxtaskbaricononrbuttondclick
}
90 \func{virtual void
}{OnRButtonDClick
}{\void}
92 Override this function to intercept right mouse button double-click events.
94 \membersection{wxTaskBarIcon::OnRButtonUp
}\label{wxtaskbaricononrbuttonup
}
96 \func{virtual void
}{OnRButtonUp
}{\void}
98 Override this function to intercept right mouse button up events.
100 \membersection{wxTaskBarIcon::OnMouseMove
}\label{wxtaskbaricononmousemove
}
102 \func{virtual void
}{OnMouseMove
}{\void}
104 Override this function to intercept mouse move events.
106 \membersection{wxTaskBarIcon::RemoveIcon
}\label{wxtaskbariconremoveicon
}
108 \func{bool
}{RemoveIcon
}{\void}
110 Removes the icon previously set with
\helpref{SetIcon
}{wxtaskbariconseticon
}.
112 \membersection{wxTaskBarIcon::SetIcon
}\label{wxtaskbariconseticon
}
114 \func{bool
}{SetIcon
}{\param{const wxIcon\&
}{ icon
},
\param{const wxString\&
}{tooltip
}}
116 Sets the icon, and optional tooltip text.