]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/bitmap.h
added wxBitmapToHICON/CURSOR helper functions
[wxWidgets.git] / include / wx / msw / bitmap.h
index 2aab4a41eee87034f901908b53899a10cb6ca5eb..f834ebba857097dd382b4507ea1c605fe326d9db 100644 (file)
@@ -24,43 +24,14 @@ class WXDLLEXPORT wxDC;
 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;
-
-// ----------------------------------------------------------------------------
-// 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;
-    wxPalette     m_bitmapPalette;
-    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;
-};
+class WXDLLEXPORT wxPalette;
+class WXDLLEXPORT wxRawBitmapData;
 
 // ----------------------------------------------------------------------------
 // wxBitmap: a mono or colour bitmap
@@ -88,11 +59,25 @@ public:
     // 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);
-    
-    // Convert from wxImage:
-    wxBitmap(const wxImage& image, int depth = -1) { (void)CreateFromImage(image, depth); }   
+
+    // Create a bitmap compatible with the given DC
+    wxBitmap(int width, int height, const wxDC& dc);
+
+#if wxUSE_IMAGE
+    // Convert from wxImage
+    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
     // the copy ctor but the resulting bitmap is invalid!
@@ -121,11 +106,13 @@ public:
 
     virtual ~wxBitmap();
 
+#if wxUSE_IMAGE
     wxImage ConvertToImage() const;
+#endif // wxUSE_IMAGE
 
     // get the given part of bitmap
     wxBitmap GetSubBitmap( const wxRect& rect ) const;
+
     // copies the contents and mask of the given (colour) icon to the bitmap
     bool CopyFromIcon(const wxIcon& icon);
 
@@ -133,40 +120,61 @@ public:
     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);
 
-    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 */ }
 
-    wxPalette* GetPalette() const { return (GetBitmapData() ? (& GetBitmapData()->m_bitmapPalette) : (wxPalette*) NULL); }
+#if wxUSE_PALETTE
+    wxPalette* GetPalette() const;
     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; }
 
+    // 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
+#if wxUSE_PALETTE
     wxPalette *GetColourMap() const { return GetPalette(); }
     void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
+#endif // wxUSE_PALETTE
 #endif // WXWIN_COMPATIBILITY
 
-    // Implementation
+    // implementation only from now on
+    // -------------------------------
+
 public:
     void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
     WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
 
-    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
@@ -186,14 +194,24 @@ protected:
     // 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 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);
 
+    // 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__