X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0004982c831f56c65c390fb617711ff52595c2f3..4017f5ca49e153e04ffd1c49bc93afd31c1cdf87:/interface/wx/colour.h diff --git a/interface/wx/colour.h b/interface/wx/colour.h index b1102d41e8..d6f3fa5f82 100644 --- a/interface/wx/colour.h +++ b/interface/wx/colour.h @@ -41,6 +41,7 @@ - ::wxBLUE - ::wxCYAN - ::wxGREEN + - ::wxYELLOW - ::wxLIGHT_GREY - ::wxRED - ::wxWHITE @@ -111,6 +112,42 @@ public: */ 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. @@ -164,15 +201,12 @@ public: */ bool operator !=(const wxColour& colour) const; - //@{ /** 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 @@ -189,6 +223,7 @@ wxColour* wxBLACK; wxColour* wxBLUE; wxColour* wxCYAN; wxColour* wxGREEN; +wxColour* wxYELLOW; wxColour* wxLIGHT_GREY; wxColour* wxRED; wxColour* wxWHITE; @@ -200,7 +235,7 @@ wxColour* wxWHITE; // Global functions/macros // ============================================================================ -/** @ingroup group_funcmacro_misc */ +/** @addtogroup group_funcmacro_misc */ //@{ /**