Typo

[wxWidgets.git] / interface / pen.h

diff --git a/interface/pen.h b/interface/pen.h
index 8b31164cd4593ac3e07a828fe6ff59c69e5c15cd..02368092d58559316fd74fc0de3e268b2b2abc27 100644 (file)
--- a/interface/pen.h
+++ b/interface/pen.h
@@ -11,6 +11,8 @@
 */
 enum wxPenStyle
 {
 */
 enum wxPenStyle
 {

+    wxPENSTYLE_INVALID = -1,
+

     wxPENSTYLE_SOLID,
         /**< Solid style. */
 
     wxPENSTYLE_SOLID,
         /**< Solid style. */
 


@@ -60,8 +62,7 @@ enum wxPenStyle
         /**< Vertical hatch. */
 
     wxPENSTYLE_FIRST_HATCH = wxPENSTYLE_BDIAGONAL_HATCH,
         /**< Vertical hatch. */
 
     wxPENSTYLE_FIRST_HATCH = wxPENSTYLE_BDIAGONAL_HATCH,

-    wxPENSTYLE_LAST_HATCH = wxPENSTYLE_VERTICAL_HATCH,
-    wxPENSTYLE_MAX
+    wxPENSTYLE_LAST_HATCH = wxPENSTYLE_VERTICAL_HATCH

 };
 
 /**
 };
 
 /**


@@ -103,22 +104,22 @@ enum wxPenCap
     lines and painting the outline of rectangles, ellipses, etc.
     It has a colour, a width and a style.
 
     lines and painting the outline of rectangles, ellipses, etc.
     It has a colour, a width and a style.
 

-    On a monochrome display, wxWidgets shows all non-white pens as black.
+    @note On a monochrome display, wxWidgets shows all non-white pens as black.

 
     Do not initialize objects on the stack before the program commences,
     since other required structures may not have been set up yet.
 
     Do not initialize objects on the stack before the program commences,
     since other required structures may not have been set up yet.

-    Instead, define global pointers to objects and create them in wxApp::OnInit
+    Instead, define global pointers to objects and create them in wxApp::OnInit()

     or when required.
 
     An application may wish to dynamically create pens with different characteristics,
     and there is the consequent danger that a large number of duplicate pens will
     be created. Therefore an application may wish to get a pointer to a pen by using
     or when required.
 
     An application may wish to dynamically create pens with different characteristics,
     and there is the consequent danger that a large number of duplicate pens will
     be created. Therefore an application may wish to get a pointer to a pen by using

-    the global list of pens wxThePenList, and calling the member function
+    the global list of pens ::wxThePenList, and calling the member function

     wxPenList::FindOrCreatePen().
     wxPenList::FindOrCreatePen().

-    See the entry for wxPenList.
+    See wxPenList for more info.

 
 

-    This class uses reference counting and copy-on-write internally so that
-    assignments between two instances of this class are very cheap.
+    This class uses @ref overview_refcount "reference counting and copy-on-write" internally
+    so that assignments between two instances of this class are very cheap.

     You can therefore use actual objects instead of pointers without efficiency problems.
     If an instance of this class is changed it will create its own data internally
     so that other instances, which previously shared the data using the reference
     You can therefore use actual objects instead of pointers without efficiency problems.
     If an instance of this class is changed it will create its own data internally
     so that other instances, which previously shared the data using the reference


@@ -128,49 +129,36 @@ enum wxPenCap
     @category{gdi}
 
     @stdobjects
     @category{gdi}
 
     @stdobjects

-    ::wxNullPen, ::wxRED_PEN, ::wxCYAN_PEN, ::wxGREEN_PEN, ::wxBLACK_PEN,
-    ::wxWHITE_PEN, ::wxTRANSPARENT_PEN, ::wxBLACK_DASHED_PEN, ::wxGREY_PEN,
-    ::wxMEDIUM_GREY_PEN, ::wxLIGHT_GREY_PEN
-
-    @see wxPenList, wxDC, wxDC::SetPen
+    @li ::wxNullPen
+    @li ::wxRED_PEN
+    @li ::wxCYAN_PEN
+    @li ::wxGREEN_PEN
+    @li ::wxBLACK_PEN
+    @li ::wxWHITE_PEN
+    @li ::wxTRANSPARENT_PEN
+    @li ::wxBLACK_DASHED_PEN
+    @li ::wxGREY_PEN
+    @li ::wxMEDIUM_GREY_PEN
+    @li ::wxLIGHT_GREY_PEN
+
+    @see wxPenList, wxDC, wxDC::SetPen()

 */
 class wxPen : public wxGDIObject
 {
 public:
     /**
 */
 class wxPen : public wxGDIObject
 {
 public:
     /**

-        Default constructor. The pen will be uninitialised, and wxPen:IsOk will return @false.
+        Default constructor. The pen will be uninitialised, and IsOk() will return @false.

     */
     wxPen();
 
     /**
         Constructs a pen from a colour object, pen width and style.
     */
     wxPen();
 
     /**
         Constructs a pen from a colour object, pen width and style.

-    */
-    wxPen(const wxColour& colour, int width = 1, wxPenStyle style = wxSOLID);
-
-    /**
-        Constructs a pen from a colour name, pen width and style.
-    */
-    wxPen(const wxString& colourName, int width, wxPenStyle style);
-
-    /**
-        Constructs a stippled pen from a stipple bitmap and a width.
-    */
-    wxPen(const wxBitmap& stipple, int width);
-
-    /**
-        Copy constructor, uses @ref overview_refcount "reference counting".

 
         @param colour
             A colour object.
 
         @param colour
             A colour object.

-        @param colourName
-            A colour name.

         @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 wxDOT, wxLONG_DASH, wxSHORT_DASH, wxDOT_DASH, or wxUSER_DASH.
-        @param stipple
-            A stipple bitmap.
-        @param pen
-            A pointer or reference to a pen to copy.
+            the style is @c wxDOT, @c wxLONG_DASH, @c wxSHORT_DASH, @c wxDOT_DASH, or @c wxUSER_DASH.

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


@@ -179,14 +167,34 @@ public:
                  above - there is no similarity even between Windows95
                  and Windows98 - so handle with care.
 
                  above - there is no similarity even between Windows95
                  and Windows98 - so handle with care.
 

-        @see SetStyle(), SetColour(), SetWidth(), SetStipple()
+        @see SetStyle(), SetColour(), SetWidth()
+    */
+    wxPen(const wxColour& colour, int width = 1, wxPenStyle style = wxPENSTYLE_SOLID);
+
+    /**
+        Constructs a stippled pen from a stipple bitmap and a width.
+
+        @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.
+        @param stipple
+            A stipple bitmap.
+
+        @see SetWidth(), SetStipple()
+    */
+    wxPen(const wxBitmap& stipple, int width);
+
+    /**
+        Copy constructor, uses @ref overview_refcount.
+
+        @param pen
+            A pointer or reference to a pen to copy.

     */
     wxPen(const wxPen& pen);
 
     /**
         Destructor.
     */
     wxPen(const wxPen& pen);
 
     /**
         Destructor.

-        See @ref overview_refcountdestruct "reference-counted object destruction" for
-        more info.
+        @see @ref overview_refcount_destruct "reference-counted object destruction"

 
         @remarks Although all remaining pens are deleted when the application
                  exits, the application should try to clean up all pens
 
         @remarks Although all remaining pens are deleted when the application
                  exits, the application should try to clean up all pens


@@ -197,60 +205,63 @@ public:
     ~wxPen();
 
     /**
     ~wxPen();
 
     /**

-        Returns the pen cap style, which may be one of @b wxCAP_ROUND, @b
-        wxCAP_PROJECTING and
-        @b wxCAP_BUTT. The default is @b wxCAP_ROUND.
+        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.

 
         @see SetCap()
     */
 
         @see SetCap()
     */

-    wxPenCap GetCap() const;
+    virtual wxPenCap GetCap() const;

 
     /**
         Returns a reference to the pen colour.
 
         @see SetColour()
     */
 
     /**
         Returns a reference to the pen colour.
 
         @see SetColour()
     */

-    wxColour GetColour() const;
+    virtual wxColour GetColour() const;

 
     /**
         Gets an array of dashes (defined as char in X, DWORD under Windows).
         @a dashes is a pointer to the internal array. Do not deallocate or store this
         pointer.
 
     /**
         Gets an array of dashes (defined as char in X, DWORD under Windows).
         @a dashes is a pointer to the internal array. Do not deallocate or store this
         pointer.

-        The function returns the number of dashes associated with this pen.
+
+        @return The number of dashes associated with this pen.

 
         @see SetDashes()
     */
 
         @see SetDashes()
     */

-    int GetDashes(wxDash** dashes) const;
+    virtual int GetDashes(wxDash** dashes) const;

 
     /**
 
     /**

-        Returns the pen join style, which may be one of @b wxJOIN_BEVEL, @b
-        wxJOIN_ROUND and
-        @b wxJOIN_MITER. The default is @b wxJOIN_ROUND.
+        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.

 
         @see SetJoin()
     */
 
         @see SetJoin()
     */

-    wxPenJoin GetJoin() const;
+    virtual wxPenJoin GetJoin() const;

 
     /**
         Gets a pointer to the stipple bitmap.
 
         @see SetStipple()
     */
 
     /**
         Gets a pointer to the stipple bitmap.
 
         @see SetStipple()
     */

-    wxBitmap* GetStipple() const;
+    virtual wxBitmap* GetStipple() const;

 
     /**
         Returns the pen style.
 
         @see wxPen(), SetStyle()
     */
 
     /**
         Returns the pen style.
 
         @see wxPen(), SetStyle()
     */

-    wxPenStyle GetStyle() const;
+    virtual wxPenStyle GetStyle() const;

 
     /**
         Returns the pen width.
 
         @see SetWidth()
     */
 
     /**
         Returns the pen width.
 
         @see SetWidth()
     */

-    int GetWidth() const;
+    virtual int GetWidth() const;

 
     /**
         Returns @true if the pen is initialised.
 
     /**
         Returns @true if the pen is initialised.


@@ -258,13 +269,12 @@ public:
     bool IsOk() const;
 
     /**
     bool IsOk() const;
 
     /**

-        Sets the pen cap style, which may be one of @b wxCAP_ROUND, @b wxCAP_PROJECTING
-        and
-        @b wxCAP_BUTT. The default is @b wxCAP_ROUND.
+        Sets 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.

 
         @see GetCap()
     */
 
         @see GetCap()
     */

-    void SetCap(wxPenCap capStyle);
+    virtual void SetCap(wxPenCap capStyle);

 
     //@{
     /**
 
     //@{
     /**


@@ -272,127 +282,129 @@ public:
 
         @see GetColour()
     */
 
         @see GetColour()
     */

-    void SetColour(wxColour& colour);
-    void SetColour(const wxString& colourName);
-    void SetColour(unsigned char red, unsigned char green,
-                   unsigned char blue);
+    virtual void SetColour(wxColour& colour);
+    virtual void SetColour(unsigned char red, unsigned char green, unsigned char blue);

     //@}
 
     /**
         Associates an array of pointers to dashes (defined as char in X, DWORD under
     //@}
 
     /**
         Associates an array of pointers to dashes (defined as char in X, DWORD under

-        Windows)
-        with the pen. The array is not deallocated by wxPen, but neither must it be
-        deallocated by the calling application until the pen is deleted or this
-        function is called with a @NULL array.
+        Windows) with the pen.
+
+        The array is not deallocated by wxPen, but neither must it be deallocated by
+        the calling application until the pen is deleted or this function is called
+        with a @NULL array.

 
         @see GetDashes()
     */
 
         @see GetDashes()
     */

-    void SetDashes(int n, wxDash* dashes);
+    virtual void SetDashes(int n, wxDash* dashes);

 
     /**
 
     /**

-        Sets the pen join style, which may be one of @b wxJOIN_BEVEL, @b wxJOIN_ROUND
-        and
-        @b wxJOIN_MITER. The default is @b wxJOIN_ROUND.
+        Sets 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.

 
         @see GetJoin()
     */
 
         @see GetJoin()
     */

-    void SetJoin(wxPenJoin join_style);
+    virtual void SetJoin(wxPenJoin join_style);

 
     /**
         Sets the bitmap for stippling.
 
         @see GetStipple()
     */
 
     /**
         Sets the bitmap for stippling.
 
         @see GetStipple()
     */

-    void SetStipple(wxBitmap* stipple);
+    virtual void SetStipple(wxBitmap* stipple);

 
     /**
         Set the pen style.
 
         @see wxPen()
     */
 
     /**
         Set the pen style.
 
         @see wxPen()
     */

-    void SetStyle(wxPenStyle style);
+    virtual void SetStyle(wxPenStyle style);

 
     /**
         Sets the pen width.
 
         @see GetWidth()
     */
 
     /**
         Sets the pen width.
 
         @see GetWidth()
     */

-    void SetWidth(int width);
+    virtual void SetWidth(int width);

 
     /**
         Inequality operator.
 
     /**
         Inequality operator.

-        See @ref overview_refcountequality "reference-counted object comparison" for
+
+        See @ref overview_refcount_equality "reference-counted object comparison" for

         more info.
     */
     bool operator !=(const wxPen& pen);
 
     /**
         more info.
     */
     bool operator !=(const wxPen& pen);
 
     /**

-        Assignment operator, using @ref overview_trefcount "reference counting".
+        Assignment operator, using @ref overview_refcount.

     */
     wxPen operator =(const wxPen& pen);
 
     /**
         Equality operator.
     */
     wxPen operator =(const wxPen& pen);
 
     /**
         Equality operator.

-        See @ref overview_refcountequality "reference-counted object comparison" for
+
+        See @ref overview_refcount_equality "reference-counted object comparison" for

         more info.
     */
     bool operator ==(const wxPen& pen);
 };
 
 /**
         more info.
     */
     bool operator ==(const wxPen& pen);
 };
 
 /**

-    FIXME
+    An empty pen.

 */
 wxPen wxNullPen;
 
 /**
 */
 wxPen wxNullPen;
 
 /**

-    FIXME
+    Red pen.

 */
 */

-wxPen wxRED_PEN;
+wxPen* wxRED_PEN;

 
 /**
 
 /**

-    FIXME
+    Cyan pen.

 */
 */

-wxPen wxCYAN_PEN;
+wxPen* wxCYAN_PEN;

 
 /**
 
 /**

-    FIXME
+    Green pen.

 */
 */

-wxPen wxGREEN_PEN;
+wxPen* wxGREEN_PEN;

 
 /**
 
 /**

-    FIXME
+    Black pen.

 */
 */

-wxPen wxBLACK_PEN;
+wxPen* wxBLACK_PEN;

 
 /**
 
 /**

-    FIXME
+    White pen.

 */
 */

-wxPen wxWHITE_PEN;
+wxPen* wxWHITE_PEN;

 
 /**
 
 /**

-    FIXME
+    Transparent pen.

 */
 */

-wxPen wxTRANSPARENT_PEN;
+wxPen* wxTRANSPARENT_PEN;

 
 /**
 
 /**

-    FIXME
+    Black dashed pen.

 */
 */

-wxPen wxBLACK_DASHED_PEN;
+wxPen* wxBLACK_DASHED_PEN;

 
 /**
 
 /**

-    FIXME
+    Grey pen.

 */
 */

-wxPen wxGREY_PEN;
+wxPen* wxGREY_PEN;

 
 /**
 
 /**

-    FIXME
+    Medium-grey pen.

 */
 */

-wxPen wxMEDIUM_GREY_PEN;
+wxPen* wxMEDIUM_GREY_PEN;

 
 /**
 
 /**

-    FIXME
+    Light-grey pen.

 */
 */

-wxPen wxLIGHT_GREY_PEN;
+wxPen* wxLIGHT_GREY_PEN;