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::CentreIn}\label{wxrectcentrein}
  72
  73 \constfunc{wxRect}{CentreIn}{\param{const wxRect\& }{r}, \param{int }{dir = wxBOTH}}
  74
  75 \constfunc{wxRect}{CenterIn}{\param{const wxRect\& }{r}, \param{int }{dir = wxBOTH}}
  76
  77 Returns the rectangle having the same size as this one but centered relatively
  78 to the given rectangle \arg{r}. By default, rectangle is centred in both
  79 directions but if \arg{dir} includes only \texttt{wxVERTICAL} or only
  80 \texttt{wxHORIZONTAL} flag, then it is only centered in this direction while
  81 the other component of its position remains unchanged.
  82
  83
  84 \membersection{wxRect::Contains}\label{wxrectcontains}
  85
  86 \constfunc{bool}{Contains}{\param{int }{x}, \param{int }{y}}
  87
  88 \constfunc{bool}{Contains}{\param{const wxPoint\& }{pt}}
  89
  90 Returns {\tt true} if the given point is inside the rectangle (or on its
  91 boundary) and {\tt false} otherwise.
  92
  93 \constfunc{bool}{Contains}{\param{const wxRect\& }{rect}}
  94
  95 Returns \true if the given rectangle is completely inside this rectangle
  96 (or touches its boundary) and \false otherwise.
  97
  98
  99 \membersection{wxRect::Deflate}\label{wxrectdeflate}
 100
 101 \func{void}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 102
 103 \func{void}{Deflate}{\param{wxCoord }{diff}}
 104
 105 \constfunc{wxRect}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 106
 107 Decrease the rectangle size.
 108
 109 This method is the opposite from \helpref{Inflate}{wxrectinflate}:
 110 Deflate(a, b) is equivalent to Inflate(-a, -b).
 111 Please refer to \helpref{Inflate}{wxrectinflate} for full description.
 112
 113 \wxheading{See also}
 114
 115 \helpref{Inflate}{wxrectinflate}
 116
 117
 118 \membersection{wxRect::GetBottom}\label{wxrectgetbottom}
 119
 120 \constfunc{int}{GetBottom}{\void}
 121
 122 Gets the bottom point of the rectangle.
 123
 124
 125 \membersection{wxRect::GetHeight}\label{wxrectgetheight}
 126
 127 \constfunc{int}{GetHeight}{\void}
 128
 129 Gets the height member.
 130
 131
 132 \membersection{wxRect::GetLeft}\label{wxrectgetleft}
 133
 134 \constfunc{int}{GetLeft}{\void}
 135
 136 Gets the left point of the rectangle (the same as \helpref{wxRect::GetX}{wxrectgetx}).
 137
 138
 139 \membersection{wxRect::GetPosition}\label{wxrectgetposition}
 140
 141 \constfunc{wxPoint}{GetPosition}{\void}
 142
 143 Gets the position.
 144
 145
 146 \membersection{wxRect::GetTopLeft}\label{wxrectgettopleft}
 147
 148 \constfunc{wxPoint}{GetTopLeft}{\void}
 149
 150 Gets the topleft position of the rectangle. (Same as GetPosition).
 151
 152
 153 \membersection{wxRect::GetBottomRight}\label{wxrectgetbottomright}
 154
 155 \constfunc{wxPoint}{GetBottomRight}{\void}
 156
 157 Gets the bottom right position. Returns the bottom right point inside the rectangle.
 158
 159
 160 \membersection{wxRect::GetRight}\label{wxrectgetright}
 161
 162 \constfunc{int}{GetRight}{\void}
 163
 164 Gets the right point of the rectangle.
 165
 166
 167 \membersection{wxRect::GetSize}\label{wxrectgetsize}
 168
 169 \constfunc{wxSize}{GetSize}{\void}
 170
 171 Gets the size.
 172
 173 \wxheading{See also}
 174
 175 \helpref{wxRect::SetSize}{wxrectsetsize}
 176
 177
 178 \membersection{wxRect::GetTop}\label{wxrectgettop}
 179
 180 \constfunc{int}{GetTop}{\void}
 181
 182 Gets the top point of the rectangle (the same as \helpref{wxRect::GetY}{wxrectgety}).
 183
 184
 185 \membersection{wxRect::GetWidth}\label{wxrectgetwidth}
 186
 187 \constfunc{int}{GetWidth}{\void}
 188
 189 Gets the width member.
 190
 191
 192 \membersection{wxRect::GetX}\label{wxrectgetx}
 193
 194 \constfunc{int}{GetX}{\void}
 195
 196 Gets the x member.
 197
 198
 199 \membersection{wxRect::GetY}\label{wxrectgety}
 200
 201 \constfunc{int}{GetY}{\void}
 202
 203 Gets the y member.
 204
 205
 206 \membersection{wxRect::Inflate}\label{wxrectinflate}
 207
 208 \func{void}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 209
 210 \func{void}{Inflate}{\param{wxCoord }{diff}}
 211
 212 \constfunc{wxRect}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 213
 214 Increases the size of the rectangle.
 215
 216 The second form uses the same {\it diff} for both {\it dx} and {\it dy}.
 217
 218 The first two versions modify the rectangle in place, the last one returns a
 219 new rectangle leaving this one unchanged.
 220
 221 The left border is moved farther left and the right border is moved farther
 222 right by {\it dx}. The upper border is moved farther up and the bottom border
 223 is moved farther down by {\it dy}. (Note the the width and height of the
 224 rectangle thus change by 2*{\it dx} and 2*{\it dy}, respectively.) If one or
 225 both of {\it dx} and {\it dy} are negative, the opposite happens: the rectangle
 226 size decreases in the respective direction.
 227
 228 Inflating and deflating behaves ``naturally''. Defined more precisely, that
 229 means:
 230 \begin{enumerate}
 231     \item ``Real'' inflates (that is, {\it dx} and/or {\it dy} >= 0) are not
 232         constrained. Thus inflating a rectangle can cause its upper left corner
 233         to move into the negative numbers. (the versions prior to 2.5.4 forced
 234         the top left coordinate to not fall below (0, 0), which implied a
 235         forced move of the rectangle.)
 236
 237     \item Deflates are clamped to not reduce the width or height of the
 238         rectangle below zero. In such cases, the top-left corner is nonetheless
 239         handled properly. For example, a rectangle at (10, 10) with size (20,
 240         40) that is inflated by (-15, -15) will become located at (20, 25) at
 241         size (0, 10). Finally, observe that the width and height are treated
 242         independently. In the above example, the width is reduced by 20,
 243         whereas the height is reduced by the full 30 (rather than also stopping
 244         at 20, when the width reached zero).
 245 \end{enumerate}
 246
 247 \wxheading{See also}
 248
 249 \helpref{Deflate}{wxrectdeflate}
 250
 251
 252 \membersection{wxRect::Intersects}\label{wxrectintersects}
 253
 254 \constfunc{bool}{Intersects}{\param{const wxRect\& }{rect}}
 255
 256 Returns {\tt true} if this rectangle has a non-empty intersection with the
 257 rectangle {\it rect} and {\tt false} otherwise.
 258
 259
 260 \membersection{wxRect::IsEmpty}\label{wxrectisempty}
 261
 262 \constfunc{bool}{IsEmpty}{}
 263
 264 Returns {\tt true} if this rectangle has a width or height less than or equal to
 265 0 and {\tt false} otherwise.
 266
 267
 268 \membersection{wxRect::Offset}\label{wxrectoffset}
 269
 270 \func{void}{Offset}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 271
 272 \func{void}{Offset}{\param{const wxPoint\& }{pt}}
 273
 274 Moves the rectangle by the specified offset. If {\it dx} is positive, the
 275 rectangle is moved to the right, if {\it dy} is positive, it is moved to the
 276 bottom, otherwise it is moved to the left or top respectively.
 277
 278
 279 \membersection{wxRect::SetHeight}\label{wxrectsetheight}
 280
 281 \func{void}{SetHeight}{\param{int}{ height}}
 282
 283 Sets the height.
 284
 285
 286 \membersection{wxRect::SetSize}\label{wxrectsetsize}
 287
 288 \func{void}{SetSize}{\param{const wxSize\&}{ s}}
 289
 290 Sets the size.
 291
 292 \wxheading{See also}
 293
 294 \helpref{wxRect::GetSize}{wxrectgetsize}
 295
 296
 297 \membersection{wxRect::SetWidth}\label{wxrectsetwidth}
 298
 299 \func{void}{SetWidth}{\param{int}{ width}}
 300
 301 Sets the width.
 302
 303
 304 \membersection{wxRect::SetX}\label{wxrectsetx}
 305
 306 \func{void}{SetX}{\param{int}{ x}}
 307
 308 Sets the x position.
 309
 310
 311 \membersection{wxRect::SetY}\label{wxrectsety}
 312
 313 \func{void}{SetY}{\param{int}{ y}}
 314
 315 Sets the y position.
 316
 317
 318 \membersection{wxRect::Union}\label{wxrectunion}
 319
 320 \constfunc{wxRect}{Union}{\param{const wxRect\&}{ rect}}
 321
 322 \func{wxRect\&}{Union}{\param{const wxRect\&}{ rect}}
 323
 324 Modifies the rectangle to contain the bounding box of this rectangle and the
 325 one passed in as parameter. The const version returns the new rectangle, the
 326 other one modifies this rectangle in place.
 327
 328
 329 \membersection{wxRect::operator $=$}\label{wxrectassign}
 330
 331 \func{void}{operator $=$}{\param{const wxRect\& }{rect}}
 332
 333 Assignment operator.
 334
 335
 336 \membersection{wxRect::operator $==$}\label{wxrectequal}
 337
 338 \func{bool}{operator $==$}{\param{const wxRect\& }{rect}}
 339
 340 Equality operator.
 341
 342
 343 \membersection{wxRect::operator $!=$}\label{wxrectnotequal}
 344
 345 \func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}
 346
 347 Inequality operator.
 348