/usr/include/wx-3.0/wx/wxPython/i_files/_constraints.i is in python-wxgtk3.0-dev 3.0.2.0+dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | /////////////////////////////////////////////////////////////////////////////
// Name: _constraints.i
// Purpose: SWIG interface defs for the layout constraints
//
// Author: Robin Dunn
//
// Created: 3-July-1997
// RCS-ID: $Id$
// Copyright: (c) 2003 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
// Not a %module
//---------------------------------------------------------------------------
%{
%}
//---------------------------------------------------------------------------
%newgroup;
enum wxEdge
{
wxLeft, wxTop, wxRight, wxBottom, wxWidth, wxHeight,
wxCentre, wxCenter = wxCentre, wxCentreX, wxCentreY
};
enum wxRelationship
{
wxUnconstrained = 0,
wxAsIs,
wxPercentOf,
wxAbove,
wxBelow,
wxLeftOf,
wxRightOf,
wxSameAs,
wxAbsolute
};
DocStr(wxIndividualLayoutConstraint,
"Objects of this class are stored in the `wx.LayoutConstraints` class as
one of eight possible constraints that a window can be involved in.
You will never need to create an instance of
wx.IndividualLayoutConstraint, rather you should create a
`wx.LayoutConstraints` instance and use the individual contstraints
that it contains.", "
Constraints are initially set to have the relationship
wx.Unconstrained, which means that their values should be calculated
by looking at known constraints.
The Edge specifies the type of edge or dimension of a window.
Edges
------
================== ==============================================
wx.Left The left edge.
wx.Top The top edge.
wx.Right The right edge.
wx.Bottom The bottom edge.
wx.CentreX The x-coordinate of the centre of the window.
wx.CentreY The y-coordinate of the centre of the window.
================== ==============================================
The Relationship 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 Below and
RightOf are a convenience for using the more general Set function.
Relationships
-------------
================== ==============================================
wx.Unconstrained The edge or dimension is unconstrained
(the default for edges.)
wx.AsIs The edge or dimension is to be taken from the current
window position or size (the default for dimensions.)
wx.Above The edge should be above another edge.
wx.Below The edge should be below another edge.
wx.LeftOf The edge should be to the left of another edge.
wx.RightOf The edge should be to the right of another edge.
wx.SameAs The edge or dimension should be the same as another edge
or dimension.
wx.PercentOf The edge or dimension should be a percentage of another
edge or dimension.
wx.Absolute The edge or dimension should be a given absolute value.
================== ==============================================
:see: `wx.LayoutConstraints`, `wx.Window.SetConstraints`
");
class wxIndividualLayoutConstraint : public wxObject
{
public:
// wxIndividualLayoutConstraint();
// ~wxIndividualLayoutConstraint();
DocDeclStr(
void , Set(wxRelationship rel, wxWindow *otherW, wxEdge otherE,
int val = 0, int marg = wxLAYOUT_DEFAULT_MARGIN),
"Sets the properties of the constraint. Normally called by one of the
convenience functions such as Above, RightOf, SameAs.", "");
DocDeclStr(
void , LeftOf(wxWindow *sibling, int marg = 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.", "");
DocDeclStr(
void , RightOf(wxWindow *sibling, int marg = 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.", "");
DocDeclStr(
void , Above(wxWindow *sibling, int marg = 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.", "");
DocDeclStr(
void , Below(wxWindow *sibling, int marg = 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.", "");
DocDeclStr(
void , SameAs(wxWindow *otherW, wxEdge edge, int marg = 0),
"Constrains this edge or dimension to be to the same as the edge of the
given window, with an optional margin.", "");
DocDeclStr(
void , PercentOf(wxWindow *otherW, wxEdge wh, int per),
"Constrains this edge or dimension to be to a percentage of the given
window, with an optional margin.", "");
DocDeclStr(
void , Absolute(int val),
"Constrains this edge or dimension to be the given absolute value.", "");
DocDeclStr(
void , Unconstrained(),
"Sets this edge or dimension to be unconstrained, that is, dependent on
other edges and dimensions from which this value can be deduced.", "");
DocDeclStr(
void , AsIs(),
"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 *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.", "");
DocDeclStr(
wxWindow *, GetOtherWindow(),
"", "");
DocDeclStr(
wxEdge , GetMyEdge() const,
"", "");
DocDeclStr(
void , SetEdge(wxEdge which),
"", "");
DocDeclStr(
void , SetValue(int v),
"", "");
DocDeclStr(
int , GetMargin(),
"", "");
DocDeclStr(
void , SetMargin(int m),
"", "");
DocDeclStr(
int , GetValue() const,
"", "");
DocDeclStr(
int , GetPercent() const,
"", "");
DocDeclStr(
int , GetOtherEdge() const,
"", "");
DocDeclStr(
bool , GetDone() const,
"", "");
DocDeclStr(
void , SetDone(bool d),
"", "");
DocDeclStr(
wxRelationship , GetRelationship(),
"", "");
DocDeclStr(
void , SetRelationship(wxRelationship r),
"", "");
DocDeclStr(
bool , ResetIfWin(wxWindow *otherW),
"Reset constraint if it mentions otherWin", "");
DocDeclStr(
bool , SatisfyConstraint(wxLayoutConstraints *constraints, wxWindow *win),
"Try to satisfy constraint", "");
DocDeclStr(
int , GetEdge(wxEdge which, wxWindow *thisWin, wxWindow *other) const,
"Get the value of this edge or dimension, or if this\n"
"is not determinable, -1.", "");
%property(Done, GetDone, SetDone, doc="See `GetDone` and `SetDone`");
%property(Margin, GetMargin, SetMargin, doc="See `GetMargin` and `SetMargin`");
%property(MyEdge, GetMyEdge, doc="See `GetMyEdge`");
%property(OtherEdge, GetOtherEdge, doc="See `GetOtherEdge`");
%property(OtherWindow, GetOtherWindow, doc="See `GetOtherWindow`");
%property(Percent, GetPercent, doc="See `GetPercent`");
%property(Relationship, GetRelationship, SetRelationship, doc="See `GetRelationship` and `SetRelationship`");
%property(Value, GetValue, SetValue, doc="See `GetValue` and `SetValue`");
};
DocStr(wxLayoutConstraints,
"**Note:** constraints are now deprecated and you should use sizers
instead.
Objects of this class can be associated with a window to define its
layout constraints, with respect to siblings or its parent.
The class consists of the following eight constraints of class
wx.IndividualLayoutConstraint, some or all of which should be accessed
directly to set the appropriate constraints.
* left: represents the left hand edge of the window
* right: represents the right hand edge of the window
* top: represents the top edge of the window
* bottom: represents the bottom edge of the window
* width: represents the width of the window
* height: represents the height of the window
* centreX: represents the horizontal centre point of the window
* centreY: represents the vertical centre point of the window
Most constraints are initially set to have the relationship
wxUnconstrained, which means that their values should be calculated by
looking at known constraints. The exceptions are width and height,
which are set to wxAsIs to ensure that if the user does not specify a
constraint, the existing width and height will be used, to be
compatible with panel items which often have take a default size. If
the constraint is ``wx.AsIs``, the dimension will not be changed.
:see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
", "");
class wxLayoutConstraints : public wxObject
{
public:
%immutable;
// Edge constraints
wxIndividualLayoutConstraint left;
wxIndividualLayoutConstraint top;
wxIndividualLayoutConstraint right;
wxIndividualLayoutConstraint bottom;
// Size constraints
wxIndividualLayoutConstraint width;
wxIndividualLayoutConstraint height;
// Centre constraints
wxIndividualLayoutConstraint centreX;
wxIndividualLayoutConstraint centreY;
%mutable;
DocCtorStr(
wxLayoutConstraints(),
"", "");
~wxLayoutConstraints();
DocDeclA(
bool, SatisfyConstraints(wxWindow *win, int *OUTPUT),
"SatisfyConstraints(Window win) -> (areSatisfied, noChanges)");
bool AreSatisfied() const;
};
//---------------------------------------------------------------------------
|