Remove wxDialog::OnSysColourChanged() documentation.

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

diff --git a/interface/wx/colour.h b/interface/wx/colour.h
index b1fcc6bebffa0d52429b365ad83a3f3869dbe2b8..bf051c3ff1fc9e85f1d5a3f617a980074b57becc 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,10 +41,12 @@
 
     @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
     - ::wxGREEN
     - ::wxBLACK
     - ::wxBLUE
     - ::wxCYAN
     - ::wxGREEN

+    - ::wxYELLOW

     - ::wxLIGHT_GREY
     - ::wxRED
     - ::wxWHITE
     - ::wxLIGHT_GREY
     - ::wxRED
     - ::wxWHITE


@@ -76,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.
     */


@@ -111,13 +123,49 @@ public:
     */
     virtual wxString GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const;
 
     */
     virtual wxString GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const;
 

+    //@{
+    /**
+        Sets the RGB or RGBA colour values from a single 32 bit value.
+
+        The arguments @a colRGB and @a colRGBA should be of the form 0x00BBGGRR
+        and 0xAABBGGRR respectively where @c 0xRR, @c 0xGG, @c 0xBB and @c 0xAA
+        are the values of the red, blue, green and alpha components.
+
+        Notice the right-to-left order of components!
+
+        @see GetRGB(), GetRGBA()
+
+        @since 2.9.1
+    */
+    void SetRGB(wxUint32 colRGB);
+    void SetRGBA(wxUint32 colRGBA);
+    //@}
+
+    //@{
+    /**
+        Gets the RGB or RGBA colour values as a single 32 bit value.
+
+        The returned value is of the same form as expected by SetRGB() and
+        SetRGBA().
+
+        Notice that GetRGB() returns the value with 0 as its highest byte
+        independently of the value actually returned by Alpha(). So for a fully
+        opaque colour, the return value of GetRGBA() is @c 0xFFBBGGRR while
+        that of GetRGB() is @c 0x00BBGGRR.
+
+        @since 2.9.1
+    */
+    wxUint32 GetRGB() const;
+    wxUint32 GetRGBA() const;
+    //@}
+

     /**
         Returns a pixel value which is platform-dependent.
         On Windows, a COLORREF is returned.
         On X, an allocated pixel value is returned.
         If the pixel is invalid (on X, unallocated), @c -1 is returned.
     */
     /**
         Returns a pixel value which is platform-dependent.
         On Windows, a COLORREF 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.


@@ -128,7 +176,7 @@ public:
         Returns @true if the colour object is valid (the colour has been initialised
         with RGB values).
     */
         Returns @true if the colour object is valid (the colour has been initialised
         with RGB values).
     */

-    bool IsOk() const;
+    virtual bool IsOk() const;

 
     /**
         Returns the red intensity.
 
     /**
         Returns the red intensity.


@@ -139,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.
 


@@ -164,31 +211,78 @@ public:
     */
     bool operator !=(const wxColour& colour) const;
 
     */
     bool operator !=(const wxColour& colour) const;
 

-    //@{

     /**
         Assignment operator, using a colour name to be found in the colour database.
 
         @see wxColourDatabase
     */
     /**
         Assignment operator, using a colour name to be found in the colour database.
 
         @see wxColourDatabase
     */

-    wxColour operator =(const wxColour& colour);
-    wxColour operator =(const wxString& colourName);
-    //@}
+    wxColour& operator=(const wxColour& colour);

 
     /**
         Tests the equality of two colours by comparing individual red, green, blue
         colours and alpha values.
     */
     bool operator ==(const wxColour& colour) const;
 
     /**
         Tests the equality of two colours by comparing individual red, green, blue
         colours and alpha values.
     */
     bool operator ==(const wxColour& colour) const;

+
+    /**
+        Assign 0 or 255 to rgb out parameters.
+        @since 2.9.0
+    */
+    static void MakeMono(unsigned char* r, unsigned char* g, unsigned char* b, bool on);
+    
+    /**
+        Create a disabled (dimmed) colour from (in/out) rgb parameters.
+        @since 2.9.0
+    */
+    static void MakeDisabled(unsigned char* r, unsigned char* g, unsigned char* b, unsigned char brightness = 255);
+    
+    /**
+        Create a grey colour from (in/out) rgb parameters using integer arithmetic.
+        @since 2.9.0
+    */
+    static void MakeGrey(unsigned char* r, unsigned char* g, unsigned char* b);
+    
+    /**
+        Create a grey colour from (in/out) rgb parameters using floating point arithmetic.
+        Defaults to using the standard ITU-T BT.601 when converting to YUV, where every pixel equals
+        (R * @a weight_r) + (G * @a weight_g) + (B * @a weight_b).
+        @since 2.9.0
+    */
+    static void MakeGrey(unsigned char* r, unsigned char* g, unsigned char* b,
+                         double weight_r, double weight_g, double weight_b);
+
+    /**
+        Blend colour, taking alpha into account.
+        @since 2.9.0
+    */
+    static unsigned char AlphaBlend(unsigned char fg, unsigned char bg, double alpha);
+    
+    /**
+        ChangeLightness() is a utility function that simply darkens
+        or lightens a color, based on the specified percentage
+        ialpha of 0 would be completely black, 200 completely white
+        an ialpha of 100 returns the same colour
+        @since 2.9.0
+    */
+    static void ChangeLightness(unsigned char* r, unsigned char* g, unsigned char* b, int ialpha);
+
+    /**
+        wxColour wrapper for ChangeLightness(r,g,b,ialpha).
+        @since 2.9.0
+    */
+    wxColour ChangeLightness(int ialpha) const;

 };
 
 
 /** @name Predefined colors. */
 //@{
 wxColour wxNullColour;
 };
 
 
 /** @name Predefined colors. */
 //@{
 wxColour wxNullColour;

+wxColour wxTransparentColour;

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

+wxColour* wxYELLOW;

 wxColour* wxLIGHT_GREY;
 wxColour* wxRED;
 wxColour* wxWHITE;
 wxColour* wxLIGHT_GREY;
 wxColour* wxRED;
 wxColour* wxWHITE;


@@ -200,7 +294,7 @@ wxColour* wxWHITE;
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_misc */
+/** @addtogroup group_funcmacro_misc */

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