avoid infinite recursion for richtooltops, (hopefully) fixes #15070

[wxWidgets.git] / interface / wx / colour.h

diff --git a/interface/wx/colour.h b/interface/wx/colour.h
index 82134dd1fb1bf38f3bd2c6cd8c19cfd3016564ec..886b65adc6533ec336542dc4f58355cb8e9c257f 100644 (file)
--- a/interface/wx/colour.h
+++ b/interface/wx/colour.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxColour
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxColour
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -13,12 +13,16 @@
 
     @{
 */
 
     @{
 */

-#define wxC2S_NAME              1   //!< Return colour name, when possible.
-#define wxC2S_CSS_SYNTAX        2   //!< Return colour in "rgb(r,g,b)" syntax.
-#define wxC2S_HTML_SYNTAX       4   //!< Return colour in "#rrggbb" syntax.
+enum {
+    wxC2S_NAME             = 1,   // return colour name, when possible
+    wxC2S_CSS_SYNTAX       = 2,   // return colour in rgb(r,g,b) syntax
+    wxC2S_HTML_SYNTAX      = 4    // return colour in #rrggbb syntax
+};

 
 //@}
 
 
 //@}
 

+const unsigned char wxALPHA_TRANSPARENT = 0;
+const unsigned char wxALPHA_OPAQUE = 0xff;

 
 /**
     @class wxColour
 
 /**
     @class wxColour


@@ -37,6 +41,7 @@
 
     @stdobjects
     - ::wxNullColour - An empty, invalid colour.
 
     @stdobjects
     - ::wxNullColour - An empty, invalid colour.

+    - ::wxTransparentColour - Valid but fully transparent colour (new in 2.9.1).

     - ::wxBLACK
     - ::wxBLUE
     - ::wxCYAN
     - ::wxBLACK
     - ::wxBLUE
     - ::wxCYAN


@@ -77,6 +82,12 @@ public:
     */
     wxColour(const wxString& colourName);
 
     */
     wxColour(const wxString& colourName);
 

+    /**
+        @param colRGB
+            A packed RGB value.
+    */
+    wxColour(unsigned long colRGB);
+    

     /**
         Copy constructor.
     */
     /**
         Copy constructor.
     */


@@ -154,7 +165,7 @@ public:
         On X, an allocated pixel value is returned.
         If the pixel is invalid (on X, unallocated), @c -1 is returned.
     */
         On X, an allocated pixel value is returned.
         If the pixel is invalid (on X, unallocated), @c -1 is returned.
     */

-    int GetPixel() const;
+    wxIntPtr GetPixel() const;

 
     /**
         Returns the green intensity.
 
     /**
         Returns the green intensity.


@@ -176,13 +187,12 @@ public:
     /**
         Sets the RGB intensity values using the given values (first overload),
         extracting them from the packed long (second overload), using the given
     /**
         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).
+        string (third overload).

 
         When using third form, Set() accepts: colour names (those listed in
 
         When using third form, Set() accepts: colour names (those listed in

-        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).
+        wxColourDatabase), the CSS-like @c "rgb(r,g,b)" or @c "rgba(r,g,b,a)" syntax 
+        (case insensitive) and the HTML-like syntax: @c "#" followed by 6 hexadecimal 
+        digits for red, green, blue components.

 
         Returns @true if the conversion was successful, @false otherwise.
 
 
         Returns @true if the conversion was successful, @false otherwise.
 


@@ -225,7 +235,16 @@ public:
         @since 2.9.0
     */
     static void MakeDisabled(unsigned char* r, unsigned char* g, unsigned char* b, unsigned char brightness = 255);
         @since 2.9.0
     */
     static void MakeDisabled(unsigned char* r, unsigned char* g, unsigned char* b, unsigned char brightness = 255);

-    
+
+    /**
+        Make a disabled version of this colour.
+
+        This method modifies the object in place and returns the object itself.
+
+        @since 2.9.5
+     */
+    wxColour& MakeDisabled(unsigned char brightness = 255);
+

     /**
         Create a grey colour from (in/out) rgb parameters using integer arithmetic.
         @since 2.9.0
     /**
         Create a grey colour from (in/out) rgb parameters using integer arithmetic.
         @since 2.9.0


@@ -267,6 +286,7 @@ public:
 /** @name Predefined colors. */
 //@{
 wxColour wxNullColour;
 /** @name Predefined colors. */
 //@{
 wxColour wxNullColour;

+wxColour wxTransparentColour;

 wxColour* wxBLACK;
 wxColour* wxBLUE;
 wxColour* wxCYAN;
 wxColour* wxBLACK;
 wxColour* wxBLUE;
 wxColour* wxCYAN;