X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/239ef314528b253ea4ca5946ec2cfcb74bab1866..d86c187031547bd2f0604adddef273deedea7907:/docs/latex/wx/taskbar.tex diff --git a/docs/latex/wx/taskbar.tex b/docs/latex/wx/taskbar.tex index ddfd3c7a4f..073247e548 100644 --- a/docs/latex/wx/taskbar.tex +++ b/docs/latex/wx/taskbar.tex @@ -27,6 +27,10 @@ be on by default. +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \wxheading{Event handling} To process input from a taskbar icon, use the following event handler macros to direct input to member @@ -51,22 +55,29 @@ wxEVT\_TASKBAR\_RIGHT\_UP event.} wxEVT\_TASKBAR\_LEFT\_DCLICK event.} \twocolitem{{\bf EVT\_TASKBAR\_RIGHT\_DCLICK(func)}}{Process a wxEVT\_TASKBAR\_RIGHT\_DCLICK event.} +\twocolitem{{\bf EVT\_TASKBAR\_CLICK(func)}}{This is a synonym for either +EVT\_TASKBAR\_RIGHT\_DOWN or UP depending on the platform, use this event macro +to catch the event which should result in the menu being displayed on the +current platform.} \end{twocollist}% \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxTaskBarIcon::wxTaskBarIcon}\label{wxtaskbariconctor} \func{}{wxTaskBarIcon}{\void} Default constructor. + \membersection{wxTaskBarIcon::\destruct{wxTaskBarIcon}}\label{wxtaskbaricondtor} \func{}{\destruct{wxTaskBarIcon}}{\void} Destroys the wxTaskBarIcon object, removing the icon if not already removed. + \membersection{wxTaskBarIcon::CreatePopupMenu}\label{wxtaskbariconcreatepopupmenu} \func{virtual wxMenu*}{CreatePopupMenu}{\void} @@ -80,18 +91,31 @@ no menu is shown, otherwise the menu is displayed and then deleted by the library as soon as the user dismisses it. The events can be handled by a class derived from wxTaskBarIcon. + +\membersection{wxTaskBarIcon::Destroy}\label{wxtaskbaricondestroy} + +\func{void}{Destroy}{\void} + +This method is similar to \helpref{wxWindow::Destroy}{wxwindowdestroy} and can +be used to schedule the task bar icon object for the delayed destruction: it +will be deleted during the next event loop iteration, which allows the task bar +icon to process any pending events for it before being destroyed. + + \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}} @@ -106,12 +130,14 @@ It is recommended to override callback instead of calling this method from event handler, because some ports (e.g. wxCocoa) may not implement PopupMenu and mouse click events at all. + \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}}