Cured some bugs/typos/spacing in docs

[wxWidgets.git] / src / gtk / bitmap.cpp

diff --git a/src/gtk/bitmap.cpp b/src/gtk/bitmap.cpp
index 6c2ecbe6d40acd140cd67a6f7641f3578354c24b..832600e1a2d78c5434e7a7b5c74a75c4318077be 100644 (file)
--- a/src/gtk/bitmap.cpp
+++ b/src/gtk/bitmap.cpp
@@ -2,10 +2,9 @@
 // Name:        bitmap.cpp
 // Purpose:
 // Author:      Robert Roebling
 // Name:        bitmap.cpp
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__
 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__


@@ -13,11 +12,13 @@
 #endif
 
 #include "wx/bitmap.h"
 #endif
 
 #include "wx/bitmap.h"

-#include "gdk/gdkprivate.h"
+#include "wx/icon.h"
+#include "wx/filefn.h"
+#include "wx/image.h"

 
 

-#ifdef USE_GDK_IMLIB
-#include "gdk_imlib.h"
-#endif
+#include "gdk/gdk.h"
+#include "gdk/gdkprivate.h"
+#include "gdk/gdkx.h"

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


@@ -25,80 +26,124 @@
 
 IMPLEMENT_DYNAMIC_CLASS(wxMask,wxObject)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxMask,wxObject)
 

-wxMask::wxMask(void)
+wxMask::wxMask()

 {
 {

-  m_bitmap = NULL;
-};
+    m_bitmap = (GdkBitmap *) NULL;
+}

 
 

-wxMask::wxMask( const wxBitmap& WXUNUSED(bitmap), const wxColour& WXUNUSED(colour) )
+wxMask::wxMask( const wxBitmap& bitmap, const wxColour& colour )

 {
 {

-};
+    Create( bitmap, colour );
+}

 
 

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

 {
 {

-};
+    Create( bitmap, paletteIndex );
+}

 
 

-wxMask::wxMask( const wxBitmap& WXUNUSED(bitmap) )
+wxMask::wxMask( const wxBitmap& bitmap )

 {
 {

-};
+    Create( bitmap );
+}

 
 

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

 {
 {

-#ifdef USE_GDK_IMLIB
-  // do not delete the mask, gdk_imlib does it for you
-#else
-  if (m_bitmap) gdk_bitmap_unref( m_bitmap );
-#endif  
-};
+    if (m_bitmap) gdk_bitmap_unref( m_bitmap );
+}

 
 

-GdkBitmap *wxMask::GetBitmap(void) const
+bool wxMask::Create( const wxBitmap& bitmap, const wxColour& colour )

 {
 {

-  return m_bitmap;
-};
-  
+    if (m_bitmap)
+    { 
+        gdk_bitmap_unref( m_bitmap );
+       m_bitmap = (GdkBitmap*) NULL;
+    }
+    
+    wxFAIL_MSG( _T("TODO") );
+    
+    return FALSE;
+}
+
+bool wxMask::Create( const wxBitmap& WXUNUSED(bitmap), int WXUNUSED(paletteIndex) )
+{
+    if (m_bitmap)
+    { 
+        gdk_bitmap_unref( m_bitmap );
+       m_bitmap = (GdkBitmap*) NULL;
+    }
+    
+    wxFAIL_MSG( _T("not implemented") );
+    
+    return FALSE;
+}
+
+bool wxMask::Create( const wxBitmap& bitmap )
+{
+    if (m_bitmap)
+    { 
+        gdk_bitmap_unref( m_bitmap );
+       m_bitmap = (GdkBitmap*) NULL;
+    }
+    
+    if (!bitmap.Ok()) return FALSE;
+    
+    wxCHECK_MSG( bitmap.GetBitmap(), FALSE, _T("Cannot create mask from colour bitmap") );
+    
+    m_bitmap = gdk_pixmap_new( (GdkWindow*) &gdk_root_parent, bitmap.GetWidth(), bitmap.GetHeight(), 1 );
+    
+    if (!m_bitmap) return FALSE;
+    
+    GdkGC *gc = gdk_gc_new( m_bitmap );
+    
+    gdk_draw_bitmap( m_bitmap, gc, bitmap.GetBitmap(), 0, 0, 0, 0, bitmap.GetWidth(), bitmap.GetHeight() );
+    
+    gdk_gc_unref( gc );
+    
+    return TRUE;
+}
+
+GdkBitmap *wxMask::GetBitmap() const
+{
+    return m_bitmap;
+}
+

 //-----------------------------------------------------------------------------
 // wxBitmap
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 // wxBitmap
 //-----------------------------------------------------------------------------
 

