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

/////////////////////////////////////////////////////////////////////////////
// Name:        bitmap.h
// Purpose:     wxBitmap class
// Author:      Julian Smart
// Modified by:
// Created:     17/09/98
// RCS-ID:      $Id$
// Copyright:   (c) Julian Smart
// Licence:   	wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_BITMAP_H_
#define _WX_BITMAP_H_

#ifdef __GNUG__
#pragma interface "bitmap.h"
#endif

#include "wx/gdiobj.h"
#include "wx/gdicmn.h"
#include "wx/palette.h"

// Bitmap
class WXDLLEXPORT wxDC;
class WXDLLEXPORT wxControl;
class WXDLLEXPORT wxBitmap;
class WXDLLEXPORT wxBitmapHandler;
class WXDLLEXPORT wxIcon;
class WXDLLEXPORT wxCursor;

// A mask is a mono bitmap used for drawing bitmaps
// transparently.
class WXDLLEXPORT wxMask: public wxObject
{
  DECLARE_DYNAMIC_CLASS(wxMask)

public:
  wxMask();

  // Construct a mask from a bitmap and a colour indicating
  // the transparent area
  wxMask(const wxBitmap& bitmap, const wxColour& colour);

  // Construct a mask from a bitmap and a palette index indicating
  // the transparent area
  wxMask(const wxBitmap& bitmap, int paletteIndex);

  // Construct a mask from a mono bitmap (copies the bitmap).
  wxMask(const wxBitmap& bitmap);

  ~wxMask();

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

  inline WXPixmap GetPixmap() const { return m_pixmap; }
  inline void SetPixmap(WXPixmap pixmap) { m_pixmap = pixmap; }

protected:
  WXPixmap      m_pixmap;
};

class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData
{
    friend class WXDLLEXPORT wxBitmap;
    friend class WXDLLEXPORT wxIcon;
    friend class WXDLLEXPORT wxCursor;
public:
    wxBitmapRefData();
    ~wxBitmapRefData();

public:
  int               m_width;
  int               m_height;
  int               m_depth;
  bool              m_ok;
  int               m_numColors;
  wxPalette         m_bitmapPalette;
  int               m_quality;

  wxMask *          m_bitmapMask; // Optional mask

  // Motif implementation
public:
  WXPixmap          m_pixmap;
  WXDisplay*        m_display;
  bool              m_freePixmap;
  unsigned long*    m_freeColors;
  long              m_freeColorsCount;

  // These 5 variables are for wxControl
  WXPixmap          m_insensPixmap ;
  WXPixmap          m_labelPixmap ;
  WXPixmap          m_armPixmap ;
  WXImage*          m_image ;
  WXImage*          m_insensImage ;
};

#define M_BITMAPDATA ((wxBitmapRefData *)m_refData)

class WXDLLEXPORT wxBitmapHandler: public wxObject
{
  DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
public:
  wxBitmapHandler() { m_name = ""; m_extension = ""; m_type = 0; };

  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(wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);

  inline void SetName(const wxString& name) { m_name = name; }
  inline void SetExtension(const wxString& ext) { m_extension = ext; }
  inline void SetType(long type) { m_type = type; }
  inline wxString GetName() const { return m_name; }
  inline wxString GetExtension() const { return m_extension; }
  inline long GetType() const { return m_type; }
protected:
  wxString  m_name;
  wxString  m_extension;
  long      m_type;
};

#define M_BITMAPHANDLERDATA ((wxBitmapRefData *)bitmap->GetRefData())

class WXDLLEXPORT wxBitmap: public wxGDIObject
{
  DECLARE_DYNAMIC_CLASS(wxBitmap)

  friend class WXDLLEXPORT wxBitmapHandler;

public:
  wxBitmap(); // Platform-specific

  // Copy constructors
  inline wxBitmap(const wxBitmap& bitmap)
  { Ref(bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); }

  // Initialize with raw XBM data
  wxBitmap(const char bits[], int width, int height, int depth = 1);

  // Initialize with XPM data
  wxBitmap(char **data, wxControl* control = NULL);

  // Load a file or resource
  wxBitmap(const wxString& name, long type = wxBITMAP_TYPE_XPM);

