X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0004982c831f56c65c390fb617711ff52595c2f3..ee7553e935502f77f7aed93221a449b982dee40d:/interface/wx/icon.h?ds=sidebyside diff --git a/interface/wx/icon.h b/interface/wx/icon.h index b51860c24e..b574ce34f8 100644 --- a/interface/wx/icon.h +++ b/interface/wx/icon.h @@ -3,7 +3,7 @@ // Purpose: interface of wxIcon // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -90,24 +90,17 @@ public: @param bits Specifies an array of pixel values. @param width - Specifies the width of the bitmap. + The width of the image. @param height - Specifies the height of the bitmap. - @param depth - Specifies the depth of the bitmap. - If this is omitted, then a value of 1 (monochrome bitmap) is used. - */ - wxIcon(const char bits[], int width, int height, int depth = 1); + The height of the image. + @beginWxPerlOnly + In wxPerl use Wx::Icon->newBits(bits, width, height, depth = -1); + @endWxPerlOnly - /** - Creates a new icon. A depth of ::wxICON_SCREEN_DEPTH indicates the - depth of the current screen or visual. - - Some platforms only support 1 for monochrome and ::wxICON_SCREEN_DEPTH for - the current colour setting. + @onlyfor{wxmsw,wxosx} */ - wxIcon(int width, int height, int depth = wxICON_SCREEN_DEPTH); + wxIcon(const char bits[], int width, int height); /** Creates a bitmap from XPM data. @@ -125,17 +118,21 @@ public: the appropriate platform, or an icon resource on Windows. @code - wxIcon icon(wxICON(mondrian)); + wxIcon icon(wxICON(sample)); // Equivalent to: #if defined(__WXGTK__) || defined(__WXMOTIF__) - wxIcon icon(mondrian_xpm); + wxIcon icon(sample_xpm); #endif #if defined(__WXMSW__) - wxIcon icon("mondrian"); + wxIcon icon("sample"); #endif @endcode + + @beginWxPerlOnly + In wxPerl use Wx::Icon->newFromXPM(data). + @endWxPerlOnly */ wxIcon(const char* const* bits); @@ -182,6 +179,12 @@ public: */ virtual ~wxIcon(); + /** + Returns disabled (dimmed) version of the icon. MSW only. + @since 2.9.0 + */ + wxIcon ConvertToDisabled(unsigned char brightness = 255) const; + /** Copies @a bmp bitmap to this icon. Under MS Windows the bitmap must have mask colour set. @@ -271,7 +274,7 @@ public: @param icon Icon to assign. */ - wxIcon operator =(const wxIcon& icon); + wxIcon& operator=(const wxIcon& icon); }; /**