]> git.saurik.com Git - wxWidgets.git/blobdiff - contrib/docs/latex/fl/cbfloatedbarwindow.tex
corrected version number extraction
[wxWidgets.git] / contrib / docs / latex / fl / cbfloatedbarwindow.tex
index 417df44a52bcdd4b269846a958f56860c97df01e..a35d7695817c4d2195829d471a587dac7df8d371 100644 (file)
@@ -1,15 +1,23 @@
 %
 % automatically generated by HelpGen $Revision$ from
-% toolwnd.h at 05/Jan/02 22:50:58
+% toolwnd.h at 21/Jan/02 21:14:17
 %
 
 
 \section{\class{cbFloatedBarWindow}}\label{cbfloatedbarwindow}
 
+
+cbFloatedBarWindow is a kind of wxToolWindow,
+implementing floating toolbars.
+
 \wxheading{Derived from}
 
 \helpref{wxToolWindow}{wxtoolwindow}
 
+\wxheading{Include files}
+
+<wx/fl/toolwnd.h>
+
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \func{}{cbFloatedBarWindow}{\void}
 
+Default constructor.
+
 
 \membersection{cbFloatedBarWindow::GetBar}\label{cbfloatedbarwindowgetbar}
 
 \func{cbBarInfo*}{GetBar}{\void}
 
+Returns the bar information for this window.
+
 
 \membersection{cbFloatedBarWindow::GetPreferredSize}\label{cbfloatedbarwindowgetpreferredsize}
 
 \func{wxSize}{GetPreferredSize}{\param{const wxSize\& }{given}}
 
-overriden methods of wxToolWindow
+Overridden function returning the preferred size.
 
 
 \membersection{cbFloatedBarWindow::HandleTitleClick}\label{cbfloatedbarwindowhandletitleclick}
 
 \func{bool}{HandleTitleClick}{\param{wxMouseEvent\& }{event}}
 
+Overridden function responding to mouse button clicks on the titlebar.
+
 
 \membersection{cbFloatedBarWindow::OnDblClick}\label{cbfloatedbarwindowondblclick}
 
 \func{void}{OnDblClick}{\param{wxMouseEvent\& }{event}}
 
+Responds to double-click mouse events.
+
 
 \membersection{cbFloatedBarWindow::OnMiniButtonClicked}\label{cbfloatedbarwindowonminibuttonclicked}
 
 \func{void}{OnMiniButtonClicked}{\param{int }{btnIdx}}
 
+Overridden function responding to mouse clicks on mini-buttons.
+
 
 \membersection{cbFloatedBarWindow::PositionFloatedWnd}\label{cbfloatedbarwindowpositionfloatedwnd}
 
 \func{void}{PositionFloatedWnd}{\param{int }{scrX}, \param{int }{scrY}, \param{int }{width}, \param{int }{height}}
 
-given coordinates are those of the bar itself
-floated container window's position and size
-are ajusted accordingly
+Position the floating window. The given coordinates
+are those of the bar itself; the floated container window's
+position and size are ajusted accordingly.
 
 
 \membersection{cbFloatedBarWindow::SetBar}\label{cbfloatedbarwindowsetbar}
 
 \func{void}{SetBar}{\param{cbBarInfo* }{pBar}}
 
+Sets the bar information for this window.
+
 
 \membersection{cbFloatedBarWindow::SetLayout}\label{cbfloatedbarwindowsetlayout}
 
 \func{void}{SetLayout}{\param{wxFrameLayout* }{pLayout}}
 
+Sets the layout for this window.
+