Make SaveFile and LoadFile virtual so they can be overridden

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

diff --git a/include/wx/gtk1/bitmap.h b/include/wx/gtk1/bitmap.h
index 8051b4da71bd0be62b1766a7144889b2f25ababd..e41dbc4b61d8a2ca5495630d435bc698baf92937 100644 (file)
--- a/include/wx/gtk1/bitmap.h
+++ b/include/wx/gtk1/bitmap.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        bitmap.h
+// Name:        wx/gtk1/bitmap.h
 // Purpose:
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
@@ -11,92 +11,150 @@
 #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/image.h"
+#include "wx/gdiobj.h"
+
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
 
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 
-class wxMask;
-class wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxMask;
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxImage;
 
 //-----------------------------------------------------------------------------
 // wxMask
 //-----------------------------------------------------------------------------
 
-class wxMask: public wxObject
+class WXDLLIMPEXP_CORE wxMask: public wxObject
 {
-  DECLARE_DYNAMIC_CLASS(wxMask)
-
 public:
-  wxMask();
-  wxMask( const wxBitmap& bitmap, const wxColour& colour );
-  wxMask( const wxBitmap& bitmap, int paletteIndex );
-  wxMask( const wxBitmap& bitmap );
-  ~wxMask();
-
- // implementation
-    
-  GdkBitmap   *m_bitmap;
-  GdkBitmap *GetBitmap() const;
+    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;
+
+    GdkBitmap *GetBitmap() const;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxMask)
 };
 
 //-----------------------------------------------------------------------------
 // wxBitmap
 //-----------------------------------------------------------------------------
 
-class wxBitmap: public wxObject
+class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase
 {
-  DECLARE_DYNAMIC_CLASS(wxBitmap)
-
 public:
-  wxBitmap();
-  wxBitmap( int width, int height, int depth = -1 );
-  wxBitmap( const char bits[], int width, int height, int depth = 1 );
-  wxBitmap( const wxImage &image );
-  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;
-    
-  wxImage ConvertToImage() const;
-
-  int GetHeight() const;
-  int GetWidth() const;
-  int GetDepth() const;
-  void SetHeight( int height );
-  void SetWidth( int width );
-  void SetDepth( int depth );
-
-  wxMask *GetMask() const;
-  void SetMask( wxMask *mask );
-
-  bool SaveFile( const wxString &name, int type, wxPalette *palette = (wxPalette *) NULL );
-  bool LoadFile( const wxString &name, int type = wxBITMAP_TYPE_XPM );
-
-  wxPalette *GetPalette() const;
-  wxPalette *GetColourMap() const
-    { return GetPalette(); };
-      
-// implementation      
-
-  GdkPixmap *GetPixmap() const;
-  GdkBitmap *GetBitmap() const;
-
-    // no data :-)
+    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 );
+    wxBitmap( const wxImage& image, int depth = -1 ) { (void)CreateFromImage(image, depth); }
+    virtual ~wxBitmap();
+    bool Ok() const { return IsOk(); }
+    bool IsOk() const;
+
+    bool Create(int width, int height, int depth = -1);
+
+    int GetHeight() const;
+    int GetWidth() const;
+    int GetDepth() const;
+
+    wxImage ConvertToImage() const;
+
+    // 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 SetBitmap( GdkBitmap *bitmap );
+
+    GdkPixmap *GetPixmap() const;
+    GdkBitmap *GetBitmap() const;
+    bool HasPixmap() const;
+
+    // Basically, this corresponds to Win32 StretchBlt()
+    wxBitmap Rescale( int clipx, int clipy, int clipwidth, int clipheight, int width, int height );
+
+    // raw bitmap access support functions
+    void *GetRawData(wxPixelDataBase& data, int bpp);
+    void UngetRawData(wxPixelDataBase& data);
+
+    bool HasAlpha() const;
+
+protected:
+    bool CreateFromImage(const wxImage& image, int depth);
+
+    virtual wxObjectRefData *CreateRefData() const;
+    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+
+private:
+    // to be called from CreateFromImage only!
+    bool CreateFromImageAsBitmap(const wxImage& image);
+    bool CreateFromImageAsPixmap(const wxImage& image);
+
+    friend class wxBitmapHandler;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxBitmap)
+};
+
+//-----------------------------------------------------------------------------
+// wxBitmapHandler
+//-----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
+{
+    DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
 };
 
 #endif // __GTKBITMAPH__