]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/layout.tex
escape underscores introduced by the last change
[wxWidgets.git] / docs / latex / wx / layout.tex
... / ...
CommitLineData
1\section{\class{wxLayoutConstraints}}\label{wxlayoutconstraints}
2
3{\bf Note:} constraints are now deprecated and you should use \helpref{sizers}{sizeroverview} instead.
4
5Objects of this class can be associated with a window to define its
6layout constraints, with respect to siblings or its parent.
7
8The class consists of the following eight constraints of class wxIndividualLayoutConstraint,
9some or all of which should be accessed directly to set the appropriate
10constraints.
11
12\begin{itemize}\itemsep=0pt
13\item {\bf left:} represents the left hand edge of the window
14\item {\bf right:} represents the right hand edge of the window
15\item {\bf top:} represents the top edge of the window
16\item {\bf bottom:} represents the bottom edge of the window
17\item {\bf width:} represents the width of the window
18\item {\bf height:} represents the height of the window
19\item {\bf centreX:} represents the horizontal centre point of the window
20\item {\bf centreY:} represents the vertical centre point of the window
21\end{itemize}
22
23Most constraints are initially set to have the relationship wxUnconstrained,
24which means that their values should be calculated by looking at known constraints.
25The exceptions are {\it width} and {\it height}, which are set to wxAsIs to
26ensure that if the user does not specify a constraint, the existing
27width and height will be used, to be compatible with panel items which often
28have take a default size. If the constraint is wxAsIs, the dimension will
29not be changed.
30
31\perlnote{In wxPerl the constraints are accessed as
32\begin{verbatim}
33 constraint = Wx::LayoutConstraints->new();
34 constraint->centreX->AsIs();
35 constraint->centreY->Unconstrained();
36\end{verbatim}
37}
38
39\wxheading{Derived from}
40
41\helpref{wxObject}{wxobject}
42
43\wxheading{Include files}
44
45<wx/layout.h>
46
47\wxheading{Library}
48
49\helpref{wxCore}{librarieslist}
50
51\wxheading{See also}
52
53\helpref{Overview and examples}{constraintsoverview},\rtfsp
54\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}, \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints}
55
56\latexignore{\rtfignore{\wxheading{Members}}}
57
58\membersection{wxLayoutConstraints::wxLayoutConstraints}\label{wxlayoutconstraintsctor}
59
60\func{}{wxLayoutConstraints}{\void}
61
62Constructor.
63
64\membersection{wxLayoutConstraints::bottom}\label{wxlayoutconstraintsbottom}
65
66\member{wxIndividualLayoutConstraint}{bottom}
67
68Constraint for the bottom edge.
69
70\membersection{wxLayoutConstraints::centreX}\label{wxlayoutconstraintscentrex}
71
72\member{wxIndividualLayoutConstraint}{centreX}
73
74Constraint for the horizontal centre point.
75
76\membersection{wxLayoutConstraints::centreY}\label{wxlayoutconstraintscentrey}
77
78\member{wxIndividualLayoutConstraint}{centreY}
79
80Constraint for the vertical centre point.
81
82\membersection{wxLayoutConstraints::height}\label{wxlayoutconstraintsheight}
83
84\member{wxIndividualLayoutConstraint}{height}
85
86Constraint for the height.
87
88\membersection{wxLayoutConstraints::left}\label{wxlayoutconstraintsleft}
89
90\member{wxIndividualLayoutConstraint}{left}
91
92Constraint for the left-hand edge.
93
94\membersection{wxLayoutConstraints::right}\label{wxlayoutconstraintsright}
95
96\member{wxIndividualLayoutConstraint}{right}
97
98Constraint for the right-hand edge.
99
100\membersection{wxLayoutConstraints::top}\label{wxlayoutconstraintstop}
101
102\member{wxIndividualLayoutConstraint}{top}
103
104Constraint for the top edge.
105
106\membersection{wxLayoutConstraints::width}\label{wxlayoutconstraintswidth}
107
108\member{wxIndividualLayoutConstraint}{width}
109
110Constraint for the width.
111
112