Add a more convenient wxColour::MakeDisabled() overload.

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

diff --git a/interface/wx/icon.h b/interface/wx/icon.h
index 5a055a7168e75fd1a5755a8ee1c4989b03edb9be..083bce75340f76322c280c281c65a7ae71eb7205 100644 (file)
--- 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
 /////////////////////////////////////////////////////////////////////////////
 
 
@@ -50,7 +50,7 @@
     @see @ref overview_bitmap, @ref overview_bitmap_supportedformats,
          wxDC::DrawIcon, wxCursor
 */
-class wxIcon : public wxBitmap
+class wxIcon : public wxGDIObject
 {
 public:
     /**
@@ -94,6 +94,10 @@ public:
         @param height
             The height of the image.
 
+        @beginWxPerlOnly
+        In wxPerl use Wx::Icon->newBits(bits, width, height, depth = -1);
+        @endWxPerlOnly
+
         @onlyfor{wxmsw,wxosx}
     */
     wxIcon(const char bits[], int width, int height);
@@ -114,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);
 
@@ -171,6 +179,19 @@ public:
     */
     virtual ~wxIcon();
 
+    /**
+        Returns disabled (dimmed) version of the icon.
+
+        This method is available in wxIcon only under wxMSW, other ports only
+        have it in wxBitmap. You can always use wxImage::ConvertToDisabled()
+        and create the icon from wxImage manually however.
+
+        @onlyfor{wxmsw}
+
+        @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.