synchronize GTK2 minimum version in docs

[wxWidgets.git] / include / wx / msw / dib.h

diff --git a/include/wx/msw/dib.h b/include/wx/msw/dib.h
index a72122254a3846ec0fe14f19c118ed10c5caa1df..fcfce370fddfda998085950e56983d10317745a8 100644 (file)
--- a/include/wx/msw/dib.h
+++ b/include/wx/msw/dib.h
@@ -5,23 +5,28 @@
 // Modified by:
 // Created:     03.03.03 (replaces the old file with the same name)
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     03.03.03 (replaces the old file with the same name)
 // RCS-ID:      $Id$

-// Copyright:   (c) 1997-2003 wxWindows team
+// Copyright:   (c) 1997-2003 wxWidgets team

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MSW_DIB_H_
 #define _WX_MSW_DIB_H_
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MSW_DIB_H_
 #define _WX_MSW_DIB_H_
 

-class WXDLLEXPORT wxBitmap;
-class WXDLLEXPORT wxPalette;
+class WXDLLIMPEXP_FWD_CORE wxPalette;

 
 #include "wx/msw/private.h"
 
 
 #include "wx/msw/private.h"
 

+#if wxUSE_WXDIB
+
+#ifdef __WXMSW__
+    #include "wx/bitmap.h"
+#endif // __WXMSW__
+

 // ----------------------------------------------------------------------------
 // wxDIB: represents a DIB section
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxDIB: represents a DIB section
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDIB
+class WXDLLIMPEXP_CORE wxDIB

 {
 public:
     // ctors and such
 {
 public:
     // ctors and such


@@ -35,6 +40,16 @@ public:
     wxDIB(int width, int height, int depth)
         { Init(); (void)Create(width, height, depth); }
 
     wxDIB(int width, int height, int depth)
         { Init(); (void)Create(width, height, depth); }
 

+#ifdef __WXMSW__
+    // create a DIB from the DDB
+    wxDIB(const wxBitmap& bmp)
+        { Init(); (void)Create(bmp); }
+#endif // __WXMSW__
+
+    // create a DIB from the Windows DDB
+    wxDIB(HBITMAP hbmp)
+        { Init(); (void)Create(hbmp); }
+

     // load a DIB from file (any depth is supoprted here unlike above)
     //
     // as above, use IsOk() to see if the bitmap was loaded successfully
     // load a DIB from file (any depth is supoprted here unlike above)
     //
     // as above, use IsOk() to see if the bitmap was loaded successfully


@@ -43,6 +58,10 @@ public:
 
     // same as the corresponding ctors but with return value
     bool Create(int width, int height, int depth);
 
     // same as the corresponding ctors but with return value
     bool Create(int width, int height, int depth);

+#ifdef __WXMSW__
+    bool Create(const wxBitmap& bmp) { return Create(GetHbitmapOf(bmp)); }
+#endif
+    bool Create(HBITMAP hbmp);

     bool Load(const wxString& filename);
 
     // dtor is not virtual, this class is not meant to be used polymorphically
     bool Load(const wxString& filename);
 
     // dtor is not virtual, this class is not meant to be used polymorphically


@@ -52,10 +71,12 @@ public:
     // operations
     // ----------
 
     // operations
     // ----------
 

-    // create a bitmap compatiblr with the given HDC (or screen by default) and
+#ifndef __WXWINCE__
+    // create a bitmap compatible with the given HDC (or screen by default) and

     // return its handle, the caller is responsible for freeing it (using
     // DeleteObject())
     // return its handle, the caller is responsible for freeing it (using
     // DeleteObject())

-    HBITMAP CreateDDB(HDC hdc = NULL) const;
+    HBITMAP CreateDDB(HDC hdc = 0) const;
+#endif // !__WXWINCE__

 
     // get the handle from the DIB and reset it, i.e. this object won't destroy
     // the DIB after this (but the caller should do it)
 
     // get the handle from the DIB and reset it, i.e. this object won't destroy
     // the DIB after this (but the caller should do it)


@@ -66,6 +87,9 @@ public:
     wxPalette *CreatePalette() const;
 #endif // wxUSE_PALETTE
 
     wxPalette *CreatePalette() const;
 #endif // wxUSE_PALETTE
 

+    // save the DIB as a .BMP file to the file with the given name
+    bool Save(const wxString& filename);
+

 
     // accessors
     // ---------
 
     // accessors
     // ---------


@@ -86,19 +110,63 @@ public:
 
     // get raw pointer to bitmap bits, you should know what you do if you
     // decide to use it
 
     // get raw pointer to bitmap bits, you should know what you do if you
     // decide to use it

-    void *GetData() const { DoGetObject(); return m_data; }
+    unsigned char *GetData() const
+        { DoGetObject(); return (unsigned char *)m_data; }
+
+
+    // HBITMAP conversion
+    // ------------------
+
+    // these functions are only used by wxWidgets internally right now, please
+    // don't use them directly if possible as they're subject to change
+
+#ifndef __WXWINCE__
+    // creates a DDB compatible with the given (or screen) DC from either
+    // a plain DIB or a DIB section (in which case the last parameter must be
+    // non NULL)
+    static HBITMAP ConvertToBitmap(const BITMAPINFO *pbi,
+                                   HDC hdc = 0,
+                                   void *bits = NULL);
+
+    // create a plain DIB (not a DIB section) from a DDB, the caller is
+    // responsable for freeing it using ::GlobalFree()
+    static HGLOBAL ConvertFromBitmap(HBITMAP hbmp);
+
+    // creates a DIB from the given DDB or calculates the space needed by it:
+    // if pbi is NULL, only the space is calculated, otherwise pbi is supposed
+    // to point at BITMAPINFO of the correct size which is filled by this
+    // function (this overload is needed for wxBitmapDataObject code in
+    // src/msw/ole/dataobj.cpp)
+    static size_t ConvertFromBitmap(BITMAPINFO *pbi, HBITMAP hbmp);
+#endif // __WXWINCE__

 
 
     // wxImage conversion
     // ------------------
 
 #if wxUSE_IMAGE
 
 
     // wxImage conversion
     // ------------------
 
 #if wxUSE_IMAGE

-    // create a DIB from the given image, the DIB will be either 24 or 32 (if
-    // the image has alpha channel) bpp
-    wxDIB(const wxImage& image) { Init(); (void)Create(image); }
+    // Possible formats for DIBs created by the functions below.
+    enum PixelFormat
+    {
+        PixelFormat_PreMultiplied = 0,
+        PixelFormat_NotPreMultiplied = 1
+    };
+
+    // Create a DIB from the given image, the DIB will be either 24 or 32 (if
+    // the image has alpha channel) bpp.
+    //
+    // By default the DIB stores pixel data in pre-multiplied format so that it
+    // can be used with ::AlphaBlend() but it is also possible to disable
+    // pre-multiplication for the DIB to be usable with ImageList_Draw() which
+    // does pre-multiplication internally.
+    wxDIB(const wxImage& image, PixelFormat pf = PixelFormat_PreMultiplied)
+    {
+        Init();
+        (void)Create(image, pf);
+    }

 
     // same as the above ctor but with the return code
 
     // same as the above ctor but with the return code

-    bool Create(const wxImage& image);
+    bool Create(const wxImage& image, PixelFormat pf = PixelFormat_PreMultiplied);

 
     // create wxImage having the same data as this DIB
     wxImage ConvertToImage() const;
 
     // create wxImage having the same data as this DIB
     wxImage ConvertToImage() const;


@@ -118,30 +186,15 @@ public:
 
 private:
     // common part of all ctors
 
 private:
     // common part of all ctors

-    void Init()
-    {
-        m_handle = 0;
-
-        m_data = NULL;
-
-        m_width =
-        m_height =
-        m_depth = 0;
-    }
+    void Init();

 
     // free resources
 
     // free resources

-    void Free()
-    {
-        if ( m_handle )
-        {
-            if ( !::DeleteObject(m_handle) )
-            {
-                wxLogLastError(wxT("DeleteObject(hDIB)"));
-            }
+    void Free();
+
+    // initialize the contents from the provided DDB (Create() must have been
+    // already called)
+    bool CopyFromDDB(HBITMAP hbmp);

 
 

-            Init();
-        }
-    }

 
     // the DIB section handle, 0 if invalid
     HBITMAP m_handle;
 
     // the DIB section handle, 0 if invalid
     HBITMAP m_handle;


@@ -165,6 +218,11 @@ private:
         m_height,
         m_depth;
 
         m_height,
         m_depth;
 

+    // in some cases we could be using a handle which we didn't create and in
+    // this case we shouldn't free it neither -- this flag tell us if this is
+    // the case
+    bool m_ownsHandle;
+

 
     // DIBs can't be copied
     wxDIB(const wxDIB&);
 
     // DIBs can't be copied
     wxDIB(const wxDIB&);


@@ -175,42 +233,40 @@ private:
 // inline functions implementation
 // ----------------------------------------------------------------------------
 
 // inline functions implementation
 // ----------------------------------------------------------------------------
 

-inline wxDIB::~wxDIB()
+inline
+void wxDIB::Init()

 {
 {

-    Free();
-}
-
-// ----------------------------------------------------------------------------
-// Functions for working with DIBs
-// ----------------------------------------------------------------------------
-
-// WARNING: these functions are private to wxWindows and shouldn't be used
-//          by the user code, they risk to disappear in the next versions!
-
-// VZ: we have 3 different sets of functions: from bitmap.cpp (wxCreateDIB and
-//     wxFreeDIB), from dib.cpp and from dataobj.cpp - surely there is some
-//     redundancy between them? (FIXME)
+    m_handle = 0;
+    m_ownsHandle = true;

 
 

-// defined in ole/dataobj.cpp
-extern WXDLLEXPORT size_t wxConvertBitmapToDIB(LPBITMAPINFO pbi, const wxBitmap& bitmap);
-extern WXDLLEXPORT wxBitmap wxConvertDIBToBitmap(const LPBITMAPINFO pbi);
+    m_data = NULL;

 
 

-// the rest is defined in dib.cpp
+    m_width =
+    m_height =
+    m_depth = 0;
+}

 
 

-// Save (device dependent) wxBitmap as a DIB
-bool wxSaveBitmap(wxChar *filename, wxBitmap *bitmap, wxPalette *palette = NULL);
+inline
+void wxDIB::Free()
+{
+    if ( m_handle && m_ownsHandle )
+    {
+        if ( !::DeleteObject(m_handle) )
+        {
+            wxLogLastError(wxT("DeleteObject(hDIB)"));
+        }

 
 

-// Load device independent bitmap into device dependent bitmap
-wxBitmap *wxLoadBitmap(wxChar *filename, wxPalette **palette = NULL);
+        Init();
+    }
+}

 
 

-// Load into existing bitmap;
-bool wxLoadIntoBitmap(wxChar *filename, wxBitmap *bitmap, wxPalette **pal = NULL);
+inline wxDIB::~wxDIB()
+{
+    Free();
+}

 
 

-HANDLE wxBitmapToDIB (HBITMAP hBitmap, HPALETTE hPal);
-bool   wxReadDIB(LPTSTR lpFileName, HBITMAP *bitmap, HPALETTE *palette);
-HANDLE wxReadDIB2(LPTSTR lpFileName);
-LPSTR wxFindDIBBits (LPSTR lpbi);
-HPALETTE wxMakeDIBPalette(LPBITMAPINFOHEADER lpInfo);
+#endif
+    // wxUSE_WXDIB

 
 #endif // _WX_MSW_DIB_H_
 
 
 #endif // _WX_MSW_DIB_H_