2001-06-26 16:59:19 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: wx/bitmap.h
|
|
|
|
// Purpose: wxBitmap class interface
|
|
|
|
// Author: Vaclav Slavik
|
|
|
|
// Modified by:
|
|
|
|
// Created: 22.04.01
|
|
|
|
// RCS-ID: $Id$
|
2004-05-23 10:56:36 -04:00
|
|
|
// Copyright: (c) wxWidgets team
|
2004-05-23 16:53:33 -04:00
|
|
|
// Licence: wxWindows licence
|
2001-06-26 16:59:19 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
1998-08-14 20:23:28 -04:00
|
|
|
#ifndef _WX_BITMAP_H_BASE_
|
|
|
|
#define _WX_BITMAP_H_BASE_
|
1998-05-20 10:01:55 -04:00
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// headers
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2003-08-09 08:38:21 -04:00
|
|
|
#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
|
2001-06-26 16:59:19 -04:00
|
|
|
#pragma interface "bitmapbase.h"
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#include "wx/object.h"
|
|
|
|
#include "wx/string.h"
|
|
|
|
#include "wx/gdiobj.h"
|
2001-06-27 09:55:28 -04:00
|
|
|
#include "wx/gdicmn.h" // for wxBitmapType
|
2001-06-26 16:59:19 -04:00
|
|
|
|
|
|
|
class WXDLLEXPORT wxBitmap;
|
|
|
|
class WXDLLEXPORT wxBitmapHandler;
|
2001-06-27 09:55:28 -04:00
|
|
|
class WXDLLEXPORT wxImage;
|
|
|
|
class WXDLLEXPORT wxMask;
|
|
|
|
class WXDLLEXPORT wxPalette;
|
2001-06-26 16:59:19 -04:00
|
|
|
|
2004-06-23 11:01:33 -04:00
|
|
|
#if defined(__WXMGL__) || \
|
|
|
|
defined(__WXMAC__) || \
|
|
|
|
defined(__WXCOCOA__) || \
|
|
|
|
defined(__WXMOTIF__) || \
|
|
|
|
defined(__WXX11__)
|
2001-07-05 16:55:06 -04:00
|
|
|
// Only used by some ports
|
2001-08-03 16:26:24 -04:00
|
|
|
// FIXME -- make all ports (but MSW which uses wxGDIImage) use these base classes
|
|
|
|
|
2001-06-26 16:59:19 -04:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxBitmapHandler: class which knows how to create/load/save bitmaps in
|
|
|
|
// different formats
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxBitmapHandlerBase : public wxObject
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxBitmapHandlerBase()
|
2002-05-03 15:41:22 -04:00
|
|
|
: m_name()
|
|
|
|
, m_extension()
|
|
|
|
, m_type(wxBITMAP_TYPE_INVALID)
|
|
|
|
{ }
|
2001-06-26 16:59:19 -04:00
|
|
|
|
|
|
|
virtual ~wxBitmapHandlerBase() { }
|
|
|
|
|
|
|
|
virtual bool Create(wxBitmap *bitmap, void *data, long flags,
|
|
|
|
int width, int height, int depth = 1) = 0;
|
|
|
|
virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
|
|
|
|
int desiredWidth, int desiredHeight) = 0;
|
|
|
|
virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name,
|
|
|
|
int type, const wxPalette *palette = NULL) = 0;
|
|
|
|
|
|
|
|
void SetName(const wxString& name) { m_name = name; }
|
|
|
|
void SetExtension(const wxString& ext) { m_extension = ext; }
|
|
|
|
void SetType(wxBitmapType type) { m_type = type; }
|
|
|
|
wxString GetName() const { return m_name; }
|
|
|
|
wxString GetExtension() const { return m_extension; }
|
|
|
|
wxBitmapType GetType() const { return m_type; }
|
|
|
|
|
|
|
|
protected:
|
|
|
|
wxString m_name;
|
|
|
|
wxString m_extension;
|
|
|
|
wxBitmapType m_type;
|
|
|
|
|
|
|
|
DECLARE_ABSTRACT_CLASS(wxBitmapHandlerBase)
|
|
|
|
};
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxBitmapBase : public wxGDIObject
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxBitmapBase() : wxGDIObject() {}
|
|
|
|
virtual ~wxBitmapBase() {}
|
|
|
|
|
|
|
|
/*
|
|
|
|
Derived class must implement these:
|
|
|
|
|
|
|
|
wxBitmap();
|
|
|
|
wxBitmap(int width, int height, int depth = -1);
|
|
|
|
wxBitmap(const char bits[], int width, int height, int depth = 1);
|
|
|
|
wxBitmap(const char **bits);
|
|
|
|
wxBitmap(char **bits);
|
|
|
|
wxBitmap(const wxBitmap& bmp);
|
|
|
|
wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM);
|
|
|
|
wxBitmap(const wxImage& image, int depth = -1);
|
|
|
|
wxBitmap& operator = (const wxBitmap& bmp);
|
|
|
|
bool operator == (const wxBitmap& bmp) const;
|
|
|
|
bool operator != (const wxBitmap& bmp) const;
|
|
|
|
|
|
|
|
bool Create(int width, int height, int depth = -1);
|
|
|
|
|
|
|
|
static void InitStandardHandlers();
|
|
|
|
*/
|
|
|
|
|
|
|
|
virtual bool Ok() const = 0;
|
|
|
|
|
|
|
|
virtual int GetHeight() const = 0;
|
|
|
|
virtual int GetWidth() const = 0;
|
|
|
|
virtual int GetDepth() const = 0;
|
|
|
|
|
|
|
|
virtual wxImage ConvertToImage() const = 0;
|
|
|
|
|
|
|
|
virtual wxMask *GetMask() const = 0;
|
|
|
|
virtual void SetMask(wxMask *mask) = 0;
|
|
|
|
|
|
|
|
virtual wxBitmap GetSubBitmap(const wxRect& rect) const = 0;
|
|
|
|
|
|
|
|
virtual bool SaveFile(const wxString &name, wxBitmapType type,
|
|
|
|
const wxPalette *palette = (wxPalette *)NULL) const = 0;
|
|
|
|
virtual bool LoadFile(const wxString &name, wxBitmapType type) = 0;
|
|
|
|
|
2003-03-22 14:09:33 -05:00
|
|
|
/*
|
|
|
|
If raw bitmap access is supported (see wx/rawbmp.h), the following
|
|
|
|
methods should be implemented:
|
|
|
|
|
|
|
|
virtual bool GetRawData(wxRawBitmapData *data) = 0;
|
|
|
|
virtual void UngetRawData(wxRawBitmapData *data) = 0;
|
|
|
|
*/
|
|
|
|
|
|
|
|
#if wxUSE_PALETTE
|
2001-06-26 16:59:19 -04:00
|
|
|
virtual wxPalette *GetPalette() const = 0;
|
|
|
|
virtual void SetPalette(const wxPalette& palette) = 0;
|
2003-03-22 14:09:33 -05:00
|
|
|
#endif // wxUSE_PALETTE
|
2001-06-26 16:59:19 -04:00
|
|
|
|
|
|
|
// copies the contents and mask of the given (colour) icon to the bitmap
|
|
|
|
virtual bool CopyFromIcon(const wxIcon& icon) = 0;
|
|
|
|
|
|
|
|
// implementation:
|
|
|
|
virtual void SetHeight(int height) = 0;
|
|
|
|
virtual void SetWidth(int width) = 0;
|
|
|
|
virtual void SetDepth(int depth) = 0;
|
|
|
|
|
|
|
|
// Format handling
|
|
|
|
static inline wxList& GetHandlers() { return sm_handlers; }
|
|
|
|
static void AddHandler(wxBitmapHandlerBase *handler);
|
|
|
|
static void InsertHandler(wxBitmapHandlerBase *handler);
|
|
|
|
static bool RemoveHandler(const wxString& name);
|
|
|
|
static wxBitmapHandler *FindHandler(const wxString& name);
|
|
|
|
static wxBitmapHandler *FindHandler(const wxString& extension, wxBitmapType bitmapType);
|
|
|
|
static wxBitmapHandler *FindHandler(wxBitmapType bitmapType);
|
|
|
|
|
|
|
|
//static void InitStandardHandlers();
|
|
|
|
// (wxBitmap must implement this one)
|
|
|
|
|
|
|
|
static void CleanUpHandlers();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
static wxList sm_handlers;
|
|
|
|
|
|
|
|
DECLARE_ABSTRACT_CLASS(wxBitmapBase)
|
|
|
|
};
|
2001-07-05 16:55:06 -04:00
|
|
|
#endif
|
2001-06-26 16:59:19 -04:00
|
|
|
|
1998-07-10 10:15:17 -04:00
|
|
|
#if defined(__WXMSW__)
|
1998-05-20 10:01:55 -04:00
|
|
|
#include "wx/msw/bitmap.h"
|
1998-07-10 10:15:17 -04:00
|
|
|
#elif defined(__WXMOTIF__)
|
2003-04-09 12:44:27 -04:00
|
|
|
#include "wx/x11/bitmap.h"
|
1998-07-10 10:15:17 -04:00
|
|
|
#elif defined(__WXGTK__)
|
1998-05-20 10:01:55 -04:00
|
|
|
#include "wx/gtk/bitmap.h"
|
2002-02-05 11:34:33 -05:00
|
|
|
#elif defined(__WXX11__)
|
|
|
|
#include "wx/x11/bitmap.h"
|
2001-06-26 16:59:19 -04:00
|
|
|
#elif defined(__WXMGL__)
|
|
|
|
#include "wx/mgl/bitmap.h"
|
1998-08-14 20:23:28 -04:00
|
|
|
#elif defined(__WXMAC__)
|
|
|
|
#include "wx/mac/bitmap.h"
|
2003-03-22 00:57:18 -05:00
|
|
|
#elif defined(__WXCOCOA__)
|
|
|
|
#include "wx/cocoa/bitmap.h"
|
1999-07-27 23:38:12 -04:00
|
|
|
#elif defined(__WXPM__)
|
|
|
|
#include "wx/os2/bitmap.h"
|
1998-05-20 10:01:55 -04:00
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif
|
1998-08-14 20:23:28 -04:00
|
|
|
// _WX_BITMAP_H_BASE_
|