More initial reviews of d* interface headers.

[wxWidgets.git] / interface / gdicmn.h

diff --git a/interface/gdicmn.h b/interface/gdicmn.h
index 74f15a61c7f3395974aec4b06666f733c2326001..724de72b8486b21a450669c4915c66c69f251aac 100644 (file)
--- a/interface/gdicmn.h
+++ b/interface/gdicmn.h
@@ -8,7 +8,9 @@
 
 
 /**
-    Bitmap flags.
+    Bitmap type flags.
+
+    See wxBitmap and wxImage classes.
 */
 enum wxBitmapType
 {
@@ -50,6 +52,8 @@ enum wxBitmapType
 
 /**
     Standard cursors.
+
+    See wxCursor.
 */
 enum wxStockCursor
 {
@@ -98,6 +102,7 @@ enum wxStockCursor
     @wxheader{gdicmn.h}
 
     A @b wxRealPoint is a useful data structure for graphics operations.
+
     It contains floating point @e x and @e y members.
     See also wxPoint for an integer version.
 
@@ -109,16 +114,22 @@ enum wxStockCursor
 class wxRealPoint
 {
 public:
-    //@{
+    wxRealPoint();
+
     /**
-        Create a point.
-        double  x
-        double  y
-        Members of the @b wxRealPoint object.
+        Initializes the point with the given coordinates.
     */
-    wxRealPoint();
     wxRealPoint(double x, double y);
-    //@}
+
+    /**
+        X coordinate of this point.
+    */
+    double x;
+
+    /**
+        Y coordinate of this point.
+    */
+    double y;
 };
 
 
@@ -270,9 +281,9 @@ public:
         rectangle thus change by 2*@a dx and 2*@e dy, respectively.) If one or
         both of @a dx and @a dy are negative, the opposite happens: the rectangle
         size decreases in the respective direction.
-        Inflating and deflating behaves "naturally''. Defined more precisely, that
+        Inflating and deflating behaves "naturally". Defined more precisely, that
         means:
-             "Real'' inflates (that is, @a dx and/or @a dy = 0) are not
+             "Real" inflates (that is, @a dx and/or @a dy = 0) are not
                 constrained. Thus inflating a rectangle can cause its upper left corner
                 to move into the negative numbers. (the versions prior to 2.5.4 forced
                 the top left coordinate to not fall below (0, 0), which implied a
@@ -423,6 +434,9 @@ public:
     @library{wxcore}
     @category{data}
 
+    @stdobjects
+    ::wxDefaultPosition
+
     @see wxRealPoint
 */
 class wxPoint
@@ -468,6 +482,10 @@ public:
     */
 };
 
+/**
+    Global istance of a wxPoint initialized with values -1;-1.
+*/
+wxPoint wxDefaultPosition;
 
 
 /**
@@ -475,7 +493,7 @@ public:
     @wxheader{gdicmn.h}
 
     wxWidgets maintains a database of standard RGB colours for a predefined
-    set of named colours (such as "BLACK'', "LIGHT GREY''). The
+    set of named colours (such as "BLACK", "LIGHT GREY"). The
     application may add to this set if desired by using
     wxColourDatabase::AddColour and may use it to look up
     colours by names using wxColourDatabase::Find or find the names
@@ -524,49 +542,6 @@ public:
 };
 
 
-
-/**
-    @class wxFontList
-    @wxheader{gdicmn.h}
-
-    A font list is a list containing all fonts which have been created. There
-    is only one instance of this class: @b wxTheFontList.  Use this object to search
-    for a previously created font of the desired type and create it if not already
-    found.
-    In some windowing systems, the font may be a scarce resource, so it is best to
-    reuse old resources if possible.  When an application finishes, all fonts will
-    be
-    deleted and their resources freed, eliminating the possibility of 'memory
-    leaks'.
-
-    @library{wxcore}
-    @category{gdi}
-
-    @see wxFont
-*/
-class wxFontList : public wxList
-{
-public:
-    /**
-        Constructor. The application should not construct its own font list:
-        use the object pointer @b wxTheFontList.
-    */
-    wxFontList();
-
-    /**
-        Finds a font of the given specification, or creates one and adds it to the
-        list. See the @ref wxFont::ctor "wxFont constructor" for
-        details of the arguments.
-    */
-    wxFont* FindOrCreateFont(int point_size, int family, int style,
-                             int weight,
-                             bool underline = false,
-                             const wxString& facename = NULL,
-                             wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
-};
-
-
-
 /**
     @class wxSize
     @wxheader{gdicmn.h}
@@ -582,10 +557,12 @@ public:
     named @c width and @c height since it makes much more sense for
     sizes.
 
-
     @library{wxcore}
     @category{data}
 
+    @stdobjects
+    ::wxDefaultSize
+
     @see wxPoint, wxRealPoint
 */
 class wxSize
@@ -715,6 +692,10 @@ public:
     void SetWidth(int width);
 };
 
+/**
+    Global instance of a wxSize object initialized with values -1;-1.
+*/
+wxSize wxDefaultSize;