docs/latex/wx/rect.tex

   1 \section{\class{wxRect}}\label{wxrect}
   2
   3 A class for manipulating rectangles.
   4
   5 \wxheading{Derived from}
   6
   7 None
   8
   9 \wxheading{Include files}
  10
  11 <wx/gdicmn.h>
  12
  13 \wxheading{See also}
  14
  15 \helpref{wxPoint}{wxpoint}, \helpref{wxSize}{wxsize}
  16
  17 \latexignore{\rtfignore{\wxheading{Members}}}
  18
  19
  20 \membersection{wxRect::wxRect}\label{wxrectctor}
  21
  22 \func{}{wxRect}{\void}
  23
  24 Default constructor.
  25
  26 \func{}{wxRect}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height}}
  27
  28 Creates a wxRect object from x, y, width and height values.
  29
  30 \func{}{wxRect}{\param{const wxPoint\&}{ topLeft}, \param{const wxPoint\&}{ bottomRight}}
  31
  32 Creates a wxRect object from top-left and bottom-right points.
  33
  34 \func{}{wxRect}{\param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size}}
  35
  36 Creates a wxRect object from position and size values.
  37
  38 \func{}{wxRect}{\param{const wxSize\&}{ size}}
  39
  40 Creates a wxRect object from size values at the origin.
  41
  42
  43 \membersection{wxRect::x}\label{wxrectx}
  44
  45 \member{int}{x}
  46
  47 x coordinate of the top-level corner of the rectangle.
  48
  49
  50 \membersection{wxRect::y}\label{wxrecty}
  51
  52 \member{int}{y}
  53
  54 y coordinate of the top-level corner of the rectangle.
  55
  56
  57 \membersection{wxRect::width}\label{wxrectwidth}
  58
  59 \member{int}{width}
  60
  61 Width member.
  62
  63
  64 \membersection{wxRect::height}\label{wxrectheight}
  65
  66 \member{int}{height}
  67
  68 Height member.
  69
  70
  71 \membersection{wxRect::Deflate}\label{wxrectdeflate}
  72
  73 \func{void}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
  74
  75 \func{void}{Deflate}{\param{wxCoord }{diff}}
  76
  77 \constfunc{wxRect}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
  78
  79 Decrease the rectangle size.
  80
  81 This method is the opposite from \helpref{Inflate}{wxrectinflate}:
  82 Deflate(a, b) is equivalent to Inflate(-a, -b).
  83 Please refer to \helpref{Inflate}{wxrectinflate} for full description.
  84
  85 \wxheading{See also}
  86
  87 \helpref{Inflate}{wxrectinflate}
  88
  89
  90 \membersection{wxRect::GetBottom}\label{wxrectgetbottom}
  91
  92 \constfunc{int}{GetBottom}{\void}
  93
  94 Gets the bottom point of the rectangle.
  95
  96
  97 \membersection{wxRect::GetHeight}\label{wxrectgetheight}
  98
  99 \constfunc{int}{GetHeight}{\void}
 100
 101 Gets the height member.
 102
 103
 104 \membersection{wxRect::GetLeft}\label{wxrectgetleft}
 105
 106 \constfunc{int}{GetLeft}{\void}
 107
 108 Gets the left point of the rectangle (the same as \helpref{wxRect::GetX}{wxrectgetx}).
 109
 110
 111 \membersection{wxRect::GetPosition}\label{wxrectgetposition}
 112
 113 \constfunc{wxPoint}{GetPosition}{\void}
 114
 115 Gets the position.
 116
 117
 118 \membersection{wxRect::GetTopLeft}\label{wxrectgettopleft}
 119
 120 \constfunc{wxPoint}{GetTopLeft}{\void}
 121
 122 Gets the topleft position of the rectangle. (Same as GetPosition).
 123
 124
 125 \membersection{wxRect::GetBottomRight}\label{wxrectgetbottomright}
 126
 127 \constfunc{wxPoint}{GetBottomRight}{\void}
 128
 129 Gets the the bottom right position. Returns the bottom right point inside the rectangle.
 130
 131
 132 \membersection{wxRect::GetRight}\label{wxrectgetright}
 133
 134 \constfunc{int}{GetRight}{\void}
 135
 136 Gets the right point of the rectangle.
 137
 138
 139 \membersection{wxRect::GetSize}\label{wxrectgetsize}
 140
 141 \constfunc{wxSize}{GetSize}{\void}
 142
 143 Gets the size.
 144
 145
 146 \membersection{wxRect::GetTop}\label{wxrectgettop}
 147
 148 \constfunc{int}{GetTop}{\void}
 149
 150 Gets the top point of the rectangle (the same as \helpref{wxRect::GetY}{wxrectgety}).
 151
 152
 153 \membersection{wxRect::GetWidth}\label{wxrectgetwidth}
 154
 155 \constfunc{int}{GetWidth}{\void}
 156
 157 Gets the width member.
 158
 159
 160 \membersection{wxRect::GetX}\label{wxrectgetx}
 161
 162 \constfunc{int}{GetX}{\void}
 163
 164 Gets the x member.
 165
 166
 167 \membersection{wxRect::GetY}\label{wxrectgety}
 168
 169 \constfunc{int}{GetY}{\void}
 170
 171 Gets the y member.
 172
 173
 174 \membersection{wxRect::Inflate}\label{wxrectinflate}
 175
 176 \func{void}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 177
 178 \func{void}{Inflate}{\param{wxCoord }{diff}}
 179
 180 \constfunc{wxRect}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 181
 182 Increases the size of the rectangle.
 183
 184 The second form uses the same {\it diff} for both {\it dx} and {\it dy}.
 185
 186 The first two versions modify the rectangle in place, the last one returns a
 187 new rectangle leaving this one unchanged.
 188
 189 The left border is moved farther left and the right border is moved farther
 190 right by {\it dx}. The upper border is moved farther up and the bottom border
 191 is moved farther down by {\it dy}. (Note the the width and height of the
 192 rectangle thus change by 2*{\it dx} and 2*{\it dy}, respectively.) If one or
 193 both of {\it dx} and {\it dy} are negative, the opposite happens: the rectangle
 194 size decreases in the respective direction.
 195
 196 Inflating and deflating behaves ``naturally''. Defined more precisely, that
 197 means:
 198 \begin{enumerate}
 199     \item ``Real'' inflates (that is, {\it dx} and/or {\it dy} >= 0) are not
 200         constrained. Thus inflating a rectangle can cause its upper left corner
 201         to move into the negative numbers. (the versions prior to 2.5.4 forced
 202         the top left coordinate to not fall below (0, 0), which implied a
 203         forced move of the rectangle.)
 204
 205     \item Deflates are clamped to not reduce the width or height of the
 206         rectangle below zero. In such cases, the top-left corner is nonetheless
 207         handled properly. For example, a rectangle at (10, 10) with size (20,
 208         40) that is inflated by (-15, -15) will become located at (20, 25) at
 209         size (0, 10). Finally, observe that the width and height are treated
 210         independently. In the above example, the width is reduced by 20,
 211         whereas the height is reduced by the full 30 (rather than also stopping
 212         at 20, when the width reached zero).
 213 \end{enumerate}
 214
 215 \wxheading{See also}
 216
 217 \helpref{Deflate}{wxrectdeflate}
 218
 219
 220 \membersection{wxRect::Inside}\label{wxrectinside}
 221
 222 \constfunc{bool}{Inside}{\param{int }{x}, \param{int }{y}}
 223
 224 \constfunc{bool}{Inside}{\param{const wxPoint\& }{pt}}
 225
 226 Returns {\tt true} if the given point is inside the rectangle (or on its
 227 boundary) and {\tt false} otherwise.
 228
 229
 230 \membersection{wxRect::Intersects}\label{wxrectintersects}
 231
 232 \constfunc{bool}{Intersects}{\param{const wxRect\& }{rect}}
 233
 234 Returns {\tt true} if this rectangle has a non empty intersection with the
 235 rectangle {\it rect} and {\tt false} otherwise.
 236
 237
 238 \membersection{wxRect::Offset}\label{wxrectoffset}
 239
 240 \func{void}{Offset}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 241
 242 \func{void}{Offset}{\param{const wxPoint\& }{pt}}
 243
 244 Moves the rectangle by the specified offset. If {\it dx} is positive, the
 245 rectangle is moved to the right, if {\it dy} is positive, it is moved to the
 246 bottom, otherwise it is moved to the left or top respectively.
 247
 248
 249 \membersection{wxRect::SetHeight}\label{wxrectsetheight}
 250
 251 \func{void}{SetHeight}{\param{int}{ height}}
 252
 253 Sets the height.
 254
 255
 256 \membersection{wxRect::SetWidth}\label{wxrectsetwidth}
 257
 258 \func{void}{SetWidth}{\param{int}{ width}}
 259
 260 Sets the width.
 261
 262
 263 \membersection{wxRect::SetX}\label{wxrectsetx}
 264
 265 \func{void}{SetX}{\param{int}{ x}}
 266
 267 Sets the x position.
 268
 269
 270 \membersection{wxRect::SetY}\label{wxrectsety}
 271
 272 \func{void}{SetY}{\param{int}{ y}}
 273
 274 Sets the y position.
 275
 276
 277 \membersection{wxRect::Union}\label{wxrectunion}
 278
 279 \constfunc{wxRect}{Union}{\param{const wxRect\&}{ rect}}
 280
 281 \func{wxRect\&}{Union}{\param{const wxRect\&}{ rect}}
 282
 283 Modifies the rectangle to contain the bounding box of this rectangle and the
 284 one passed in as parameter. The const version returns the new rectangle, the
 285 other one modifies this rectangle in place.
 286
 287
 288 \membersection{wxRect::operator $=$}\label{wxrectassign}
 289
 290 \func{void}{operator $=$}{\param{const wxRect\& }{rect}}
 291
 292 Assignment operator.
 293
 294
 295 \membersection{wxRect::operator $==$}\label{wxrectequal}
 296
 297 \func{bool}{operator $==$}{\param{const wxRect\& }{rect}}
 298
 299 Equality operator.
 300
 301
 302 \membersection{wxRect::operator $!=$}\label{wxrectnotequal}
 303
 304 \func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}
 305
 306 Inequality operator.
 307