synchronize GTK2 minimum version in docs

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

diff --git a/interface/wx/bitmap.h b/interface/wx/bitmap.h
index 3d1ec2000eb637b01e7fc3889c66a4b900e1a8dc..1b185d7f3c90fe9a0d1d43d869fd1e24e1df6c07 100644 (file)
--- a/interface/wx/bitmap.h
+++ b/interface/wx/bitmap.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxBitmap* classes
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxBitmap* classes
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

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


@@ -21,7 +21,7 @@
 
     If you wish to extend the capabilities of wxBitmap, derive a class from
     wxBitmapHandler and add the handler using wxBitmap::AddHandler() in your
 
     If you wish to extend the capabilities of wxBitmap, derive a class from
     wxBitmapHandler and add the handler using wxBitmap::AddHandler() in your

-    application initialisation.
+    application initialization.

 
     Note that all wxBitmapHandlers provided by wxWidgets are part of the
     @ref page_libs_wxcore library.
 
     Note that all wxBitmapHandlers provided by wxWidgets are part of the
     @ref page_libs_wxcore library.


@@ -29,7 +29,7 @@
     wxBitmap class documentation.
 
     @library{wxcore}
     wxBitmap class documentation.
 
     @library{wxcore}

-    @category{misc}
+    @category{gdi}

 
     @see @ref overview_bitmap, wxBitmap, wxIcon, wxCursor
 */
 
     @see @ref overview_bitmap, wxBitmap, wxIcon, wxCursor
 */


@@ -165,19 +165,34 @@ public:
     If you need direct access the bitmap data instead going through
     drawing to it using wxMemoryDC you need to use the wxPixelData
     class (either wxNativePixelData for RGB bitmaps or wxAlphaPixelData
     If you need direct access the bitmap data instead going through
     drawing to it using wxMemoryDC you need to use the wxPixelData
     class (either wxNativePixelData for RGB bitmaps or wxAlphaPixelData

-    for bitmaps with an additionaly alpha channel).
+    for bitmaps with an additionally alpha channel).

 
 

-    @note
-    Many wxBitmap functions take a @e type parameter, which is a value of the
-    ::wxBitmapType enumeration.
+    Note that many wxBitmap functions take a @e type parameter, which is a 
+    value of the ::wxBitmapType enumeration.

     The validity of those values depends however on the platform where your program
     is running and from the wxWidgets configuration.
     The validity of those values depends however on the platform where your program
     is running and from the wxWidgets configuration.

-    If all possible wxWidgets settings are used, the Windows platform supports BMP file,
-    BMP resource, XPM data, and XPM.
-    Under wxGTK, the available formats are BMP file, XPM data, XPM file, and PNG file.
-    Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM file.
-    In addition, wxBitmap can load and save all formats that wxImage; see wxImage for
-    more info. Of course, you must have wxImage handlers loaded.
+    If all possible wxWidgets settings are used:
+    - wxMSW supports BMP and ICO files, BMP and ICO resources;
+    - wxGTK supports XPM files;
+    - wxMac supports PICT resources;
+    - wxX11 supports XPM files, XPM data, XBM data;
+
+    In addition, wxBitmap can load and save all formats that wxImage can; see wxImage
+    for more info. Of course, you must have loaded the wxImage handlers 
+    (see ::wxInitAllImageHandlers() and wxImage::AddHandler).
+    Note that all available wxBitmapHandlers for a given wxWidgets port are 
+    automatically loaded at startup so you won't need to use wxBitmap::AddHandler.
+
+    More on the difference between wxImage and wxBitmap: wxImage is just a
+    buffer of RGB bytes with an optional buffer for the alpha bytes. It is all
+    generic, platform independent and image file format independent code. It
+    includes generic code for scaling, resizing, clipping, and other manipulations
+    of the image data. OTOH, wxBitmap is intended to be a wrapper of whatever is
+    the native image format that is quickest/easiest to draw to a DC or to be the
+    target of the drawing operations performed on a wxMemoryDC. By splitting the
+    responsibilities between wxImage/wxBitmap like this then it's easier to use
+    generic code shared by all platforms and image types for generic operations and
+    platform specific code where performance or compatibility is needed.

 
     @library{wxcore}
     @category{gdi}
 
     @library{wxcore}
     @category{gdi}


