document new wxBLUE_PEN object; add some more details for standard object instances...

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58652 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/brush.h b/interface/wx/brush.h
index 3551a1d725ec6882e2dfe52ea009d8629685fc24..7af8e2f53384515a0a5ece4ee5b9959dde5eba31 100644 (file)
--- a/interface/wx/brush.h
+++ b/interface/wx/brush.h
@@ -20,10 +20,12 @@ enum wxBrushStyle
         /**< Transparent (no fill). */
 
     wxBRUSHSTYLE_STIPPLE_MASK_OPAQUE = wxSTIPPLE_MASK_OPAQUE,
         /**< Transparent (no fill). */
 
     wxBRUSHSTYLE_STIPPLE_MASK_OPAQUE = wxSTIPPLE_MASK_OPAQUE,

-        /**< @todo WHAT's THIS?? */
+        /**< Uses a bitmap as a stipple; the mask is used for blitting monochrome
+             using text foreground and background colors. */

 
     wxBRUSHSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK,
 
     wxBRUSHSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK,

-        /**< @todo WHAT's THIS?? */
+        /**< Uses a bitmap as a stipple; mask is used for masking areas in the
+             stipple bitmap. */

 
     wxBRUSHSTYLE_STIPPLE = wxSTIPPLE,
         /**< Uses a bitmap as a stipple. */
 
     wxBRUSHSTYLE_STIPPLE = wxSTIPPLE,
         /**< Uses a bitmap as a stipple. */


@@ -117,7 +119,7 @@ public:
 
     /**
         Constructs a stippled brush using a bitmap.
 
     /**
         Constructs a stippled brush using a bitmap.

-        The brush style will be set to wxBRUSHSTYLE_STIPPLE.
+        The brush style will be set to @c wxBRUSHSTYLE_STIPPLE.

     */
     wxBrush(const wxBitmap& stippleBitmap);
 
     */
     wxBrush(const wxBitmap& stippleBitmap);
 


@@ -147,7 +149,7 @@ public:
     virtual wxColour GetColour() const;
 
     /**
     virtual wxColour GetColour() const;
 
     /**

-        Gets a pointer to the stipple bitmap. If the brush does not have a wxBRUSHSTYLE_STIPPLE
+        Gets a pointer to the stipple bitmap. If the brush does not have a @c wxBRUSHSTYLE_STIPPLE

         style, this bitmap may be non-@NULL but uninitialised (i.e. wxBitmap:IsOk() returns @false).
 
         @see SetStipple()
         style, this bitmap may be non-@NULL but uninitialised (i.e. wxBitmap:IsOk() returns @false).
 
         @see SetStipple()


@@ -191,9 +193,9 @@ public:
         @param bitmap
             The bitmap to use for stippling.
 
         @param bitmap
             The bitmap to use for stippling.
 

-        @remarks The style will be set to wxBRUSHSTYLE_STIPPLE, unless the bitmap
+        @remarks The style will be set to @c wxBRUSHSTYLE_STIPPLE, unless the bitmap

                  has a mask associated to it, in which case the style will be set
                  has a mask associated to it, in which case the style will be set

-                 to wxBRUSHSTYLE_STIPPLE_MASK_OPAQUE.
+                 to @c wxBRUSHSTYLE_STIPPLE_MASK_OPAQUE.

 
         @see wxBitmap
     */
 
         @see wxBitmap
     */


