Removed redundant wx<Control>NameStr declarations.

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

diff --git a/include/wx/msw/dib.h b/include/wx/msw/dib.h
index ec1a601db7ab1575f065ddae6fefa3a8011a77f9..6a2a40a02077f88e3d253f9f1ea55a929fa2e292 100644 (file)
--- a/include/wx/msw/dib.h
+++ b/include/wx/msw/dib.h
@@ -35,26 +35,45 @@ 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); }
 

-    // same as ctor but with return value
+    // create a DIB from the DDB
+    wxDIB(const wxBitmap& bmp)
+        { Init(); (void)Create(bmp); }
+
+    // load a DIB from file (any depth is supoprted here unlike above)
+    //
+    // as above, use IsOk() to see if the bitmap was loaded successfully
+    wxDIB(const wxString& filename)
+        { Init(); (void)Load(filename); }
+
+    // same as the corresponding ctors but with return value

     bool Create(int width, int height, int depth);
     bool Create(int width, int height, int depth);

+    bool Create(const wxBitmap& bmp);
+    bool Load(const wxString& filename);

 
     // dtor is not virtual, this class is not meant to be used polymorphically
 
     // dtor is not virtual, this class is not meant to be used polymorphically

-    ~wxDIB()
-    {
-        if ( m_handle && !::DeleteObject(m_handle) )
-        {
-            wxLogLastError(wxT("DeleteObject(hDIB)"));
-        }
-    }
+    ~wxDIB();

 
 
     // operations
     // ----------
 
 
 
     // operations
     // ----------
 

+    // create a bitmap compatiblr with the given HDC (or screen by default) and
+    // return its handle, the caller is responsible for freeing it (using
+    // DeleteObject())
+    HBITMAP CreateDDB(HDC hdc = 0) const;
+

     // 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)
     HBITMAP Detach() { HBITMAP hbmp = m_handle; m_handle = 0; return hbmp; }
 
     // 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)
     HBITMAP Detach() { HBITMAP hbmp = m_handle; m_handle = 0; return hbmp; }
 

+#if wxUSE_PALETTE
+    // create a palette for this DIB (always a trivial/default one for 24bpp)
+    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
     // ---------


@@ -78,6 +97,31 @@ public:
     void *GetData() const { DoGetObject(); return m_data; }
 
 
     void *GetData() const { DoGetObject(); return m_data; }
 
 

+    // HBITMAP conversion
+    // ------------------
+
+    // these functions are only used by wxWindows internally right now, please
+    // don't use them directly if possible as they're subject to change
+
+    // 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);
+
+

     // wxImage conversion
     // ------------------
 
     // wxImage conversion
     // ------------------
 


@@ -107,16 +151,10 @@ public:
 
 private:
     // common part of all ctors
 
 private:
     // common part of all ctors

-    void Init()
-    {
-        m_handle = 0;
+    void Init();

 
 

-        m_data = NULL;
-
-        m_width =
-        m_height =
-        m_depth = 0;
-    }
+    // free resources
+    void Free();

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


@@ -140,49 +178,52 @@ 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&);
     wxDIB& operator=(const wxDIB&);
 };
 
 
     // DIBs can't be copied
     wxDIB(const wxDIB&);
     wxDIB& operator=(const wxDIB&);
 };
 

-

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// Functions for working with DIBs
+// inline functions implementation

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-// 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)
-
-// defined in bitmap.cpp
-extern bool wxCreateDIB(long xSize, long ySize, long bitsPerPixel,
-                       HPALETTE hPal, LPBITMAPINFO* lpDIBHeader);
-extern void wxFreeDIB(LPBITMAPINFO lpDIBHeader);
-
-// defined in ole/dataobj.cpp
-extern WXDLLEXPORT size_t wxConvertBitmapToDIB(LPBITMAPINFO pbi, const wxBitmap& bitmap);
-extern WXDLLEXPORT wxBitmap wxConvertDIBToBitmap(const LPBITMAPINFO pbi);
+inline
+void wxDIB::Init()
+{
+    m_handle = 0;
+    m_ownsHandle = true;

 
 

-// the rest is defined in dib.cpp
+    m_data = NULL;

 
 

-// Save (device dependent) wxBitmap as a DIB
-bool wxSaveBitmap(wxChar *filename, wxBitmap *bitmap, wxPalette *palette = NULL);
+    m_width =
+    m_height =
+    m_depth = 0;
+}

 
 

-// Load device independent bitmap into device dependent bitmap
-wxBitmap *wxLoadBitmap(wxChar *filename, wxPalette **palette = NULL);
+inline
+void wxDIB::Free()
+{
+    if ( m_handle && m_ownsHandle )
+    {
+        if ( !::DeleteObject(m_handle) )
+        {
+            wxLogLastError(wxT("DeleteObject(hDIB)"));
+        }

 
 

-// Load into existing bitmap;
-bool wxLoadIntoBitmap(wxChar *filename, wxBitmap *bitmap, wxPalette **pal = NULL);
+        Init();
+    }
+}

 
 

-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);
+inline wxDIB::~wxDIB()
+{
+    Free();
+}

 
 #endif // _WX_MSW_DIB_H_
 
 
 #endif // _WX_MSW_DIB_H_