added wxWindow::AlwaysShowScrollbars() and its wxMac implementation

[wxWidgets.git] / docs / latex / wx / upduievt.tex

diff --git a/docs/latex/wx/upduievt.tex b/docs/latex/wx/upduievt.tex
index d6aabd751a426e4e3be70821dfe7f7e995244715..79c9305f20a5468b0bdeb216a2ff21893df06362 100644 (file)
--- 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.
 
 <wx/event.h>
 
 
 <wx/event.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Event table macros}
 
 To process an update event, use these event handler macros to direct input to member
 \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,
 \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.
 
 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
 \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
 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


@@ -81,43 +85,6 @@ to be shown, and not in idle time.
 
 Constructor.
 
 
 Constructor.
 

-\membersection{wxUpdateUIEvent::m\_checked}\label{wxupdateuieventmchecked}
-
-\member{bool}{m\_checked}
-
-true if the element should be checked, false otherwise.
-
-\membersection{wxUpdateUIEvent::m\_enabled}\label{wxupdateuieventmenabled}
-
-\member{bool}{m\_checked}
-
-true if the element should be enabled, false otherwise.
-
-\membersection{wxUpdateUIEvent::m\_setChecked}\label{wxupdateuieventmsetchecked}
-
-\member{bool}{m\_setChecked}
-
-true if the application has set the {\bf m\_checked} member.
-
-\membersection{wxUpdateUIEvent::m\_setEnabled}\label{wxupdateuieventmsetenabled}
-
-\member{bool}{m\_setEnabled}
-
-true if the application has set the {\bf m\_enabled} member.
-
-\membersection{wxUpdateUIEvent::m\_setText}\label{wxupdateuieventmsettext}
-
-\member{bool}{m\_setText}
-
-true if the application has set the {\bf m\_text} member.
-
-\membersection{wxUpdateUIEvent::m\_text}\label{wxupdateuieventmtext}
-
-\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}}
 \membersection{wxUpdateUIEvent::CanUpdate}\label{wxupdateuieventcanupdate}
 
 \func{static bool}{CanUpdate}{\param{wxWindow*}{ window}}


@@ -126,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}),
 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
 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


@@ -153,6 +120,12 @@ Check or uncheck the UI element.
 
 Enable or disable 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}
 \membersection{wxUpdateUIEvent::GetChecked}\label{wxupdateuieventgetchecked}
 
 \constfunc{bool}{GetChecked}{\void}


@@ -165,23 +138,35 @@ Returns true if the UI element should be checked.
 
 Returns true if the UI element should be enabled.
 
 
 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}
 
 \membersection{wxUpdateUIEvent::GetSetChecked}\label{wxupdateuieventgetsetchecked}
 
 \constfunc{bool}{GetSetChecked}{\void}
 

-Returns true if the application has called {\bf SetChecked}. For wxWidgets 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}
 
 
 \membersection{wxUpdateUIEvent::GetSetEnabled}\label{wxupdateuieventgetsetenabled}
 
 \constfunc{bool}{GetSetEnabled}{\void}
 

-Returns true if the application has called {\bf SetEnabled}. For wxWidgets 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}
 
 
 \membersection{wxUpdateUIEvent::GetSetText}\label{wxupdateuieventgetsettext}
 
 \constfunc{bool}{GetSetText}{\void}
 

-Returns true if the application has called {\bf SetText}. For wxWidgets internal use only.
+Returns true if the application has called \helpref{wxUpdateUIEvent::SetText}{wxupdateuieventsettext}. For wxWidgets internal use only.

 
 \membersection{wxUpdateUIEvent::GetText}\label{wxupdateuieventgettext}
 
 
 \membersection{wxUpdateUIEvent::GetText}\label{wxupdateuieventgettext}
 


@@ -225,7 +210,7 @@ idle processing.
 
 \membersection{wxUpdateUIEvent::SetMode}\label{wxupdateuieventsetmode}
 
 
 \membersection{wxUpdateUIEvent::SetMode}\label{wxupdateuieventsetmode}
 

-\func{static void}{SetMode}{\param{wxIdleMode }{mode}}
+\func{static void}{SetMode}{\param{wxUpdateUIMode }{mode}}

 
 Specify how wxWidgets will send update events: to
 all windows, or only to those which specify that they
 
 Specify how wxWidgets will send update events: to
 all windows, or only to those which specify that they