added wxBitmapToHICON/CURSOR helper functions

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

diff --git a/include/wx/msw/bitmap.h b/include/wx/msw/bitmap.h
index f173d69e39c128067db04e7058114e91b4fb06b7..f834ebba857097dd382b4507ea1c605fe326d9db 100644 (file)
--- a/include/wx/msw/bitmap.h
+++ b/include/wx/msw/bitmap.h
@@ -24,53 +24,14 @@ class WXDLLEXPORT wxDC;
 class WXDLLEXPORT wxControl;
 class WXDLLEXPORT wxBitmap;
 class WXDLLEXPORT wxBitmapHandler;
 class WXDLLEXPORT wxControl;
 class WXDLLEXPORT wxBitmap;
 class WXDLLEXPORT wxBitmapHandler;

+class WXDLLEXPORT wxBitmapRefData;

 class WXDLLEXPORT wxIcon;
 class WXDLLEXPORT wxMask;
 class WXDLLEXPORT wxCursor;
 class WXDLLEXPORT wxControl;
 class WXDLLEXPORT wxImage;
 class WXDLLEXPORT wxPalette;
 class WXDLLEXPORT wxIcon;
 class WXDLLEXPORT wxMask;
 class WXDLLEXPORT wxCursor;
 class WXDLLEXPORT wxControl;
 class WXDLLEXPORT wxImage;
 class WXDLLEXPORT wxPalette;

-
-// ----------------------------------------------------------------------------
-// Bitmap data
-//
-// NB: this class is private, but declared here to make it possible inline
-//     wxBitmap functions accessing it
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
-{
-public:
-    wxBitmapRefData();
-    virtual ~wxBitmapRefData() { Free(); }
-
-    virtual void Free();
-
-public:
-    int           m_numColors;
-#if wxUSE_PALETTE
-    wxPalette     m_bitmapPalette;
-#endif // wxUSE_PALETTE
-    int           m_quality;
-
-    // MSW-specific
-    // ------------
-
-    // this field is solely for error checking: we detect selecting a bitmap
-    // into more than one DC at once or deleting a bitmap still selected into a
-    // DC (both are serious programming errors under Windows)
-    wxDC         *m_selectedInto;
-
-    // optional mask for transparent drawing
-    wxMask       *m_bitmapMask;
-
-#if wxUSE_DIB_FOR_BITMAP
-    WXHANDLE     m_hFileMap;   // file mapping handle for large DIB's
-#endif
-
-
-    DECLARE_NO_COPY_CLASS(wxBitmapRefData)
-};
+class WXDLLEXPORT wxRawBitmapData;

 
 // ----------------------------------------------------------------------------
 // wxBitmap: a mono or colour bitmap
 
 // ----------------------------------------------------------------------------
 // wxBitmap: a mono or colour bitmap


@@ -98,13 +59,24 @@ public:
     // New constructor for generalised creation from data
     wxBitmap(void *data, long type, int width, int height, int depth = 1);
 
     // New constructor for generalised creation from data
     wxBitmap(void *data, long type, int width, int height, int depth = 1);
 

-    // If depth is omitted, will create a bitmap compatible with the display
+    // Create a new, uninitialized bitmap of the given size and depth (if it
+    // is omitted, will create a bitmap compatible with the display)
+    //
+    // NB: this ctor will create a DIB for 24 and 32bpp bitmaps, use ctor
+    //     taking a DC argument if you want to force using DDB in this case

     wxBitmap(int width, int height, int depth = -1);
 
     wxBitmap(int width, int height, int depth = -1);
 

+    // Create a bitmap compatible with the given DC
+    wxBitmap(int width, int height, const wxDC& dc);
+

 #if wxUSE_IMAGE
 #if wxUSE_IMAGE

-    // Convert from wxImage:
+    // Convert from wxImage

     wxBitmap(const wxImage& image, int depth = -1)
         { (void)CreateFromImage(image, depth); }
     wxBitmap(const wxImage& image, int depth = -1)
         { (void)CreateFromImage(image, depth); }

+
+    // Create a DDB compatible with the given DC from wxImage
+    wxBitmap(const wxImage& image, const wxDC& dc)
+        { (void)CreateFromImage(image, dc); }

 #endif // wxUSE_IMAGE
 
     // we must have this, otherwise icons are silently copied into bitmaps using
 #endif // wxUSE_IMAGE
 
     // we must have this, otherwise icons are silently copied into bitmaps using


@@ -148,49 +120,61 @@ public:
     bool CopyFromCursor(const wxCursor& cursor);
 
     virtual bool Create(int width, int height, int depth = -1);
     bool CopyFromCursor(const wxCursor& cursor);
 
     virtual bool Create(int width, int height, int depth = -1);

+    virtual bool Create(int width, int height, const wxDC& dc);

     virtual bool Create(void *data, long type, int width, int height, int depth = 1);
     virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
     virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
 
     virtual bool Create(void *data, long type, int width, int height, int depth = 1);
     virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_BMP_RESOURCE);
     virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
 

-    wxBitmapRefData *GetBitmapData() const { return (wxBitmapRefData *)m_refData; }
+    wxBitmapRefData *GetBitmapData() const
+        { return (wxBitmapRefData *)m_refData; }

 
 

