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 \wxheading{Derived from}
  30
  31 \helpref{wxObject}{wxobject}
  32
  33 \wxheading{Include files}
  34
  35 <wx/layout.h>
  36
  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
  48 Constructor.
  49
  50 \membersection{wxLayoutConstraints::bottom}
  51
  52 \member{wxIndividualLayoutConstraint}{bottom}
  53
  54 Constraint for the bottom edge.
  55
  56 \membersection{wxLayoutConstraints::centreX}
  57
  58 \member{wxIndividualLayoutConstraint}{centreX}
  59
  60 Constraint for the horizontal centre point.
  61
  62 \membersection{wxLayoutConstraints::centreY}
  63
  64 \member{wxIndividualLayoutConstraint}{centreY}
  65
  66 Constraint for the vertical centre point.
  67
  68 \membersection{wxLayoutConstraints::height}
  69
  70 \member{wxIndividualLayoutConstraint}{height}
  71
  72 Constraint for the height.
  73
  74 \membersection{wxLayoutConstraints::left}
  75
  76 \member{wxIndividualLayoutConstraint}{left}
  77
  78 Constraint for the left-hand edge.
  79
  80 \membersection{wxLayoutConstraints::right}
  81
  82 \member{wxIndividualLayoutConstraint}{right}
  83
  84 Constraint for the right-hand edge.
  85
  86 \membersection{wxLayoutConstraints::top}
  87
  88 \member{wxIndividualLayoutConstraint}{top}
  89
  90 Constraint for the top edge.
  91
  92 \membersection{wxLayoutConstraints::width}
  93
  94 \member{wxIndividualLayoutConstraint}{width}
  95
  96 Constraint for the width.
  97
  98