]> git.saurik.com Git - wxWidgets.git/blame - interface/wx/gdicmn.h
Fixed bug: wxPropertyGridInterface::SetPropertyReadOnly() with wxPG_DONT_RECURSE...
[wxWidgets.git] / interface / wx / gdicmn.h
CommitLineData
23324ae1
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: gdicmn.h
e54c96f1 3// Purpose: interface of wxRealPoint
23324ae1
FM
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
698d17c3
FM
9
10/**
3d2cf884 11 Bitmap type flags. See wxBitmap and wxImage classes.
698d17c3
FM
12*/
13enum wxBitmapType
14{
15 wxBITMAP_TYPE_INVALID,
16 wxBITMAP_TYPE_BMP,
17 wxBITMAP_TYPE_BMP_RESOURCE,
18 wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
19 wxBITMAP_TYPE_ICO,
20 wxBITMAP_TYPE_ICO_RESOURCE,
21 wxBITMAP_TYPE_CUR,
22 wxBITMAP_TYPE_CUR_RESOURCE,
23 wxBITMAP_TYPE_XBM,
24 wxBITMAP_TYPE_XBM_DATA,
25 wxBITMAP_TYPE_XPM,
26 wxBITMAP_TYPE_XPM_DATA,
27 wxBITMAP_TYPE_TIF,
28 wxBITMAP_TYPE_TIF_RESOURCE,
29 wxBITMAP_TYPE_GIF,
30 wxBITMAP_TYPE_GIF_RESOURCE,
31 wxBITMAP_TYPE_PNG,
32 wxBITMAP_TYPE_PNG_RESOURCE,
33 wxBITMAP_TYPE_JPEG,
34 wxBITMAP_TYPE_JPEG_RESOURCE,
35 wxBITMAP_TYPE_PNM,
36 wxBITMAP_TYPE_PNM_RESOURCE,
37 wxBITMAP_TYPE_PCX,
38 wxBITMAP_TYPE_PCX_RESOURCE,
39 wxBITMAP_TYPE_PICT,
40 wxBITMAP_TYPE_PICT_RESOURCE,
41 wxBITMAP_TYPE_ICON,
42 wxBITMAP_TYPE_ICON_RESOURCE,
43 wxBITMAP_TYPE_ANI,
44 wxBITMAP_TYPE_IFF,
45 wxBITMAP_TYPE_TGA,
46 wxBITMAP_TYPE_MACCURSOR,
47 wxBITMAP_TYPE_MACCURSOR_RESOURCE,
48 wxBITMAP_TYPE_ANY = 50
49};
50
808f5a3a
FM
51/**
52 Polygon filling mode. See wxDC::DrawPolygon.
53*/
54enum wxPolygonFillMode
55{
56 wxODDEVEN_RULE = 1,
57 wxWINDING_RULE
58};
59
698d17c3 60/**
3d2cf884 61 Standard cursors. See wxCursor.
698d17c3
FM
62*/
63enum wxStockCursor
64{
65 wxCURSOR_NONE,
3d2cf884
BP
66 wxCURSOR_ARROW, ///< A standard arrow cursor.
67 wxCURSOR_RIGHT_ARROW, ///< A standard arrow cursor pointing to the right.
68 wxCURSOR_BULLSEYE, ///< Bullseye cursor.
69 wxCURSOR_CHAR, ///< Rectangular character cursor.
70 wxCURSOR_CROSS, ///< A cross cursor.
71 wxCURSOR_HAND, ///< A hand cursor.
72 wxCURSOR_IBEAM, ///< An I-beam cursor (vertical line).
73 wxCURSOR_LEFT_BUTTON, ///< Represents a mouse with the left button depressed.
74 wxCURSOR_MAGNIFIER, ///< A magnifier icon.
75 wxCURSOR_MIDDLE_BUTTON, ///< Represents a mouse with the middle button depressed.
76 wxCURSOR_NO_ENTRY, ///< A no-entry sign cursor.
77 wxCURSOR_PAINT_BRUSH, ///< A paintbrush cursor.
78 wxCURSOR_PENCIL, ///< A pencil cursor.
79 wxCURSOR_POINT_LEFT, ///< A cursor that points left.
80 wxCURSOR_POINT_RIGHT, ///< A cursor that points right.
81 wxCURSOR_QUESTION_ARROW, ///< An arrow and question mark.
82 wxCURSOR_RIGHT_BUTTON, ///< Represents a mouse with the right button depressed.
83 wxCURSOR_SIZENESW, ///< A sizing cursor pointing NE-SW.
84 wxCURSOR_SIZENS, ///< A sizing cursor pointing N-S.
85 wxCURSOR_SIZENWSE, ///< A sizing cursor pointing NW-SE.
86 wxCURSOR_SIZEWE, ///< A sizing cursor pointing W-E.
87 wxCURSOR_SIZING, ///< A general sizing cursor.
88 wxCURSOR_SPRAYCAN, ///< A spraycan cursor.
89 wxCURSOR_WAIT, ///< A wait cursor.
90 wxCURSOR_WATCH, ///< A watch cursor.
91 wxCURSOR_BLANK, ///< Transparent cursor.
92 wxCURSOR_DEFAULT, ///< Standard X11 cursor (only in wxGTK).
93 wxCURSOR_COPY_ARROW , ///< MacOS Theme Plus arrow (only in wxMac).
94 wxCURSOR_CROSS_REVERSE, ///< Only available on wxX11.
95 wxCURSOR_DOUBLE_ARROW, ///< Only available on wxX11.
96 wxCURSOR_BASED_ARROW_UP, ///< Only available on wxX11.
97 wxCURSOR_BASED_ARROW_DOWN, ///< Only available on wxX11.
98 wxCURSOR_ARROWWAIT, ///< A wait cursor with a standard arrow.
698d17c3
FM
99 wxCURSOR_MAX
100};
101
102
103
23324ae1
FM
104/**
105 @class wxRealPoint
7c913512 106
3d2cf884 107 A wxRealPoint is a useful data structure for graphics operations.
65874118 108
f834ee48
FM
109 It contains floating point @e x and @e y members.
110 See wxPoint for an integer version.
111
112 Note that the coordinates stored inside a wxRealPoint object may be negative
113 and that wxRealPoint functions do not perform any check against negative values.
7c913512 114
23324ae1
FM
115 @library{wxcore}
116 @category{data}
7c913512 117
e54c96f1 118 @see wxPoint
23324ae1 119*/
7c913512 120class wxRealPoint
23324ae1
FM
121{
122public:
f834ee48
FM
123 /**
124 Initializes to zero the x and y members.
125 */
65874118
FM
126 wxRealPoint();
127
23324ae1 128 /**
65874118 129 Initializes the point with the given coordinates.
23324ae1 130 */
7c913512 131 wxRealPoint(double x, double y);
65874118
FM
132
133 /**
134 X coordinate of this point.
135 */
136 double x;
137
138 /**
139 Y coordinate of this point.
140 */
141 double y;
23324ae1
FM
142};
143
144
e54c96f1 145
23324ae1
FM
146/**
147 @class wxRect
7c913512 148
23324ae1 149 A class for manipulating rectangles.
7c913512 150
f834ee48
FM
151 Note that the x, y coordinates and the width and height stored inside a wxRect
152 object may be negative and that wxRect functions do not perform any check against
153 negative values.
154
23324ae1
FM
155 @library{wxcore}
156 @category{data}
7c913512 157
e54c96f1 158 @see wxPoint, wxSize
23324ae1 159*/
7c913512 160class wxRect
23324ae1
FM
161{
162public:
23324ae1 163 /**
3d2cf884 164 Default constructor.
f834ee48 165 Initializes to zero the internal @a x, @a y, @a width and @a height members.
23324ae1
FM
166 */
167 wxRect();
3d2cf884
BP
168 /**
169 Creates a wxRect object from @a x, @a y, @a width and @a height values.
170 */
7c913512 171 wxRect(int x, int y, int width, int height);
3d2cf884
BP
172 /**
173 Creates a wxRect object from top-left and bottom-right points.
174 */
7c913512 175 wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
3d2cf884 176 /**
f834ee48 177 Creates a wxRect object from position @a pos and @a size values.
3d2cf884 178 */
7c913512 179 wxRect(const wxPoint& pos, const wxSize& size);
3d2cf884
BP
180 /**
181 Creates a wxRect object from @a size values at the origin.
182 */
7c913512 183 wxRect(const wxSize& size);
23324ae1
FM
184
185 //@{
186 /**
3d2cf884
BP
187 Returns the rectangle having the same size as this one but centered
188 relatively to the given rectangle @a r. By default, rectangle is
189 centred in both directions but if @a dir includes only @c wxVERTICAL or
190 only @c wxHORIZONTAL, then it is only centered in this direction while
23324ae1
FM
191 the other component of its position remains unchanged.
192 */
328f5751 193 wxRect CentreIn(const wxRect& r, int dir = wxBOTH) const;
3d2cf884 194 wxRect CenterIn(const wxRect& r, int dir = wxBOTH) const;
23324ae1
FM
195 //@}
196
23324ae1 197 /**
3d2cf884
BP
198 Returns @true if the given point is inside the rectangle (or on its
199 boundary) and @false otherwise.
23324ae1 200 */
328f5751 201 bool Contains(int x, int y) const;
3d2cf884
BP
202 /**
203 Returns @true if the given point is inside the rectangle (or on its
204 boundary) and @false otherwise.
205 */
206 bool Contains(const wxPoint& pt) const;
207 /**
208 Returns @true if the given rectangle is completely inside this
209 rectangle (or touches its boundary) and @false otherwise.
210 */
211 bool Contains(const wxRect& rect) const;
23324ae1
FM
212
213 //@{
214 /**
215 Decrease the rectangle size.
8024723d 216
3d2cf884
BP
217 This method is the opposite from Inflate(): Deflate(a, b) is equivalent
218 to Inflate(-a, -b). Please refer to Inflate() for full description.
23324ae1 219 */
3d2cf884
BP
220 void Deflate(wxCoord dx, wxCoord dy);
221 void Deflate(const wxSize& diff);
222 void Deflate(wxCoord diff);
328f5751 223 wxRect Deflate(wxCoord dx, wxCoord dy) const;
23324ae1
FM
224 //@}
225
226 /**
227 Gets the bottom point of the rectangle.
228 */
328f5751 229 int GetBottom() const;
23324ae1
FM
230
231 /**
232 Gets the position of the bottom left corner.
233 */
328f5751 234 wxPoint GetBottomLeft() const;
23324ae1
FM
235
236 /**
237 Gets the position of the bottom right corner.
238 */
328f5751 239 wxPoint GetBottomRight() const;
23324ae1
FM
240
241 /**
242 Gets the height member.
243 */
328f5751 244 int GetHeight() const;
23324ae1
FM
245
246 /**
3d2cf884 247 Gets the left point of the rectangle (the same as GetX()).
23324ae1 248 */
328f5751 249 int GetLeft() const;
23324ae1
FM
250
251 /**
252 Gets the position.
253 */
328f5751 254 wxPoint GetPosition() const;
23324ae1
FM
255
256 /**
257 Gets the right point of the rectangle.
258 */
328f5751 259 int GetRight() const;
23324ae1
FM
260
261 /**
262 Gets the size.
8024723d 263
4cc4bfaf 264 @see SetSize()
23324ae1 265 */
328f5751 266 wxSize GetSize() const;
23324ae1
FM
267
268 /**
3d2cf884 269 Gets the top point of the rectangle (the same as GetY()).
23324ae1 270 */
328f5751 271 int GetTop() const;
23324ae1
FM
272
273 /**
7c913512 274 Gets the position of the top left corner of the rectangle, same as
23324ae1
FM
275 GetPosition().
276 */
328f5751 277 wxPoint GetTopLeft() const;
23324ae1
FM
278
279 /**
280 Gets the position of the top right corner.
281 */
328f5751 282 wxPoint GetTopRight() const;
23324ae1
FM
283
284 /**
285 Gets the width member.
286 */
328f5751 287 int GetWidth() const;
23324ae1
FM
288
289 /**
290 Gets the x member.
291 */
328f5751 292 int GetX() const;
23324ae1
FM
293
294 /**
295 Gets the y member.
296 */
328f5751 297 int GetY() const;
23324ae1
FM
298
299 //@{
300 /**
301 Increases the size of the rectangle.
3d2cf884
BP
302
303 The left border is moved farther left and the right border is moved
304 farther right by @a dx. The upper border is moved farther up and the
305 bottom border is moved farther down by @a dy. (Note the the width and
306 height of the rectangle thus change by 2*dx and 2*dy, respectively.) If
307 one or both of @a dx and @a dy are negative, the opposite happens: the
308 rectangle size decreases in the respective direction.
309
310 Inflating and deflating behaves "naturally". Defined more precisely,
311 that means:
312 -# "Real" inflates (that is, @a dx and/or @a dy = 0) are not
313 constrained. Thus inflating a rectangle can cause its upper left
314 corner to move into the negative numbers. (2.5.4 and older forced
315 the top left coordinate to not fall below (0, 0), which implied a
316 forced move of the rectangle.)
317 -# Deflates are clamped to not reduce the width or height of the
318 rectangle below zero. In such cases, the top-left corner is
319 nonetheless handled properly. For example, a rectangle at (10, 10)
320 with size (20, 40) that is inflated by (-15, -15) will become
321 located at (20, 25) at size (0, 10). Finally, observe that the width
322 and height are treated independently. In the above example, the
323 width is reduced by 20, whereas the height is reduced by the full 30
324 (rather than also stopping at 20, when the width reached zero).
8024723d 325
4cc4bfaf 326 @see Deflate()
23324ae1 327 */
3d2cf884
BP
328 void Inflate(wxCoord dx, wxCoord dy);
329 void Inflate(const wxSize& diff);
330 void Inflate(wxCoord diff);
328f5751 331 wxRect Inflate(wxCoord dx, wxCoord dy) const;
23324ae1
FM
332 //@}
333
23324ae1 334 /**
c909e907 335 Modifies this rectangle to contain the overlapping portion of this rectangle
3d2cf884 336 and the one passed in as parameter.
c909e907
FM
337
338 @return This rectangle, modified.
23324ae1 339 */
3d2cf884 340 wxRect& Intersect(const wxRect& rect);
c909e907
FM
341
342 /**
343 Returns the overlapping portion of this rectangle and the one passed in as
344 parameter.
345 */
346 wxRect Intersect(const wxRect& rect) const;
23324ae1
FM
347
348 /**
349 Returns @true if this rectangle has a non-empty intersection with the
4cc4bfaf 350 rectangle @a rect and @false otherwise.
23324ae1 351 */
328f5751 352 bool Intersects(const wxRect& rect) const;
23324ae1
FM
353
354 /**
3d2cf884
BP
355 Returns @true if this rectangle has a width or height less than or
356 equal to 0 and @false otherwise.
23324ae1 357 */
328f5751 358 bool IsEmpty() const;
23324ae1
FM
359
360 //@{
361 /**
4cc4bfaf
FM
362 Moves the rectangle by the specified offset. If @a dx is positive, the
363 rectangle is moved to the right, if @a dy is positive, it is moved to the
23324ae1
FM
364 bottom, otherwise it is moved to the left or top respectively.
365 */
366 void Offset(wxCoord dx, wxCoord dy);
7c913512 367 void Offset(const wxPoint& pt);
23324ae1
FM
368 //@}
369
370 /**
371 Sets the height.
372 */
373 void SetHeight(int height);
374
375 /**
376 Sets the size.
8024723d 377
4cc4bfaf 378 @see GetSize()
23324ae1
FM
379 */
380 void SetSize(const wxSize& s);
381
382 /**
383 Sets the width.
384 */
385 void SetWidth(int width);
386
387 /**
388 Sets the x position.
389 */
4cc4bfaf 390 void SetX(int x);
23324ae1
FM
391
392 /**
393 Sets the y position.
394 */
4cc4bfaf 395 void SetY(int y);
23324ae1
FM
396
397 //@{
398 /**
3d2cf884
BP
399 Modifies the rectangle to contain the bounding box of this rectangle
400 and the one passed in as parameter.
23324ae1 401 */
3d2cf884
BP
402 wxRect Union(const wxRect& rect) const;
403 wxRect& Union(const wxRect& rect);
23324ae1
FM
404 //@}
405
406 /**
3d2cf884 407 Inequality operator.
23324ae1 408 */
3d2cf884 409 bool operator !=(const wxRect& r1, const wxRect& r2);
23324ae1 410
3d2cf884
BP
411 //@{
412 /**
413 Like Union(), but doesn't treat empty rectangles specially.
414 */
415 wxRect operator +(const wxRect& r1, const wxRect& r2);
416 wxRect& operator +=(const wxRect& r);
417 //@}
23324ae1
FM
418
419 //@{
420 /**
421 Returns the intersection of two rectangles (which may be empty).
422 */
3d2cf884
BP
423 wxRect operator *(const wxRect& r1, const wxRect& r2);
424 wxRect& operator *=(const wxRect& r);
23324ae1
FM
425 //@}
426
427 /**
428 Assignment operator.
429 */
5267aefd 430 wxRect& operator=(const wxRect& rect);
23324ae1
FM
431
432 /**
433 Equality operator.
434 */
435 bool operator ==(const wxRect& r1, const wxRect& r2);
436
437 /**
3d2cf884 438 Height member.
23324ae1 439 */
3d2cf884 440 int height;
23324ae1 441
3d2cf884
BP
442 /**
443 Width member.
444 */
445 int width;
23324ae1
FM
446
447 /**
23324ae1
FM
448 x coordinate of the top-level corner of the rectangle.
449 */
3d2cf884 450 int x;
23324ae1
FM
451
452 /**
23324ae1
FM
453 y coordinate of the top-level corner of the rectangle.
454 */
3d2cf884 455 int y;
23324ae1
FM
456};
457
458
e54c96f1 459
23324ae1
FM
460/**
461 @class wxPoint
7c913512 462
3d2cf884 463 A wxPoint is a useful data structure for graphics operations.
7c913512 464
f834ee48
FM
465 It contains integer @e x and @e y members.
466 See wxRealPoint for a floating point version.
467
468 Note that the width and height stored inside a wxPoint object may be negative
469 and that wxPoint functions do not perform any check against negative values
470 (this is used to e.g. store the special -1 value in ::wxDefaultPosition instance).
7c913512 471
23324ae1
FM
472 @library{wxcore}
473 @category{data}
7c913512 474
65874118
FM
475 @stdobjects
476 ::wxDefaultPosition
477
e54c96f1 478 @see wxRealPoint
23324ae1 479*/
7c913512 480class wxPoint
23324ae1
FM
481{
482public:
23324ae1 483 /**
3d2cf884 484 Constructs a point.
f834ee48 485 Initializes the internal x and y coordinates to zero.
23324ae1
FM
486 */
487 wxPoint();
f834ee48
FM
488
489 /**
490 Initializes the point object with the given @a x and @a y coordinates.
491 */
7c913512 492 wxPoint(int x, int y);
23324ae1 493
23324ae1 494 /**
f834ee48 495 @name Miscellaneous operators
23324ae1 496 */
f834ee48 497 //@{
5267aefd 498 wxPoint& operator=(const wxPoint& pt);
3d2cf884 499
7c913512
FM
500 bool operator ==(const wxPoint& p1, const wxPoint& p2);
501 bool operator !=(const wxPoint& p1, const wxPoint& p2);
3d2cf884 502
7c913512
FM
503 wxPoint operator +(const wxPoint& p1, const wxPoint& p2);
504 wxPoint operator -(const wxPoint& p1, const wxPoint& p2);
3d2cf884
BP
505
506 wxPoint& operator +=(const wxPoint& pt);
507 wxPoint& operator -=(const wxPoint& pt);
508
7c913512
FM
509 wxPoint operator +(const wxPoint& pt, const wxSize& sz);
510 wxPoint operator -(const wxPoint& pt, const wxSize& sz);
511 wxPoint operator +(const wxSize& sz, const wxPoint& pt);
512 wxPoint operator -(const wxSize& sz, const wxPoint& pt);
3d2cf884
BP
513
514 wxPoint& operator +=(const wxSize& sz);
515 wxPoint& operator -=(const wxSize& sz);
f834ee48
FM
516 //@}
517
23324ae1 518 /**
23324ae1
FM
519 x member.
520 */
3d2cf884 521 int x;
23324ae1
FM
522
523 /**
23324ae1
FM
524 y member.
525 */
3d2cf884 526 int y;
23324ae1
FM
527};
528
65874118 529/**
3d2cf884 530 Global istance of a wxPoint initialized with values (-1,-1).
65874118
FM
531*/
532wxPoint wxDefaultPosition;
23324ae1 533
e54c96f1 534
23324ae1
FM
535/**
536 @class wxColourDatabase
7c913512 537
23324ae1 538 wxWidgets maintains a database of standard RGB colours for a predefined
3d2cf884
BP
539 set of named colours. The application may add to this set if desired by
540 using AddColour() and may use it to look up colours by names using Find()
541 or find the names for the standard colour using FindName().
542
543 There is one predefined, global instance of this class called
544 ::wxTheColourDatabase.
545
546 The standard database contains at least the following colours:
547
548 @beginTable
549 <tr><td>
550 AQUAMARINE
551 @n BLACK
552 @n BLUE
553 @n BLUE VIOLET
554 @n BROWN
555 @n CADET BLUE
556 @n CORAL
557 @n CORNFLOWER BLUE
558 @n CYAN
559 @n DARK GREY
560 @n DARK GREEN
561 @n DARK OLIVE GREEN
562 @n DARK ORCHID
563 @n DARK SLATE BLUE
564 @n DARK SLATE GREY
565 @n DARK TURQUOISE
566 @n DIM GREY
567 </td><td>
568 FIREBRICK
569 @n FOREST GREEN
570 @n GOLD
571 @n GOLDENROD
572 @n GREY
573 @n GREEN
574 @n GREEN YELLOW
575 @n INDIAN RED
576 @n KHAKI
577 @n LIGHT BLUE
578 @n LIGHT GREY
579 @n LIGHT STEEL BLUE
580 @n LIME GREEN
581 @n MAGENTA
582 @n MAROON
583 @n MEDIUM AQUAMARINE
584 @n MEDIUM BLUE
585 </td><td>
586 MEDIUM FOREST GREEN
587 @n MEDIUM GOLDENROD
588 @n MEDIUM ORCHID
589 @n MEDIUM SEA GREEN
590 @n MEDIUM SLATE BLUE
591 @n MEDIUM SPRING GREEN
592 @n MEDIUM TURQUOISE
593 @n MEDIUM VIOLET RED
594 @n MIDNIGHT BLUE
595 @n NAVY
596 @n ORANGE
597 @n ORANGE RED
598 @n ORCHID
599 @n PALE GREEN
600 @n PINK
601 @n PLUM
602 @n PURPLE
603 </td><td>
604 RED
605 @n SALMON
606 @n SEA GREEN
607 @n SIENNA
608 @n SKY BLUE
609 @n SLATE BLUE
610 @n SPRING GREEN
611 @n STEEL BLUE
612 @n TAN
613 @n THISTLE
614 @n TURQUOISE
615 @n VIOLET
616 @n VIOLET RED
617 @n WHEAT
618 @n WHITE
619 @n YELLOW
620 @n YELLOW GREEN
621 </td></tr>
622 @endTable
7c913512 623
23324ae1 624 @library{wxcore}
3d2cf884 625 @category{gdi}
7c913512 626
e54c96f1 627 @see wxColour
23324ae1 628*/
7c913512 629class wxColourDatabase
23324ae1
FM
630{
631public:
632 /**
3d2cf884
BP
633 Constructs the colour database. It will be initialized at the first
634 use.
23324ae1
FM
635 */
636 wxColourDatabase();
637
23324ae1 638 /**
3d2cf884
BP
639 Adds a colour to the database. If a colour with the same name already
640 exists, it is replaced.
23324ae1 641 */
3d2cf884 642 void AddColour(const wxString& colourName, const wxColour& colour);
23324ae1
FM
643
644 /**
3d2cf884
BP
645 Finds a colour given the name. Returns an invalid colour object (that
646 is, wxColour::IsOk() will return @false) if the colour wasn't found in
647 the database.
23324ae1 648 */
adaaa686 649 wxColour Find(const wxString& colourName) const;
23324ae1
FM
650
651 /**
3d2cf884
BP
652 Finds a colour name given the colour. Returns an empty string if the
653 colour is not found in the database.
23324ae1 654 */
328f5751 655 wxString FindName(const wxColour& colour) const;
23324ae1
FM
656};
657
658
23324ae1
FM
659/**
660 @class wxSize
7c913512 661
f834ee48
FM
662 A wxSize is a useful data structure for graphics operations.
663 It simply contains integer @e width and @e height members.
664
665 Note that the width and height stored inside a wxSize object may be negative
666 and that wxSize functions do not perform any check against negative values
667 (this is used to e.g. store the special -1 value in ::wxDefaultSize instance).
668 See also IsFullySpecified() and SetDefaults() for utility functions regarding
669 the special -1 value.
7c913512 670
3d2cf884
BP
671 wxSize is used throughout wxWidgets as well as wxPoint which, although
672 almost equivalent to wxSize, has a different meaning: wxPoint represents a
673 position while wxSize represents the size.
7c913512 674
3d2cf884
BP
675 @beginWxPythonOnly
676 wxPython defines aliases for the @e x and @e y members named @e width and
677 @e height since it makes much more sense for sizes.
678 @endWxPythonOnly
7c913512 679
23324ae1
FM
680 @library{wxcore}
681 @category{data}
7c913512 682
65874118
FM
683 @stdobjects
684 ::wxDefaultSize
685
e54c96f1 686 @see wxPoint, wxRealPoint
23324ae1 687*/
7c913512 688class wxSize
23324ae1
FM
689{
690public:
23324ae1 691 /**
f834ee48 692 Initializes this size object with zero width and height.
23324ae1
FM
693 */
694 wxSize();
f834ee48
FM
695
696 /**
697 Initializes this size object with the given @a width and @a height.
698 */
7c913512 699 wxSize(int width, int height);
23324ae1
FM
700
701 //@{
702 /**
3d2cf884 703 Decreases the size in both x and y directions.
8024723d 704
4cc4bfaf 705 @see IncBy()
23324ae1
FM
706 */
707 void DecBy(const wxSize& size);
7c913512
FM
708 void DecBy(int dx, int dy);
709 void DecBy(int d);
23324ae1
FM
710 //@}
711
712 /**
3d2cf884
BP
713 Decrements this object so that both of its dimensions are not greater
714 than the corresponding dimensions of the @a size.
8024723d 715
4cc4bfaf 716 @see IncTo()
23324ae1
FM
717 */
718 void DecTo(const wxSize& size);
719
720 /**
721 Gets the height member.
722 */
328f5751 723 int GetHeight() const;
23324ae1
FM
724
725 /**
726 Gets the width member.
727 */
328f5751 728 int GetWidth() const;
23324ae1
FM
729
730 //@{
731 /**
3d2cf884 732 Increases the size in both x and y directions.
8024723d 733
4cc4bfaf 734 @see DecBy()
23324ae1
FM
735 */
736 void IncBy(const wxSize& size);
7c913512
FM
737 void IncBy(int dx, int dy);
738 void IncBy(int d);
23324ae1
FM
739 //@}
740
741 /**
3d2cf884
BP
742 Increments this object so that both of its dimensions are not less than
743 the corresponding dimensions of the @a size.
8024723d 744
4cc4bfaf 745 @see DecTo()
23324ae1
FM
746 */
747 void IncTo(const wxSize& size);
748
749 /**
3d2cf884
BP
750 Returns @true if neither of the size object components is equal to -1,
751 which is used as default for the size values in wxWidgets (hence the
752 predefined ::wxDefaultSize has both of its components equal to -1).
753
754 This method is typically used before calling SetDefaults().
23324ae1 755 */
328f5751 756 bool IsFullySpecified() const;
23324ae1 757
23324ae1 758 /**
3d2cf884
BP
759 Scales the dimensions of this object by the given factors. If you want
760 to scale both dimensions by the same factor you can also use
761 operator*=().
23324ae1 762
d29a9a8a 763 @return A reference to this object (so that you can concatenate other
3d2cf884 764 operations in the same line).
23324ae1 765 */
3d2cf884 766 wxSize& Scale(float xscale, float yscale);
23324ae1
FM
767
768 /**
769 Sets the width and height members.
770 */
4cc4bfaf 771 void Set(int width, int height);
23324ae1
FM
772
773 /**
3d2cf884
BP
774 Combine this size object with another one replacing the default (i.e.
775 equal to -1) components of this object with those of the other. It is
776 typically used like this:
777
778 @code
779 if ( !size.IsFullySpecified() )
780 {
781 size.SetDefaults(GetDefaultSize());
782 }
783 @endcode
8024723d 784
4cc4bfaf 785 @see IsFullySpecified()
23324ae1
FM
786 */
787 void SetDefaults(const wxSize& sizeDefault);
788
789 /**
790 Sets the height.
791 */
792 void SetHeight(int height);
793
794 /**
795 Sets the width.
796 */
797 void SetWidth(int width);
3d2cf884 798
f834ee48 799
3d2cf884 800 /**
f834ee48 801 @name Miscellaneous operators
3d2cf884 802 */
f834ee48 803 //@{
5267aefd 804 wxSize& operator=(const wxSize& sz);
3d2cf884
BP
805
806 bool operator ==(const wxSize& s1, const wxSize& s2);
807 bool operator !=(const wxSize& s1, const wxSize& s2);
808
809 wxSize operator +(const wxSize& s1, const wxSize& s2);
810 wxSize operator -(const wxSize& s1, const wxSize& s2);
811 wxSize& operator +=(const wxSize& sz);
812 wxSize& operator -=(const wxSize& sz);
813
814 wxSize operator /(const wxSize& sz, int factor);
815 wxSize operator *(const wxSize& sz, int factor);
816 wxSize operator *(int factor, const wxSize& sz);
817 wxSize& operator /=(int factor);
818 wxSize& operator *=(int factor);
f834ee48 819 //@}
23324ae1
FM
820};
821
65874118 822/**
3d2cf884 823 Global instance of a wxSize object initialized to (-1,-1).
65874118
FM
824*/
825wxSize wxDefaultSize;
23324ae1 826
e54c96f1 827
23324ae1 828
e54c96f1 829
23324ae1
FM
830// ============================================================================
831// Global functions/macros
832// ============================================================================
833
b21126db 834/** @addtogroup group_funcmacro_gdi */
23324ae1 835//@{
c83e60aa 836
23324ae1 837/**
a055a116
BP
838 This macro loads a bitmap from either application resources (on the
839 platforms for which they exist, i.e. Windows and OS2) or from an XPM file.
840 This can help to avoid using @ifdef_ when creating bitmaps.
841
842 @see @ref overview_bitmap, wxICON()
843
844 @header{wx/gdicmn.h}
23324ae1 845*/
a055a116 846#define wxBITMAP(bitmapName)
23324ae1 847
23324ae1 848/**
a055a116
BP
849 This macro loads an icon from either application resources (on the
850 platforms for which they exist, i.e. Windows and OS2) or from an XPM file.
851 This can help to avoid using @ifdef_ when creating icons.
852
853 @see @ref overview_bitmap, wxBITMAP()
854
855 @header{wx/gdicmn.h}
23324ae1 856*/
808f5a3a 857#define wxICON(iconName)
23324ae1 858
23324ae1 859/**
a055a116
BP
860 Returns @true if the display is colour, @false otherwise.
861
862 @header{wx/gdicmn.h}
23324ae1 863*/
a055a116 864bool wxColourDisplay();
23324ae1
FM
865
866/**
a055a116
BP
867 Returns the depth of the display (a value of 1 denotes a monochrome
868 display).
7c913512 869
a055a116 870 @header{wx/gdicmn.h}
23324ae1 871*/
a055a116 872int wxDisplayDepth();
23324ae1
FM
873
874/**
a055a116
BP
875 Globally sets the cursor; only has an effect on Windows, Mac and GTK+. You
876 should call this function with wxNullCursor to restore the system cursor.
877
878 @see wxCursor, wxWindow::SetCursor()
879
880 @header{wx/gdicmn.h}
23324ae1 881*/
a055a116 882void wxSetCursor(const wxCursor& cursor);
23324ae1 883
a055a116
BP
884//@}
885
b21126db 886/** @addtogroup group_funcmacro_gdi */
a055a116 887//@{
23324ae1 888/**
a055a116
BP
889 Returns the dimensions of the work area on the display. On Windows this
890 means the area not covered by the taskbar, etc. Other platforms are
891 currently defaulting to the whole display until a way is found to provide
892 this info for all window managers, etc.
7c913512 893
a055a116 894 @header{wx/gdicmn.h}
23324ae1 895*/
a055a116
BP
896void wxClientDisplayRect(int* x, int* y, int* width, int* height);
897wxRect wxGetClientDisplayRect();
898//@}
23324ae1 899
b21126db 900/** @addtogroup group_funcmacro_gdi */
40fcf546
VS
901//@{
902/**
903 Returns the display resolution in pixels per inch.
904
ed9dd914
VZ
905 The @c x component of the returned wxSize object contains the horizontal
906 resolution and the @c y one -- the vertical resolution.
907
40fcf546
VS
908 @header{wx/gdicmn.h}
909
910 @since 2.9.0
911*/
912wxSize wxGetDisplayPPI();
913//@}
914
b21126db 915/** @addtogroup group_funcmacro_gdi */
a055a116 916//@{
23324ae1 917/**
a055a116
BP
918 Returns the display size in pixels.
919
ed9dd914
VZ
920 For the version taking @a width and @a header arguments, either of them
921 can be @NULL if the caller is not interested in the returned value.
922
a055a116 923 @header{wx/gdicmn.h}
23324ae1 924*/
a055a116
BP
925void wxDisplaySize(int* width, int* height);
926wxSize wxGetDisplaySize();
927//@}
928
b21126db 929/** @addtogroup group_funcmacro_gdi */
a055a116
BP
930//@{
931/**
932 Returns the display size in millimeters.
23324ae1 933
ed9dd914
VZ
934 For the version taking @a width and @a header arguments, either of them
935 can be @NULL if the caller is not interested in the returned value.
936
937 @see wxGetDisplayPPI()
938
a055a116
BP
939 @header{wx/gdicmn.h}
940*/
941void wxDisplaySizeMM(int* width, int* height);
942wxSize wxGetDisplaySizeMM();
c83e60aa
BP
943//@}
944