@@ -224,56 +226,77 @@ public:
 
 /**
     An empty brush.
 
 /**
     An empty brush.

+    wxBrush::IsOk() always returns @false for this object.

 */
 wxBrush wxNullBrush;
 
 /**
     Blue brush.
 */
 wxBrush wxNullBrush;
 
 /**
     Blue brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxBLUE_BRUSH;
 
 /**
     Green brush.
 */
 wxBrush* wxBLUE_BRUSH;
 
 /**
     Green brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxGREEN_BRUSH;
 
 /**
     White brush.
 */
 wxBrush* wxGREEN_BRUSH;
 
 /**
     White brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxWHITE_BRUSH;
 
 /**
     Black brush.
 */
 wxBrush* wxWHITE_BRUSH;
 
 /**
     Black brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxBLACK_BRUSH;
 
 /**
     Grey brush.
 */
 wxBrush* wxBLACK_BRUSH;
 
 /**
     Grey brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxGREY_BRUSH;
 
 /**
     Medium grey brush.
 */
 wxBrush* wxGREY_BRUSH;
 
 /**
     Medium grey brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxMEDIUM_GREY_BRUSH;
 
 /**
     Light grey brush.
 */
 wxBrush* wxMEDIUM_GREY_BRUSH;
 
 /**
     Light grey brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxLIGHT_GREY_BRUSH;
 
 /**
     Transparent brush.
 */
 wxBrush* wxLIGHT_GREY_BRUSH;
 
 /**
     Transparent brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxTRANSPARENT_BRUSH;
 
 /**
     Cyan brush.
 */
 wxBrush* wxTRANSPARENT_BRUSH;
 
 /**
     Cyan brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxCYAN_BRUSH;
 
 /**
     Red brush.
 */
 wxBrush* wxCYAN_BRUSH;
 
 /**
     Red brush.

+    Except for the color it has all standard attributes
+    (@c wxBRUSHSTYLE_SOLID, no stipple bitmap, etc...).

 */
 wxBrush* wxRED_BRUSH;
 
 */
 wxBrush* wxRED_BRUSH;
 

diff --git a/interface/wx/pen.h b/interface/wx/pen.h
index 86775db3a9b043d13fb05d8fad41c57093173cc4..0bcddb1248c6dc6f994d0e1c33facb90b8fc2c64 100644 (file)
--- a/interface/wx/pen.h
+++ b/interface/wx/pen.h
@@ -158,7 +158,8 @@ public:
             A colour object.
         @param width
             Pen width. Under Windows, the pen width cannot be greater than 1 if
             A colour object.
         @param width
             Pen width. Under Windows, the pen width cannot be greater than 1 if

-            the style is @c wxDOT, @c wxLONG_DASH, @c wxSHORT_DASH, @c wxDOT_DASH, or @c wxUSER_DASH.
+            the style is @c wxPENSTYLE_DOT, @c wxPENSTYLE_LONG_DASH, @c wxPENSTYLE_SHORT_DASH,
+            @c wxPENSTYLE_DOT_DASH, or @c wxPENSTYLE_USER_DASH.

         @param style
             The style may be one of the ::wxPenStyle values.
 
         @param style
             The style may be one of the ::wxPenStyle values.
 


@@ -176,7 +177,8 @@ public:
 
         @param width
             Pen width. Under Windows, the pen width cannot be greater than 1 if
 
         @param width
             Pen width. Under Windows, the pen width cannot be greater than 1 if

-            the style is @c wxDOT, @c wxLONG_DASH, @c wxSHORT_DASH, @c wxDOT_DASH, or @c wxUSER_DASH.
+            the style is @c wxPENSTYLE_DOT, @c wxPENSTYLE_LONG_DASH, @c wxPENSTYLE_SHORT_DASH,
+            @c wxPENSTYLE_DOT_DASH, or @c wxPENSTYLE_USER_DASH.

         @param stipple
             A stipple bitmap.
 
         @param stipple
             A stipple bitmap.
 