-// CMB 20/5/98: added m_bitmap for GdkBitmaps

 class wxBitmapRefData: public wxObjectRefData
 {
 class wxBitmapRefData: public wxObjectRefData
 {

-  public:
-  
-    wxBitmapRefData(void);
-    ~wxBitmapRefData(void);
-  
-    GdkPixmap      *m_pixmap;
-    GdkBitmap      *m_bitmap;
-    wxMask         *m_mask;
-    int             m_width;
-    int             m_height;
-    int             m_bpp;
-    wxPalette      *m_palette;
+public:
+  wxBitmapRefData();
+  ~wxBitmapRefData();
+
+  GdkPixmap      *m_pixmap;
+  GdkBitmap      *m_bitmap;
+  wxMask         *m_mask;
+  int             m_width;
+  int             m_height;
+  int             m_bpp;
+  wxPalette      *m_palette;

 };
 
 };
 

-wxBitmapRefData::wxBitmapRefData(void)
+wxBitmapRefData::wxBitmapRefData()

 {
 {

-  m_pixmap = NULL;
-  m_bitmap = NULL;
-  m_mask = NULL;
-  m_width = 0;
-  m_height = 0;
-  m_bpp = 0;
-  m_palette = NULL;
-};
+    m_pixmap = (GdkPixmap *) NULL;
+    m_bitmap = (GdkBitmap *) NULL;
+    m_mask = (wxMask *) NULL;
+    m_width = 0;
+    m_height = 0;
+    m_bpp = 0;
+    m_palette = (wxPalette *) NULL;
+}

 
 

-wxBitmapRefData::~wxBitmapRefData(void)
+wxBitmapRefData::~wxBitmapRefData()

 {
 {

-#ifdef USE_GDK_IMLIB
-  if (m_pixmap) gdk_imlib_free_pixmap( m_pixmap );
-#else
-  if (m_pixmap) gdk_pixmap_unref( m_pixmap );
-  if (m_bitmap) gdk_bitmap_unref( m_bitmap );
-#endif
-  if (m_mask) delete m_mask;
-  if (m_palette) delete m_palette;
-};
+    if (m_pixmap) gdk_pixmap_unref( m_pixmap );
+    if (m_bitmap) gdk_bitmap_unref( m_bitmap );
+    if (m_mask) delete m_mask;
+    if (m_palette) delete m_palette;
+}

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


@@ -106,212 +151,281 @@ wxBitmapRefData::~wxBitmapRefData(void)
 
 IMPLEMENT_DYNAMIC_CLASS(wxBitmap,wxGDIObject)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxBitmap,wxGDIObject)
 

