1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxRealPoint
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
11 Bitmap type flags. See wxBitmap and wxImage classes.
15 wxBITMAP_TYPE_INVALID
,
17 wxBITMAP_TYPE_BMP_RESOURCE
,
18 wxBITMAP_TYPE_RESOURCE
= wxBITMAP_TYPE_BMP_RESOURCE
,
20 wxBITMAP_TYPE_ICO_RESOURCE
,
22 wxBITMAP_TYPE_CUR_RESOURCE
,
24 wxBITMAP_TYPE_XBM_DATA
,
26 wxBITMAP_TYPE_XPM_DATA
,
28 wxBITMAP_TYPE_TIF
= wxBITMAP_TYPE_TIFF
,
29 wxBITMAP_TYPE_TIFF_RESOURCE
,
30 wxBITMAP_TYPE_TIF_RESOURCE
= wxBITMAP_TYPE_TIFF_RESOURCE
,
32 wxBITMAP_TYPE_GIF_RESOURCE
,
34 wxBITMAP_TYPE_PNG_RESOURCE
,
36 wxBITMAP_TYPE_JPEG_RESOURCE
,
38 wxBITMAP_TYPE_PNM_RESOURCE
,
40 wxBITMAP_TYPE_PCX_RESOURCE
,
42 wxBITMAP_TYPE_PICT_RESOURCE
,
44 wxBITMAP_TYPE_ICON_RESOURCE
,
48 wxBITMAP_TYPE_MACCURSOR
,
49 wxBITMAP_TYPE_MACCURSOR_RESOURCE
,
50 wxBITMAP_TYPE_ANY
= 50
54 Polygon filling mode. See wxDC::DrawPolygon.
56 enum wxPolygonFillMode
65 Notice that under wxMSW some of these cursors are defined in @c wx.rc file
66 and not by the system itself so you should include this file from your own
67 resource file (possibly creating a trivial resource file just containing a
68 single include line if you don't need it otherwise) to be able to use them.
75 wxCURSOR_ARROW
, ///< A standard arrow cursor.
76 wxCURSOR_RIGHT_ARROW
, ///< A standard arrow cursor pointing to the right.
77 wxCURSOR_BULLSEYE
, ///< Bullseye cursor.
78 wxCURSOR_CHAR
, ///< Rectangular character cursor.
79 wxCURSOR_CROSS
, ///< A cross cursor.
80 wxCURSOR_HAND
, ///< A hand cursor.
81 wxCURSOR_IBEAM
, ///< An I-beam cursor (vertical line).
82 wxCURSOR_LEFT_BUTTON
, ///< Represents a mouse with the left button depressed.
83 wxCURSOR_MAGNIFIER
, ///< A magnifier icon.
84 wxCURSOR_MIDDLE_BUTTON
, ///< Represents a mouse with the middle button depressed.
85 wxCURSOR_NO_ENTRY
, ///< A no-entry sign cursor.
86 wxCURSOR_PAINT_BRUSH
, ///< A paintbrush cursor.
87 wxCURSOR_PENCIL
, ///< A pencil cursor.
88 wxCURSOR_POINT_LEFT
, ///< A cursor that points left.
89 wxCURSOR_POINT_RIGHT
, ///< A cursor that points right.
90 wxCURSOR_QUESTION_ARROW
, ///< An arrow and question mark.
91 wxCURSOR_RIGHT_BUTTON
, ///< Represents a mouse with the right button depressed.
92 wxCURSOR_SIZENESW
, ///< A sizing cursor pointing NE-SW.
93 wxCURSOR_SIZENS
, ///< A sizing cursor pointing N-S.
94 wxCURSOR_SIZENWSE
, ///< A sizing cursor pointing NW-SE.
95 wxCURSOR_SIZEWE
, ///< A sizing cursor pointing W-E.
96 wxCURSOR_SIZING
, ///< A general sizing cursor.
97 wxCURSOR_SPRAYCAN
, ///< A spraycan cursor.
98 wxCURSOR_WAIT
, ///< A wait cursor.
99 wxCURSOR_WATCH
, ///< A watch cursor.
100 wxCURSOR_BLANK
, ///< Transparent cursor.
101 wxCURSOR_DEFAULT
, ///< Standard X11 cursor (only in wxGTK).
102 wxCURSOR_COPY_ARROW
, ///< MacOS Theme Plus arrow (only in wxMac).
103 wxCURSOR_CROSS_REVERSE
, ///< Only available on wxX11.
104 wxCURSOR_DOUBLE_ARROW
, ///< Only available on wxX11.
105 wxCURSOR_BASED_ARROW_UP
, ///< Only available on wxX11.
106 wxCURSOR_BASED_ARROW_DOWN
, ///< Only available on wxX11.
107 wxCURSOR_ARROWWAIT
, ///< A wait cursor with a standard arrow.
116 A wxRealPoint is a useful data structure for graphics operations.
118 It contains floating point @e x and @e y members.
119 See wxPoint for an integer version.
121 Note that the coordinates stored inside a wxRealPoint object may be negative
122 and that wxRealPoint functions do not perform any check against negative values.
133 Initializes to zero the x and y members.
138 Initializes the point with the given coordinates.
140 wxRealPoint(double x
, double y
);
143 Converts the given wxPoint (with integer coordinates) to a wxRealPoint.
145 wxRealPoint(const wxPoint
& pt
);
148 @name Miscellaneous operators
150 Note that these operators are documented as class members
151 (to make them easier to find) but, as their prototype shows,
152 they are implemented as global operators; note that this is
153 transparent to the user but it helps to understand why the
154 following functions are documented to take the wxPoint they
155 operate on as an explicit argument.
158 wxRealPoint
& operator=(const wxRealPoint
& pt
);
160 bool operator ==(const wxRealPoint
& p1
, const wxRealPoint
& p2
);
161 bool operator !=(const wxRealPoint
& p1
, const wxRealPoint
& p2
);
163 wxRealPoint
operator +(const wxRealPoint
& p1
, const wxRealPoint
& p2
);
164 wxRealPoint
operator -(const wxRealPoint
& p1
, const wxRealPoint
& p2
);
166 wxRealPoint
& operator +=(const wxRealPoint
& pt
);
167 wxRealPoint
& operator -=(const wxRealPoint
& pt
);
169 wxRealPoint
operator +(const wxRealPoint
& pt
, const wxSize
& sz
);
170 wxRealPoint
operator -(const wxRealPoint
& pt
, const wxSize
& sz
);
171 wxRealPoint
operator +(const wxSize
& sz
, const wxRealPoint
& pt
);
172 wxRealPoint
operator -(const wxSize
& sz
, const wxRealPoint
& pt
);
174 wxRealPoint
& operator +=(const wxSize
& sz
);
175 wxRealPoint
& operator -=(const wxSize
& sz
);
177 wxSize
operator /(const wxRealPoint
& sz
, int factor
);
178 wxSize
operator *(const wxRealPoint
& sz
, int factor
);
179 wxSize
operator *(int factor
, const wxSize
& sz
);
180 wxSize
& operator /=(int factor
);
181 wxSize
& operator *=(int factor
);
185 X coordinate of this point.
190 Y coordinate of this point.
200 A class for manipulating rectangles.
202 Note that the x, y coordinates and the width and height stored inside a wxRect
203 object may be negative and that wxRect functions do not perform any check against
216 Initializes to zero the internal @a x, @a y, @a width and @a height members.
220 Creates a wxRect object from @a x, @a y, @a width and @a height values.
222 wxRect(int x
, int y
, int width
, int height
);
224 Creates a wxRect object from top-left and bottom-right points.
226 wxRect(const wxPoint
& topLeft
, const wxPoint
& bottomRight
);
228 Creates a wxRect object from position @a pos and @a size values.
230 wxRect(const wxPoint
& pos
, const wxSize
& size
);
232 Creates a wxRect object from @a size values at the origin.
234 wxRect(const wxSize
& size
);
238 Returns the rectangle having the same size as this one but centered
239 relatively to the given rectangle @a r. By default, rectangle is
240 centred in both directions but if @a dir includes only @c wxVERTICAL or
241 only @c wxHORIZONTAL, then it is only centered in this direction while
242 the other component of its position remains unchanged.
244 wxRect
CentreIn(const wxRect
& r
, int dir
= wxBOTH
) const;
245 wxRect
CenterIn(const wxRect
& r
, int dir
= wxBOTH
) const;
249 Returns @true if the given point is inside the rectangle (or on its
250 boundary) and @false otherwise.
252 bool Contains(int x
, int y
) const;
254 Returns @true if the given point is inside the rectangle (or on its
255 boundary) and @false otherwise.
257 bool Contains(const wxPoint
& pt
) const;
259 Returns @true if the given rectangle is completely inside this
260 rectangle (or touches its boundary) and @false otherwise.
262 bool Contains(const wxRect
& rect
) const;
266 Decrease the rectangle size.
268 This method is the opposite from Inflate(): Deflate(a, b) is equivalent
269 to Inflate(-a, -b). Please refer to Inflate() for full description.
271 wxRect
& Deflate(wxCoord dx
, wxCoord dy
);
272 wxRect
& Deflate(const wxSize
& diff
);
273 wxRect
& Deflate(wxCoord diff
);
274 wxRect
Deflate(wxCoord dx
, wxCoord dy
) const;
278 Gets the bottom point of the rectangle.
280 int GetBottom() const;
283 Gets the position of the bottom left corner.
285 wxPoint
GetBottomLeft() const;
288 Gets the position of the bottom right corner.
290 wxPoint
GetBottomRight() const;
293 Gets the height member.
295 int GetHeight() const;
298 Gets the left point of the rectangle (the same as GetX()).
305 wxPoint
GetPosition() const;
308 Gets the right point of the rectangle.
310 int GetRight() const;
317 wxSize
GetSize() const;
320 Gets the top point of the rectangle (the same as GetY()).
325 Gets the position of the top left corner of the rectangle, same as
328 wxPoint
GetTopLeft() const;
331 Gets the position of the top right corner.
333 wxPoint
GetTopRight() const;
336 Gets the width member.
338 int GetWidth() const;
352 Increases the size of the rectangle.
354 The left border is moved farther left and the right border is moved
355 farther right by @a dx. The upper border is moved farther up and the
356 bottom border is moved farther down by @a dy. (Note that the width and
357 height of the rectangle thus change by 2*dx and 2*dy, respectively.) If
358 one or both of @a dx and @a dy are negative, the opposite happens: the
359 rectangle size decreases in the respective direction.
361 Inflating and deflating behaves "naturally". Defined more precisely,
363 -# "Real" inflates (that is, @a dx and/or @a dy = 0) are not
364 constrained. Thus inflating a rectangle can cause its upper left
365 corner to move into the negative numbers. (2.5.4 and older forced
366 the top left coordinate to not fall below (0, 0), which implied a
367 forced move of the rectangle.)
368 -# Deflates are clamped to not reduce the width or height of the
369 rectangle below zero. In such cases, the top-left corner is
370 nonetheless handled properly. For example, a rectangle at (10, 10)
371 with size (20, 40) that is inflated by (-15, -15) will become
372 located at (20, 25) at size (0, 10). Finally, observe that the width
373 and height are treated independently. In the above example, the
374 width is reduced by 20, whereas the height is reduced by the full 30
375 (rather than also stopping at 20, when the width reached zero).
379 wxRect
& Inflate(wxCoord dx
, wxCoord dy
);
380 wxRect
& Inflate(const wxSize
& diff
);
381 wxRect
& Inflate(wxCoord diff
);
382 wxRect
Inflate(wxCoord dx
, wxCoord dy
) const;
386 Modifies this rectangle to contain the overlapping portion of this rectangle
387 and the one passed in as parameter.
389 @return This rectangle, modified.
391 wxRect
& Intersect(const wxRect
& rect
);
394 Returns the overlapping portion of this rectangle and the one passed in as
397 wxRect
Intersect(const wxRect
& rect
) const;
400 Returns @true if this rectangle has a non-empty intersection with the
401 rectangle @a rect and @false otherwise.
403 bool Intersects(const wxRect
& rect
) const;
406 Returns @true if this rectangle has a width or height less than or
407 equal to 0 and @false otherwise.
409 bool IsEmpty() const;
413 Moves the rectangle by the specified offset. If @a dx is positive, the
414 rectangle is moved to the right, if @a dy is positive, it is moved to the
415 bottom, otherwise it is moved to the left or top respectively.
417 void Offset(wxCoord dx
, wxCoord dy
);
418 void Offset(const wxPoint
& pt
);
424 void SetHeight(int height
);
431 void SetSize(const wxSize
& s
);
436 void SetWidth(int width
);
450 Modifies the rectangle to contain the bounding box of this rectangle
451 and the one passed in as parameter.
453 wxRect
Union(const wxRect
& rect
) const;
454 wxRect
& Union(const wxRect
& rect
);
460 bool operator !=(const wxRect
& r1
, const wxRect
& r2
);
464 Like Union(), but doesn't treat empty rectangles specially.
466 wxRect
operator +(const wxRect
& r1
, const wxRect
& r2
);
467 wxRect
& operator +=(const wxRect
& r
);
472 Returns the intersection of two rectangles (which may be empty).
474 wxRect
operator *(const wxRect
& r1
, const wxRect
& r2
);
475 wxRect
& operator *=(const wxRect
& r
);
481 wxRect
& operator=(const wxRect
& rect
);
486 bool operator ==(const wxRect
& r1
, const wxRect
& r2
);
499 x coordinate of the top-level corner of the rectangle.
504 y coordinate of the top-level corner of the rectangle.
514 A wxPoint is a useful data structure for graphics operations.
516 It contains integer @e x and @e y members.
517 See wxRealPoint for a floating point version.
519 Note that the width and height stored inside a wxPoint object may be negative
520 and that wxPoint functions do not perform any check against negative values
521 (this is used to e.g. store the special -1 value in ::wxDefaultPosition instance).
536 Initializes the internal x and y coordinates to zero.
541 Initializes the point object with the given @a x and @a y coordinates.
543 wxPoint(int x
, int y
);
546 Converts the given wxRealPoint (with floating point coordinates) to a
549 wxPoint(const wxRealPoint
& pt
);
552 @name Miscellaneous operators
554 Note that these operators are documented as class members
555 (to make them easier to find) but, as their prototype shows,
556 they are implemented as global operators; note that this is
557 transparent to the user but it helps to understand why the
558 following functions are documented to take the wxPoint they
559 operate on as an explicit argument.
562 wxPoint
& operator=(const wxPoint
& pt
);
564 bool operator ==(const wxPoint
& p1
, const wxPoint
& p2
);
565 bool operator !=(const wxPoint
& p1
, const wxPoint
& p2
);
567 wxPoint
operator +(const wxPoint
& p1
, const wxPoint
& p2
);
568 wxPoint
operator -(const wxPoint
& p1
, const wxPoint
& p2
);
570 wxPoint
& operator +=(const wxPoint
& pt
);
571 wxPoint
& operator -=(const wxPoint
& pt
);
573 wxPoint
operator +(const wxPoint
& pt
, const wxSize
& sz
);
574 wxPoint
operator -(const wxPoint
& pt
, const wxSize
& sz
);
575 wxPoint
operator +(const wxSize
& sz
, const wxPoint
& pt
);
576 wxPoint
operator -(const wxSize
& sz
, const wxPoint
& pt
);
578 wxPoint
& operator +=(const wxSize
& sz
);
579 wxPoint
& operator -=(const wxSize
& sz
);
581 wxSize
operator /(const wxPoint
& sz
, int factor
);
582 wxSize
operator *(const wxPoint
& sz
, int factor
);
583 wxSize
operator *(int factor
, const wxSize
& sz
);
584 wxSize
& operator /=(int factor
);
585 wxSize
& operator *=(int factor
);
590 @name Defaults handling.
592 Test for and set non-specified wxPoint components.
594 Although a wxPoint is always initialized to (0, 0), wxWidgets commonly
595 uses wxDefaultCoord (defined as @c -1) to indicate that a point hasn't
596 been initialized or specified. In particular, ::wxDefaultPosition is
597 used in many places with this meaning.
602 Returns @true if neither of the point components is equal to
605 This method is typically used before calling SetDefaults().
609 bool IsFullySpecified() const;
612 Combine this object with another one replacing the uninitialized
615 It is typically used like this:
618 if ( !pos.IsFullySpecified() )
620 pos.SetDefaults(GetDefaultPosition());
624 @see IsFullySpecified()
628 void SetDefaults(const wxPoint
& pt
);
643 Global instance of a wxPoint initialized with values (-1,-1).
645 const wxPoint wxDefaultPosition
;
649 @class wxColourDatabase
651 wxWidgets maintains a database of standard RGB colours for a predefined
652 set of named colours. The application may add to this set if desired by
653 using AddColour() and may use it to look up colours by names using Find()
654 or find the names for the standard colour using FindName().
656 There is one predefined, global instance of this class called
657 ::wxTheColourDatabase.
659 The standard database contains at least the following colours:
704 @n MEDIUM SPRING GREEN
742 class wxColourDatabase
746 Constructs the colour database. It will be initialized at the first
752 Adds a colour to the database. If a colour with the same name already
753 exists, it is replaced.
755 void AddColour(const wxString
& colourName
, const wxColour
& colour
);
758 Finds a colour given the name. Returns an invalid colour object (that
759 is, wxColour::IsOk() will return @false) if the colour wasn't found in
762 wxColour
Find(const wxString
& colourName
) const;
765 Finds a colour name given the colour. Returns an empty string if the
766 colour is not found in the database.
768 wxString
FindName(const wxColour
& colour
) const;
773 Global instance of a wxColourDatabase.
775 wxColourDatabase
* wxTheColourDatabase
;
781 A wxSize is a useful data structure for graphics operations.
782 It simply contains integer @e width and @e height members.
784 Note that the width and height stored inside a wxSize object may be negative
785 and that wxSize functions do not perform any check against negative values
786 (this is used to e.g. store the special -1 value in ::wxDefaultSize instance).
787 See also IsFullySpecified() and SetDefaults() for utility functions regarding
788 the special -1 value.
790 wxSize is used throughout wxWidgets as well as wxPoint which, although
791 almost equivalent to wxSize, has a different meaning: wxPoint represents a
792 position while wxSize represents the size.
800 @see wxPoint, wxRealPoint
806 Initializes this size object with zero width and height.
811 Initializes this size object with the given @a width and @a height.
813 wxSize(int width
, int height
);
817 Decreases the size in both x and y directions.
821 void DecBy(const wxPoint
& pt
);
822 void DecBy(const wxSize
& size
);
823 void DecBy(int dx
, int dy
);
828 Decrements this object so that both of its dimensions are not greater
829 than the corresponding dimensions of the @a size.
833 void DecTo(const wxSize
& size
);
836 Gets the height member.
838 int GetHeight() const;
841 Gets the width member.
843 int GetWidth() const;
847 Increases the size in both x and y directions.
851 void IncBy(const wxPoint
& pt
);
852 void IncBy(const wxSize
& size
);
853 void IncBy(int dx
, int dy
);
858 Increments this object so that both of its dimensions are not less than
859 the corresponding dimensions of the @a size.
863 void IncTo(const wxSize
& size
);
866 Returns @true if neither of the size object components is equal to -1,
867 which is used as default for the size values in wxWidgets (hence the
868 predefined ::wxDefaultSize has both of its components equal to -1).
870 This method is typically used before calling SetDefaults().
872 bool IsFullySpecified() const;
875 Scales the dimensions of this object by the given factors. If you want
876 to scale both dimensions by the same factor you can also use
879 @return A reference to this object (so that you can concatenate other
880 operations in the same line).
882 wxSize
& Scale(float xscale
, float yscale
);
885 Sets the width and height members.
887 void Set(int width
, int height
);
890 Combine this size object with another one replacing the default (i.e.
891 equal to -1) components of this object with those of the other. It is
892 typically used like this:
895 if ( !size.IsFullySpecified() )
897 size.SetDefaults(GetDefaultSize());
901 @see IsFullySpecified()
903 void SetDefaults(const wxSize
& sizeDefault
);
908 void SetHeight(int height
);
913 void SetWidth(int width
);
917 @name Miscellaneous operators
919 Note that these operators are documented as class members
920 (to make them easier to find) but, as their prototype shows,
921 they are implemented as global operators; note that this is
922 transparent to the user but it helps to understand why the
923 following functions are documented to take the wxSize they
924 operate on as an explicit argument.
927 wxSize
& operator=(const wxSize
& sz
);
929 bool operator ==(const wxSize
& s1
, const wxSize
& s2
);
930 bool operator !=(const wxSize
& s1
, const wxSize
& s2
);
932 wxSize
operator +(const wxSize
& s1
, const wxSize
& s2
);
933 wxSize
operator -(const wxSize
& s1
, const wxSize
& s2
);
934 wxSize
& operator +=(const wxSize
& sz
);
935 wxSize
& operator -=(const wxSize
& sz
);
937 wxSize
operator /(const wxSize
& sz
, int factor
);
938 wxSize
operator *(const wxSize
& sz
, int factor
);
939 wxSize
operator *(int factor
, const wxSize
& sz
);
940 wxSize
& operator /=(int factor
);
941 wxSize
& operator *=(int factor
);
946 Global instance of a wxSize object initialized to (-1,-1).
948 const wxSize wxDefaultSize
;
953 // ============================================================================
954 // Global functions/macros
955 // ============================================================================
957 /** @addtogroup group_funcmacro_gdi */
961 This macro loads a bitmap from either application resources (on the
962 platforms for which they exist, i.e. Windows and OS2) or from an XPM file.
963 This can help to avoid using @ifdef_ when creating bitmaps.
965 @see @ref overview_bitmap, wxICON()
969 #define wxBITMAP(bitmapName)
972 This macro loads an icon from either application resources (on the
973 platforms for which they exist, i.e. Windows and OS2) or from an XPM file.
974 This can help to avoid using @ifdef_ when creating icons.
976 @see @ref overview_bitmap, wxBITMAP()
980 #define wxICON(iconName)
983 Returns @true if the display is colour, @false otherwise.
987 bool wxColourDisplay();
990 Returns the depth of the display (a value of 1 denotes a monochrome
995 int wxDisplayDepth();
998 Globally sets the cursor; only has an effect on Windows, Mac and GTK+. You
999 should call this function with wxNullCursor to restore the system cursor.
1001 @see wxCursor, wxWindow::SetCursor()
1003 @header{wx/gdicmn.h}
1005 void wxSetCursor(const wxCursor
& cursor
);
1009 /** @addtogroup group_funcmacro_gdi */
1012 Returns the dimensions of the work area on the display. On Windows this
1013 means the area not covered by the taskbar, etc. Other platforms are
1014 currently defaulting to the whole display until a way is found to provide
1015 this info for all window managers, etc.
1017 @header{wx/gdicmn.h}
1019 void wxClientDisplayRect(int* x
, int* y
, int* width
, int* height
);
1020 wxRect
wxGetClientDisplayRect();
1023 /** @addtogroup group_funcmacro_gdi */
1026 Returns the display resolution in pixels per inch.
1028 The @c x component of the returned wxSize object contains the horizontal
1029 resolution and the @c y one -- the vertical resolution.
1031 @header{wx/gdicmn.h}
1035 wxSize
wxGetDisplayPPI();
1038 /** @addtogroup group_funcmacro_gdi */
1041 Returns the display size in pixels.
1043 For the version taking @a width and @a header arguments, either of them
1044 can be @NULL if the caller is not interested in the returned value.
1046 @header{wx/gdicmn.h}
1048 void wxDisplaySize(int* width
, int* height
);
1049 wxSize
wxGetDisplaySize();
1052 /** @addtogroup group_funcmacro_gdi */
1055 Returns the display size in millimeters.
1057 For the version taking @a width and @a header arguments, either of them
1058 can be @NULL if the caller is not interested in the returned value.
1060 @see wxGetDisplayPPI()
1062 @header{wx/gdicmn.h}
1064 void wxDisplaySizeMM(int* width
, int* height
);
1065 wxSize
wxGetDisplaySizeMM();