]> git.saurik.com Git - wxWidgets.git/blame - include/wx/cocoa/bitmap.h
djgpp doesn't have wint_t as separate type
[wxWidgets.git] / include / wx / cocoa / bitmap.h
CommitLineData
a24aff65 1/////////////////////////////////////////////////////////////////////////////
1b88201f 2// Name: wx/cocoa/bitmap.h
a24aff65 3// Purpose: wxBitmap class
d135b1a5 4// Author: David Elliott
a24aff65 5// Modified by:
d135b1a5 6// Created: 2003/07/19
a24aff65 7// RCS-ID: $Id$
d135b1a5 8// Copyright: (c) 2003 David Elliott
1b88201f 9// Licence: wxWindows licence
a24aff65
DE
10/////////////////////////////////////////////////////////////////////////////
11
d135b1a5
DE
12#ifndef __WX_COCOA_BITMAP_H__
13#define __WX_COCOA_BITMAP_H__
a24aff65
DE
14
15#include "wx/palette.h"
16
17// Bitmap
18class WXDLLEXPORT wxBitmap;
a24aff65
DE
19class WXDLLEXPORT wxIcon;
20class WXDLLEXPORT wxCursor;
21class WXDLLEXPORT wxImage;
b60c6e97 22class WXDLLEXPORT wxPixelDataBase;
a24aff65 23
d135b1a5
DE
24// ========================================================================
25// wxMask
26// ========================================================================
d135b1a5 27
016b0643 28// A mask is a 1-bit alpha bitmap used for drawing bitmaps transparently.
a24aff65
DE
29class WXDLLEXPORT wxMask: public wxObject
30{
31 DECLARE_DYNAMIC_CLASS(wxMask)
a24aff65 32public:
016b0643 33 wxMask();
a24aff65 34
016b0643
DE
35 // Construct a mask from a bitmap and a colour indicating
36 // the transparent area
37 wxMask(const wxBitmap& bitmap, const wxColour& colour);
a24aff65 38
016b0643
DE
39 // Construct a mask from a bitmap and a palette index indicating
40 // the transparent area
41 wxMask(const wxBitmap& bitmap, int paletteIndex);
a24aff65 42
016b0643
DE
43 // Construct a mask from a mono bitmap (copies the bitmap).
44 wxMask(const wxBitmap& bitmap);
a24aff65 45
d3c7fc99 46 virtual ~wxMask();
a24aff65 47
016b0643
DE
48 bool Create(const wxBitmap& bitmap, const wxColour& colour);
49 bool Create(const wxBitmap& bitmap, int paletteIndex);
50 bool Create(const wxBitmap& bitmap);
a24aff65 51
016b0643
DE
52 // wxCocoa
53 inline WX_NSBitmapImageRep GetNSBitmapImageRep()
54 { return m_cocoaNSBitmapImageRep; }
a24aff65 55protected:
016b0643 56 WX_NSBitmapImageRep m_cocoaNSBitmapImageRep;
a24aff65
DE
57};
58
d135b1a5
DE
59// ========================================================================
60// wxBitmap
61// ========================================================================
62class WXDLLEXPORT wxBitmap: public wxGDIObject
a24aff65 63{
d135b1a5
DE
64 DECLARE_DYNAMIC_CLASS(wxBitmap)
65// ------------------------------------------------------------------------
66// initialization
67// ------------------------------------------------------------------------
a24aff65 68public:
d135b1a5
DE
69 // Platform-specific default constructor
70 wxBitmap();
d135b1a5
DE
71 // Initialize with raw data.
72 wxBitmap(const char bits[], int width, int height, int depth = 1);
73 // Initialize with XPM data
452418c4 74 wxBitmap(const char* const* bits);
d135b1a5
DE
75 // Load a file or resource
76 wxBitmap(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
77 // Constructor for generalised creation from data
452418c4 78 wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1);
d135b1a5
DE
79 // If depth is omitted, will create a bitmap compatible with the display
80 wxBitmap(int width, int height, int depth = -1);
81 // Convert from wxImage:
82 wxBitmap(const wxImage& image, int depth = -1)
83 { CreateFromImage(image, depth); }
b5df4fc7
DE
84 // Convert from wxIcon
85 wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); }
86
d135b1a5 87 // destructor
d3c7fc99 88 virtual ~wxBitmap();
1b88201f 89
d135b1a5
DE
90// ------------------------------------------------------------------------
91// Implementation
92// ------------------------------------------------------------------------
a24aff65 93public:
d135b1a5
DE
94 // Initialize from wxImage
95 bool CreateFromImage(const wxImage& image, int depth=-1);
96
97 virtual bool Create(int width, int height, int depth = -1);
452418c4 98 virtual bool Create(const void* data, wxBitmapType type, int width, int height, int depth = 1);
d135b1a5
DE
99 virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_TYPE_BMP_RESOURCE);
100 virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const;
101
102 // copies the contents and mask of the given (colour) icon to the bitmap
103 virtual bool CopyFromIcon(const wxIcon& icon);
104
105 wxImage ConvertToImage() const;
106
107 // get the given part of bitmap
108 wxBitmap GetSubBitmap( const wxRect& rect ) const;
109
b7cacb43
VZ
110 bool Ok() const { return IsOk(); }
111 bool IsOk() const;
d135b1a5
DE
112 int GetWidth() const;
113 int GetHeight() const;
114 int GetDepth() const;
115 int GetQuality() const;
116 void SetWidth(int w);
117 void SetHeight(int h);
118 void SetDepth(int d);
119 void SetQuality(int q);
120 void SetOk(bool isOk);
121
b60c6e97
DE
122 // raw bitmap access support functions
123 void *GetRawData(wxPixelDataBase& data, int bpp);
124 void UngetRawData(wxPixelDataBase& data);
4170c465 125 void UseAlpha();
b60c6e97 126
d135b1a5
DE
127 wxPalette* GetPalette() const;
128 void SetPalette(const wxPalette& palette);
129
130 wxMask *GetMask() const;
131 void SetMask(wxMask *mask) ;
132
133 int GetBitmapType() const;
1b88201f 134
d135b1a5
DE
135 // wxObjectRefData
136 wxObjectRefData *CreateRefData() const;
137 wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
138
139 // wxCocoa
140 WX_NSBitmapImageRep GetNSBitmapImageRep();
ab13160e 141 void SetNSBitmapImageRep(WX_NSBitmapImageRep bitmapImageRep);
9c54e4ae 142 WX_NSImage GetNSImage(bool useMask) const;
d135b1a5
DE
143
144 static void InitStandardHandlers() { }
145 static void CleanUpHandlers() { }
a24aff65 146};
d135b1a5 147
452418c4
PC
148class WXDLLIMPEXP_CORE wxBitmapHandler: public wxBitmapHandlerBase
149{
150 DECLARE_ABSTRACT_CLASS(wxBitmapHandler)
151};
152
1b88201f
WS
153#endif
154 // __WX_COCOA_BITMAP_H__