X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9a75ba66de8f9dd3ebac0f41ec2e27be6d95aa73..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/upduievt.tex?ds=sidebyside diff --git a/docs/latex/wx/upduievt.tex b/docs/latex/wx/upduievt.tex index d4673f24f5..79c9305f20 100644 --- a/docs/latex/wx/upduievt.tex +++ b/docs/latex/wx/upduievt.tex @@ -13,6 +13,10 @@ to give an application the chance to update various user interface elements. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Event table macros} To process an update event, use these event handler macros to direct input to member @@ -27,7 +31,7 @@ functions that take a wxUpdateUIEvent argument. \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. @@ -52,7 +56,7 @@ your application, you can do one or both of the following: \begin{enumerate} \item Call \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmode} with a value of wxUPDATE\_UI\_PROCESS\_SPECIFIED, and set the extra style -wxWS\_EX\_PROCESS\_UPDATE\_EVENTS for every window that should receive update events. +wxWS\_EX\_PROCESS\_UI\_UPDATES for every window that should receive update events. No other windows will receive update events. \item Call \helpref{wxUpdateUIEvent::SetUpdateInterval}{wxupdateuieventsetupdateinterval} with a millisecond value to set the delay between updates. You may need @@ -89,7 +93,7 @@ Returns {\tt true} if it is appropriate to update (send UI update events to) this window. This function looks at the mode used (see \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmode}), -the wxWS\_EX\_PROCESS\_UPDATE\_EVENTS flag in {\it window}, +the wxWS\_EX\_PROCESS\_UI\_UPDATES flag in {\it window}, the time update events were last sent in idle time, and the update interval, to determine whether events should be sent to this window now. By default this will always return {\tt true} because @@ -116,6 +120,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} @@ -128,6 +138,12 @@ 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} @@ -140,6 +156,12 @@ Returns true if the application has called \helpref{wxUpdateUIEvent::Check}{wxup 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}