]> git.saurik.com Git - wxWidgets.git/blame - include/wx/gtk/bitmap.h
Added GetPureVitualSize() returning just m_virtualSize.
[wxWidgets.git] / include / wx / gtk / bitmap.h
CommitLineData
c801d85f
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: bitmap.h
3// Purpose:
4// Author: Robert Roebling
6f65e337 5// RCS-ID: $Id$
01111366 6// Copyright: (c) 1998 Robert Roebling
65571936 7// Licence: wxWindows licence
c801d85f
KB
8/////////////////////////////////////////////////////////////////////////////
9
10
11#ifndef __GTKBITMAPH__
12#define __GTKBITMAPH__
13
12028905 14#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
c801d85f
KB
15#pragma interface
16#endif
17
18#include "wx/defs.h"
19#include "wx/object.h"
20#include "wx/string.h"
21#include "wx/palette.h"
58c837a4 22#include "wx/gdiobj.h"
c801d85f 23
feac7937
VS
24#ifdef __WXGTK20__
25typedef struct _GdkPixbuf GdkPixbuf;
26#endif
27
c801d85f
KB
28//-----------------------------------------------------------------------------
29// classes
30//-----------------------------------------------------------------------------
31
c801d85f
KB
32class wxMask;
33class wxBitmap;
fd859211 34class wxImage;
c801d85f
KB
35
36//-----------------------------------------------------------------------------
37// wxMask
38//-----------------------------------------------------------------------------
39
40class wxMask: public wxObject
41{
fd0eed64 42public:
8636aed8
RR
43 wxMask();
44 wxMask( const wxBitmap& bitmap, const wxColour& colour );
45 wxMask( const wxBitmap& bitmap, int paletteIndex );
46 wxMask( const wxBitmap& bitmap );
47 ~wxMask();
91b8de8d 48
8636aed8
RR
49 bool Create( const wxBitmap& bitmap, const wxColour& colour );
50 bool Create( const wxBitmap& bitmap, int paletteIndex );
51 bool Create( const wxBitmap& bitmap );
52
53 // implementation
54 GdkBitmap *m_bitmap;
55
56 GdkBitmap *GetBitmap() const;
57
58private:
59 DECLARE_DYNAMIC_CLASS(wxMask)
c801d85f
KB
60};
61
62//-----------------------------------------------------------------------------
63// wxBitmap
64//-----------------------------------------------------------------------------
65
4611dd06 66class wxBitmap: public wxBitmapBase
c801d85f 67{
fd0eed64 68public:
8636aed8
RR
69 wxBitmap();
70 wxBitmap( int width, int height, int depth = -1 );
71 wxBitmap( const char bits[], int width, int height, int depth = 1 );
e838cc14
VZ
72 wxBitmap( const char **bits ) { (void)CreateFromXpm(bits); }
73 wxBitmap( char **bits ) { (void)CreateFromXpm((const char **)bits); }
8636aed8 74 wxBitmap( const wxBitmap& bmp );
4611dd06 75 wxBitmap( const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM );
fd859211 76 wxBitmap( const wxImage& image, int depth = -1 ) { (void)CreateFromImage(image, depth); }
8636aed8
RR
77 ~wxBitmap();
78 wxBitmap& operator = ( const wxBitmap& bmp );
f6bcfd97
BP
79 bool operator == ( const wxBitmap& bmp ) const;
80 bool operator != ( const wxBitmap& bmp ) const;
8636aed8
RR
81 bool Ok() const;
82
c826213d
RR
83 bool Create(int width, int height, int depth = -1);
84
8636aed8
RR
85 int GetHeight() const;
86 int GetWidth() const;
87 int GetDepth() const;
fd859211
VS
88
89 wxImage ConvertToImage() const;
8636aed8 90
db0aec83
VS
91 // copies the contents and mask of the given (colour) icon to the bitmap
92 virtual bool CopyFromIcon(const wxIcon& icon);
93
8636aed8
RR
94 wxMask *GetMask() const;
95 void SetMask( wxMask *mask );
17bec151
RR
96
97 wxBitmap GetSubBitmap( const wxRect& rect ) const;
8636aed8 98
4611dd06
RR
99 bool SaveFile(const wxString &name, wxBitmapType type,
100 const wxPalette *palette = (wxPalette *)NULL) const;
101 bool LoadFile(const wxString &name, wxBitmapType type = wxBITMAP_TYPE_XPM );
8636aed8 102
4611dd06 103#if wxUSE_PALETTE
8636aed8 104 wxPalette *GetPalette() const;
4611dd06 105 void SetPalette(const wxPalette& palette);
55e90a2e 106 wxPalette *GetColourMap() const { return GetPalette(); };
4611dd06 107#endif // wxUSE_PALETTE
55e90a2e 108
4b61c88d 109 static void InitStandardHandlers();
8bbe427f 110
8636aed8 111 // implementation
20e05ffb 112 // --------------
c801d85f 113
8636aed8
RR
114 void SetHeight( int height );
115 void SetWidth( int width );
116 void SetDepth( int depth );
117 void SetPixmap( GdkPixmap *pixmap );
82ea63e6 118 void SetBitmap( GdkBitmap *bitmap );
feac7937
VS
119#ifdef __WXGTK20__
120 void SetPixbuf(GdkPixbuf *pixbuf);
121#endif
8bbe427f 122
8636aed8
RR
123 GdkPixmap *GetPixmap() const;
124 GdkBitmap *GetBitmap() const;
feac7937
VS
125 bool HasPixmap() const;
126#ifdef __WXGTK20__
127 bool HasPixbuf() const;
128 GdkPixbuf *GetPixbuf() const;
129#endif
8636aed8 130
783da845
RR
131 // Basically, this corresponds to Win32 StretchBlt()
132 wxBitmap Rescale( int clipx, int clipy, int clipwidth, int clipheight, int width, int height );
e838cc14
VZ
133protected:
134 bool CreateFromXpm(const char **bits);
fd859211 135 bool CreateFromImage(const wxImage& image, int depth);
e838cc14 136
8636aed8 137private:
feac7937
VS
138 // to be called from CreateFromImage only!
139 bool CreateFromImageAsBitmap(const wxImage& image);
140 bool CreateFromImageAsPixmap(const wxImage& image);
141
142#ifdef __WXGTK20__
143 bool CreateFromImageAsPixbuf(const wxImage& image);
144
145 enum Representation
146 {
147 Pixmap,
148 Pixbuf
149 };
150 // removes other representations from memory, keeping only 'keep'
151 // (wxBitmap may keep same bitmap e.g. as both pixmap and pixbuf):
152 void PurgeOtherRepresentations(Representation keep);
153
154 friend class wxMemoryDC;
155#endif
4b61c88d
RR
156 friend class wxBitmapHandler;
157
158private:
8636aed8 159 DECLARE_DYNAMIC_CLASS(wxBitmap)
c801d85f
KB
160};
161
4b61c88d
RR
162//-----------------------------------------------------------------------------
163// wxBitmapHandler
164//-----------------------------------------------------------------------------
165
166class wxBitmapHandler: public wxBitmapHandlerBase
167{
168public:
169 wxBitmapHandler() { }
170 virtual ~wxBitmapHandler();
171
172 virtual bool Create(wxBitmap *bitmap, void *data, long flags, int width, int height, int depth = 1);
173 virtual bool LoadFile(wxBitmap *bitmap, const wxString& name, long flags,
174 int desiredWidth, int desiredHeight);
175 virtual bool SaveFile(const wxBitmap *bitmap, const wxString& name, int type, const wxPalette *palette = NULL);
176
177private:
178 DECLARE_DYNAMIC_CLASS(wxBitmapHandler)
179};
180
181
c801d85f 182#endif // __GTKBITMAPH__