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 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 \wxheading{See also}
 146
 147 \helpref{wxRect::SetSize}{wxrectsetsize}
 148
 149
 150 \membersection{wxRect::GetTop}\label{wxrectgettop}
 151
 152 \constfunc{int}{GetTop}{\void}
 153
 154 Gets the top point of the rectangle (the same as \helpref{wxRect::GetY}{wxrectgety}).
 155
 156
 157 \membersection{wxRect::GetWidth}\label{wxrectgetwidth}
 158
 159 \constfunc{int}{GetWidth}{\void}
 160
 161 Gets the width member.
 162
 163
 164 \membersection{wxRect::GetX}\label{wxrectgetx}
 165
 166 \constfunc{int}{GetX}{\void}
 167
 168 Gets the x member.
 169
 170
 171 \membersection{wxRect::GetY}\label{wxrectgety}
 172
 173 \constfunc{int}{GetY}{\void}
 174
 175 Gets the y member.
 176
 177
 178 \membersection{wxRect::Inflate}\label{wxrectinflate}
 179
 180 \func{void}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 181
 182 \func{void}{Inflate}{\param{wxCoord }{diff}}
 183
 184 \constfunc{wxRect}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 185
 186 Increases the size of the rectangle.
 187
 188 The second form uses the same {\it diff} for both {\it dx} and {\it dy}.
 189
 190 The first two versions modify the rectangle in place, the last one returns a
 191 new rectangle leaving this one unchanged.
 192
 193 The left border is moved farther left and the right border is moved farther
 194 right by {\it dx}. The upper border is moved farther up and the bottom border
 195 is moved farther down by {\it dy}. (Note the the width and height of the
 196 rectangle thus change by 2*{\it dx} and 2*{\it dy}, respectively.) If one or
 197 both of {\it dx} and {\it dy} are negative, the opposite happens: the rectangle
 198 size decreases in the respective direction.
 199
 200 Inflating and deflating behaves ``naturally''. Defined more precisely, that
 201 means:
 202 \begin{enumerate}
 203     \item ``Real'' inflates (that is, {\it dx} and/or {\it dy} >= 0) are not
 204         constrained. Thus inflating a rectangle can cause its upper left corner
 205         to move into the negative numbers. (the versions prior to 2.5.4 forced
 206         the top left coordinate to not fall below (0, 0), which implied a
 207         forced move of the rectangle.)
 208
 209     \item Deflates are clamped to not reduce the width or height of the
 210         rectangle below zero. In such cases, the top-left corner is nonetheless
 211         handled properly. For example, a rectangle at (10, 10) with size (20,
 212         40) that is inflated by (-15, -15) will become located at (20, 25) at
 213         size (0, 10). Finally, observe that the width and height are treated
 214         independently. In the above example, the width is reduced by 20,
 215         whereas the height is reduced by the full 30 (rather than also stopping
 216         at 20, when the width reached zero).
 217 \end{enumerate}
 218
 219 \wxheading{See also}
 220
 221 \helpref{Deflate}{wxrectdeflate}
 222
 223
 224 \membersection{wxRect::Inside}\label{wxrectinside}
 225
 226 \constfunc{bool}{Inside}{\param{int }{x}, \param{int }{y}}
 227
 228 \constfunc{bool}{Inside}{\param{const wxPoint\& }{pt}}
 229
 230 Returns {\tt true} if the given point is inside the rectangle (or on its
 231 boundary) and {\tt false} otherwise.
 232
 233
 234 \membersection{wxRect::Intersects}\label{wxrectintersects}
 235
 236 \constfunc{bool}{Intersects}{\param{const wxRect\& }{rect}}
 237
 238 Returns {\tt true} if this rectangle has a non empty intersection with the
 239 rectangle {\it rect} and {\tt false} otherwise.
 240
 241
 242 \membersection{wxRect::IsEmpty}\label{wxrectisempty}
 243
 244 \constfunc{bool}{IsEmpty}{}
 245
 246 Returns {\tt true} if this rectangle has a width or height less than or equal to
 247 0 and {\tt false} otherwise.
 248
 249
 250 \membersection{wxRect::Offset}\label{wxrectoffset}
 251
 252 \func{void}{Offset}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 253
 254 \func{void}{Offset}{\param{const wxPoint\& }{pt}}
 255
 256 Moves the rectangle by the specified offset. If {\it dx} is positive, the
 257 rectangle is moved to the right, if {\it dy} is positive, it is moved to the
 258 bottom, otherwise it is moved to the left or top respectively.
 259
 260
 261 \membersection{wxRect::SetHeight}\label{wxrectsetheight}
 262
 263 \func{void}{SetHeight}{\param{int}{ height}}
 264
 265 Sets the height.
 266
 267
 268 \membersection{wxRect::SetSize}\label{wxrectsetsize}
 269
 270 \func{void}{SetSize}{\param{const wxSize\&}{ s}}
 271
 272 Sets the size.
 273
 274 \wxheading{See also}
 275
 276 \helpref{wxRect::GetSize}{wxrectgetsize}
 277
 278
 279 \membersection{wxRect::SetWidth}\label{wxrectsetwidth}
 280
 281 \func{void}{SetWidth}{\param{int}{ width}}
 282
 283 Sets the width.
 284
 285
 286 \membersection{wxRect::SetX}\label{wxrectsetx}
 287
 288 \func{void}{SetX}{\param{int}{ x}}
 289
 290 Sets the x position.
 291
 292
 293 \membersection{wxRect::SetY}\label{wxrectsety}
 294
 295 \func{void}{SetY}{\param{int}{ y}}
 296
 297 Sets the y position.
 298
 299
 300 \membersection{wxRect::Union}\label{wxrectunion}
 301
 302 \constfunc{wxRect}{Union}{\param{const wxRect\&}{ rect}}
 303
 304 \func{wxRect\&}{Union}{\param{const wxRect\&}{ rect}}
 305
 306 Modifies the rectangle to contain the bounding box of this rectangle and the
 307 one passed in as parameter. The const version returns the new rectangle, the
 308 other one modifies this rectangle in place.
 309
 310
 311 \membersection{wxRect::operator $=$}\label{wxrectassign}
 312
 313 \func{void}{operator $=$}{\param{const wxRect\& }{rect}}
 314
 315 Assignment operator.
 316
 317
 318 \membersection{wxRect::operator $==$}\label{wxrectequal}
 319
 320 \func{bool}{operator $==$}{\param{const wxRect\& }{rect}}
 321
 322 Equality operator.
 323
 324
 325 \membersection{wxRect::operator $!=$}\label{wxrectnotequal}
 326
 327 \func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}
 328
 329 Inequality operator.
 330