Add const to GetTargetSize()

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

diff --git a/include/wx/gtk/bitmap.h b/include/wx/gtk/bitmap.h
index 61f2bb2708197f40f7bf7648d61be8b7285f9b29..21d6bcd28606a3b286f110a44628b9f28e164759 100644 (file)
--- a/include/wx/gtk/bitmap.h
+++ b/include/wx/gtk/bitmap.h
@@ -1,145 +1,161 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:
 // Author:      Robert Roebling
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+#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"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxDC;
-class wxPaintDC;
-class wxMemoryDC;
-class wxToolBar;
-class wxBitmapButton;
-class wxStaticBitmap;
-class wxFrame;
-class wxDialog;
-class wxTreeCtrl;
-class wxNotebook;
-
-class wxMask;
-class wxBitmap;
+typedef struct _GdkPixbuf GdkPixbuf;
+class WXDLLEXPORT wxPixelDataBase;

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

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

 {
 {

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

     wxMask();
     wxMask( const wxBitmap& bitmap, const wxColour& colour );
     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();

 
 

-  private:
+    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 );

 
 

-    friend wxBitmap;
-    friend wxDC;
-    friend wxPaintDC;
-    friend wxToolBar;
-    friend wxBitmapButton;
-    friend wxStaticBitmap;
-    friend wxFrame;
-    friend wxDialog;
-    friend wxTreeCtrl;
-    friend wxNotebook;
+    // implementation
+    GdkBitmap   *m_bitmap;

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

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

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

-// CMB 20/5/98: added xbm constructor and GetBitmap() method
-class wxBitmap: public wxObject
+class WXDLLIMPEXP_CORE wxBitmap: public wxBitmapBase

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxBitmap)
-
-  public:
-
+public:

     wxBitmap();
     wxBitmap( int width, int height, int depth = -1 );
     wxBitmap( const char bits[], int width, int height, int depth = 1 );
     wxBitmap();
     wxBitmap( int width, int height, int depth = -1 );
     wxBitmap( const char bits[], int width, int height, int depth = 1 );

-    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 );
+    wxBitmap( const char **bits ) { (void)CreateFromXpm(bits); }
+    wxBitmap( char **bits ) { (void)CreateFromXpm((const char **)bits); }
+    wxBitmap( const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM );
+    wxBitmap( const wxImage& image, int depth = -1 ) { (void)CreateFromImage(image, depth); }
+    virtual ~wxBitmap();
+    bool operator == ( const wxBitmap& bmp ) const;
+    bool operator != ( const wxBitmap& bmp ) const;

     bool Ok() const;
 
     bool Ok() 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;

-    void SetHeight( int height );
-    void SetWidth( int width );
-    void SetDepth( int depth );
+
+    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 );
 
 
     wxMask *GetMask() const;
     void SetMask( wxMask *mask );
 

-    void Resize( int height, int width );
+    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 *GetPalette() const;

-    wxPalette *GetColourMap() const
-      { return GetPalette(); };
-
-  private:
-
-    friend wxDC;
-    friend wxPaintDC;
-    friend wxMemoryDC;
-    friend wxToolBar;
-    friend wxBitmapButton;
-    friend wxStaticBitmap;
-    friend wxFrame;
-    friend wxDialog;
-    friend wxTreeCtrl;
-    friend wxNotebook;
+    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 SetPixbuf(GdkPixbuf *pixbuf);

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

-    GdkBitmap *GetBitmap() const;
-  
-    void DestroyImage();
-    void RecreateImage();
-    void Render();
+    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 );
+
+    // 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 CreateFromImageAsPixmap(const wxImage& image, int depth);
+    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;
+    friend class wxBitmapHandler;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxBitmap)
+};
+
+//-----------------------------------------------------------------------------
+// wxBitmapHandler
+//-----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE 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);

 
 

-    // no data :-)
+private:
+    DECLARE_DYNAMIC_CLASS(wxBitmapHandler)

 };
 
 };
 

-#endif // __GTKBITMAPH__
+#endif // _WX_GTK_BITMAP_H_