Skeleton for generic Drag code

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

diff --git a/include/wx/gtk/bitmap.h b/include/wx/gtk/bitmap.h
index a6c24d9c068a3d80e4270889f45e23017f411f04..8c65fa9e805801bf8994d91fb1049dc7c6fd7b60 100644 (file)
--- a/include/wx/gtk/bitmap.h
+++ b/include/wx/gtk/bitmap.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        bitmap.h
+// Name:        wx/gtk/bitmap.h
 // Purpose:
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
@@ -7,50 +7,38 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+#ifndef _WX_GTK_BITMAP_H_
+#define _WX_GTK_BITMAP_H_
 
-#ifndef __GTKBITMAPH__
-#define __GTKBITMAPH__
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/palette.h"
-#include "wx/gdiobj.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxMask;
-class wxBitmap;
-class wxImage;
+typedef struct _GdkPixbuf GdkPixbuf;
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
 
 //-----------------------------------------------------------------------------
 // wxMask
 //-----------------------------------------------------------------------------
 
-class wxMask: public wxObject
+class WXDLLIMPEXP_CORE wxMask: public wxObject
 {
 public:
     wxMask();
     wxMask( const wxBitmap& bitmap, const wxColour& colour );
+#if wxUSE_PALETTE
     wxMask( const wxBitmap& bitmap, int paletteIndex );
+#endif // wxUSE_PALETTE
     wxMask( const wxBitmap& bitmap );
-    ~wxMask();
-  
+    virtual ~wxMask();
+
     bool Create( const wxBitmap& bitmap, const wxColour& colour );
+#if wxUSE_PALETTE
     bool Create( const wxBitmap& bitmap, int paletteIndex );
+#endif // wxUSE_PALETTE
     bool Create( const wxBitmap& bitmap );
 
     // implementation
     GdkBitmap   *m_bitmap;
-    
+
     GdkBitmap *GetBitmap() const;
-  
+
 private:
     DECLARE_DYNAMIC_CLASS(wxMask)
 };
@@ -59,42 +47,54 @@ private:
 // wxBitmap
 //-----------------------------------------------------------------------------
 
-class wxBitmap: public wxGDIObject
+class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase
 {
 public:
-    wxBitmap();
-    wxBitmap( int width, int height, int depth = -1 );
+    wxBitmap() { }
+    wxBitmap( int width, int height, int depth = wxBITMAP_SCREEN_DEPTH );
     wxBitmap( const char bits[], int width, int height, int depth = 1 );
-    wxBitmap( const char **bits ) { (void)CreateFromXpm(bits); }
-    wxBitmap( char **bits ) { (void)CreateFromXpm((const char **)bits); }
-    wxBitmap( const wxBitmap& bmp );
-    wxBitmap( const wxString &filename, int type = wxBITMAP_TYPE_XPM );
-    wxBitmap( const wxImage& image, int depth = -1 ) { (void)CreateFromImage(image, depth); }
-    ~wxBitmap();
-    wxBitmap& operator = ( const wxBitmap& bmp );
-    bool operator == ( const wxBitmap& bmp ) const;
-    bool operator != ( const wxBitmap& bmp ) const;
-    bool Ok() const;
-
-    bool Create(int width, int height, int depth = -1);
-    
-    int GetHeight() const;
-    int GetWidth() const;
-    int GetDepth() const;
-    
+    wxBitmap( const char* const* bits );
+#ifdef wxNEEDS_CHARPP
+    // needed for old GCC
+    wxBitmap(char** data)
+    { *this = wxBitmap(const_cast<const char* const*>(data)); }
+#endif
+    wxBitmap( const wxString &filename, wxBitmapType type = wxBITMAP_DEFAULT_TYPE );
+#if wxUSE_IMAGE
+    wxBitmap( const wxImage& image, int depth = wxBITMAP_SCREEN_DEPTH )
+        { (void)CreateFromImage(image, depth); }
+#endif // wxUSE_IMAGE
+    virtual ~wxBitmap();
+
+    bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
+
+    virtual int GetHeight() const;
+    virtual int GetWidth() const;
+    virtual int GetDepth() const;
+
+#if wxUSE_IMAGE
     wxImage ConvertToImage() const;
+#endif // wxUSE_IMAGE
+
+    // copies the contents and mask of the given (colour) icon to the bitmap
+    virtual bool CopyFromIcon(const wxIcon& icon);
 
     wxMask *GetMask() const;
     void SetMask( wxMask *mask );
-    
+
     wxBitmap GetSubBitmap( const wxRect& rect ) const;
 
-    bool SaveFile( const wxString &name, int type, wxPalette *palette = (wxPalette *) NULL );
-    bool LoadFile( const wxString &name, int type = wxBITMAP_TYPE_XPM );
+    bool SaveFile(const wxString &name, wxBitmapType type,
+                          const wxPalette *palette = NULL) const;
+    bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
 
+#if wxUSE_PALETTE
     wxPalette *GetPalette() const;
-    wxPalette *GetColourMap() const
-    { return GetPalette(); };
+    void SetPalette(const wxPalette& palette);
+    wxPalette *GetColourMap() const { return GetPalette(); };
+#endif // wxUSE_PALETTE
+
+    static void InitStandardHandlers();
 
     // implementation
     // --------------
@@ -103,17 +103,47 @@ public:
     void SetWidth( int width );
     void SetDepth( int depth );
     void SetPixmap( GdkPixmap *pixmap );
-    void SetBitmap( GdkBitmap *bitmap );
+    void SetPixbuf(GdkPixbuf* pixbuf, int depth = 0);
 
     GdkPixmap *GetPixmap() const;
-    GdkBitmap *GetBitmap() const;
-    
+    bool HasPixmap() const;
+    bool HasPixbuf() const;
+    GdkPixbuf *GetPixbuf() const;
+
+    // raw bitmap access support functions
+    void *GetRawData(wxPixelDataBase& data, int bpp);
+    void UngetRawData(wxPixelDataBase& data);
+
+    bool HasAlpha() const;
+
 protected:
-    bool CreateFromXpm(const char **bits);
+#if wxUSE_IMAGE
     bool CreateFromImage(const wxImage& image, int depth);
+#endif // wxUSE_IMAGE
+
+    virtual wxGDIRefData* CreateGDIRefData() const;
+    virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* data) const;
+
+private:
+#if wxUSE_IMAGE
+    // to be called from CreateFromImage only!
+    bool CreateFromImageAsPixmap(const wxImage& image, int depth);
+    bool CreateFromImageAsPixbuf(const wxImage& image);
+#endif // wxUSE_IMAGE
+
+public:
+    // implementation only
+    enum Representation
+    {
+        Pixmap,
+        Pixbuf
+    };
+    // removes other representations from memory, keeping only 'keep'
+    // (wxBitmap may keep same bitmap e.g. as both pixmap and pixbuf):
+    void PurgeOtherRepresentations(Representation keep);
 
 private:
     DECLARE_DYNAMIC_CLASS(wxBitmap)
 };
 
-#endif // __GTKBITMAPH__
+#endif // _WX_GTK_BITMAP_H_