@@ -207,8 +209,8 @@ public:
     virtual ~wxPen();
 
     /**
     virtual ~wxPen();
 
     /**

-        Returns the pen cap style, which may be one of @c wxCAP_ROUND, @c
-        wxCAP_PROJECTING and @c wxCAP_BUTT.
+        Returns the pen cap style, which may be one of @c wxCAP_ROUND,
+        @c wxCAP_PROJECTING and @c wxCAP_BUTT.

 
         The default is @c wxCAP_ROUND.
 
 
         The default is @c wxCAP_ROUND.
 


@@ -224,7 +226,7 @@ public:
     virtual wxColour GetColour() const;
 
     /**
     virtual wxColour GetColour() const;
 
     /**

-        Gets an array of dashes (defined as char in X, DWORD under Windows).
+        Gets an array of dashes (defined as @c char in X, @c DWORD under Windows).

         @a dashes is a pointer to the internal array. Do not deallocate or store this
         pointer.
 
         @a dashes is a pointer to the internal array. Do not deallocate or store this
         pointer.
 


@@ -235,8 +237,8 @@ public:
     virtual int GetDashes(wxDash** dashes) const;
 
     /**
     virtual int GetDashes(wxDash** dashes) const;
 
     /**

-        Returns the pen join style, which may be one of @c wxJOIN_BEVEL, @c
-        wxJOIN_ROUND and @c wxJOIN_MITER.
+        Returns the pen join style, which may be one of @c wxJOIN_BEVEL,
+        @c wxJOIN_ROUND and @c wxJOIN_MITER.

 
         The default is @c wxJOIN_ROUND.
 
 
         The default is @c wxJOIN_ROUND.
 


@@ -289,7 +291,7 @@ public:
     //@}
 
     /**
     //@}
 
     /**

-        Associates an array of pointers to dashes (defined as char in X, DWORD under
+        Associates an array of pointers to dashes (defined as @c char in X, @c DWORD under

         Windows) with the pen.
 
         The array is not deallocated by wxPen, but neither must it be deallocated by
         Windows) with the pen.
 
         The array is not deallocated by wxPen, but neither must it be deallocated by


@@ -355,56 +357,84 @@ public:
 
 /**
     An empty pen.
 
 /**
     An empty pen.

+    wxPen::IsOk() always returns @false for this object.

 */
 wxPen wxNullPen;
 
 /**
     Red pen.
 */
 wxPen wxNullPen;
 
 /**
     Red pen.

+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).

 */
 wxPen* wxRED_PEN;
 
 */
 wxPen* wxRED_PEN;
 

+/**
+    Blue pen.
+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).
+*/
+wxPen* wxBLUE_PEN;
+

 /**
     Cyan pen.
 /**
     Cyan pen.

+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).

 */
 wxPen* wxCYAN_PEN;
 
 /**
     Green pen.
 */
 wxPen* wxCYAN_PEN;
 
 /**
     Green pen.

+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).

 */
 wxPen* wxGREEN_PEN;
 
 /**
     Black pen.
 */
 wxPen* wxGREEN_PEN;
 
 /**
     Black pen.

+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).

 */
 wxPen* wxBLACK_PEN;
 
 /**
     White pen.
 */
 wxPen* wxBLACK_PEN;
 
 /**
     White pen.

+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).

 */
 wxPen* wxWHITE_PEN;
 
 /**
     Transparent pen.
 */
 wxPen* wxWHITE_PEN;
 
 /**
     Transparent pen.

+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).

 */
 wxPen* wxTRANSPARENT_PEN;
 
 /**
     Black dashed pen.
 */
 wxPen* wxTRANSPARENT_PEN;
 
 /**
     Black dashed pen.

+    Except for the color and for the @c wxPENSTYLE_SHORT_DASH it has all standard attributes
+    (1-pixel width, @c wxCAP_ROUND style, etc...).

 */
 wxPen* wxBLACK_DASHED_PEN;
 
 /**
     Grey pen.
 */
 wxPen* wxBLACK_DASHED_PEN;
 
 /**
     Grey pen.

+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).

 */
 wxPen* wxGREY_PEN;
 
 /**
     Medium-grey pen.
 */
 wxPen* wxGREY_PEN;
 
 /**
     Medium-grey pen.

+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).

 */
 wxPen* wxMEDIUM_GREY_PEN;
 
 /**
     Light-grey pen.
 */
 wxPen* wxMEDIUM_GREY_PEN;
 
 /**
     Light-grey pen.

+    Except for the color it has all standard attributes
+    (1-pixel width, @c wxPENSTYLE_SOLID and @c wxCAP_ROUND styles, etc...).

 */
 wxPen* wxLIGHT_GREY_PEN;
 
 */
 wxPen* wxLIGHT_GREY_PEN;