added WX_ASSERT_MESSAGE macro to simply using CPPUNIT_ASSERT_MESSAGE with wxString...

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

diff --git a/include/wx/gtk/bitmap.h b/include/wx/gtk/bitmap.h
index 42f2dabc5a87130bd35371b277141b4f783a3ce4..5cc7ed1c1c6aba9546a4ffb12a8e7ca014b2f635 100644 (file)
--- a/include/wx/gtk/bitmap.h
+++ b/include/wx/gtk/bitmap.h
@@ -1,121 +1,162 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        bitmap.h
+// Name:        wx/gtk/bitmap.h

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97

 // RCS-ID:      $Id$
 // RCS-ID:      $Id$

-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// 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
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/palette.h"
+typedef struct _GdkPixbuf GdkPixbuf;
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;

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

-// classes
+// wxMask

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

-class wxDC;
-class wxPaintDC;
-class wxMemoryDC;
-class wxToolBarGTK;
+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 );
+    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;

 
 

-class wxMask;
-class wxBitmap;
+    GdkBitmap *GetBitmap() const;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxMask)
+};

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

-// wxMask
+// wxBitmap

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

-class wxMask: public wxObject
+class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxMask)
+public:
+    wxBitmap() { }
+    wxBitmap( int width, int height, int depth = -1 );
+    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(wx_const_cast(const char* const*, data));
+    }
+#endif
+    wxBitmap( const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM );
+#if wxUSE_IMAGE
+    wxBitmap( const wxImage& image, int depth = -1 ) { (void)CreateFromImage(image, depth); }
+#endif // wxUSE_IMAGE
+    virtual ~wxBitmap();

 
 

-  public:
-  
-    wxMask(void);
-    wxMask( const wxBitmap& bitmap, const wxColour& colour );
-    wxMask( const wxBitmap& bitmap, const int paletteIndex );
-    wxMask( const wxBitmap& bitmap );
-    ~wxMask(void);
-
-  private:
-  
-    friend wxBitmap;
-    friend wxDC;
-    friend wxPaintDC;
-    friend wxToolBarGTK;
-    
-    GdkBitmap *GetBitmap(void) const;
-    
-  protected:
-  
-    GdkBitmap *m_bitmap;     
-    
+    bool Create(int width, int height, int depth = -1);
+
+    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, wxBitmapType type,
+                          const wxPalette *palette = (wxPalette *)NULL) const;
+    bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_TYPE_XPM );
+
+#if wxUSE_PALETTE
+    wxPalette *GetPalette() const;
+    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 );
+    void SetPixmap( GdkPixmap *pixmap );
+    void SetPixbuf(GdkPixbuf* pixbuf, int depth = 0);
+
+    GdkPixmap *GetPixmap() const;
+    bool HasPixmap() const;
+    bool HasPixbuf() const;
+    GdkPixbuf *GetPixbuf() const;
+
+    // Basically, this corresponds to Win32 StretchBlt()
+    wxBitmap Rescale(int clipx, int clipy, int clipwidth, int clipheight, int width, int height) const;
+
+    // raw bitmap access support functions
+    void *GetRawData(wxPixelDataBase& data, int bpp);
+    void UngetRawData(wxPixelDataBase& data);
+
+    bool HasAlpha() const;
+
+protected:
+#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)

 };
 
 //-----------------------------------------------------------------------------
 };
 
 //-----------------------------------------------------------------------------

-// wxBitmap
+// wxBitmapHandler

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

-// CMB 20/5/98: added xbm constructor and GetBitmap() method
-class wxBitmap: public wxObject
+class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxBitmap)
-
-  public:
-
-    wxBitmap(void);
-    wxBitmap( const int width, const int height, const int depth = -1 );
-    wxBitmap( const char bits[], const int width, const int height, const int depth = 1 );
-    wxBitmap( char **bits );
-    wxBitmap( const wxBitmap& bmp );
-    wxBitmap( const wxBitmap* bmp );
-    wxBitmap( const wxString &filename, const int type );
-    ~wxBitmap(void);
-    wxBitmap& operator = ( const wxBitmap& bmp );
-    bool operator == ( const wxBitmap& bmp );
-    bool operator != ( const wxBitmap& bmp );
-    bool Ok(void) const;
-    
-    int GetHeight(void) const;
-    int GetWidth(void) const;
-    int GetDepth(void) const;
-    void SetHeight( const int height );
-    void SetWidth( const int width );
-    void SetDepth( const int depth );
-
-    wxMask *GetMask(void) const;
-    void SetMask( wxMask *mask );
-    
-    bool SaveFile( const wxString &name, const int type, wxPalette *palette = NULL );
-    bool LoadFile( const wxString &name, const int type );
-        
-    wxPalette *GetPalette(void) const;
-    wxPalette *GetColourMap(void) const
-      { return GetPalette(); };
-
-  private:
-  
-    friend wxDC;
-    friend wxPaintDC;
-    friend wxMemoryDC;
-    friend wxToolBarGTK;
-
-    GdkPixmap *GetPixmap(void) const;
-    GdkBitmap *GetBitmap(void) const;
-    
-    // no data :-)
+    DECLARE_ABSTRACT_CLASS(wxBitmapHandler)

 };
 
 };
 

-#endif // __GTKBITMAPH__
+#endif // _WX_GTK_BITMAP_H_