added support for 2 extra mouse buttons (patch 1757630)

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

diff --git a/include/wx/gtk/bitmap.h b/include/wx/gtk/bitmap.h
index 2917413d439611dfeefd36358faeb0973e9037c7..f0c4fe73c607412a57ee2fec40303556a507d2b5 100644 (file)
--- a/include/wx/gtk/bitmap.h
+++ b/include/wx/gtk/bitmap.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Purpose:
 // Author:      Robert Roebling
 // RCS-ID:      $Id$


@@ -7,49 +7,38 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // 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"
-#include "wx/gdiobj.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxMask;
-class wxBitmap;
+typedef struct _GdkPixbuf GdkPixbuf;
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;

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

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

 {
 public:
     wxMask();
     wxMask( const wxBitmap& bitmap, const wxColour& colour );
 {
 public:
     wxMask();
     wxMask( const wxBitmap& bitmap, const wxColour& colour );

+#if wxUSE_PALETTE

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

+#endif // wxUSE_PALETTE

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

-    ~wxMask();
-  
+    virtual ~wxMask();
+

     bool Create( const wxBitmap& bitmap, const wxColour& colour );
     bool Create( const wxBitmap& bitmap, const wxColour& colour );

+#if wxUSE_PALETTE

     bool Create( const wxBitmap& bitmap, int paletteIndex );
     bool Create( const wxBitmap& bitmap, int paletteIndex );

+#endif // wxUSE_PALETTE

     bool Create( const wxBitmap& bitmap );
 
     // implementation
     GdkBitmap   *m_bitmap;
     bool Create( const wxBitmap& bitmap );
 
     // implementation
     GdkBitmap   *m_bitmap;

-    
+

     GdkBitmap *GetBitmap() const;
     GdkBitmap *GetBitmap() const;

-  
+

 private:
     DECLARE_DYNAMIC_CLASS(wxMask)
 };
 private:
     DECLARE_DYNAMIC_CLASS(wxMask)
 };


@@ -58,35 +47,57 @@ private:
 // wxBitmap
 //-----------------------------------------------------------------------------
 
 // wxBitmap
 //-----------------------------------------------------------------------------
 

-class wxBitmap: public wxGDIObject
+class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase

 {
 public:
 {
 public:

-    wxBitmap();
+    wxBitmap() { }

     wxBitmap( int width, int height, int depth = -1 );
     wxBitmap( const char bits[], int width, int height, int depth = 1 );
     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 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;
+    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();
+    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;
 
 
     int GetHeight() const;
     int GetWidth() const;
     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 );
 
     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 );
+    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;
     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
     // --------------
 
     // implementation
     // --------------


@@ -95,15 +106,60 @@ public:
     void SetWidth( int width );
     void SetDepth( int depth );
     void SetPixmap( GdkPixmap *pixmap );
     void SetWidth( int width );
     void SetDepth( int depth );
     void SetPixmap( GdkPixmap *pixmap );

+    void SetPixbuf(GdkPixbuf* pixbuf, int depth = 0);

 
     GdkPixmap *GetPixmap() const;
 
     GdkPixmap *GetPixmap() const;

-    GdkBitmap *GetBitmap() 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:
 protected:

-    bool CreateFromXpm(const char **bits);
+#if wxUSE_IMAGE
+    bool CreateFromImage(const wxImage& image, int depth);
+#endif // wxUSE_IMAGE
+
+    virtual wxObjectRefData* CreateRefData() const;
+    virtual wxObjectRefData* CloneRefData(const wxObjectRefData* 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
+
+    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;
+    friend class wxBitmapHandler;

 
 private:
     DECLARE_DYNAMIC_CLASS(wxBitmap)
 };
 
 
 private:
     DECLARE_DYNAMIC_CLASS(wxBitmap)
 };
 

-#endif // __GTKBITMAPH__
+//-----------------------------------------------------------------------------
+// wxBitmapHandler
+//-----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
+{
+    DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
+};
+
+#endif // _WX_GTK_BITMAP_H_