pen.h depends from brush.h in compat mode

[wxWidgets.git] / interface / colour.h

diff --git a/interface/colour.h b/interface/colour.h
index 9d29536bd0522257ca8e48b51c5a879cbcfbe848..9df414c4c7314c474836e128c28e3e657dd4b492 100644 (file)
--- a/interface/colour.h
+++ b/interface/colour.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        colour.h
-// Purpose:     documentation for wxColour class
+// Purpose:     interface of wxColour
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -24,25 +24,10 @@
     @category{gdi}
 
     @stdobjects
-    Objects:
-    wxNullColour
-    Pointers:
-    wxBLACK
+    ::Objects:, ::wxNullColour, ::Pointers:, ::wxBLACK, ::wxWHITE, ::wxRED,
+    ::wxBLUE, ::wxGREEN, ::wxCYAN, ::wxLIGHT_GREY,
 
-    wxWHITE
-
-    wxRED
-
-    wxBLUE
-
-    wxGREEN
-
-    wxCYAN
-
-    wxLIGHT_GREY
-
-    @seealso
-    wxColourDatabase, wxPen, wxBrush, wxColourDialog, wxSystemSettings
+    @see wxColourDatabase, wxPen, wxBrush, wxColourDialog, wxSystemSettings
 */
 class wxColour : public wxObject
 {
@@ -79,21 +64,23 @@ public:
         Returns the alpha value, on platforms where alpha is not yet supported, this
         always returns wxALPHA_OPAQUE.
     */
-    unsigned char Alpha();
+    unsigned char Alpha() const;
 
     /**
         Returns the blue intensity.
     */
-    unsigned char Blue();
+    unsigned char Blue() const;
 
     //@{
     /**
         is not
         specified in flags.
-        This function is new since wxWidgets version 2.7.0
+        
+        @wxsince{2.7.0}
     */
     wxString GetAsString(long flags);
-    wxC2S_NAME wxC2S_CSS_SYNTAX, to obtain
+    const wxC2S_NAME, to obtain the colour name (e.g.
+            wxColour(255,0,0) - "red"), wxC2S_CSS_SYNTAX, to obtain
     the colour in the "rgb(r,g,b)" or "rgba(r,g,b,a)" syntax
     (e.g. wxColour(255,0,0,85) - "rgba(255,0,0,0.333)"), and
     wxC2S_HTML_SYNTAX, to obtain the colour as  "#" followed
@@ -109,35 +96,36 @@ public:
         On X, an allocated pixel value is returned.
         -1 is returned if the pixel is invalid (on X, unallocated).
     */
-    long GetPixel();
+    long GetPixel() const;
 
     /**
         Returns the green intensity.
     */
-    unsigned char Green();
+    unsigned char Green() const;
 
     /**
         Returns @true if the colour object is valid (the colour has been initialised
         with RGB values).
     */
-    bool IsOk();
+    bool IsOk() const;
 
     /**
         Returns the red intensity.
     */
-    unsigned char Red();
+    unsigned char Red() const;
 
     //@{
     /**
         Sets the RGB intensity values using the given values (first overload),
         extracting them from the packed long (second overload), using the given string (third overloard).
         When using third form, Set() accepts: colour names (those listed in
-        wxTheColourDatabase), the CSS-like
+        wxTheColourDatabase()), the CSS-like
         @c "rgb(r,g,b)" or @c "rgba(r,g,b,a)" syntax (case insensitive)
         and the HTML-like syntax (i.e. @c "#" followed by 6 hexadecimal digits
         for red, green, blue components).
         Returns @true if the conversion was successful, @false otherwise.
-        This function is new since wxWidgets version 2.7.0
+        
+        @wxsince{2.7.0}
     */
     void Set(unsigned char red, unsigned char green,
              unsigned char blue,
@@ -168,3 +156,58 @@ public:
     */
     bool operator ==(const wxColour& colour);
 };
+
+
+/**
+    FIXME
+*/
+wxColour Objects:
+;
+
+/**
+    FIXME
+*/
+wxColour wxNullColour;
+
+/**
+    FIXME
+*/
+wxColour Pointers:
+;
+
+/**
+    FIXME
+*/
+wxColour wxBLACK;
+
+/**
+    FIXME
+*/
+wxColour wxWHITE;
+
+/**
+    FIXME
+*/
+wxColour wxRED;
+
+/**
+    FIXME
+*/
+wxColour wxBLUE;
+
+/**
+    FIXME
+*/
+wxColour wxGREEN;
+
+/**
+    FIXME
+*/
+wxColour wxCYAN;
+
+/**
+    FIXME
+*/
+wxColour wxLIGHT_GREY;
+
+