Applied rowspan patch #15276 (dghart)
[wxWidgets.git] / include / wx / gtk / bitmap.h
index 7baf8849f35ebdfb8bed0d7f7f3ce3af20a7f007..afd8247eb444bd6249a135a4f35e0fae94530d20 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
-// Name:        bitmap.h
+// Name:        wx/gtk/bitmap.h
 // Purpose:
 // Author:      Robert Roebling
-// Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+#ifndef _WX_GTK_BITMAP_H_
+#define _WX_GTK_BITMAP_H_
 
-#ifndef __GTKBITMAPH__
-#define __GTKBITMAPH__
-
-#ifdef __GNUG__
-#pragma interface
+#ifdef __WXGTK3__
+typedef struct _cairo cairo_t;
+typedef struct _cairo_surface cairo_surface_t;
 #endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/palette.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxMask;
-class wxBitmap;
+typedef struct _GdkPixbuf GdkPixbuf;
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
 
 //-----------------------------------------------------------------------------
 // wxMask
 //-----------------------------------------------------------------------------
 
-class wxMask: public wxObject
+class WXDLLIMPEXP_CORE wxMask: public wxMaskBase
 {
-  DECLARE_DYNAMIC_CLASS(wxMask)
-
-  public:
-
+public:
     wxMask();
+    wxMask(const wxMask& mask);
     wxMask( const wxBitmap& bitmap, const wxColour& colour );
+#if wxUSE_PALETTE
     wxMask( const wxBitmap& bitmap, int paletteIndex );
+#endif // wxUSE_PALETTE
     wxMask( const wxBitmap& bitmap );
-    ~wxMask();
-
-  // implementation
-    
-    GdkBitmap *GetBitmap() const;
+    virtual ~wxMask();
+    wxBitmap GetBitmap() const;
+
+    // implementation
+#ifdef __WXGTK3__
+    wxMask(cairo_surface_t*);
+    operator cairo_surface_t*() const;
+#else
+    wxMask(GdkPixmap*);
+    operator GdkPixmap*() const;
+#endif
 
-  protected:
+protected:
+    virtual void FreeData();
+    virtual bool InitFromColour(const wxBitmap& bitmap, const wxColour& colour);
+    virtual bool InitFromMonoBitmap(const wxBitmap& bitmap);
 
-    GdkBitmap *m_bitmap;
+private:
+#ifdef __WXGTK3__
+    cairo_surface_t* m_bitmap;
+#else
+    GdkPixmap* m_bitmap;
+#endif
 
+    DECLARE_DYNAMIC_CLASS(wxMask)
 };
 
 //-----------------------------------------------------------------------------
 // wxBitmap
 //-----------------------------------------------------------------------------
 
-// CMB 20/5/98: added xbm constructor and GetBitmap() method
-class wxBitmap: public wxObject
+class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase
 {
-  DECLARE_DYNAMIC_CLASS(wxBitmap)
+public:
+    wxBitmap() { }
+    wxBitmap( int width, int height, int depth = wxBITMAP_SCREEN_DEPTH )
+        { Create(width, height, depth); }
+    wxBitmap( const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH )
+        { Create(sz, depth); }
+    wxBitmap( const char bits[], int width, int height, int depth = 1 );
+    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);
+#endif // wxUSE_IMAGE
+    wxBitmap(GdkPixbuf* pixbuf, int depth = 0);
+    virtual ~wxBitmap();
 
-  public:
+    bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
+    bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
+        { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
 
-    wxBitmap();
-    wxBitmap( int width, int height, int depth = -1 );
-    wxBitmap( const char bits[], int width, int height, int depth = 1 );
-    wxBitmap( char **bits );
-    wxBitmap( const wxBitmap& bmp );
-    wxBitmap( const wxBitmap* bmp );
-    wxBitmap( const wxString &filename, int type = wxBITMAP_TYPE_XPM);
-    ~wxBitmap();
-    wxBitmap& operator = ( const wxBitmap& bmp );
-    bool operator == ( const wxBitmap& bmp );
-    bool operator != ( const wxBitmap& bmp );
-    bool Ok() const;
-
-    int GetHeight() const;
-    int GetWidth() const;
-    int GetDepth() const;
-    void SetHeight( int height );
-    void SetWidth( int width );
-    void SetDepth( int 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 GetMaskBitmap() const;
 
-    void Resize( int height, int width );
+    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(); };
-      
-  // implementation      
+    void SetPalette(const wxPalette& palette);
+    wxPalette *GetColourMap() const { return GetPalette(); }
+#endif // wxUSE_PALETTE
+
+    static void InitStandardHandlers();
 
+    // implementation
+    // --------------
+
+    void SetHeight( int height );
+    void SetWidth( int width );
+    void SetDepth( int depth );
+
+#ifdef __WXGTK3__
+    GdkPixbuf* GetPixbufNoMask() const;
+    cairo_t* CairoCreate() const;
+    void Draw(cairo_t* cr, int x, int y, bool useMask = true, const wxColour* fg = NULL, const wxColour* bg = NULL) const;
+    void SetSourceSurface(cairo_t* cr, int x, int y, const wxColour* fg = NULL, const wxColour* bg = NULL) const;
+#else
     GdkPixmap *GetPixmap() const;
-    GdkBitmap *GetBitmap() const;
+    bool HasPixmap() const;
+    bool HasPixbuf() const;
+    wxBitmap(GdkPixmap* pixmap);
+#endif
+    GdkPixbuf *GetPixbuf() const;
+
+    // raw bitmap access support functions
+    void *GetRawData(wxPixelDataBase& data, int bpp);
+    void UngetRawData(wxPixelDataBase& data);
+
+    bool HasAlpha() const;
 
-    void DestroyImage();
-    void RecreateImage();
-    void Render();
+protected:
+#ifndef __WXGTK3__
+#if wxUSE_IMAGE
+    bool CreateFromImage(const wxImage& image, int depth);
+#endif // wxUSE_IMAGE
+#endif
+
+    virtual wxGDIRefData* CreateGDIRefData() const;
+    virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* data) const;
+
+private:
+#ifndef __WXGTK3__
+    void SetPixmap(GdkPixmap* pixmap);
+#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);
+#endif
 
-    // no data :-)
+    DECLARE_DYNAMIC_CLASS(wxBitmap)
 };
 
-#endif // __GTKBITMAPH__
+#endif // _WX_GTK_BITMAP_H_