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