%
% automatically generated by HelpGen $Revision$ from
-% controlbar.h at 05/Jan/02 22:50:58
+% controlbar.h at 21/Jan/02 21:14:13
%
Abstract interface for bar-size handler classes.
- These objects receive notifications, whenever the docking
- state of the bar is changed, thus they have a possibility
- to adjust the values in cbDimInfo::mSizes accordingly.
- Specific handlers can be hooked to specific types of bars.
-
+These objects receive notifications whenever the docking
+state of the bar is changed, thus they provide the possibility
+to adjust the values in cbDimInfo::mSizes accordingly.
+Specific handlers can be hooked up to specific types of bar.
+
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
+\wxheading{Include files}
+
+<wx/fl/controlbar.h>
+
\wxheading{Data structures}
\latexignore{\rtfignore{\wxheading{Members}}}
to multiple bars, it's instance is
reference-counted
-initial reference count is 0, since handler is not used, until the
-first invocation of AddRef()
+Default constructor. The initial reference count is 0, since
+the handler is not used until the first invocation of AddRef().
\membersection{cbBarDimHandlerBase::AddRef}\label{cbbardimhandlerbaseaddref}
\func{void}{AddRef}{\void}
+Increments the reference count.
+
\membersection{cbBarDimHandlerBase::OnChangeBarState}\label{cbbardimhandlerbaseonchangebarstate}
\func{void}{OnChangeBarState}{\param{cbBarInfo* }{pBar}, \param{int }{newState}}
-"bar-state-changes" notification
+Responds to "bar-state-changes" notifications.
\membersection{cbBarDimHandlerBase::OnResizeBar}\label{cbbardimhandlerbaseonresizebar}
\func{void}{OnResizeBar}{\param{cbBarInfo* }{pBar}, \param{const wxSize\& }{given}, \param{wxSize\& }{preferred}}
+Responds to bar resize notifications.
+
\membersection{cbBarDimHandlerBase::RemoveRef}\label{cbbardimhandlerbaseremoveref}
\func{void}{RemoveRef}{\void}
+Decrements the reference count, and if the count is at zero,
+delete 'this'.
+