]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/layout.tex
If somebody ever decides to actually check in fsfile.tex and
[wxWidgets.git] / docs / latex / wx / layout.tex
CommitLineData
a660d684
KB
1\section{\class{wxLayoutConstraints}}\label{wxlayoutconstraints}
2
3Objects of this class can be associated with a window to define its
4layout constraints, with respect to siblings or its parent.
5
6The class consists of the following eight constraints of class wxIndividualLayoutConstraint,
7some or all of which should be accessed directly to set the appropriate
8constraints.
9
10\begin{itemize}\itemsep=0pt
11\item {\bf left:} represents the left hand edge of the window
12\item {\bf right:} represents the right hand edge of the window
13\item {\bf top:} represents the top edge of the window
14\item {\bf bottom:} represents the bottom edge of the window
15\item {\bf width:} represents the width of the window
16\item {\bf height:} represents the height of the window
17\item {\bf centreX:} represents the horizontal centre point of the window
18\item {\bf centreY:} represents the vertical centre point of the window
19\end{itemize}
20
21Most constraints are initially set to have the relationship wxUnconstrained,
22which means that their values should be calculated by looking at known constraints.
23The exceptions are {\it width} and {\it height}, which are set to wxAsIs to
24ensure that if the user does not specify a constraint, the existing
25width and height will be used, to be compatible with panel items which often
26have take a default size. If the constraint is wxAsIs, the dimension will
27not be changed.
28
29\wxheading{Derived from}
30
31\helpref{wxObject}{wxobject}
32
954b8ae6
JS
33\wxheading{Include files}
34
35<wx/layout.h>
36
a660d684
KB
37\wxheading{See also}
38
39\helpref{Overview and examples}{constraintsoverview},\rtfsp
40\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}, \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints}
41
42\latexignore{\rtfignore{\wxheading{Members}}}
43
44\membersection{wxLayoutConstraints::wxLayoutConstraints}
45
46\func{}{wxLayoutConstraints}{\void}
47
48Constructor.
49
50\membersection{wxLayoutConstraints::bottom}
51
52\member{wxIndividualLayoutConstraint}{bottom}
53
54Constraint for the bottom edge.
55
56\membersection{wxLayoutConstraints::centreX}
57
58\member{wxIndividualLayoutConstraint}{centreX}
59
60Constraint for the horizontal centre point.
61
62\membersection{wxLayoutConstraints::centreY}
63
64\member{wxIndividualLayoutConstraint}{centreY}
65
66Constraint for the vertical centre point.
67
68\membersection{wxLayoutConstraints::height}
69
70\member{wxIndividualLayoutConstraint}{height}
71
72Constraint for the height.
73
74\membersection{wxLayoutConstraints::left}
75
76\member{wxIndividualLayoutConstraint}{left}
77
78Constraint for the left-hand edge.
79
80\membersection{wxLayoutConstraints::right}
81
82\member{wxIndividualLayoutConstraint}{right}
83
84Constraint for the right-hand edge.
85
86\membersection{wxLayoutConstraints::top}
87
88\member{wxIndividualLayoutConstraint}{top}
89
90Constraint for the top edge.
91
92\membersection{wxLayoutConstraints::width}
93
94\member{wxIndividualLayoutConstraint}{width}
95
96Constraint for the width.
97
98