00e7a427a0
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18526 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
323 lines
11 KiB
C++
323 lines
11 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/msw/bitmap.h
|
|
// Purpose: wxBitmap class
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 01/02/97
|
|
// 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/msw/gdiimage.h"
|
|
#include "wx/gdicmn.h"
|
|
#include "wx/palette.h"
|
|
|
|
class WXDLLEXPORT wxDC;
|
|
class WXDLLEXPORT wxControl;
|
|
class WXDLLEXPORT wxBitmap;
|
|
class WXDLLEXPORT wxBitmapHandler;
|
|
class WXDLLEXPORT wxIcon;
|
|
class WXDLLEXPORT wxMask;
|
|
class WXDLLEXPORT wxCursor;
|
|
class WXDLLEXPORT wxControl;
|
|
class WXDLLEXPORT wxImage;
|
|
class WXDLLEXPORT wxPalette;
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// Bitmap data
|
|
//
|
|
// NB: this class is private, but declared here to make it possible inline
|
|
// wxBitmap functions accessing it
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxBitmapRefData : public wxGDIImageRefData
|
|
{
|
|
public:
|
|
wxBitmapRefData();
|
|
virtual ~wxBitmapRefData() { Free(); }
|
|
|
|
virtual void Free();
|
|
|
|
public:
|
|
int m_numColors;
|
|
#if wxUSE_PALETTE
|
|
wxPalette m_bitmapPalette;
|
|
#endif // wxUSE_PALETTE
|
|
int m_quality;
|
|
|
|
// MSW-specific
|
|
// ------------
|
|
|
|
// this field is solely for error checking: we detect selecting a bitmap
|
|
// into more than one DC at once or deleting a bitmap still selected into a
|
|
// DC (both are serious programming errors under Windows)
|
|
wxDC *m_selectedInto;
|
|
|
|
// optional mask for transparent drawing
|
|
wxMask *m_bitmapMask;
|
|
|
|
#if wxUSE_DIB_FOR_BITMAP
|
|
WXHANDLE m_hFileMap; // file mapping handle for large DIB's
|
|
#endif
|
|
|
|
|
|
DECLARE_NO_COPY_CLASS(wxBitmapRefData)
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxBitmap: a mono or colour bitmap
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxBitmap : public wxGDIImage
|
|
{
|
|
public:
|
|
// default ctor creates an invalid bitmap, you must Create() it later
|
|
wxBitmap() { Init(); }
|
|
|
|
// Copy constructors
|
|
wxBitmap(const wxBitmap& bitmap) { Init(); Ref(bitmap); }
|
|
|
|
// Initialize with raw data
|
|
wxBitmap(const char bits[], int width, int height, int depth = 1);
|
|
|
|
// Initialize with XPM data
|
|
wxBitmap(const char **data) { CreateFromXpm(data); }
|
|
wxBitmap(char **data) { CreateFromXpm((const char **)data); }
|
|
|
|
// Load a file or resource
|
|
wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
|
|
|
|
// New 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);
|
|
|
|
#if wxUSE_IMAGE
|
|
// Convert from wxImage:
|
|
wxBitmap(const wxImage& image, int depth = -1)
|
|
{ (void)CreateFromImage(image, depth); }
|
|
#endif // wxUSE_IMAGE
|
|
|
|
// we must have this, otherwise icons are silently copied into bitmaps using
|
|
// the copy ctor but the resulting bitmap is invalid!
|
|
wxBitmap(const wxIcon& icon) { Init(); CopyFromIcon(icon); }
|
|
|
|
wxBitmap& operator=(const wxBitmap& bitmap)
|
|
{
|
|
if ( m_refData != bitmap.m_refData )
|
|
Ref(bitmap);
|
|
return *this;
|
|
}
|
|
|
|
wxBitmap& operator=(const wxIcon& icon)
|
|
{
|
|
(void)CopyFromIcon(icon);
|
|
|
|
return *this;
|
|
}
|
|
|
|
wxBitmap& operator=(const wxCursor& cursor)
|
|
{
|
|
(void)CopyFromCursor(cursor);
|
|
|
|
return *this;
|
|
}
|
|
|
|
virtual ~wxBitmap();
|
|
|
|
#if wxUSE_IMAGE
|
|
wxImage ConvertToImage() const;
|
|
#endif // wxUSE_IMAGE
|
|
|
|
// get the given part of bitmap
|
|
wxBitmap GetSubBitmap( const wxRect& rect ) const;
|
|
|
|
// copies the contents and mask of the given (colour) icon to the bitmap
|
|
bool CopyFromIcon(const wxIcon& icon);
|
|
|
|
// copies the contents and mask of the given cursor to the bitmap
|
|
bool CopyFromCursor(const wxCursor& cursor);
|
|
|
|
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_BMP_RESOURCE);
|
|
virtual bool SaveFile(const wxString& name, int type, const wxPalette *cmap = NULL);
|
|
|
|
wxBitmapRefData *GetBitmapData() const { return (wxBitmapRefData *)m_refData; }
|
|
|
|
int GetQuality() const { return (GetBitmapData() ? GetBitmapData()->m_quality : 0); }
|
|
void SetQuality(int q);
|
|
|
|
#if wxUSE_PALETTE
|
|
wxPalette* GetPalette() const { return (GetBitmapData() ? (& GetBitmapData()->m_bitmapPalette) : (wxPalette*) NULL); }
|
|
void SetPalette(const wxPalette& palette);
|
|
#endif // wxUSE_PALETTE
|
|
|
|
wxMask *GetMask() const { return (GetBitmapData() ? GetBitmapData()->m_bitmapMask : (wxMask*) NULL); }
|
|
void SetMask(wxMask *mask) ;
|
|
|
|
bool operator==(const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
|
|
bool operator!=(const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
|
|
|
|
#if WXWIN_COMPATIBILITY_2
|
|
void SetOk(bool isOk);
|
|
#endif // WXWIN_COMPATIBILITY_2
|
|
|
|
#if wxUSE_PALETTE
|
|
#if WXWIN_COMPATIBILITY
|
|
wxPalette *GetColourMap() const { return GetPalette(); }
|
|
void SetColourMap(wxPalette *cmap) { SetPalette(*cmap); };
|
|
#endif // WXWIN_COMPATIBILITY
|
|
#endif // wxUSE_PALETTE
|
|
|
|
// Implementation
|
|
public:
|
|
void SetHBITMAP(WXHBITMAP bmp) { SetHandle((WXHANDLE)bmp); }
|
|
WXHBITMAP GetHBITMAP() const { return (WXHBITMAP)GetHandle(); }
|
|
|
|
#if wxUSE_DIB_FOR_BITMAP
|
|
void SetHFileMap(WXHANDLE hFileMap) { GetBitmapData()->m_hFileMap = hFileMap; }
|
|
WXHANDLE GetHFileMap() const { return GetBitmapData()->m_hFileMap; }
|
|
#endif // wxUSE_DIB_FOR_BITMAP
|
|
|
|
void SetSelectedInto(wxDC *dc) { if (GetBitmapData()) GetBitmapData()->m_selectedInto = dc; }
|
|
wxDC *GetSelectedInto() const { return (GetBitmapData() ? GetBitmapData()->m_selectedInto : (wxDC*) NULL); }
|
|
|
|
// Creates a bitmap that matches the device context's depth, from an
|
|
// arbitray bitmap. At present, the original bitmap must have an associated
|
|
// palette. (TODO: use a default palette if no palette exists.) This
|
|
// function is necessary for you to Blit an arbitrary bitmap (which may
|
|
// have the wrong depth). wxDC::SelectObject will compare the depth of the
|
|
// bitmap with the DC's depth, and create a new bitmap if the depths
|
|
// differ. Eventually we should perhaps make this a public API function so
|
|
// that an app can efficiently produce bitmaps of the correct depth. The
|
|
// Windows solution is to use SetDibBits to blit an arbotrary DIB directly
|
|
// to a DC, but this is too Windows-specific, hence this solution of
|
|
// quietly converting the wxBitmap. Contributed by Frederic Villeneuve
|
|
// <frederic.villeneuve@natinst.com>
|
|
wxBitmap GetBitmapForDC(wxDC& dc) const;
|
|
|
|
protected:
|
|
// common part of all ctors
|
|
void Init();
|
|
|
|
virtual wxGDIImageRefData *CreateData() const
|
|
{ return new wxBitmapRefData; }
|
|
|
|
// creates the bitmap from XPM data, supposed to be called from ctor
|
|
bool CreateFromXpm(const char **bits);
|
|
|
|
#if wxUSE_IMAGE
|
|
// creates the bitmap from wxImage, supposed to be called from ctor
|
|
bool CreateFromImage(const wxImage& image, int depth);
|
|
#endif // wxUSE_IMAGE
|
|
|
|
#if wxUSE_DIB_FOR_BITMAP
|
|
void *CreateDIB(int width, int height, int depth);
|
|
void CopyDIBLine(void* src, void* dest, int count) const;
|
|
#endif
|
|
|
|
private:
|
|
#ifdef __WIN32__
|
|
// common part of CopyFromIcon/CopyFromCursor for Win32
|
|
bool CopyFromIconOrCursor(const wxGDIImage& icon);
|
|
#endif // __WIN32__
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxBitmap)
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxMask: a mono bitmap used for drawing bitmaps transparently.
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxMask : public wxObject
|
|
{
|
|
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);
|
|
|
|
// construct a mask from the givne bitmap handle
|
|
wxMask(WXHBITMAP hbmp) { m_maskBitmap = hbmp; }
|
|
|
|
virtual ~wxMask();
|
|
|
|
bool Create(const wxBitmap& bitmap, const wxColour& colour);
|
|
bool Create(const wxBitmap& bitmap, int paletteIndex);
|
|
bool Create(const wxBitmap& bitmap);
|
|
|
|
// Implementation
|
|
WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
|
|
void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
|
|
|
|
protected:
|
|
WXHBITMAP m_maskBitmap;
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxMask)
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxBitmapHandler is a class which knows how to load/save bitmaps to/from file
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxBitmapHandler : public wxGDIImageHandler
|
|
{
|
|
public:
|
|
wxBitmapHandler() { m_type = wxBITMAP_TYPE_INVALID; }
|
|
wxBitmapHandler(const wxString& name, const wxString& ext, long type)
|
|
: wxGDIImageHandler(name, ext, type)
|
|
{
|
|
}
|
|
|
|
// keep wxBitmapHandler derived from wxGDIImageHandler compatible with the
|
|
// old class which worked only with bitmaps
|
|
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);
|
|
|
|
virtual bool Create(wxGDIImage *image,
|
|
void *data,
|
|
long flags,
|
|
int width, int height, int depth = 1);
|
|
virtual bool Load(wxGDIImage *image,
|
|
const wxString& name,
|
|
long flags,
|
|
int desiredWidth, int desiredHeight);
|
|
virtual bool Save(wxGDIImage *image,
|
|
const wxString& name,
|
|
int type);
|
|
|
|
private:
|
|
DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
|
|
};
|
|
|
|
#endif
|
|
// _WX_BITMAP_H_
|