@@ -256,6 +271,10 @@ public:
         @param depth
             Specifies the depth of the bitmap.
             If this is omitted, then a value of 1 (monochrome bitmap) is used.
         @param depth
             Specifies the depth of the bitmap.
             If this is omitted, then a value of 1 (monochrome bitmap) is used.

+
+        @beginWxPerlOnly
+        In wxPerl use Wx::Bitmap->newFromBits(bits, width, height, depth).
+        @endWxPerlOnly

     */
     wxBitmap(const char bits[], int width, int height, int depth = 1);
 
     */
     wxBitmap(const char bits[], int width, int height, int depth = 1);
 


@@ -269,9 +288,18 @@ public:
         A depth of 32 including an alpha channel is supported under MSW, Mac and GTK+.
     */
     wxBitmap(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
         A depth of 32 including an alpha channel is supported under MSW, Mac and GTK+.
     */
     wxBitmap(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);

+    
+    /**
+        @overload
+    */
+    wxBitmap(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH);

 
     /**
         Creates a bitmap from XPM data.
 
     /**
         Creates a bitmap from XPM data.

+
+        @beginWxPerlOnly
+        In wxPerl use Wx::Bitmap->newFromXPM(data).
+        @endWxPerlOnly

     */
     wxBitmap(const char* const* bits);
 
     */
     wxBitmap(const char* const* bits);
 


@@ -336,6 +364,14 @@ public:
         @param handler
             A new bitmap format handler object. There is usually only one instance
             of a given handler class in an application session.
         @param handler
             A new bitmap format handler object. There is usually only one instance
             of a given handler class in an application session.

+            
+        Note that unlike wxImage::AddHandler, there's no documented list of
+        the wxBitmapHandlers available in wxWidgets.
+        This is because they are platform-specific and most important, they are 
+        all automatically loaded at startup.
+        
+        If you want to be sure that wxBitmap can load a certain type of image,
+        you'd better use wxImage::AddHandler.

 
         @see wxBitmapHandler
     */
 
         @see wxBitmapHandler
     */


@@ -362,10 +398,15 @@ public:
     /**
         Creates a fresh bitmap.
         If the final argument is omitted, the display depth of the screen is used.
     /**
         Creates a fresh bitmap.
         If the final argument is omitted, the display depth of the screen is used.

-
-        This overload works on all platforms.
+        
+        @return @true if the creation was successful.

     */
     virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
     */
     virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);

+    
+    /**
+        @overload
+    */
+    virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH);

 
     /*
         Creates a bitmap from the given data, which can be of arbitrary type.
 
     /*
         Creates a bitmap from the given data, which can be of arbitrary type.


@@ -436,7 +477,7 @@ public:
 
         @see wxBitmapHandler
     */
 
         @see wxBitmapHandler
     */

-    static wxList GetHandlers();
+    static wxList& GetHandlers();

 
     /**
         Gets the height of the bitmap in pixels.
 
     /**
         Gets the height of the bitmap in pixels.


@@ -476,6 +517,15 @@ public:
     */
     wxSize GetSize() const;
 
     */
     wxSize GetSize() const;
 

+    /**
+        Returns disabled (dimmed) version of the bitmap.
+
+        This method is not available when <code>wxUSE_IMAGE == 0</code>.
+
+        @since 2.9.0
+    */
+    wxBitmap ConvertToDisabled(unsigned char brightness = 255) const;
+

     /**
         Gets the width of the bitmap in pixels.
 
     /**
         Gets the width of the bitmap in pixels.
 


@@ -660,19 +710,11 @@ public:
 
     /**
         Constructs a mask from a monochrome bitmap.
 
     /**
         Constructs a mask from a monochrome bitmap.

-
-        @beginWxPythonOnly
-        This is the default constructor for wxMask in wxPython.
-        @endWxPythonOnly

     */
     wxMask(const wxBitmap& bitmap);
 
     /**
         Constructs a mask from a bitmap and a colour that indicates the background.
     */
     wxMask(const wxBitmap& bitmap);
 
     /**
         Constructs a mask from a bitmap and a colour that indicates the background.

-
-        @beginWxPythonOnly
-        wxPython has an alternate wxMask constructor matching this form called wxMaskColour.
-        @endWxPythonOnly

     */
     wxMask(const wxBitmap& bitmap, const wxColour& colour);
 
     */
     wxMask(const wxBitmap& bitmap, const wxColour& colour);