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
);
429 void SetPosition(const wxPoint
& pos
);
436 void SetSize(const wxSize
& s
);
441 void SetWidth(int width
);
454 Set the left side of the rectangle.
456 Notice that because the rectangle stores its left side and width,
457 calling SetLeft() changes the right side position too -- but does
460 void SetLeft(int left
);
463 Set the right side of the rectangle.
465 Notice that this doesn't affect GetLeft() return value but changes the
466 rectangle width to set its right side to the given position.
468 void SetRight(int right
);
471 Set the top edge of the rectangle.
473 Notice that because the rectangle stores its top side and height,
474 calling SetTop() changes the bottom side position too -- but does
477 void SetTop(int top
);
480 Set the bottom edge of the rectangle.
482 Notice that this doesn't affect GetTop() return value but changes the
483 rectangle height to set its bottom side to the given position.
485 void SetBottom(int bottom
);
488 Set the top-left point of the rectangle.
490 void SetTopLeft(const wxPoint
&p
);
493 Set the bottom-right point of the rectangle.
495 void SetBottomRight(const wxPoint
&p
);
498 Set the top-right point of the rectangle.
500 void SetTopRight(const wxPoint
&p
);
503 Set the bottom-left point of the rectangle.
505 void SetBottomLeft(const wxPoint
&p
);
510 Modifies the rectangle to contain the bounding box of this rectangle
511 and the one passed in as parameter.
513 wxRect
Union(const wxRect
& rect
) const;
514 wxRect
& Union(const wxRect
& rect
);
520 bool operator !=(const wxRect
& r1
, const wxRect
& r2
);
524 Like Union(), but doesn't treat empty rectangles specially.
526 wxRect
operator +(const wxRect
& r1
, const wxRect
& r2
);
527 wxRect
& operator +=(const wxRect
& r
);
532 Returns the intersection of two rectangles (which may be empty).
534 wxRect
operator *(const wxRect
& r1
, const wxRect
& r2
);
535 wxRect
& operator *=(const wxRect
& r
);
541 wxRect
& operator=(const wxRect
& rect
);
546 bool operator ==(const wxRect
& r1
, const wxRect
& r2
);
559 x coordinate of the top-level corner of the rectangle.
564 y coordinate of the top-level corner of the rectangle.
574 A wxPoint is a useful data structure for graphics operations.
576 It contains integer @e x and @e y members.
577 See wxRealPoint for a floating point version.
579 Note that the width and height stored inside a wxPoint object may be negative
580 and that wxPoint functions do not perform any check against negative values
581 (this is used to e.g. store the special -1 value in ::wxDefaultPosition instance).
596 Initializes the internal x and y coordinates to zero.
601 Initializes the point object with the given @a x and @a y coordinates.
603 wxPoint(int x
, int y
);
606 Converts the given wxRealPoint (with floating point coordinates) to a
609 wxPoint(const wxRealPoint
& pt
);
612 @name Miscellaneous operators
614 Note that these operators are documented as class members
615 (to make them easier to find) but, as their prototype shows,
616 they are implemented as global operators; note that this is
617 transparent to the user but it helps to understand why the
618 following functions are documented to take the wxPoint they
619 operate on as an explicit argument.
622 wxPoint
& operator=(const wxPoint
& pt
);
624 bool operator ==(const wxPoint
& p1
, const wxPoint
& p2
);
625 bool operator !=(const wxPoint
& p1
, const wxPoint
& p2
);
627 wxPoint
operator +(const wxPoint
& p1
, const wxPoint
& p2
);
628 wxPoint
operator -(const wxPoint
& p1
, const wxPoint
& p2
);
630 wxPoint
& operator +=(const wxPoint
& pt
);
631 wxPoint
& operator -=(const wxPoint
& pt
);
633 wxPoint
operator +(const wxPoint
& pt
, const wxSize
& sz
);
634 wxPoint
operator -(const wxPoint
& pt
, const wxSize
& sz
);
635 wxPoint
operator +(const wxSize
& sz
, const wxPoint
& pt
);
636 wxPoint
operator -(const wxSize
& sz
, const wxPoint
& pt
);
638 wxPoint
& operator +=(const wxSize
& sz
);
639 wxPoint
& operator -=(const wxSize
& sz
);
641 wxSize
operator /(const wxPoint
& sz
, int factor
);
642 wxSize
operator *(const wxPoint
& sz
, int factor
);
643 wxSize
operator *(int factor
, const wxSize
& sz
);
644 wxSize
& operator /=(int factor
);
645 wxSize
& operator *=(int factor
);
650 @name Defaults handling.
652 Test for and set non-specified wxPoint components.
654 Although a wxPoint is always initialized to (0, 0), wxWidgets commonly
655 uses wxDefaultCoord (defined as @c -1) to indicate that a point hasn't
656 been initialized or specified. In particular, ::wxDefaultPosition is
657 used in many places with this meaning.
662 Returns @true if neither of the point components is equal to
665 This method is typically used before calling SetDefaults().
669 bool IsFullySpecified() const;
672 Combine this object with another one replacing the uninitialized
675 It is typically used like this:
678 if ( !pos.IsFullySpecified() )
680 pos.SetDefaults(GetDefaultPosition());
684 @see IsFullySpecified()
688 void SetDefaults(const wxPoint
& pt
);
703 Global instance of a wxPoint initialized with values (-1,-1).
705 const wxPoint wxDefaultPosition
;
709 @class wxColourDatabase
711 wxWidgets maintains a database of standard RGB colours for a predefined
712 set of named colours. The application may add to this set if desired by
713 using AddColour() and may use it to look up colours by names using Find()
714 or find the names for the standard colour using FindName().
716 There is one predefined, global instance of this class called
717 ::wxTheColourDatabase.
719 The standard database contains at least the following colours:
764 @n MEDIUM SPRING GREEN
802 class wxColourDatabase
806 Constructs the colour database. It will be initialized at the first
812 Adds a colour to the database. If a colour with the same name already
813 exists, it is replaced.
815 void AddColour(const wxString
& colourName
, const wxColour
& colour
);
818 Finds a colour given the name. Returns an invalid colour object (that
819 is, wxColour::IsOk() will return @false) if the colour wasn't found in
822 wxColour
Find(const wxString
& colourName
) const;
825 Finds a colour name given the colour. Returns an empty string if the
826 colour is not found in the database.
828 wxString
FindName(const wxColour
& colour
) const;
833 Global instance of a wxColourDatabase.
835 wxColourDatabase
* wxTheColourDatabase
;
841 A wxSize is a useful data structure for graphics operations.
842 It simply contains integer @e width and @e height members.
844 Note that the width and height stored inside a wxSize object may be negative
845 and that wxSize functions do not perform any check against negative values
846 (this is used to e.g. store the special -1 value in ::wxDefaultSize instance).
847 See also IsFullySpecified() and SetDefaults() for utility functions regarding
848 the special -1 value.
850 wxSize is used throughout wxWidgets as well as wxPoint which, although
851 almost equivalent to wxSize, has a different meaning: wxPoint represents a
852 position while wxSize represents the size.
860 @see wxPoint, wxRealPoint
866 Initializes this size object with zero width and height.
871 Initializes this size object with the given @a width and @a height.
873 wxSize(int width
, int height
);
877 Decreases the size in both x and y directions.
881 void DecBy(const wxPoint
& pt
);
882 void DecBy(const wxSize
& size
);
883 void DecBy(int dx
, int dy
);
888 Decrements this object so that both of its dimensions are not greater
889 than the corresponding dimensions of the @a size.
893 void DecTo(const wxSize
& size
);
896 Decrements this object to be not bigger than the given size ignoring
897 non-specified components.
899 This is similar to DecTo() but doesn't do anything for x or y
900 component if the same component of @a size is not specified, i.e. set
905 void DecToIfSpecified(const wxSize
& size
);
908 Gets the height member.
910 int GetHeight() const;
913 Gets the width member.
915 int GetWidth() const;
919 Increases the size in both x and y directions.
923 void IncBy(const wxPoint
& pt
);
924 void IncBy(const wxSize
& size
);
925 void IncBy(int dx
, int dy
);
930 Increments this object so that both of its dimensions are not less than
931 the corresponding dimensions of the @a size.
935 void IncTo(const wxSize
& size
);
938 Returns @true if neither of the size object components is equal to -1,
939 which is used as default for the size values in wxWidgets (hence the
940 predefined ::wxDefaultSize has both of its components equal to -1).
942 This method is typically used before calling SetDefaults().
944 bool IsFullySpecified() const;
947 Scales the dimensions of this object by the given factors. If you want
948 to scale both dimensions by the same factor you can also use
951 @return A reference to this object (so that you can concatenate other
952 operations in the same line).
954 wxSize
& Scale(float xscale
, float yscale
);
957 Sets the width and height members.
959 void Set(int width
, int height
);
962 Combine this size object with another one replacing the default (i.e.\ equal to -1)
963 components of this object with those of the other. It is typically used like this:
966 if ( !size.IsFullySpecified() )
968 size.SetDefaults(GetDefaultSize());
972 @see IsFullySpecified()
974 void SetDefaults(const wxSize
& sizeDefault
);
979 void SetHeight(int height
);
984 void SetWidth(int width
);
988 @name Miscellaneous operators
990 Note that these operators are documented as class members
991 (to make them easier to find) but, as their prototype shows,
992 they are implemented as global operators; note that this is
993 transparent to the user but it helps to understand why the
994 following functions are documented to take the wxSize they
995 operate on as an explicit argument.
998 wxSize
& operator=(const wxSize
& sz
);
1000 bool operator ==(const wxSize
& s1
, const wxSize
& s2
);
1001 bool operator !=(const wxSize
& s1
, const wxSize
& s2
);
1003 wxSize
operator +(const wxSize
& s1
, const wxSize
& s2
);
1004 wxSize
operator -(const wxSize
& s1
, const wxSize
& s2
);
1005 wxSize
& operator +=(const wxSize
& sz
);
1006 wxSize
& operator -=(const wxSize
& sz
);
1008 wxSize
operator /(const wxSize
& sz
, int factor
);
1009 wxSize
operator *(const wxSize
& sz
, int factor
);
1010 wxSize
operator *(int factor
, const wxSize
& sz
);
1011 wxSize
& operator /=(int factor
);
1012 wxSize
& operator *=(int factor
);
1017 Global instance of a wxSize object initialized to (-1,-1).
1019 const wxSize wxDefaultSize
;
1024 // ============================================================================
1025 // Global functions/macros
1026 // ============================================================================
1028 /** @addtogroup group_funcmacro_gdi */
1032 This macro loads a bitmap from either application resources (on the
1033 platforms for which they exist, i.e. Windows and OS2) or from an XPM file.
1034 This can help to avoid using @ifdef_ when creating bitmaps.
1036 @see @ref overview_bitmap, wxICON()
1038 @header{wx/gdicmn.h}
1040 #define wxBITMAP(bitmapName)
1043 Creates a bitmap from either application resources or embedded image data
1046 This macro is similar to wxBITMAP() but works with bitmap data in PNG
1047 format and not BMP or XPM.
1049 Under Windows the given @a bitmapName must be present in the application
1050 resource file with the type @c RCDATA and refer to a PNG image. I.e. you
1051 should have a definition similar to the following in your @c .rc file:
1053 mybitmap RCDATA "mybitmap.png"
1055 to be able to use @c wxBITMAP_PNG(mybitmap) in the code.
1057 Under OS X the file with the specified name and "png" extension must be
1058 present in the "Resources" subdirectory of the application bundle.
1060 Under the other platforms, this is equivalent to wxBITMAP_PNG_FROM_DATA()
1061 and so loads the image data from the array called @c bitmapName_png that
1062 must exist. Notice that it @e must be an array and not a pointer as the
1063 macro needs to be able to determine its size. Such an array can be produced
1064 by a number of conversion programs. A very simple one is included in
1065 wxWidgets distribution as @c misc/scripts/png2c.py.
1067 Finally notice that you must register PNG image handler to be able to
1068 load bitmaps from PNG data. This can be done either by calling
1069 wxInitAllImageHandlers() which also registers all the other image formats
1070 or including the necessary header:
1072 #include <wx/imagpng.h>
1076 wxImage::AddHandler(new wxPNGHandler);
1078 in your application startup code.
1080 @see wxBITMAP_PNG_FROM_DATA()
1082 @header{wx/gdicmn.h}
1086 #define wxBITMAP_PNG(bitmapName)
1089 Creates a bitmap from embedded image data in PNG format.
1091 This macro is a thin wrapper around wxBitmap::NewFromPNGData() and takes
1092 just the base name of the array containing the image data and computes its
1093 size internally. In other words, the array called @c bitmapName_png must
1094 exist. Notice that it @e must be an array and not a pointer as the macro
1095 needs to be able to determine its size. Such an array can be produced by a
1096 number of conversion programs. A very simple one is included in wxWidgets
1097 distribution as @c misc/scripts/png2c.py.
1099 You can use wxBITMAP_PNG() to load the PNG bitmaps from resources on the
1100 platforms that support this and only fall back to loading them from data
1101 under the other ones (i.e. not Windows and not OS X).
1103 @header{wx/gdicmn.h}
1107 #define wxBITMAP_PNG_FROM_DATA(bitmapName)
1110 This macro loads an icon from either application resources (on the
1111 platforms for which they exist, i.e. Windows and OS2) or from an XPM file.
1112 This can help to avoid using @ifdef_ when creating icons.
1114 @see @ref overview_bitmap, wxBITMAP()
1116 @header{wx/gdicmn.h}
1118 #define wxICON(iconName)
1121 Returns @true if the display is colour, @false otherwise.
1123 @header{wx/gdicmn.h}
1125 bool wxColourDisplay();
1128 Returns the depth of the display (a value of 1 denotes a monochrome
1131 @header{wx/gdicmn.h}
1133 int wxDisplayDepth();
1136 Globally sets the cursor; only has an effect on Windows, Mac and GTK+. You
1137 should call this function with wxNullCursor to restore the system cursor.
1139 @see wxCursor, wxWindow::SetCursor()
1141 @header{wx/gdicmn.h}
1143 void wxSetCursor(const wxCursor
& cursor
);
1147 /** @addtogroup group_funcmacro_gdi */
1150 Returns the dimensions of the work area on the display. On Windows this
1151 means the area not covered by the taskbar, etc. Other platforms are
1152 currently defaulting to the whole display until a way is found to provide
1153 this info for all window managers, etc.
1155 @header{wx/gdicmn.h}
1157 void wxClientDisplayRect(int* x
, int* y
, int* width
, int* height
);
1158 wxRect
wxGetClientDisplayRect();
1161 /** @addtogroup group_funcmacro_gdi */
1164 Returns the display resolution in pixels per inch.
1166 The @c x component of the returned wxSize object contains the horizontal
1167 resolution and the @c y one -- the vertical resolution.
1169 @header{wx/gdicmn.h}
1173 wxSize
wxGetDisplayPPI();
1176 /** @addtogroup group_funcmacro_gdi */
1179 Returns the display size in pixels.
1181 For the version taking @a width and @a header arguments, either of them
1182 can be @NULL if the caller is not interested in the returned value.
1184 @header{wx/gdicmn.h}
1186 void wxDisplaySize(int* width
, int* height
);
1187 wxSize
wxGetDisplaySize();
1190 /** @addtogroup group_funcmacro_gdi */
1193 Returns the display size in millimeters.
1195 For the version taking @a width and @a header arguments, either of them
1196 can be @NULL if the caller is not interested in the returned value.
1198 @see wxGetDisplayPPI()
1200 @header{wx/gdicmn.h}
1202 void wxDisplaySizeMM(int* width
, int* height
);
1203 wxSize
wxGetDisplaySizeMM();