added wxConvFileName which is a variable, not define as wxConvFile; added comments...

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

diff --git a/include/wx/gtk/bitmap.h b/include/wx/gtk/bitmap.h
index a6c24d9c068a3d80e4270889f45e23017f411f04..c3058826d59f75050d356ee284072b05d634fc49 100644 (file)
--- a/include/wx/gtk/bitmap.h
+++ b/include/wx/gtk/bitmap.h
@@ -11,7 +11,7 @@
 #ifndef __GTKBITMAPH__
 #define __GTKBITMAPH__
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface
 #endif
 
@@ -21,6 +21,12 @@
 #include "wx/palette.h"
 #include "wx/gdiobj.h"
 
+#ifdef __WXGTK20__
+typedef struct _GdkPixbuf GdkPixbuf;
+#endif
+
+class WXDLLEXPORT wxPixelDataBase;
+
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
@@ -59,7 +65,7 @@ private:
 // wxBitmap
 //-----------------------------------------------------------------------------
 
-class wxBitmap: public wxGDIObject
+class wxBitmap: public wxBitmapBase
 {
 public:
     wxBitmap();
@@ -68,7 +74,7 @@ public:
     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 wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM );
     wxBitmap( const wxImage& image, int depth = -1 ) { (void)CreateFromImage(image, depth); }
     ~wxBitmap();
     wxBitmap& operator = ( const wxBitmap& bmp );
@@ -84,17 +90,25 @@ public:
     
     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, 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 = (wxPalette *)NULL) const;
+    bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_TYPE_XPM );
 
+#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
     // --------------
@@ -104,16 +118,75 @@ public:
     void SetDepth( int depth );
     void SetPixmap( GdkPixmap *pixmap );
     void SetBitmap( GdkBitmap *bitmap );
+#ifdef __WXGTK20__
+    void SetPixbuf(GdkPixbuf *pixbuf);
+#endif
 
     GdkPixmap *GetPixmap() const;
     GdkBitmap *GetBitmap() const;
+    bool HasPixmap() const;
+#ifdef __WXGTK20__
+    bool HasPixbuf() const;
+    GdkPixbuf *GetPixbuf() const;
+#endif
+    
+    // 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;
+    void UseAlpha();
+
 protected:
     bool CreateFromXpm(const char **bits);
     bool CreateFromImage(const wxImage& image, int depth);
 
 private:
+    // to be called from CreateFromImage only!
+    bool CreateFromImageAsBitmap(const wxImage& image);
+    bool CreateFromImageAsPixmap(const wxImage& image);
+
+#ifdef __WXGTK20__
+    bool CreateFromImageAsPixbuf(const wxImage& image);
+
+    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);
+
+    friend class wxMemoryDC;
+#endif
+    friend class wxBitmapHandler;
+
+private:    
     DECLARE_DYNAMIC_CLASS(wxBitmap)
 };
 
+//-----------------------------------------------------------------------------
+// wxBitmapHandler
+//-----------------------------------------------------------------------------
+
+class wxBitmapHandler: public wxBitmapHandlerBase
+{
+public:
+    wxBitmapHandler() { }
+    virtual ~wxBitmapHandler();
+
+    virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
+    virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
+        int desiredWidth, int desiredHeight);
+    virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
+};
+
+
 #endif // __GTKBITMAPH__