/////////////////////////////////////////////////////////////////////////////
-// Name: bitmap.h
+// Name: wx/cocoa/bitmap.h
// Purpose: wxBitmap class
-// Author: AUTHOR
+// Author: David Elliott
// Modified by:
-// Created: ??/??/98
+// Created: 2003/07/19
// RCS-ID: $Id$
-// Copyright: (c) AUTHOR
-// Licence: wxWindows licence
+// Copyright: (c) 2003 David Elliott
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifndef _WX_BITMAP_H_
-#define _WX_BITMAP_H_
-
-#if defined(__GNUG__) && !defined(__APPLE__)
- #pragma interface "bitmap.h"
-#endif
+#ifndef __WX_COCOA_BITMAP_H__
+#define __WX_COCOA_BITMAP_H__
#include "wx/palette.h"
// Bitmap
-class WXDLLEXPORT wxBitmap;
-class WXDLLEXPORT wxBitmapHandler;
-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxCursor;
-class WXDLLEXPORT wxImage;
-
-// A mask is a mono bitmap used for drawing bitmaps
-// transparently.
-class WXDLLEXPORT wxMask: public wxObject
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxIcon;
+class WXDLLIMPEXP_FWD_CORE wxCursor;
+class WXDLLIMPEXP_FWD_CORE wxImage;
+class WXDLLIMPEXP_FWD_CORE wxPixelDataBase;
+
+// ========================================================================
+// wxMask
+// ========================================================================
+
+// A mask is a 1-bit alpha bitmap used for drawing bitmaps transparently.
+class WXDLLIMPEXP_CORE wxMask: public wxObject
{
DECLARE_DYNAMIC_CLASS(wxMask)
- DECLARE_NO_COPY_CLASS(wxMask)
-
public:
- wxMask();
+ 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 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 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 a mono bitmap (copies the bitmap).
- wxMask(const wxBitmap& bitmap);
+ // Copy constructor
+ wxMask(const wxMask& src);
- ~wxMask();
+ virtual ~wxMask();
- bool Create(const wxBitmap& bitmap, const wxColour& colour);
- bool Create(const wxBitmap& bitmap, int paletteIndex);
- bool Create(const wxBitmap& bitmap);
+ bool Create(const wxBitmap& bitmap, const wxColour& colour);
+ bool Create(const wxBitmap& bitmap, int paletteIndex);
+ bool Create(const wxBitmap& bitmap);
- // Implementation
-// inline WXHBITMAP GetMaskBitmap() const { return m_maskBitmap; }
-// inline void SetMaskBitmap(WXHBITMAP bmp) { m_maskBitmap = bmp; }
+ // wxCocoa
+ inline WX_NSBitmapImageRep GetNSBitmapImageRep()
+ { return m_cocoaNSBitmapImageRep; }
protected:
-// WXHBITMAP m_maskBitmap;
+ WX_NSBitmapImageRep m_cocoaNSBitmapImageRep;
};
-class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData
+
+// ========================================================================
+// wxBitmap
+// ========================================================================
+
+class WXDLLIMPEXP_CORE wxBitmap: public wxGDIObject,
+ public wxBitmapHelpers
{
- DECLARE_NO_COPY_CLASS(wxBitmapRefData)
-
- friend class WXDLLEXPORT wxBitmap;
- friend class WXDLLEXPORT wxIcon;
- friend class WXDLLEXPORT wxCursor;
+// ------------------------------------------------------------------------
+// initialization
+// ------------------------------------------------------------------------
public:
- wxBitmapRefData();
- ~wxBitmapRefData();
-
+ // Platform-specific default constructor
+ wxBitmap();
+ // Initialize with raw data.
+ wxBitmap(const char bits[], int width, int height, int depth = 1);
+ // Initialize with XPM data
+ wxBitmap(const char* const* bits);
+ // Load a file or resource
+ wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
+ // Construct from Cocoa's NSImage
+ wxBitmap(NSImage* cocoaNSImage);
+ // Construct from Cocoa's NSBitmapImageRep
+ wxBitmap(NSBitmapImageRep* cocoaNSBitmapImageRep);
+ // Constructor for generalised creation from data
+ wxBitmap(const void* data, wxBitmapType 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)
+ { (void)Create(width, height, depth); }
+ wxBitmap(const wxSize& sz, int depth = -1)
+ { (void)Create(sz, depth); }
+ // Convert from wxImage:
+ wxBitmap(const wxImage& image, int depth = -1)
+ { CreateFromImage(image, depth); }
+ // Convert from wxIcon
+ wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
+
+ // destructor
+ virtual ~wxBitmap();
+
+// ------------------------------------------------------------------------
+// Implementation
+// ------------------------------------------------------------------------
public:
- int m_width;
- int m_height;
- int m_depth;
- bool m_ok;
- int m_numColors;
- wxPalette m_bitmapPalette;
- int m_quality;
-
- // TOTO: platofmr specific hBitmap
-// WXHBITMAP m_hBitmap;
- wxMask * m_bitmapMask; // Optional mask
-};
+ // Initialize from wxImage
+ bool CreateFromImage(const wxImage& image, int depth=-1);
-#define M_BITMAPDATA ((wxBitmapRefData *)m_refData)
+ virtual bool Create(int width, int height, int depth = wxBITMAP_SCREEN_DEPTH);
+ virtual bool Create(const wxSize& sz, int depth = wxBITMAP_SCREEN_DEPTH)
+ { return Create(sz.GetWidth(), sz.GetHeight(), depth); }
-class WXDLLEXPORT wxBitmapHandler: public wxBitmapHandlerBase
-{
- DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
-public:
- wxBitmapHandler() : m_name(), m_extension(), m_type(0) { }
- virtual ~wxBitmapHandler();
+ bool Create(NSImage* cocoaNSImage);
+ bool Create(NSBitmapImageRep* cocoaNSBitmapImageRep);
+ virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
+ virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE);
+ virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
- 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);
+ // copies the contents and mask of the given (colour) icon to the bitmap
+ virtual bool CopyFromIcon(const wxIcon& icon);
- void SetName(const wxString& name) { m_name = name; }
- void SetExtension(const wxString& ext) { m_extension = ext; }
- void SetType(long type) { m_type = type; }
- wxString GetName() const { return m_name; }
- wxString GetExtension() const { return m_extension; }
- long GetType() const { return m_type; }
+ wxImage ConvertToImage() const;
-protected:
- wxString m_name;
- wxString m_extension;
- long m_type;
-};
+ // get the given part of bitmap
+ wxBitmap GetSubBitmap( const wxRect& rect ) const;
-#define M_BITMAPHANDLERDATA ((wxBitmapRefData *)bitmap->GetRefData())
+ int GetWidth() const;
+ int GetHeight() const;
+ int GetDepth() const;
+ int GetQuality() const;
+ void SetWidth(int w);
+ void SetHeight(int h);
+ void SetDepth(int d);
+ void SetQuality(int q);
+ void SetOk(bool isOk);
-class WXDLLEXPORT wxBitmap: public wxBitmapBase
-{
- DECLARE_DYNAMIC_CLASS(wxBitmap)
+ // raw bitmap access support functions
+ void *GetRawData(wxPixelDataBase& data, int bpp);
+ void UngetRawData(wxPixelDataBase& data);
- friend class WXDLLEXPORT wxBitmapHandler;
+ wxPalette* GetPalette() const;
+ void SetPalette(const wxPalette& palette);
-public:
- wxBitmap(); // Platform-specific
-
- // Copy constructors
- wxBitmap(const wxBitmap& bitmap)
- : wxBitmapBase()
- { Ref(bitmap); }
-
- // Initialize with raw data.
- wxBitmap(const char bits[], int width, int height, int depth = 1);
-
- // Initialize with XPM data
- bool CreateFromXpm(const char **bits);
- wxBitmap(const char **bits) { CreateFromXpm(bits); }
- wxBitmap(char **bits);
-
- // Load a file or resource
- wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
-
- // Constructor for generalised creation from data
- wxBitmap(void *data, wxBitmapType 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);
-
- // Convert from wxImage:
- wxBitmap(const wxImage& image, int depth = -1);
-
- ~wxBitmap();
-
- wxImage ConvertToImage() const;
-
- // get the given part of bitmap
- wxBitmap GetSubBitmap( const wxRect& rect ) const;
-
- virtual bool Create(int width, int height, int depth = -1);
- virtual bool Create(void *data, wxBitmapType type, int width, int height, int depth = 1);
- virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
- virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
-
- // copies the contents and mask of the given (colour) icon to the bitmap
- virtual bool CopyFromIcon(const wxIcon& icon);
-
- bool Ok() const;
- int GetWidth() const;
- int GetHeight() const;
- int GetDepth() const;
- int GetQuality() const;
- void SetWidth(int w);
- void SetHeight(int h);
- void SetDepth(int d);
- void SetQuality(int q);
- void SetOk(bool isOk);
-
- wxPalette* GetPalette() const;
- void SetPalette(const wxPalette& palette);
-
- wxMask *GetMask() const;
- void SetMask(wxMask *mask) ;
-
- int GetBitmapType() const;
-
- inline wxBitmap& operator = (const wxBitmap& bitmap) { if (*this == bitmap) return (*this); Ref(bitmap); return *this; }
- inline bool operator == (const wxBitmap& bitmap) const { return m_refData == bitmap.m_refData; }
- inline bool operator != (const wxBitmap& bitmap) const { return m_refData != bitmap.m_refData; }
-
- static void InitStandardHandlers();
-protected:
+ wxMask *GetMask() const;
+ void SetMask(wxMask *mask) ;
- // TODO: Implementation
-public:
-// void SetHBITMAP(WXHBITMAP bmp);
-// WXHBITMAP GetHBITMAP() const;
-
-// WXHMETAFILE GetPict() const;
+ wxBitmapType GetBitmapType() const;
+
+ // wxCocoa
+ WX_NSBitmapImageRep GetNSBitmapImageRep();
+ void SetNSBitmapImageRep(WX_NSBitmapImageRep bitmapImageRep);
+ WX_NSImage GetNSImage(bool useMask) const;
- bool FreeResource(bool force = FALSE);
+ static void InitStandardHandlers() { }
+ static void CleanUpHandlers() { }
+
+protected:
+ wxGDIRefData *CreateGDIRefData() const;
+ wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
+
+ DECLARE_DYNAMIC_CLASS(wxBitmap)
};
-#endif
- // _WX_BITMAP_H_
+
+
+#endif // __WX_COCOA_BITMAP_H__