SWIGged updates for wxGTK

[wxWidgets.git] / contrib / docs / latex / fl / cbdiminfo.tex

diff --git a/contrib/docs/latex/fl/cbdiminfo.tex b/contrib/docs/latex/fl/cbdiminfo.tex
index 9cf4bb5c868591ed5b7eb9fa035ea5dc4dcbc699..4a7121499cc6e3b84dd47ce766026cc59a5528cf 100644 (file)
--- a/contrib/docs/latex/fl/cbdiminfo.tex
+++ b/contrib/docs/latex/fl/cbdiminfo.tex
@@ -1,18 +1,23 @@
 %
 % automatically generated by HelpGen $Revision$ from
-% controlbar.h at 05/Jan/02 22:50:59
+% controlbar.h at 21/Jan/02 21:14:13
 %
 
 
 \section{\class{cbDimInfo}}\label{cbdiminfo}
 
 
-helper classes (used internally by wxFrameLayout class) holds and manages information about bar dimensions
+Helper class used internally by the wxFrameLayout class.
+Holds and manages information about bar dimensions.
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<controlbar.h>
+
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -22,31 +27,54 @@ helper classes (used internally by wxFrameLayout class) holds and manages inform
 
 \func{}{cbDimInfo}{\param{cbBarDimHandlerBase* }{pDimHandler}, \param{bool }{isFixed}}
 
+Constructor.
+isFixed is TRUE if vertical/horizontal dimensions cannot be manually adjusted
+by the user using resizing handles. If FALSE, the frame-layout
+automatically places resizing handles among bars that do are not fixed.
+
 
 \func{}{cbDimInfo}{\param{int }{dh\_x}, \param{int }{dh\_y}, \param{int }{dv\_x}, \param{int }{dv\_y}, \param{int }{f\_x}, \param{int }{f\_y}, \param{bool }{isFixed = TRUE}, \param{int }{horizGap = 6}, \param{int }{vertGap = 6}, \param{cbBarDimHandlerBase* }{pDimHandler = NULL}}
 
-dims when docked horizontally
+Constructor taking dimenstion information.
+dh\_x, dh\_y are the dimensions when docked horizontally.
+dv\_x, dv\_y are the dimensions when docked vertically.
+f\_x, f\_y are the dimensions when floating.
+For information on isFixed, see comments above.
+horizGap is the left/right gap, separating decorations
+from the bar's actual wndow, filled with the frame's background colour.
+The dimension is given in the frame's coordinates.
+vertGap is the top/bottom gap, separating decorations
+from the bar's actual wndow, filled with the frame's background colour.
+The dimension is given in the frame's coordinates.
 
 
 \func{}{cbDimInfo}{\param{int }{x}, \param{int }{y}, \param{bool }{isFixed = TRUE}, \param{int }{gap = 6}, \param{cbBarDimHandlerBase* }{pDimHandler = NULL}}
 
+Constructor.
+
 
 \func{}{cbDimInfo}{\void}
 
+Default constructor.
+
 
 \membersection{cbDimInfo::\destruct{cbDimInfo}}\label{cbdiminfodtor}
 
 \func{}{\destruct{cbDimInfo}}{\void}
 
-destroys handler automatically, if present
+Destructor. Destroys handler automatically, if present.
 
 
 \membersection{cbDimInfo::GetDimHandler}\label{cbdiminfogetdimhandler}
 
 \func{cbBarDimHandlerBase*}{GetDimHandler}{\void}
 
+Returns the handler, if any.
+
 
 \membersection{cbDimInfo::operator=}\label{cbdiminfooperatorassign}
 
 \func{const cbDimInfo\& operator}{operator=}{\param{const cbDimInfo\& }{other}}
 
+Assignment operator.
+