-wxBitmap::wxBitmap(void)
+wxBitmap::wxBitmap()

 {
 {

-  if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
-};
-  
-wxBitmap::wxBitmap( const int width, const int height, const int depth )
-{
-  m_refData = new wxBitmapRefData();
-  M_BMPDATA->m_mask = NULL;
-  M_BMPDATA->m_pixmap = 
-    gdk_pixmap_new( (GdkWindow*) &gdk_root_parent, width, height, depth );
-  gdk_window_get_size( M_BMPDATA->m_pixmap, &(M_BMPDATA->m_width), &(M_BMPDATA->m_height) );
-  M_BMPDATA->m_bpp = depth;
-   
-  if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
-};
+    if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
+}
+
+wxBitmap::wxBitmap( int width, int height, int depth )
+{
+    wxCHECK_RET( (width > 0) && (height > 0), _T("invalid bitmap size") )
+    
+    GdkWindow *parent = (GdkWindow*) &gdk_root_parent;
+    if (depth == -1) depth = gdk_window_get_visual( parent )->depth;
+    
+    wxCHECK_RET( (depth ==  gdk_window_get_visual( parent )->depth) ||
+                 (depth == 1), _T("invalid bitmap depth") )
+
+    m_refData = new wxBitmapRefData();
+    M_BMPDATA->m_mask = (wxMask *) NULL;
+    M_BMPDATA->m_width = width;
+    M_BMPDATA->m_height = height;
+    if (depth == 1)
+    {
+        M_BMPDATA->m_bitmap = gdk_pixmap_new( parent, width, height, 1 );
+        M_BMPDATA->m_bpp = 1;
+    }
+    else
+    {
+        M_BMPDATA->m_pixmap = gdk_pixmap_new( parent, width, height, depth );
+        M_BMPDATA->m_bpp = gdk_window_get_visual( parent )->depth;
+    }
+
+    if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
+}
+
+wxBitmap::wxBitmap( const char **bits )
+{
+    wxCHECK_RET( bits != NULL, _T("invalid bitmap data") )
+
+    m_refData = new wxBitmapRefData();
+
+    GdkBitmap *mask = (GdkBitmap*) NULL;
+    GdkWindow *parent = (GdkWindow*) &gdk_root_parent;
+
+    M_BMPDATA->m_pixmap = gdk_pixmap_create_from_xpm_d( parent, &mask, NULL, (gchar **) bits );
+
+    if (mask)
+    {
+        M_BMPDATA->m_mask = new wxMask();
+        M_BMPDATA->m_mask->m_bitmap = mask;
+    }
+
+    gdk_window_get_size( M_BMPDATA->m_pixmap, &(M_BMPDATA->m_width), &(M_BMPDATA->m_height) );
+
+    M_BMPDATA->m_bpp = gdk_window_get_visual( parent )->depth;  // ?
+    if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
+}

 
 wxBitmap::wxBitmap( char **bits )
 {
 
 wxBitmap::wxBitmap( char **bits )
 {

-  m_refData = new wxBitmapRefData();
-  
-  GdkBitmap *mask = NULL;
+    wxCHECK_RET( bits != NULL, _T("invalid bitmap data") )
+
+    m_refData = new wxBitmapRefData();
+
+    GdkBitmap *mask = (GdkBitmap*) NULL;
+    GdkWindow *parent = (GdkWindow*) &gdk_root_parent;
+
+    M_BMPDATA->m_pixmap = gdk_pixmap_create_from_xpm_d( parent, &mask, NULL, (gchar **) bits );
+
+    wxCHECK_RET( M_BMPDATA->m_pixmap, _T("couldn't create pixmap") );
+
+    if (mask)
+    {
+        M_BMPDATA->m_mask = new wxMask();
+        M_BMPDATA->m_mask->m_bitmap = mask;
+    }
+
+    gdk_window_get_size( M_BMPDATA->m_pixmap, &(M_BMPDATA->m_width), &(M_BMPDATA->m_height) );
+
+    M_BMPDATA->m_bpp = gdk_window_get_visual( parent )->depth;  // ?
+    if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
+}

 
 

-#ifndef USE_GDK_IMLIB
-  M_BMPDATA->m_pixmap = 
-    gdk_pixmap_create_from_xpm_d( (GdkWindow*) &gdk_root_parent, &mask, NULL, (gchar **) bits );
-#else
-  M_BMPDATA->m_pixmap = NULL;
-  int res = gdk_imlib_data_to_pixmap( bits, &M_BMPDATA->m_pixmap, &mask );
-#endif
-  
-  if (mask)
-  {
-    M_BMPDATA->m_mask = new wxMask();
-    M_BMPDATA->m_mask->m_bitmap = mask;
-  };
-                                 
-  gdk_window_get_size( M_BMPDATA->m_pixmap, &(M_BMPDATA->m_width), &(M_BMPDATA->m_height) );
-  M_BMPDATA->m_bpp = 24; // ?
-   
-  if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
-};
-  

 wxBitmap::wxBitmap( const wxBitmap& bmp )
 {
 wxBitmap::wxBitmap( const wxBitmap& bmp )
 {

-  Ref( bmp );
-   
-  if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
-};
-  
-wxBitmap::wxBitmap( const wxBitmap* bmp )
-{
-  if (bmp) Ref( *bmp );
-   
-  if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
-};
+    Ref( bmp );
+
+    if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
+}

 
 

