]> git.saurik.com Git - wxWidgets.git/blob - contrib/docs/latex/fl/cbdiminfo.tex
test undividable words
[wxWidgets.git] / contrib / docs / latex / fl / cbdiminfo.tex
1 %
2 % automatically generated by HelpGen $Revision$ from
3 % controlbar.h at 21/Jan/02 21:14:13
4 %
5
6
7 \section{\class{cbDimInfo}}\label{cbdiminfo}
8
9
10 Helper class used internally by the wxFrameLayout class.
11 Holds and manages information about bar dimensions.
12
13 \wxheading{Derived from}
14
15 \helpref{wxObject}{wxobject}
16
17 \wxheading{Include files}
18
19 <wx/fl/controlbar.h>
20
21 \wxheading{Data structures}
22
23 \latexignore{\rtfignore{\wxheading{Members}}}
24
25
26 \membersection{cbDimInfo::cbDimInfo}\label{cbdiminfocbdiminfo}
27
28 \func{}{cbDimInfo}{\param{cbBarDimHandlerBase* }{pDimHandler}, \param{bool }{isFixed}}
29
30 Constructor.
31 isFixed is TRUE if vertical/horizontal dimensions cannot be manually adjusted
32 by the user using resizing handles. If FALSE, the frame-layout
33 automatically places resizing handles among bars that do are not fixed.
34
35
36 \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}}
37
38 Constructor taking dimenstion information.
39 dh\_x, dh\_y are the dimensions when docked horizontally.
40 dv\_x, dv\_y are the dimensions when docked vertically.
41 f\_x, f\_y are the dimensions when floating.
42 For information on isFixed, see comments above.
43 horizGap is the left/right gap, separating decorations
44 from the bar's actual wndow, filled with the frame's background colour.
45 The dimension is given in the frame's coordinates.
46 vertGap is the top/bottom gap, separating decorations
47 from the bar's actual wndow, filled with the frame's background colour.
48 The dimension is given in the frame's coordinates.
49
50
51 \func{}{cbDimInfo}{\param{int }{x}, \param{int }{y}, \param{bool }{isFixed = TRUE}, \param{int }{gap = 6}, \param{cbBarDimHandlerBase* }{pDimHandler = NULL}}
52
53 Constructor.
54
55
56 \func{}{cbDimInfo}{\void}
57
58 Default constructor.
59
60
61 \membersection{cbDimInfo::\destruct{cbDimInfo}}\label{cbdiminfodtor}
62
63 \func{}{\destruct{cbDimInfo}}{\void}
64
65 Destructor. Destroys handler automatically, if present.
66
67
68 \membersection{cbDimInfo::GetDimHandler}\label{cbdiminfogetdimhandler}
69
70 \func{cbBarDimHandlerBase*}{GetDimHandler}{\void}
71
72 Returns the handler, if any.
73
74
75 \membersection{cbDimInfo::operator=}\label{cbdiminfooperatorassign}
76
77 \func{const cbDimInfo\& operator}{operator=}{\param{const cbDimInfo\& }{other}}
78
79 Assignment operator.
80