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 1d6260c5fca6ce6de6af981494f75f91a59d7d05..c3058826d59f75050d356ee284072b05d634fc49 100644 (file)
--- a/include/wx/gtk/bitmap.h
+++ b/include/wx/gtk/bitmap.h
@@ -2,17 +2,16 @@
 // Name:        bitmap.h
 // Purpose:
 // Author:      Robert Roebling
 // Name:        bitmap.h
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// RCS-ID:      $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 #ifndef __GTKBITMAPH__
 #define __GTKBITMAPH__
 
 /////////////////////////////////////////////////////////////////////////////
 
 
 #ifndef __GTKBITMAPH__
 #define __GTKBITMAPH__
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface
 #endif
 
 #pragma interface
 #endif
 


@@ -20,18 +19,21 @@
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/palette.h"
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/palette.h"

+#include "wx/gdiobj.h"
+
+#ifdef __WXGTK20__
+typedef struct _GdkPixbuf GdkPixbuf;
+#endif
+
+class WXDLLEXPORT wxPixelDataBase;

 
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 

-class wxDC;
-class wxPaintDC;
-class wxMemoryDC;
-class wxToolBarGTK;
-

 class wxMask;
 class wxBitmap;
 class wxMask;
 class wxBitmap;

+class wxImage;

 
 //-----------------------------------------------------------------------------
 // wxMask
 
 //-----------------------------------------------------------------------------
 // wxMask


@@ -39,80 +41,152 @@ class wxBitmap;
 
 class wxMask: public wxObject
 {
 
 class wxMask: public wxObject
 {

-  DECLARE_DYNAMIC_CLASS(wxMask)
-
-  public:
-  
-    wxMask(void);
+public:
+    wxMask();

     wxMask( const wxBitmap& bitmap, const wxColour& colour );
     wxMask( const wxBitmap& bitmap, const wxColour& colour );

-    wxMask( const wxBitmap& bitmap, const int paletteIndex );
+    wxMask( const wxBitmap& bitmap, int paletteIndex );

     wxMask( const wxBitmap& bitmap );
     wxMask( const wxBitmap& bitmap );

-    ~wxMask(void);
-
-  private:
+    ~wxMask();

   
   

-    friend wxBitmap;
-    friend wxDC;
-    friend wxPaintDC;
-    friend wxToolBarGTK;
-    
-    GdkBitmap *GetBitmap(void) const;
+    bool Create( const wxBitmap& bitmap, const wxColour& colour );
+    bool Create( const wxBitmap& bitmap, int paletteIndex );
+    bool Create( const wxBitmap& bitmap );
+
+    // implementation
+    GdkBitmap   *m_bitmap;

     
     

-  protected:
+    GdkBitmap *GetBitmap() const;

   
   

-    GdkBitmap *m_bitmap;     
-    
+private:
+    DECLARE_DYNAMIC_CLASS(wxMask)

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

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

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxBitmap)
-
-  public:
-
-    wxBitmap(void);
-    wxBitmap( const int width, const int height, const int depth = -1 );
-    wxBitmap( char **bits );
+public:
+    wxBitmap();
+    wxBitmap( int width, int height, int depth = -1 );
+    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 wxBitmap& bmp );

-    wxBitmap( const wxBitmap* bmp );
-    wxBitmap( const wxString &filename, const int type );
-    ~wxBitmap(void);
+    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 );
     wxBitmap& operator = ( const wxBitmap& bmp );

-    bool operator == ( const wxBitmap& bmp );
-    bool operator != ( const wxBitmap& bmp );
-    bool Ok(void) const;
+    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;

     
     

-    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;
+    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 );
     
     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;
+    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 );
+#ifdef __WXGTK20__
+    void SetPixbuf(GdkPixbuf *pixbuf);
+#endif

 
 

-    GdkPixmap *GetPixmap(void) const;
+    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 );

     
     

-    // no data :-)
+    // 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__
 #endif // __GTKBITMAPH__