X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e39af974ef7846e26686ae39d74e4696c1fef0c3..5c35d5c1d984f46d33e8181c907936e96160d795:/docs/latex/wx/upduievt.tex diff --git a/docs/latex/wx/upduievt.tex b/docs/latex/wx/upduievt.tex index 8cb08b8aa5..aea947ee53 100644 --- a/docs/latex/wx/upduievt.tex +++ b/docs/latex/wx/upduievt.tex @@ -1,6 +1,6 @@ \section{\class{wxUpdateUIEvent}}\label{wxupdateuievent} -This class is used for pseudo-events which are called by wxWindows +This class is used for pseudo-events which are called by wxWidgets to give an application the chance to update various user interface elements. \wxheading{Derived from} @@ -22,24 +22,24 @@ functions that take a wxUpdateUIEvent argument. \begin{twocollist}\itemsep=0pt \twocolitem{{\bf EVT\_UPDATE\_UI(id, func)}}{Process a wxEVT\_UPDATE\_UI event for the command with the given id.} \twocolitem{{\bf EVT\_UPDATE\_UI\_RANGE(id1, id2, func)}}{Process a wxEVT\_UPDATE\_UI event for any command with id included in the given range.} -\end{twocollist}% +\end{twocollist} \wxheading{Remarks} Without update UI events, an application has to work hard to check/uncheck, enable/disable, -and set the text for elements such as menu items and toolbar buttons. +show/hide, and set the text for elements such as menu items and toolbar buttons. The code for doing this has to be mixed up with the code that is invoked when an action is invoked for a menu item or button. With update UI events, you define an event handler to look at the state of -the application and change UI elements accordingly. wxWindows will call your +the application and change UI elements accordingly. wxWidgets will call your member functions in idle time, so you don't have to worry where to call this code. In addition to being a clearer and more declarative method, it also means you don't have to worry whether you're updating a toolbar or menubar identifier. The same handler can update a menu item and toolbar button, if the identifier is the same. Instead of directly manipulating the menu or button, you call functions in the event -object, such as \helpref{wxUpdateUIEvent::Check}{wxupdateuieventcheck}. wxWindows +object, such as \helpref{wxUpdateUIEvent::Check}{wxupdateuieventcheck}. wxWidgets will determine whether such a call has been made, and which UI element to update. These events will work for popup menus as well as menubars. Just before a menu is popped @@ -65,7 +65,7 @@ Note that although events are sent in idle time, defining a wxIdleEvent handler for a window does not affect this because the events are sent from \helpref{wxWindow::OnInternalIdle}{wxwindowoninternalidle} which is {\bf always} called in idle time. -wxWindows tries to optimize update events on some platforms. On Windows +wxWidgets tries to optimize update events on some platforms. On Windows and GTK+, events for menubar items are only sent when the menu is about to be shown, and not in idle time. @@ -75,49 +75,12 @@ to be shown, and not in idle time. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxUpdateUIEvent::wxUpdateUIEvent} +\membersection{wxUpdateUIEvent::wxUpdateUIEvent}\label{wxupdateuieventctor} \func{}{wxUpdateUIEvent}{\param{wxWindowID }{commandId = 0}} Constructor. -\membersection{wxUpdateUIEvent::m\_checked} - -\member{bool}{m\_checked} - -true if the element should be checked, false otherwise. - -\membersection{wxUpdateUIEvent::m\_enabled} - -\member{bool}{m\_checked} - -true if the element should be enabled, false otherwise. - -\membersection{wxUpdateUIEvent::m\_setChecked} - -\member{bool}{m\_setChecked} - -true if the application has set the {\bf m\_checked} member. - -\membersection{wxUpdateUIEvent::m\_setEnabled} - -\member{bool}{m\_setEnabled} - -true if the application has set the {\bf m\_enabled} member. - -\membersection{wxUpdateUIEvent::m\_setText} - -\member{bool}{m\_setText} - -true if the application has set the {\bf m\_text} member. - -\membersection{wxUpdateUIEvent::m\_text} - -\member{wxString}{m\_text} - -Holds the text with which the the application wishes to -update the UI element. - \membersection{wxUpdateUIEvent::CanUpdate}\label{wxupdateuieventcanupdate} \func{static bool}{CanUpdate}{\param{wxWindow*}{ window}} @@ -153,6 +116,12 @@ Check or uncheck the UI element. Enable or disable the UI element. +\membersection{wxUpdateUIEvent::Show}\label{wxupdateuieventshow} + +\func{void}{Show}{\param{bool}{ show}} + +Show or hide the UI element. + \membersection{wxUpdateUIEvent::GetChecked}\label{wxupdateuieventgetchecked} \constfunc{bool}{GetChecked}{\void} @@ -165,23 +134,35 @@ Returns true if the UI element should be checked. Returns true if the UI element should be enabled. +\membersection{wxUpdateUIEvent::GetShown}\label{wxupdateuieventgetshown} + +\constfunc{bool}{GetShown}{\void} + +Returns true if the UI element should be shown. + \membersection{wxUpdateUIEvent::GetSetChecked}\label{wxupdateuieventgetsetchecked} \constfunc{bool}{GetSetChecked}{\void} -Returns true if the application has called {\bf SetChecked}. For wxWindows internal use only. +Returns true if the application has called \helpref{wxUpdateUIEvent::Check}{wxupdateuieventcheck}. For wxWidgets internal use only. \membersection{wxUpdateUIEvent::GetSetEnabled}\label{wxupdateuieventgetsetenabled} \constfunc{bool}{GetSetEnabled}{\void} -Returns true if the application has called {\bf SetEnabled}. For wxWindows internal use only. +Returns true if the application has called \helpref{wxUpdateUIEvent::Enable}{wxupdateuieventenable}. For wxWidgets internal use only. + +\membersection{wxUpdateUIEvent::GetSetShown}\label{wxupdateuieventgetsetshown} + +\constfunc{bool}{GetSetShown}{\void} + +Returns true if the application has called \helpref{wxUpdateUIEvent::Show}{wxupdateuieventshow}. For wxWidgets internal use only. \membersection{wxUpdateUIEvent::GetSetText}\label{wxupdateuieventgetsettext} \constfunc{bool}{GetSetText}{\void} -Returns true if the application has called {\bf SetText}. For wxWindows internal use only. +Returns true if the application has called \helpref{wxUpdateUIEvent::SetText}{wxupdateuieventsettext}. For wxWidgets internal use only. \membersection{wxUpdateUIEvent::GetText}\label{wxupdateuieventgettext} @@ -193,7 +174,7 @@ Returns the text that should be set for the UI element. \func{static wxUpdateUIMode}{GetMode}{\void} -Static function returning a value specifying how wxWindows +Static function returning a value specifying how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events. @@ -225,9 +206,9 @@ idle processing. \membersection{wxUpdateUIEvent::SetMode}\label{wxupdateuieventsetmode} -\func{static void}{SetMode}{\param{wxIdleMode }{mode}} +\func{static void}{SetMode}{\param{wxUpdateUIMode }{mode}} -Specify how wxWindows will send update events: to +Specify how wxWidgets will send update events: to all windows, or only to those which specify that they will process the events.