docs/latex/wx/layout.tex

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