projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxLayoutConstraints}}\label{wxlayoutconstraints} |
| 2 | ||
| 413055db VZ |
3 | {\bf Note:} constraints are now deprecated and you should use \helpref{sizers}{sizeroverview} instead. |
| 4 | ||
| a660d684 KB |
5 | Objects of this class can be associated with a window to define its |
| 6 | layout constraints, with respect to siblings or its parent. | |
| 7 | ||
| 8 | The class consists of the following eight constraints of class wxIndividualLayoutConstraint, | |
| 9 | some or all of which should be accessed directly to set the appropriate | |
| 10 | constraints. | |
| 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 | ||
| 23 | Most constraints are initially set to have the relationship wxUnconstrained, | |
| 24 | which means that their values should be calculated by looking at known constraints. | |
| 25 | The exceptions are {\it width} and {\it height}, which are set to wxAsIs to | |
| 26 | ensure that if the user does not specify a constraint, the existing | |
| 27 | width and height will be used, to be compatible with panel items which often | |
| 28 | have take a default size. If the constraint is wxAsIs, the dimension will | |
| 29 | not be changed. | |
| 30 | ||
| 5873607e VZ |
31 | \perlnote{In wxPerl the constraints are accessed as |
| 32 | \begin{verbatim} | |
| 0a67eeac MB |
33 | constraint = Wx::LayoutConstraints->new(); |
| 34 | constraint->centreX->AsIs(); | |
| 35 | constraint->centreY->Unconstrained(); | |
| 5873607e VZ |
36 | \end{verbatim} |
| 37 | } | |
| 38 | ||
| a660d684 KB |
39 | \wxheading{Derived from} |
| 40 | ||
| 41 | \helpref{wxObject}{wxobject} | |
| 42 | ||
| 954b8ae6 JS |
43 | \wxheading{Include files} |
| 44 | ||
| 45 | <wx/layout.h> | |
| 46 | ||
| a660d684 KB |
47 | \wxheading{See also} |
| 48 | ||
| 49 | \helpref{Overview and examples}{constraintsoverview},\rtfsp | |
| 50 | \helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}, \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} | |
| 51 | ||
| 52 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 53 | ||
| 54 | \membersection{wxLayoutConstraints::wxLayoutConstraints} | |
| 55 | ||
| 56 | \func{}{wxLayoutConstraints}{\void} | |
| 57 | ||
| 58 | Constructor. | |
| 59 | ||
| 60 | \membersection{wxLayoutConstraints::bottom} | |
| 61 | ||
| 62 | \member{wxIndividualLayoutConstraint}{bottom} | |
| 63 | ||
| 64 | Constraint for the bottom edge. | |
| 65 | ||
| 66 | \membersection{wxLayoutConstraints::centreX} | |
| 67 | ||
| 68 | \member{wxIndividualLayoutConstraint}{centreX} | |
| 69 | ||
| 70 | Constraint for the horizontal centre point. | |
| 71 | ||
| 72 | \membersection{wxLayoutConstraints::centreY} | |
| 73 | ||
| 74 | \member{wxIndividualLayoutConstraint}{centreY} | |
| 75 | ||
| 76 | Constraint for the vertical centre point. | |
| 77 | ||
| 78 | \membersection{wxLayoutConstraints::height} | |
| 79 | ||
| 80 | \member{wxIndividualLayoutConstraint}{height} | |
| 81 | ||
| 82 | Constraint for the height. | |
| 83 | ||
| 84 | \membersection{wxLayoutConstraints::left} | |
| 85 | ||
| 86 | \member{wxIndividualLayoutConstraint}{left} | |
| 87 | ||
| 88 | Constraint for the left-hand edge. | |
| 89 | ||
| 90 | \membersection{wxLayoutConstraints::right} | |
| 91 | ||
| 92 | \member{wxIndividualLayoutConstraint}{right} | |
| 93 | ||
| 94 | Constraint for the right-hand edge. | |
| 95 | ||
| 96 | \membersection{wxLayoutConstraints::top} | |
| 97 | ||
| 98 | \member{wxIndividualLayoutConstraint}{top} | |
| 99 | ||
| 100 | Constraint for the top edge. | |
| 101 | ||
| 102 | \membersection{wxLayoutConstraints::width} | |
| 103 | ||
| 104 | \member{wxIndividualLayoutConstraint}{width} | |
| 105 | ||
| 106 | Constraint for the width. | |
| 107 | ||
| 108 |