]> git.saurik.com Git - wxWidgets.git/blobdiff - contrib/docs/latex/fl/cbupdatesmanagerbase.tex
Added new stream tests to typetest.
[wxWidgets.git] / contrib / docs / latex / fl / cbupdatesmanagerbase.tex
index e52dbf44e7e07bb2cdddad7f8344787b00c23564..51d652f0cb6e82ea6dc537dfe0a885e6c7cc8577 100644 (file)
@@ -1,20 +1,24 @@
 %
 % automatically generated by HelpGen $Revision$ from
 %
 % automatically generated by HelpGen $Revision$ from
-% controlbar.h at 05/Jan/02 22:50:59
+% controlbar.h at 21/Jan/02 21:14:14
 %
 
 
 \section{\class{cbUpdatesManagerBase}}\label{cbupdatesmanagerbase}
 
 
 %
 
 
 \section{\class{cbUpdatesManagerBase}}\label{cbupdatesmanagerbase}
 
 
-class declares abstract interface for optimized logic, which should refresh
-   areas of frame layout - that actually need to be updated. Should be extended,
-   to implement custom updating strategy
+This class declares an abstract interface for optimized logic that should refresh
+areas of frame layout that actually need to be updated. This should be extended in future
+to implement a custom updating strategy.
+
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/fl/controlbar.h>
+
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -24,57 +28,85 @@ class declares abstract interface for optimized logic, which should refresh
 
 \func{}{cbUpdatesManagerBase}{\param{wxFrameLayout* }{pPanel}}
 
 
 \func{}{cbUpdatesManagerBase}{\param{wxFrameLayout* }{pPanel}}
 
+Constructor taking layout panel.
+
 
 \func{}{cbUpdatesManagerBase}{\void}
 
 
 \func{}{cbUpdatesManagerBase}{\void}
 
+Default constructor
+
 
 \membersection{cbUpdatesManagerBase::\destruct{cbUpdatesManagerBase}}\label{cbupdatesmanagerbasedtor}
 
 \func{}{\destruct{cbUpdatesManagerBase}}{\void}
 
 
 \membersection{cbUpdatesManagerBase::\destruct{cbUpdatesManagerBase}}\label{cbupdatesmanagerbasedtor}
 
 \func{}{\destruct{cbUpdatesManagerBase}}{\void}
 
+Destructor.
+
 
 \membersection{cbUpdatesManagerBase::OnBarWillChange}\label{cbupdatesmanagerbaseonbarwillchange}
 
 \func{void}{OnBarWillChange}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pInRow}, \param{cbDockPane* }{pInPane}}
 
 
 \membersection{cbUpdatesManagerBase::OnBarWillChange}\label{cbupdatesmanagerbaseonbarwillchange}
 
 \func{void}{OnBarWillChange}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pInRow}, \param{cbDockPane* }{pInPane}}
 
+This function receives a notification from the frame layout (in the order in which
+they would usually be invoked). Custom updates-managers may utilize
+these notifications to implement a more fine-grained updating strategy.
+
 
 \membersection{cbUpdatesManagerBase::OnFinishChanges}\label{cbupdatesmanagerbaseonfinishchanges}
 
 \func{void}{OnFinishChanges}{\void}
 
 
 \membersection{cbUpdatesManagerBase::OnFinishChanges}\label{cbupdatesmanagerbaseonfinishchanges}
 
 \func{void}{OnFinishChanges}{\void}
 
+This function receives a notification from the frame layout (in the order in which
+they would usually be invoked). Custom updates-managers may utilize
+these notifications to implement a more fine-grained updating strategy.
+
 
 \membersection{cbUpdatesManagerBase::OnPaneMarginsWillChange}\label{cbupdatesmanagerbaseonpanemarginswillchange}
 
 \func{void}{OnPaneMarginsWillChange}{\param{cbDockPane* }{pPane}}
 
 
 \membersection{cbUpdatesManagerBase::OnPaneMarginsWillChange}\label{cbupdatesmanagerbaseonpanemarginswillchange}
 
 \func{void}{OnPaneMarginsWillChange}{\param{cbDockPane* }{pPane}}
 
+This function receives a notification from the frame layout (in the order in which
+they would usually be invoked). Custom updates-managers may utilize
+these notifications to implement a more fine-grained updating strategy.
+
 
 \membersection{cbUpdatesManagerBase::OnPaneWillChange}\label{cbupdatesmanagerbaseonpanewillchange}
 
 \func{void}{OnPaneWillChange}{\param{cbDockPane* }{pPane}}
 
 
 \membersection{cbUpdatesManagerBase::OnPaneWillChange}\label{cbupdatesmanagerbaseonpanewillchange}
 
 \func{void}{OnPaneWillChange}{\param{cbDockPane* }{pPane}}
 
+This function receives a notification from the frame layout (in the order in which
+they would usually be invoked). Custom updates-managers may utilize
+these notifications to implement a more fine-grained updating strategy.
+
 
 \membersection{cbUpdatesManagerBase::OnRowWillChange}\label{cbupdatesmanagerbaseonrowwillchange}
 
 \func{void}{OnRowWillChange}{\param{cbRowInfo* }{pRow}, \param{cbDockPane* }{pInPane}}
 
 
 \membersection{cbUpdatesManagerBase::OnRowWillChange}\label{cbupdatesmanagerbaseonrowwillchange}
 
 \func{void}{OnRowWillChange}{\param{cbRowInfo* }{pRow}, \param{cbDockPane* }{pInPane}}
 
+This function receives a notification from the frame layout (in the order in which
+they would usually be invoked). Custom updates-managers may utilize
+these notifications to implement a more fine-grained updating strategy.
+
 
 \membersection{cbUpdatesManagerBase::OnStartChanges}\label{cbupdatesmanagerbaseonstartchanges}
 
 \func{void}{OnStartChanges}{\void}
 
 
 \membersection{cbUpdatesManagerBase::OnStartChanges}\label{cbupdatesmanagerbaseonstartchanges}
 
 \func{void}{OnStartChanges}{\void}
 
-notificiactions received from frame-layout (in the order, in which
-they usually would be invoked). Custom updates-managers may utilize
-these notifications to implement more "fine-grained" updating strategy
+This function receives a notification from the frame layout (in the order in which
+they would usually be invoked). Custom updates-managers may utilize
+these notifications to implement a more fine-grained updating strategy.
 
 
 \membersection{cbUpdatesManagerBase::SetLayout}\label{cbupdatesmanagerbasesetlayout}
 
 \func{void}{SetLayout}{\param{wxFrameLayout* }{pLayout}}
 
 
 
 \membersection{cbUpdatesManagerBase::SetLayout}\label{cbupdatesmanagerbasesetlayout}
 
 \func{void}{SetLayout}{\param{wxFrameLayout* }{pLayout}}
 
+Sets the associated layout.
+
 
 \membersection{cbUpdatesManagerBase::UpdateNow}\label{cbupdatesmanagerbaseupdatenow}
 
 \func{void}{UpdateNow}{\void}
 
 
 \membersection{cbUpdatesManagerBase::UpdateNow}\label{cbupdatesmanagerbaseupdatenow}
 
 \func{void}{UpdateNow}{\void}
 
-refreshes parts of the frame layout, which need an update
+Refreshes parts of the frame layout that need an update.