-    int GetQuality() const { return (GetBitmapData() ? GetBitmapData()->m_quality : 0); }
-    void SetQuality(int q);
+    // raw bitmap access support functions
+    bool GetRawData(wxRawBitmapData *data);
+    void UngetRawData(wxRawBitmapData *) { /* nothing to do here */ }

 
 #if wxUSE_PALETTE
 
 #if wxUSE_PALETTE

-    wxPalette* GetPalette() const { return (GetBitmapData() ? (& GetBitmapData()->m_bitmapPalette) : (wxPalette*) NULL); }
+    wxPalette* GetPalette() const;

     void SetPalette(const wxPalette& palette);
 #endif // wxUSE_PALETTE
 
     void SetPalette(const wxPalette& palette);
 #endif // wxUSE_PALETTE
 

-    wxMask *GetMask() const { return (GetBitmapData() ? GetBitmapData()->m_bitmapMask : (wxMask*) NULL); }
-    void SetMask(wxMask *mask) ;
+    wxMask *GetMask() const;
+    void SetMask(wxMask *mask);

 
     bool operator==(const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
     bool operator!=(const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
 
 
     bool operator==(const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
     bool operator!=(const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
 

+    // this function is internal and shouldn't be used, it risks to disappear
+    bool HasAlpha() const;
+
+#if WXWIN_COMPATIBILITY_2_4
+    // these functions do nothing and are only there for backwards
+    // compatibility
+    wxDEPRECATED( int GetQuality() const );
+    wxDEPRECATED( void SetQuality(int quality) );
+#endif // WXWIN_COMPATIBILITY_2_4
+

 #if WXWIN_COMPATIBILITY_2
     void SetOk(bool isOk);
 #endif // WXWIN_COMPATIBILITY_2
 
 #if WXWIN_COMPATIBILITY_2
     void SetOk(bool isOk);
 #endif // WXWIN_COMPATIBILITY_2
 

-#if wxUSE_PALETTE

 #if WXWIN_COMPATIBILITY
 #if WXWIN_COMPATIBILITY

+#if wxUSE_PALETTE

     wxPalette *GetColourMap() const { return GetPalette(); }
     void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
     wxPalette *GetColourMap() const { return GetPalette(); }
     void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };

-#endif // WXWIN_COMPATIBILITY

 #endif // wxUSE_PALETTE
 #endif // wxUSE_PALETTE

+#endif // WXWIN_COMPATIBILITY
+
+    // implementation only from now on
+    // -------------------------------

 
 

-    // Implementation

 public:
     void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
     WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
 
 public:
     void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
     WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
 

-#if wxUSE_DIB_FOR_BITMAP
-    void SetHFileMap(WXHANDLE hFileMap) { GetBitmapData()->m_hFileMap = hFileMap; }
-    WXHANDLE GetHFileMap() const { return GetBitmapData()->m_hFileMap; }
-#endif // wxUSE_DIB_FOR_BITMAP
-
-    void SetSelectedInto(wxDC *dc) { if (GetBitmapData()) GetBitmapData()->m_selectedInto = dc; }
-    wxDC *GetSelectedInto() const { return (GetBitmapData() ? GetBitmapData()->m_selectedInto : (wxDC*) NULL); }
+#ifdef __WXDEBUG__
+    void SetSelectedInto(wxDC *dc);
+    wxDC *GetSelectedInto() const;
+#endif // __WXDEBUG__

 
     // Creates a bitmap that matches the device context's depth, from an
     // arbitray bitmap. At present, the original bitmap must have an associated
 
     // Creates a bitmap that matches the device context's depth, from an
     // arbitray bitmap. At present, the original bitmap must have an associated


@@ -210,21 +194,24 @@ protected:
     // common part of all ctors
     void Init();
 
     // common part of all ctors
     void Init();
 

-    virtual wxGDIImageRefData *CreateData() const
-        { return new wxBitmapRefData; }
+    virtual wxGDIImageRefData *CreateData() const;

 
     // creates the bitmap from XPM data, supposed to be called from ctor
     bool CreateFromXpm(const char **bits);
 
 
     // creates the bitmap from XPM data, supposed to be called from ctor
     bool CreateFromXpm(const char **bits);
 

+    // creates an uninitialized bitmap, called from Create()s above
+    bool DoCreate(int w, int h, int depth, WXHDC hdc);
+

 #if wxUSE_IMAGE
     // creates the bitmap from wxImage, supposed to be called from ctor
     bool CreateFromImage(const wxImage& image, int depth);
 #if wxUSE_IMAGE
     // creates the bitmap from wxImage, supposed to be called from ctor
     bool CreateFromImage(const wxImage& image, int depth);

-#endif // wxUSE_IMAGE

 
 

-#if wxUSE_DIB_FOR_BITMAP
-    void *CreateDIB(int width, int height, int depth);
-    void CopyDIBLine(void* src, void* dest, int count) const;
-#endif
+    // creates a DDB from wxImage, supposed to be called from ctor
+    bool CreateFromImage(const wxImage& image, const wxDC& dc);
+
+    // common part of the 2 methods above (hdc may be 0)
+    bool CreateFromImage(const wxImage& image, int depth, WXHDC hdc);
+#endif // wxUSE_IMAGE

 
 private:
 #ifdef __WIN32__
 
 private:
 #ifdef __WIN32__