add events API to wxHtmlWindow (patch #1504493 by Francesco Montorsi)

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

diff --git a/docs/latex/wx/upduievt.tex b/docs/latex/wx/upduievt.tex
index 2f9c9d0a442bbef9b08bf6ee9432570112b2e48c..aea947ee533244f943cb7e2b5152e3f597150dcb 100644 (file)
--- a/docs/latex/wx/upduievt.tex
+++ b/docs/latex/wx/upduievt.tex
@@ -27,7 +27,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.
 


@@ -75,49 +75,12 @@ to be shown, and not in idle time.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxUpdateUIEvent::wxUpdateUIEvent}
+\membersection{wxUpdateUIEvent::wxUpdateUIEvent}\label{wxupdateuieventctor}

 
 \func{}{wxUpdateUIEvent}{\param{wxWindowID }{commandId = 0}}
 
 Constructor.
 
 
 \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}}
 \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.
 
 
 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 +134,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 +206,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