X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..a5ae8241de5d07fc10d8fa6ba9c0faa1457521b8:/docs/latex/wx/upduievt.tex diff --git a/docs/latex/wx/upduievt.tex b/docs/latex/wx/upduievt.tex index 2423083c1d..a82b4af74c 100644 --- a/docs/latex/wx/upduievt.tex +++ b/docs/latex/wx/upduievt.tex @@ -5,17 +5,23 @@ to give an application the chance to update various user interface elements. \wxheading{Derived from} +\helpref{wxCommandEvent}{wxcommandevent}\\ \helpref{wxEvent}{wxevent}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Event table macros} -To process a menu event, use these event handler macros to direct input to member +To process an update event, use these event handler macros to direct input to member functions that take a wxUpdateUIEvent argument. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf EVT\_UPDATE\_UI(id, func)}}{Process a wxEVT\_UPDATE\_UI event.} +\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}% \wxheading{Remarks} @@ -36,6 +42,10 @@ Instead of directly manipulating the menu or button, you call functions in the e object, such as \helpref{wxUpdateUIEvent::Check}{wxupdateuieventcheck}. wxWindows 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 +up, \helpref{wxMenu::UpdateUI}{wxmenuupdateui} is called to process any UI events for +the window that owns the menu. + \wxheading{See also} \helpref{Event handling overview}{eventhandlingoverview} @@ -52,31 +62,31 @@ Constructor. \member{bool}{m\_checked} -TRUE if the element should be checked, FALSE otherwise. +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. +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. +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. +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. +true if the application has set the {\bf m\_text} member. \membersection{wxUpdateUIEvent::m\_text} @@ -101,31 +111,31 @@ Enable or disable the UI element. \constfunc{bool}{GetChecked}{\void} -Returns TRUE if the UI element should be checked. +Returns true if the UI element should be checked. \membersection{wxUpdateUIEvent::GetEnabled}\label{wxupdateuieventgetenabled} \constfunc{bool}{GetEnabled}{\void} -Returns TRUE if the UI element should be enabled. +Returns true if the UI element should be enabled. \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 {\bf SetChecked}. For wxWindows 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 {\bf SetEnabled}. For wxWindows 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 {\bf SetText}. For wxWindows internal use only. \membersection{wxUpdateUIEvent::GetText}\label{wxupdateuieventgettext}