  // Constructor for generalised creation from data
  wxBitmap(void *data, long type, int width, int height, int depth = 1);

  // If depth is omitted, will create a bitmap compatible with the display
  wxBitmap(int width, int height, int depth = -1);
  ~wxBitmap();

  virtual bool Create(int width, int height, int depth = -1);
  virtual bool Create(void *data, long type, int width, int height, int depth = 1);
  virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_XPM);
  virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);

  inline bool Ok() const { return (M_BITMAPDATA && M_BITMAPDATA->m_ok); }
  inline int GetWidth() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_width : 0); }
  inline int GetHeight() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_height : 0); }
  inline int GetDepth() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_depth : 0); }
  inline int GetQuality() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_quality : 0); }
  void SetWidth(int w);
  void SetHeight(int h);
  void SetDepth(int d);
  void SetQuality(int q);
  void SetOk(bool isOk);

  inline wxPalette* GetPalette() const { return (M_BITMAPDATA ? (& M_BITMAPDATA->m_bitmapPalette) : (wxPalette*) NULL); }
  void SetPalette(const wxPalette& palette);

  inline wxMask *GetMask() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_bitmapMask : (wxMask*) NULL); }
  void SetMask(wxMask *mask) ;

  inline wxBitmap& operator = (const wxBitmap& bitmap) { if (*this == bitmap) return (*this); Ref(bitmap); return *this; }
  inline bool operator == (const wxBitmap& bitmap) { return m_refData == bitmap.m_refData; }
  inline bool operator != (const wxBitmap& bitmap) { return m_refData != bitmap.m_refData; }

  // Format handling
  static inline wxList& GetHandlers() { return sm_handlers; }
  static void AddHandler(wxBitmapHandler *handler);
  static void InsertHandler(wxBitmapHandler *handler);
  static bool RemoveHandler(const wxString& name);
  static wxBitmapHandler *FindHandler(const wxString& name);
  static wxBitmapHandler *FindHandler(const wxString& extension, long bitmapType);
  static wxBitmapHandler *FindHandler(long bitmapType);

  static void InitStandardHandlers();
  static void CleanUpHandlers();

  // Motif implementation
public:
  inline WXDisplay* GetDisplay() const { return M_BITMAPDATA->m_display; }
  inline WXDisplay* GetPixmap() const { return M_BITMAPDATA->m_pixmap; }
  virtual WXPixmap GetLabelPixmap(WXWidget w) ;
  virtual WXPixmap GetArmPixmap(WXWidget w) ;
  virtual WXPixmap GetInsensPixmap(WXWidget w = (WXWidget) 0) ;

protected:
  static wxList sm_handlers;
};

// Creates a bitmap with transparent areas drawn in
// the given colour.
wxBitmap wxCreateMaskedBitmap(wxBitmap& bitmap, wxColour& colour);

#endif
  // _WX_BITMAP_H_