-wxBitmap::wxBitmap( const wxString &filename, const int type )
+wxBitmap::wxBitmap( const wxString &filename, int type )

 {
 {

-  LoadFile( filename, type );
-};
+    LoadFile( filename, type );

 
 

-// CMB 15/5/98: add constructor for xbm bitmaps
-wxBitmap::wxBitmap( const char bits[], const int width, const int height, const int WXUNUSED(depth))
+    if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
+}
+
+wxBitmap::wxBitmap( const char bits[], int width, int height, int WXUNUSED(depth))

 {
 {

-  m_refData = new wxBitmapRefData();
+    m_refData = new wxBitmapRefData();

 
 

-  M_BMPDATA->m_mask = NULL;
-  M_BMPDATA->m_bitmap = 
-    gdk_bitmap_create_from_data( (GdkWindow*) &gdk_root_parent, (gchar *) bits, width, height );
-  gdk_window_get_size( M_BMPDATA->m_bitmap, &(M_BMPDATA->m_width), &(M_BMPDATA->m_height) );
-  M_BMPDATA->m_bpp = 1;
+    M_BMPDATA->m_mask = (wxMask *) NULL;
+    M_BMPDATA->m_bitmap =
+      gdk_bitmap_create_from_data( (GdkWindow*) &gdk_root_parent, (gchar *) bits, width, height );
+    M_BMPDATA->m_width = width;
+    M_BMPDATA->m_height = height;
+    M_BMPDATA->m_bpp = 1;

 
 

-  if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);
+    wxCHECK_RET( M_BMPDATA->m_bitmap, _T("couldn't create bitmap") );
+
+    if (wxTheBitmapList) wxTheBitmapList->AddBitmap(this);

 }
 }

-  
-wxBitmap::~wxBitmap(void)
+
+wxBitmap::~wxBitmap()

 {
 {

-  if (wxTheBitmapList) wxTheBitmapList->DeleteObject(this);
-};
-  
+    if (wxTheBitmapList) wxTheBitmapList->DeleteObject(this);
+}
+

 wxBitmap& wxBitmap::operator = ( const wxBitmap& bmp )
 {
 wxBitmap& wxBitmap::operator = ( const wxBitmap& bmp )
 {

-  if (*this == bmp) return (*this); 
-  Ref( bmp ); 
-  return *this; 
-};
-  
+    if (*this == bmp) return (*this);
+    Ref( bmp );
+    return *this;
+}
+

 bool wxBitmap::operator == ( const wxBitmap& bmp )
 {
 bool wxBitmap::operator == ( const wxBitmap& bmp )
 {

-  return m_refData == bmp.m_refData; 
-};
-  
+    return m_refData == bmp.m_refData;
+}
+

 bool wxBitmap::operator != ( const wxBitmap& bmp )
 {
 bool wxBitmap::operator != ( const wxBitmap& bmp )
 {

-  return m_refData != bmp.m_refData; 
-};
-  
-bool wxBitmap::Ok(void) const
+    return m_refData != bmp.m_refData;
+}
+
+bool wxBitmap::Ok() const

 {
 {

-  return m_refData != NULL;
-};
-  
-int wxBitmap::GetHeight(void) const
+    return (m_refData != NULL);
+}
+
+int wxBitmap::GetHeight() const

 {
 {

-  if (!Ok()) return 0;
-  return M_BMPDATA->m_height;
-};
+    wxCHECK_MSG( Ok(), -1, _T("invalid bitmap") );

 
 

-int wxBitmap::GetWidth(void) const
+    return M_BMPDATA->m_height;
+}
+
+int wxBitmap::GetWidth() const

 {
 {

-  if (!Ok()) return 0;
-  return M_BMPDATA->m_width;
-};
+    wxCHECK_MSG( Ok(), -1, _T("invalid bitmap") );
+
+    return M_BMPDATA->m_width;
+}

 
 

