Better support for unspecified property value in wxDateProperty and DatePickerCtrl...

[wxWidgets.git] / interface / wx / gdicmn.h

diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h
index f415ecf9d81259c728e1b0179d9baa595bec6040..fb5089f7145a6eb8d79b84bcf89f2f9c597d6da4 100644 (file)
--- a/interface/wx/gdicmn.h
+++ b/interface/wx/gdicmn.h
@@ -94,7 +94,6 @@ enum wxStockCursor
 
 /**
     @class wxRealPoint
-    @wxheader{gdicmn.h}
 
     A wxRealPoint is a useful data structure for graphics operations.
 
@@ -131,7 +130,6 @@ public:
 
 /**
     @class wxRect
-    @wxheader{gdicmn.h}
 
     A class for manipulating rectangles.
 
@@ -313,14 +311,19 @@ public:
     wxRect Inflate(wxCoord dx, wxCoord dy) const;
     //@}
 
-    //@{
     /**
-        Modifies the rectangle to contain the overlapping box of this rectangle
+        Modifies this rectangle to contain the overlapping portion of this rectangle
         and the one passed in as parameter.
+
+        @return This rectangle, modified.
     */
-    wxRect Intersect(const wxRect& rect) const;
     wxRect& Intersect(const wxRect& rect);
-    //@}
+
+    /**
+        Returns the overlapping portion of this rectangle and the one passed in as
+        parameter.
+    */
+    wxRect Intersect(const wxRect& rect) const;
 
     /**
         Returns @true if this rectangle has a non-empty intersection with the
@@ -404,7 +407,7 @@ public:
     /**
         Assignment operator.
     */
-    void operator =(const wxRect& rect);
+    wxRect& operator=(const wxRect& rect);
 
     /**
         Equality operator.
@@ -436,7 +439,6 @@ public:
 
 /**
     @class wxPoint
-    @wxheader{gdicmn.h}
 
     A wxPoint is a useful data structure for graphics operations.
 
@@ -465,7 +467,7 @@ public:
     /**
         Assignment operator.
     */
-    void operator =(const wxPoint& pt);
+    wxPoint& operator=(const wxPoint& pt);
 
     bool operator ==(const wxPoint& p1, const wxPoint& p2);
     bool operator !=(const wxPoint& p1, const wxPoint& p2);
@@ -503,7 +505,6 @@ wxPoint wxDefaultPosition;
 
 /**
     @class wxColourDatabase
-    @wxheader{gdicmn.h}
 
     wxWidgets maintains a database of standard RGB colours for a predefined
     set of named colours. The application may add to this set if desired by
@@ -616,7 +617,7 @@ public:
         is, wxColour::IsOk() will return @false) if the colour wasn't found in
         the database.
     */
-    wxColour Find(const wxString& colourName);
+    wxColour Find(const wxString& colourName) const;
 
     /**
         Finds a colour name given the colour. Returns an empty string if the
@@ -628,7 +629,6 @@ public:
 
 /**
     @class wxSize
-    @wxheader{gdicmn.h}
 
     A wxSize is a useful data structure for graphics operations. It simply
     contains integer @e width and @e height members.
@@ -762,7 +762,7 @@ public:
     /**
         Assignment operator.
     */
-    void operator =(const wxSize& sz);
+    wxSize& operator=(const wxSize& sz);
 
     bool operator ==(const wxSize& s1, const wxSize& s2);
     bool operator !=(const wxSize& s1, const wxSize& s2);
@@ -791,7 +791,7 @@ wxSize wxDefaultSize;
 // Global functions/macros
 // ============================================================================
 
-/** @ingroup group_funcmacro_gdi */
+/** @addtogroup group_funcmacro_gdi */
 //@{
 
 /**
@@ -843,7 +843,7 @@ void wxSetCursor(const wxCursor& cursor);
 
 //@}
 
-/** @ingroup group_funcmacro_gdi */
+/** @addtogroup group_funcmacro_gdi */
 //@{
 /**
     Returns the dimensions of the work area on the display. On Windows this
@@ -857,22 +857,45 @@ void wxClientDisplayRect(int* x, int* y, int* width, int* height);
 wxRect wxGetClientDisplayRect();
 //@}
 
-/** @ingroup group_funcmacro_gdi */
+/** @addtogroup group_funcmacro_gdi */
+//@{
+/**
+    Returns the display resolution in pixels per inch.
+
+    The @c x component of the returned wxSize object contains the horizontal
+    resolution and the @c y one -- the vertical resolution.
+
+    @header{wx/gdicmn.h}
+
+    @since 2.9.0
+*/
+wxSize wxGetDisplayPPI();
+//@}
+
+/** @addtogroup group_funcmacro_gdi */
 //@{
 /**
     Returns the display size in pixels.
 
+    For the version taking @a width and @a header arguments, either of them
+    can be @NULL if the caller is not interested in the returned value.
+
     @header{wx/gdicmn.h}
 */
 void wxDisplaySize(int* width, int* height);
 wxSize wxGetDisplaySize();
 //@}
 
-/** @ingroup group_funcmacro_gdi */
+/** @addtogroup group_funcmacro_gdi */
 //@{
 /**
     Returns the display size in millimeters.
 
+    For the version taking @a width and @a header arguments, either of them
+    can be @NULL if the caller is not interested in the returned value.
+
+    @see wxGetDisplayPPI()
+
     @header{wx/gdicmn.h}
 */
 void wxDisplaySizeMM(int* width, int* height);