Commit	Line	Data
9b6dbb09 JS	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: bitmap.h
	3	// Purpose: wxBitmap class
	4	// Author: Julian Smart
	5	// Modified by:
	6	// Created: 17/09/98
	7	// RCS-ID: $Id$
	8	// Copyright: (c) Julian Smart
	9	// Licence: wxWindows licence
	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_BITMAP_H_
	13	#define _WX_BITMAP_H_
	14
	15	#ifdef __GNUG__
	16	#pragma interface "bitmap.h"
	17	#endif
	18
	19	#include "wx/gdiobj.h"
	20	#include "wx/gdicmn.h"
	21	#include "wx/palette.h"
	22
	23	// Bitmap
	24	class WXDLLEXPORT wxDC;
	25	class WXDLLEXPORT wxControl;
	26	class WXDLLEXPORT wxBitmap;
	27	class WXDLLEXPORT wxBitmapHandler;
	28	class WXDLLEXPORT wxIcon;
	29	class WXDLLEXPORT wxCursor;
	30
	31	// A mask is a mono bitmap used for drawing bitmaps
	32	// transparently.
	33	class WXDLLEXPORT wxMask: public wxObject
	34	{
	35	DECLARE_DYNAMIC_CLASS(wxMask)
	36
	37	public:
	38	wxMask();
	39
	40	// Construct a mask from a bitmap and a colour indicating
	41	// the transparent area
	42	wxMask(const wxBitmap& bitmap, const wxColour& colour);
	43
	44	// Construct a mask from a bitmap and a palette index indicating
	45	// the transparent area
	46	wxMask(const wxBitmap& bitmap, int paletteIndex);
	47
	48	// Construct a mask from a mono bitmap (copies the bitmap).
	49	wxMask(const wxBitmap& bitmap);
	50
	51	~wxMask();
	52
	53	bool Create(const wxBitmap& bitmap, const wxColour& colour);
	54	bool Create(const wxBitmap& bitmap, int paletteIndex);
	55	bool Create(const wxBitmap& bitmap);
	56
16c1f7f3	57	inline WXPixmap GetPixmap() const { return m_pixmap; }
f97c9854	58	inline void SetPixmap(WXPixmap pixmap) { m_pixmap = pixmap; }
16c1f7f3	59
9b6dbb09	60	protected:
16c1f7f3	61	WXPixmap m_pixmap;
9b6dbb09 JS	62	};
	63
	64	class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData
	65	{
	66	friend class WXDLLEXPORT wxBitmap;
	67	friend class WXDLLEXPORT wxIcon;
	68	friend class WXDLLEXPORT wxCursor;
	69	public:
	70	wxBitmapRefData();
	71	~wxBitmapRefData();
	72
	73	public:
f97c9854 JS	74	int m_width;
	75	int m_height;
	76	int m_depth;
	77	bool m_ok;
	78	int m_numColors;
	79	wxPalette m_bitmapPalette;
	80	int m_quality;
9b6dbb09	81
f97c9854	82	wxMask * m_bitmapMask; // Optional mask
16c1f7f3 JS	83
	84	// Motif implementation
	85	public:
f97c9854 JS	86	WXPixmap m_pixmap;
	87	WXDisplay* m_display;
	88	bool m_freePixmap;
	89	unsigned long* m_freeColors;
	90	long m_freeColorsCount;
	91
	92	// These 5 variables are for wxControl
	93	WXPixmap m_insensPixmap ;
	94	WXPixmap m_labelPixmap ;
	95	WXPixmap m_armPixmap ;
	96	WXImage* m_image ;
	97	WXImage* m_insensImage ;
9b6dbb09 JS	98	};
	99
	100	#define M_BITMAPDATA ((wxBitmapRefData *)m_refData)
	101
	102	class WXDLLEXPORT wxBitmapHandler: public wxObject
	103	{
	104	DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
	105	public:
	106	wxBitmapHandler() { m_name = ""; m_extension = ""; m_type = 0; };
	107
	108	virtual bool Create(wxBitmap bitmap, void data, long flags, int width, int height, int depth = 1);
	109	virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
	110	int desiredWidth, int desiredHeight);
	111	virtual bool SaveFile(wxBitmap bitmap, const wxString& name, int type, const wxPalette palette = NULL);
	112
	113	inline void SetName(const wxString& name) { m_name = name; }
	114	inline void SetExtension(const wxString& ext) { m_extension = ext; }
	115	inline void SetType(long type) { m_type = type; }
	116	inline wxString GetName() const { return m_name; }
	117	inline wxString GetExtension() const { return m_extension; }
	118	inline long GetType() const { return m_type; }
	119	protected:
	120	wxString m_name;
	121	wxString m_extension;
	122	long m_type;
	123	};
	124
	125	#define M_BITMAPHANDLERDATA ((wxBitmapRefData *)bitmap->GetRefData())
	126
	127	class WXDLLEXPORT wxBitmap: public wxGDIObject
	128	{
	129	DECLARE_DYNAMIC_CLASS(wxBitmap)
	130
	131	friend class WXDLLEXPORT wxBitmapHandler;
	132
	133	public:
	134	wxBitmap(); // Platform-specific
	135
	136	// Copy constructors
	137	inline wxBitmap(const wxBitmap& bitmap)
	138	{ Ref(bitmap); if ( wxTheBitmapList ) wxTheBitmapList->AddBitmap(this); }
9b6dbb09	139
f97c9854	140	// Initialize with raw XBM data
9b6dbb09 JS	141	wxBitmap(const char bits[], int width, int height, int depth = 1);
9b6dbb09 JS	142
9b6dbb09	143	// Initialize with XPM data
a4294b78	144	wxBitmap(char *data, wxControl control = NULL);
9b6dbb09 JS	145
9b6dbb09 JS	146	// Load a file or resource
cba2db0c	147	wxBitmap(const wxString& name, long type = wxBITMAP_TYPE_XPM);
9b6dbb09 JS	148
	149	// Constructor for generalised creation from data
	150	wxBitmap(void *data, long type, int width, int height, int depth = 1);
	151
	152	// If depth is omitted, will create a bitmap compatible with the display
	153	wxBitmap(int width, int height, int depth = -1);
	154	~wxBitmap();
	155
	156	virtual bool Create(int width, int height, int depth = -1);
	157	virtual bool Create(void *data, long type, int width, int height, int depth = 1);
cba2db0c	158	virtual bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_XPM);
9b6dbb09 JS	159	virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
	160
	161	inline bool Ok() const { return (M_BITMAPDATA && M_BITMAPDATA->m_ok); }
	162	inline int GetWidth() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_width : 0); }
	163	inline int GetHeight() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_height : 0); }
	164	inline int GetDepth() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_depth : 0); }
	165	inline int GetQuality() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_quality : 0); }
	166	void SetWidth(int w);
	167	void SetHeight(int h);
	168	void SetDepth(int d);
	169	void SetQuality(int q);
	170	void SetOk(bool isOk);
	171
	172	inline wxPalette* GetPalette() const { return (M_BITMAPDATA ? (& M_BITMAPDATA->m_bitmapPalette) : (wxPalette*) NULL); }
	173	void SetPalette(const wxPalette& palette);
	174
	175	inline wxMask GetMask() const { return (M_BITMAPDATA ? M_BITMAPDATA->m_bitmapMask : (wxMask) NULL); }
	176	void SetMask(wxMask *mask) ;
	177
	178	inline wxBitmap& operator = (const wxBitmap& bitmap) { if (this == bitmap) return (this); Ref(bitmap); return *this; }
	179	inline bool operator == (const wxBitmap& bitmap) { return m_refData == bitmap.m_refData; }
	180	inline bool operator != (const wxBitmap& bitmap) { return m_refData != bitmap.m_refData; }
	181
	182	// Format handling
	183	static inline wxList& GetHandlers() { return sm_handlers; }
	184	static void AddHandler(wxBitmapHandler *handler);
	185	static void InsertHandler(wxBitmapHandler *handler);
	186	static bool RemoveHandler(const wxString& name);
	187	static wxBitmapHandler *FindHandler(const wxString& name);
	188	static wxBitmapHandler *FindHandler(const wxString& extension, long bitmapType);
	189	static wxBitmapHandler *FindHandler(long bitmapType);
	190
	191	static void InitStandardHandlers();
	192	static void CleanUpHandlers();
16c1f7f3 JS	193
	194	// Motif implementation
	195	public:
	196	inline WXDisplay* GetDisplay() const { return M_BITMAPDATA->m_display; }
	197	inline WXDisplay* GetPixmap() const { return M_BITMAPDATA->m_pixmap; }
f97c9854 JS	198	virtual WXPixmap GetLabelPixmap(WXWidget w) ;
f97c9854 JS	199	virtual WXPixmap GetArmPixmap(WXWidget w) ;
0d57be45	200	virtual WXPixmap GetInsensPixmap(WXWidget w = (WXWidget) 0) ;
16c1f7f3	201
9b6dbb09 JS	202	protected:
9b6dbb09 JS	203	static wxList sm_handlers;
9b6dbb09	204	};
321db4b6 JS	205
	206	// Creates a bitmap with transparent areas drawn in
	207	// the given colour.
	208	wxBitmap wxCreateMaskedBitmap(wxBitmap& bitmap, wxColour& colour);
	209
9b6dbb09 JS	210	#endif
9b6dbb09 JS	211	// _WX_BITMAP_H_