Doc and comment cleanup, fixes, tweaks

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

diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h
index b5fb341b214f18ecfc8b066e218e34820a414e8f..188ad9382cd63d6d6175b07998bc16c5b3c2ceee 100644 (file)
--- a/interface/wx/gdicmn.h
+++ b/interface/wx/gdicmn.h
@@ -612,7 +612,7 @@ public:
         is, wxColour::IsOk() will return @false) if the colour wasn't found in
         the database.
     */
         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
 
     /**
         Finds a colour name given the colour. Returns an empty string if the


@@ -852,11 +852,29 @@ void wxClientDisplayRect(int* x, int* y, int* width, int* height);
 wxRect wxGetClientDisplayRect();
 //@}
 
 wxRect wxGetClientDisplayRect();
 //@}
 

+/** @ingroup 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();
+//@}
+

 /** @ingroup group_funcmacro_gdi */
 //@{
 /**
     Returns the display size in pixels.
 
 /** @ingroup 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);
     @header{wx/gdicmn.h}
 */
 void wxDisplaySize(int* width, int* height);


@@ -868,6 +886,11 @@ wxSize wxGetDisplaySize();
 /**
     Returns the display size in millimeters.
 
 /**
     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);
     @header{wx/gdicmn.h}
 */
 void wxDisplaySizeMM(int* width, int* height);