docs/latex/wx/taskbar.tex

   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
   8 \helpref{wxEvtHandler}{wxevthandler}\\
   9 \helpref{wxObject}{wxobject}
  10
  11 \wxheading{Include files}
  12
  13 <wx/taskbar.h>
  14
  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
  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
  56 Returns true if \helpref{SetIcon}{wxtaskbariconseticon} was called with no subsequent \helpref{RemoveIcon}{wxtaskbariconremoveicon}.
  57
  58 \membersection{wxTaskBarIcon::IsOk}\label{wxtaskbariconisok}
  59
  60 \func{bool}{IsOk}{\void}
  61
  62 Returns true if the object initialized successfully.
  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