regenerated headers to remove @seealso in favour of @see; fixed links to global funct...

[wxWidgets.git] / interface / pen.h

diff --git a/interface/pen.h b/interface/pen.h
index 42e360c1c80fe8b17c83233c810627920afcb95a..9a9a2833ac41c1d4993b8fb4d286faeb37bf05b6 100644 (file)
--- a/interface/pen.h
+++ b/interface/pen.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        pen.h
-// Purpose:     documentation for wxPen class
+// Purpose:     interface of wxPen
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -18,31 +18,10 @@
     @category{gdi}
 
     @stdobjects
-    Objects:
-    wxNullPen
-    Pointers:
-    wxRED_PEN
+    ::Objects:, ::wxNullPen, ::Pointers:, ::wxRED_PEN, ::wxCYAN_PEN, ::wxGREEN_PEN,
+    ::wxBLACK_PEN, ::wxWHITE_PEN, ::wxTRANSPARENT_PEN, ::wxBLACK_DASHED_PEN, ::wxGREY_PEN, ::wxMEDIUM_GREY_PEN, ::wxLIGHT_GREY_PEN,
 
-    wxCYAN_PEN
-
-    wxGREEN_PEN
-
-    wxBLACK_PEN
-
-    wxWHITE_PEN
-
-    wxTRANSPARENT_PEN
-
-    wxBLACK_DASHED_PEN
-
-    wxGREY_PEN
-
-    wxMEDIUM_GREY_PEN
-
-    wxLIGHT_GREY_PEN
-
-    @seealso
-    wxPenList, wxDC, wxDC::SetPen
+    @see wxPenList, wxDC, wxDC::SetPen
 */
 class wxPen : public wxGDIObject
 {
@@ -255,14 +234,14 @@ public:
         
         @see SetCap()
     */
-    int GetCap();
+    int GetCap() const;
 
     /**
         Returns a reference to the pen colour.
         
         @see SetColour()
     */
-    wxColour GetColour();
+    wxColour GetColour() const;
 
     /**
         Gets an array of dashes (defined as char in X, DWORD under Windows).
@@ -272,7 +251,7 @@ public:
         
         @see SetDashes()
     */
-    int GetDashes(wxDash** dashes);
+    int GetDashes(wxDash** dashes) const;
 
     /**
         Returns the pen join style, which may be one of @b wxJOIN_BEVEL, @b
@@ -281,33 +260,33 @@ public:
         
         @see SetJoin()
     */
-    int GetJoin();
+    int GetJoin() const;
 
     /**
         Gets a pointer to the stipple bitmap.
         
         @see SetStipple()
     */
-    wxBitmap* GetStipple();
+    wxBitmap* GetStipple() const;
 
     /**
         Returns the pen style.
         
         @see wxPen(), SetStyle()
     */
-    int GetStyle();
+    int GetStyle() const;
 
     /**
         Returns the pen width.
         
         @see SetWidth()
     */
-    int GetWidth();
+    int GetWidth() const;
 
     /**
         Returns @true if the pen is initialised.
     */
-    bool IsOk();
+    bool IsOk() const;
 
     /**
         Sets the pen cap style, which may be one of @b wxCAP_ROUND, @b wxCAP_PROJECTING
@@ -390,3 +369,73 @@ public:
     */
     bool operator ==(const wxPen& pen);
 };
+
+
+/**
+    FIXME
+*/
+wxPen Objects:
+;
+
+/**
+    FIXME
+*/
+wxPen wxNullPen;
+
+/**
+    FIXME
+*/
+wxPen Pointers:
+;
+
+/**
+    FIXME
+*/
+wxPen wxRED_PEN;
+
+/**
+    FIXME
+*/
+wxPen wxCYAN_PEN;
+
+/**
+    FIXME
+*/
+wxPen wxGREEN_PEN;
+
+/**
+    FIXME
+*/
+wxPen wxBLACK_PEN;
+
+/**
+    FIXME
+*/
+wxPen wxWHITE_PEN;
+
+/**
+    FIXME
+*/
+wxPen wxTRANSPARENT_PEN;
+
+/**
+    FIXME
+*/
+wxPen wxBLACK_DASHED_PEN;
+
+/**
+    FIXME
+*/
+wxPen wxGREY_PEN;
+
+/**
+    FIXME
+*/
+wxPen wxMEDIUM_GREY_PEN;
+
+/**
+    FIXME
+*/
+wxPen wxLIGHT_GREY_PEN;
+
+