-int wxBitmap::GetDepth(void) const
+int wxBitmap::GetDepth() const

 {
 {

-  if (!Ok()) return 0;
-  return M_BMPDATA->m_bpp;
-};
+    wxCHECK_MSG( Ok(), -1, _T("invalid bitmap") );
+
+    return M_BMPDATA->m_bpp;
+}

 
 

-void wxBitmap::SetHeight( const int height )
+wxMask *wxBitmap::GetMask() const

 {
 {

-  if (!Ok()) return;
-  M_BMPDATA->m_height = height;
-};
+    wxCHECK_MSG( Ok(), (wxMask *) NULL, _T("invalid bitmap") );

 
 

-void wxBitmap::SetWidth( const int width )
+    return M_BMPDATA->m_mask;
+}
+
+void wxBitmap::SetMask( wxMask *mask )

 {
 {

-  if (!Ok()) return;
-  M_BMPDATA->m_width = width;
-};
+    wxCHECK_RET( Ok(), _T("invalid bitmap") );

 
 

-void wxBitmap::SetDepth( const int depth )
+    if (M_BMPDATA->m_mask) delete M_BMPDATA->m_mask;
+
+    M_BMPDATA->m_mask = mask;
+}
+
+bool wxBitmap::SaveFile( const wxString &name, int type, wxPalette *WXUNUSED(palette) )

 {
 {

-  if (!Ok()) return;
-  M_BMPDATA->m_bpp = depth;
-};
+    wxCHECK_MSG( Ok(), FALSE, _T("invalid bitmap") );

 
 

-wxMask *wxBitmap::GetMask(void) const
+    if (type == wxBITMAP_TYPE_PNG)
+    {
+        wxImage image( *this );
+       if (image.Ok()) return image.SaveFile( name, type );
+    }
+
+    return FALSE;
+}
+
+bool wxBitmap::LoadFile( const wxString &name, int type )

 {
 {

-  if (!Ok()) return NULL;
-  return M_BMPDATA->m_mask;
-};
+    UnRef();

 
 

-void wxBitmap::SetMask( wxMask *mask )
+    if (!wxFileExists(name)) return FALSE;
+
+    if (type == wxBITMAP_TYPE_XPM)
+    {
+        m_refData = new wxBitmapRefData();
+
+        GdkBitmap *mask = (GdkBitmap*) NULL;
+        GdkWindow *parent = (GdkWindow*) &gdk_root_parent;
+
+        M_BMPDATA->m_pixmap = gdk_pixmap_create_from_xpm( parent, &mask, NULL, name.fn_str() );
+
+        if (mask)
+        {
+           M_BMPDATA->m_mask = new wxMask();
+           M_BMPDATA->m_mask->m_bitmap = mask;
+        }
+
+        gdk_window_get_size( M_BMPDATA->m_pixmap, &(M_BMPDATA->m_width), &(M_BMPDATA->m_height) );
+        M_BMPDATA->m_bpp = gdk_window_get_visual( parent )->depth;
+    }
+    else if (type == wxBITMAP_TYPE_PNG)
+    {
+        wxImage image;
+        image.LoadFile( name, type );
+        if (image.Ok()) *this = image.ConvertToBitmap();
+    }
+    else if (type == wxBITMAP_TYPE_BMP)
+    {
+        wxImage image;
+        image.LoadFile( name, type );
+        if (image.Ok()) *this = image.ConvertToBitmap();
+    }
+    else
+        return FALSE;
+
+    return TRUE;
+}
+
+wxPalette *wxBitmap::GetPalette() const

 {
 {

-  if (!Ok()) return;
-  if (M_BMPDATA->m_mask) delete M_BMPDATA->m_mask;
-  M_BMPDATA->m_mask = mask;
-};
+    if (!Ok()) return (wxPalette *) NULL;
+
+    return M_BMPDATA->m_palette;
+}

 
 

