]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/icon.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxIcon
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
12 In wxIcon context this value means: "use the screen depth".
14 #define wxICON_SCREEN_DEPTH (-1)
20 An icon is a small rectangular bitmap usually used for denoting a minimized
23 It differs from a wxBitmap in always having a mask associated with it for
24 transparent drawing. On some platforms, icons and bitmaps are implemented
25 identically, since there is no real distinction between a wxBitmap with a
26 mask and an icon; and there is no specific icon format on some platforms
27 (X-based applications usually standardize on XPMs for small bitmaps and icons).
28 However, some platforms (such as Windows) make the distinction, so a
29 separate class is provided.
32 It is usually desirable to associate a pertinent icon with a frame.
33 Icons can also be used for other purposes, for example with wxTreeCtrl and wxListCtrl.
34 Icons have different formats on different platforms therefore separate icons
35 will usually be created for the different environments.
36 Platform-specific methods for creating a wxIcon structure are catered for,
37 and this is an occasion where conditional compilation will probably be required.
38 Note that a new icon must be created for every time the icon is to be used
39 for a new window. In Windows, the icon will not be reloaded if it has already
41 An icon allocated to a frame will be deleted when the frame is deleted.
42 For more information please see @ref overview_bitmap.
50 @see @ref overview_bitmap, @ref overview_bitmap_supportedformats,
51 wxDC::DrawIcon, wxCursor
53 class wxIcon
: public wxBitmap
59 Constructs an icon object with no data; an assignment or another member
60 function such as LoadFile() must be called subsequently.
67 wxIcon(const wxIcon
& icon
);
70 Creates an icon from the given data, which can be of arbitrary type.
72 wxIcon(void* data, int type, int width, int height, int depth = -1);
74 NOTE: this ctor is not implemented by all ports, is somewhat useless
75 without further description of the "data" supported formats and
76 uses 'int type' instead of wxBitmapType, so don't document it.
80 Creates an icon from an array of bits.
81 You should only use this function for monochrome bitmaps (depth 1) in
82 portable programs: in this case the bits parameter should contain an XBM image.
84 For other bit depths, the behaviour is platform dependent: under Windows,
85 the data is passed without any changes to the underlying CreateBitmap() API.
86 Under other platforms, only monochrome bitmaps may be created using this
87 constructor and wxImage should be used for creating colour bitmaps from
91 Specifies an array of pixel values.
93 Specifies the width of the bitmap.
95 Specifies the height of the bitmap.
97 Specifies the depth of the bitmap.
98 If this is omitted, then a value of 1 (monochrome bitmap) is used.
100 wxIcon(const char bits
[], int width
, int height
, int depth
= 1);
104 Creates a new icon. A depth of ::wxICON_SCREEN_DEPTH indicates the
105 depth of the current screen or visual.
107 Some platforms only support 1 for monochrome and ::wxICON_SCREEN_DEPTH for
108 the current colour setting.
110 wxIcon(int width
, int height
, int depth
= wxICON_SCREEN_DEPTH
);
113 Creates a bitmap from XPM data.
114 To use this constructor, you must first include an XPM file.
115 For example, assuming that the file mybitmap.xpm contains an XPM array
116 of character pointers called @e mybitmap:
119 #include "mybitmap.xpm"
121 wxIcon *icon = new wxIcon(mybitmap);
124 A macro, wxICON, is available which creates an icon using an XPM on
125 the appropriate platform, or an icon resource on Windows.
128 wxIcon icon(wxICON(mondrian));
131 #if defined(__WXGTK__) || defined(__WXMOTIF__)
132 wxIcon icon(mondrian_xpm);
135 #if defined(__WXMSW__)
136 wxIcon icon("mondrian");
140 wxIcon(const char* const* bits
);
143 Loads an icon from a file or resource.
146 This can refer to a resource name or a filename under MS Windows and X.
147 Its meaning is determined by the @a type parameter.
149 May be one of the ::wxBitmapType values and indicates which type of
150 bitmap should be loaded. See the note in the class detailed description.
151 Note that the wxICON_DEFAULT_TYPE constant has different value under
152 different wxWidgets ports. See the icon.h header for the value it takes
155 Specifies the desired width of the icon. This parameter only has
156 an effect in Windows where icon resources can contain several icons
159 Specifies the desired height of the icon. This parameter only has
160 an effect in Windows where icon resources can contain several icons
165 wxIcon(const wxString
& name
, wxBitmapType type
= wxICON_DEFAULT_TYPE
,
166 int desiredWidth
= -1, int desiredHeight
= -1);
169 Loads an icon from the specified location.
171 wxIcon(const wxIconLocation
& loc
);
175 See @ref overview_refcount_destruct for more info.
177 If the application omits to delete the icon explicitly, the icon will be
178 destroyed automatically by wxWidgets when the application exits.
181 Do not delete an icon that is selected into a memory device context.
186 Copies @a bmp bitmap to this icon.
187 Under MS Windows the bitmap must have mask colour set.
191 void CopyFromBitmap(const wxBitmap
& bmp
);
194 Gets the colour depth of the icon.
195 A value of 1 indicates a monochrome icon.
197 int GetDepth() const;
200 Gets the height of the icon in pixels.
204 int GetHeight() const;
207 Gets the width of the icon in pixels.
211 int GetWidth() const;
214 Returns @true if icon data is present.
216 virtual bool IsOk() const;
219 Loads an icon from a file or resource.
222 Either a filename or a Windows resource name.
223 The meaning of name is determined by the @a type parameter.
225 One of the ::wxBitmapType values; see the note in the class
226 detailed description.
227 Note that the wxICON_DEFAULT_TYPE constant has different value under
228 different wxWidgets ports. See the icon.h header for the value it takes
231 Specifies the desired width of the icon. This parameter only has
232 an effect in Windows where icon resources can contain several icons
235 Specifies the desired height of the icon. This parameter only has
236 an effect in Windows where icon resources can contain several icons
239 @return @true if the operation succeeded, @false otherwise.
241 bool LoadFile(const wxString
& name
, wxBitmapType type
= wxICON_DEFAULT_TYPE
,
242 int desiredWidth
= -1, int desiredHeight
= -1);
245 Sets the depth member (does not affect the icon data).
250 void SetDepth(int depth
);
253 Sets the height member (does not affect the icon data).
256 Icon height in pixels.
258 void SetHeight(int height
);
261 Sets the width member (does not affect the icon data).
264 Icon width in pixels.
266 void SetWidth(int width
);
269 Assignment operator, using @ref overview_refcount.
274 wxIcon
& operator=(const wxIcon
& icon
);