projects / wxWidgets.git / blame
| 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 | ||
| 8 | \helpref{wxObject}{wxobject} | |
| 9 | ||
| 954b8ae6 JS |
10 | \wxheading{Include files} |
| 11 | ||
| 12 | <wx/taskbar.h> | |
| 13 | ||
| a660d684 KB |
14 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 15 | ||
| 16 | \membersection{wxTaskBarIcon::wxTaskBarIcon}\label{wxtaskbariconconstr} | |
| 17 | ||
| 18 | \func{}{wxTaskBarIcon}{\void} | |
| 19 | ||
| 20 | Default constructor. | |
| 21 | ||
| 22 | \membersection{wxTaskBarIcon::\destruct{wxTaskBarIcon}} | |
| 23 | ||
| 24 | \func{}{\destruct{wxTaskBarIcon}}{\void} | |
| 25 | ||
| 26 | Destroys the wxTaskBarIcon object, removing the icon if not already removed. | |
| 27 | ||
| 28 | \membersection{wxTaskBarIcon::IsIconInstalled}\label{wxtaskbariconisiconinstalled} | |
| 29 | ||
| 30 | \func{bool}{IsIconInstalled}{\void} | |
| 31 | ||
| 32 | Returns TRUE if \helpref{SetIcon}{wxtaskbariconseticon} was called with no subsequent \helpref{RemoveIcon}{wxtaskbariconremoveicon}. | |
| 33 | ||
| 34 | \membersection{wxTaskBarIcon::IsOK}\label{wxtaskbariconisok} | |
| 35 | ||
| 36 | \func{bool}{IsOK}{\void} | |
| 37 | ||
| 38 | Returns TRUE if the object initialized successfully. | |
| 39 | ||
| 40 | \membersection{wxTaskBarIcon::OnLButtonDown}\label{wxtaskbaricononlbuttondown} | |
| 41 | ||
| 42 | \func{virtual void}{OnLButtonDown}{\void} | |
| 43 | ||
| 44 | Override this function to intercept left mouse button down events. | |
| 45 | ||
| 46 | \membersection{wxTaskBarIcon::OnLButtonDClick}\label{wxtaskbaricononlbuttondclick} | |
| 47 | ||
| 48 | \func{virtual void}{OnLButtonDClick}{\void} | |
| 49 | ||
| 50 | Override this function to intercept left mouse button double-click events. | |
| 51 | ||
| 52 | \membersection{wxTaskBarIcon::OnLButtonUp}\label{wxtaskbaricononlbuttonup} | |
| 53 | ||
| 54 | \func{virtual void}{OnLButtonUp}{\void} | |
| 55 | ||
| 56 | Override this function to intercept left mouse button up events. | |
| 57 | ||
| 58 | \membersection{wxTaskBarIcon::OnRButtonDown}\label{wxtaskbaricononrbuttondown} | |
| 59 | ||
| 60 | \func{virtual void}{OnRButtonDown}{\void} | |
| 61 | ||
| 62 | Override this function to intercept right mouse button down events. | |
| 63 | ||
| 64 | \membersection{wxTaskBarIcon::OnRButtonDClick}\label{wxtaskbaricononrbuttondclick} | |
| 65 | ||
| 66 | \func{virtual void}{OnRButtonDClick}{\void} | |
| 67 | ||
| 68 | Override this function to intercept right mouse button double-click events. | |
| 69 | ||
| 70 | \membersection{wxTaskBarIcon::OnRButtonUp}\label{wxtaskbaricononrbuttonup} | |
| 71 | ||
| 72 | \func{virtual void}{OnRButtonUp}{\void} | |
| 73 | ||
| 74 | Override this function to intercept right mouse button up events. | |
| 75 | ||
| 76 | \membersection{wxTaskBarIcon::OnMouseMove}\label{wxtaskbaricononmousemove} | |
| 77 | ||
| 78 | \func{virtual void}{OnMouseMove}{\void} | |
| 79 | ||
| 80 | Override this function to intercept mouse move events. | |
| 81 | ||
| 82 | \membersection{wxTaskBarIcon::RemoveIcon}\label{wxtaskbariconremoveicon} | |
| 83 | ||
| 84 | \func{bool}{RemoveIcon}{\void} | |
| 85 | ||
| 86 | Removes the icon previously set with \helpref{SetIcon}{wxtaskbariconseticon}. | |
| 87 | ||
| 88 | \membersection{wxTaskBarIcon::SetIcon}\label{wxtaskbariconseticon} | |
| 89 | ||
| 90 | \func{bool}{SetIcon}{\param{const wxIcon\&}{ icon}, \param{const wxString\& }{tooltip}} | |
| 91 | ||
| 92 | Sets the icon, and optional tooltip text. | |
| 93 | ||
| 94 |