-bool wxBitmap::SaveFile( const wxString &WXUNUSED(name), const int WXUNUSED(type), 
-  wxPalette *WXUNUSED(palette) )
+void wxBitmap::SetHeight( int height )

 {
 {

-  return FALSE;
-};
+    if (!m_refData) m_refData = new wxBitmapRefData();
+
+    M_BMPDATA->m_height = height;
+}

 
 

-bool wxBitmap::LoadFile( const wxString &name, const int WXUNUSED(type) )
+void wxBitmap::SetWidth( int width )

 {
 {

-#ifdef USE_GDK_IMLIB
+    if (!m_refData) m_refData = new wxBitmapRefData();

 
 

-  UnRef();
-  m_refData = new wxBitmapRefData();
-  M_BMPDATA->m_mask = NULL;
+    M_BMPDATA->m_width = width;
+}

 
 

-  GdkBitmap *mask = NULL;
-  
-  int res = gdk_imlib_load_file_to_pixmap( WXSTRINGCAST name, &M_BMPDATA->m_pixmap, &mask );
+void wxBitmap::SetDepth( int depth )
+{
+    if (!m_refData) m_refData = new wxBitmapRefData();

 
 

-  if (res != 1)
-  {
-    UnRef();
-    return FALSE;
-  };
-
-  if (mask)
-  {
-    M_BMPDATA->m_mask = new wxMask();
-    M_BMPDATA->m_mask->m_bitmap = mask;
-  }
-                                 
-  gdk_window_get_size( M_BMPDATA->m_pixmap, &(M_BMPDATA->m_width), &(M_BMPDATA->m_height) );
-  M_BMPDATA->m_bpp = 24; // ?
-  
-  return TRUE;
-#endif
+    M_BMPDATA->m_bpp = depth;
+}

 
 

-  return FALSE;
-};
-        
-wxPalette *wxBitmap::GetPalette(void) const
+void wxBitmap::SetPixmap( GdkPixmap *pixmap )

 {
 {

-  if (!Ok()) return NULL;
-  return M_BMPDATA->m_palette;
-};
+    if (!m_refData) m_refData = new wxBitmapRefData();
+
+    M_BMPDATA->m_pixmap = pixmap;
+}

 
 

-GdkPixmap *wxBitmap::GetPixmap(void) const
+GdkPixmap *wxBitmap::GetPixmap() const

 {
 {

-  if (!Ok()) return NULL;
-  return M_BMPDATA->m_pixmap;
-};
-  
-GdkBitmap *wxBitmap::GetBitmap(void) const
+    wxCHECK_MSG( Ok(), (GdkPixmap *) NULL, _T("invalid bitmap") );
+
+    return M_BMPDATA->m_pixmap;
+}
+
+GdkBitmap *wxBitmap::GetBitmap() const

 {
 {

-  if (!Ok()) return NULL;
-  return M_BMPDATA->m_bitmap;
-};
-  
+    wxCHECK_MSG( Ok(), (GdkBitmap *) NULL, _T("invalid bitmap") );
+
+    return M_BMPDATA->m_bitmap;
+}