File: ilayout.tex

package info (click to toggle)
wxwidgets2.8 2.8.10.1-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 239,052 kB
  • ctags: 289,550
  • sloc: cpp: 1,838,857; xml: 396,717; python: 282,506; ansic: 126,171; makefile: 51,406; sh: 14,581; asm: 299; sql: 258; lex: 194; perl: 139; yacc: 128; pascal: 95; php: 39; lisp: 38; tcl: 24; haskell: 20; java: 18; cs: 18; erlang: 17; ruby: 16; ada: 9; ml: 9; csh: 9
file content (135 lines) | stat: -rw-r--r-- 5,814 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
\section{\class{wxIndividualLayoutConstraint}}\label{wxindividuallayoutconstraint}

Objects of this class are stored in the wxLayoutConstraint class
as one of eight possible constraints that a window can be involved in.

Constraints are initially set to have the relationship wxUnconstrained,
which means that their values should be calculated by looking at known constraints.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/layout.h>

\wxheading{See also}

\helpref{Overview and examples}{constraintsoverview},\rtfsp
\helpref{wxLayoutConstraints}{wxlayoutconstraints}, \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints}.

\latexignore{\rtfignore{\wxheading{Members}}}

\subsection{Edges and relationships}\label{edgesandrelationships}

The {\it wxEdge}\index{wxEdge} enumerated type specifies the type of edge or dimension of a window.

\begin{twocollist}\itemsep=0pt
\twocolitem{wxLeft}{The left edge.}
\twocolitem{wxTop}{The top edge.}
\twocolitem{wxRight}{The right edge.}
\twocolitem{wxBottom}{The bottom edge.}
\twocolitem{wxCentreX}{The x-coordinate of the centre of the window.}
\twocolitem{wxCentreY}{The y-coordinate of the centre of the window.}
\end{twocollist}

The {\it wxRelationship}\index{wxRelationship} enumerated type specifies the relationship that
this edge or dimension has with another specified edge or dimension. Normally, the user
doesn't use these directly because functions such as {\it Below} and {\it RightOf} are a convenience
for using the more general {\it Set} function.

\begin{twocollist}\itemsep=0pt
\twocolitem{wxUnconstrained}{The edge or dimension is unconstrained (the default for edges.}
\twocolitem{wxAsIs}{The edge or dimension is to be taken from the current window position or size (the
default for dimensions.}
\twocolitem{wxAbove}{The edge should be above another edge.}
\twocolitem{wxBelow}{The edge should be below another edge.}
\twocolitem{wxLeftOf}{The edge should be to the left of another edge.}
\twocolitem{wxRightOf}{The edge should be to the right of another edge.}
\twocolitem{wxSameAs}{The edge or dimension should be the same as another edge or dimension.}
\twocolitem{wxPercentOf}{The edge or dimension should be a percentage of another edge or dimension.}
\twocolitem{wxAbsolute}{The edge or dimension should be a given absolute value.}
\end{twocollist}

\membersection{wxIndividualLayoutConstraint::wxIndividualLayoutConstraint}\label{wxindividuallayoutconstraintctor}

\func{void}{wxIndividualLayoutConstraint}{\void}

Constructor. Not used by the end-user.

\membersection{wxIndividualLayoutConstraint::Above}\label{wxindividuallayoutconstraintabove}

\func{void}{Above}{\param{wxWindow *}{otherWin}, \param{int}{ margin = 0}}

Constrains this edge to be above the given window, with an
optional margin. Implicitly, this is relative to the top edge of the other window.

\membersection{wxIndividualLayoutConstraint::Absolute}\label{wxindividuallayoutconstraintabsolute}

\func{void}{Absolute}{\param{int}{ value}}

Constrains this edge or dimension to be the given absolute value.

\membersection{wxIndividualLayoutConstraint::AsIs}\label{wxindividuallayoutconstraintasis}

\func{void}{AsIs}{\void}

Sets this edge or constraint to be whatever the window's value is
at the moment. If either of the width and height constraints
are {\it as is}, the window will not be resized, but moved instead.
This is important when considering panel items which are intended
to have a default size, such as a button, which may take its size
from the size of the button label.

\membersection{wxIndividualLayoutConstraint::Below}\label{wxindividuallayoutconstraintbelow}

\func{void}{Below}{\param{wxWindow *}{otherWin}, \param{int}{ margin = 0}}

Constrains this edge to be below the given window, with an
optional margin. Implicitly, this is relative to the bottom edge of the other window.

\membersection{wxIndividualLayoutConstraint::Unconstrained}\label{wxindividuallayoutconstraintunconstrained}

\func{void}{Unconstrained}{\void}

Sets this edge or dimension to be unconstrained, that is, dependent on
other edges and dimensions from which this value can be deduced.

\membersection{wxIndividualLayoutConstraint::LeftOf}\label{wxindividuallayoutconstraintleftof}

\func{void}{LeftOf}{\param{wxWindow *}{otherWin}, \param{int}{ margin = 0}}

Constrains this edge to be to the left of the given window, with an
optional margin. Implicitly, this is relative to the left edge of the other window.

\membersection{wxIndividualLayoutConstraint::PercentOf}\label{wxindividuallayoutconstraintpercentof}

\func{void}{PercentOf}{\param{wxWindow *}{otherWin}, \param{wxEdge}{ edge}, \param{int}{ per}}

Constrains this edge or dimension to be to a percentage of the given window, with an
optional margin.

\membersection{wxIndividualLayoutConstraint::RightOf}\label{wxindividuallayoutconstraintrightof}

\func{void}{RightOf}{\param{wxWindow *}{otherWin}, \param{int}{ margin = 0}}

Constrains this edge to be to the right of the given window, with an
optional margin. Implicitly, this is relative to the right edge of the other window.

\membersection{wxIndividualLayoutConstraint::SameAs}\label{wxindividuallayoutconstraintsameas}

\func{void}{SameAs}{\param{wxWindow *}{otherWin}, \param{wxEdge}{ edge}, \param{int}{ margin = 0}}

Constrains this edge or dimension to be to the same as the edge of the given window, with an
optional margin.

\membersection{wxIndividualLayoutConstraint::Set}\label{wxindividuallayoutconstraintset}

\func{void}{Set}{\param{wxRelationship}{ rel}, \param{wxWindow *}{otherWin}, \param{wxEdge}{ otherEdge},
 \param{int}{ value = 0}, \param{int}{ margin = 0}}

Sets the properties of the constraint. Normally called by one of the convenience
functions such as Above, RightOf, SameAs.