latex/wx/icon.tex

3 An icon is a small rectangular bitmap usually used for denoting a
7 a wxBitmap with a mask and an icon; and there is no specific icon format on
20 <wx/icon.h>
30 It is usually desirable to associate a pertinent icon with a frame. Icons
40 Note that a new icon must be created for every time the icon is to be
41 used for a new window. In Windows, the icon will not be
42 reloaded if it has already been used. An icon allocated to a frame will
45 For more information please see \helpref{Bitmap and icon overview}{wxbitmapoverview}.
49 \helpref{Bitmap and icon overview}{wxbitmapoverview}, \helpref{supported bitmap file formats}{supportedbitmapformats},
60 \func{}{wxIcon}{\param{const wxIcon\& }{icon}}
66 Creates an icon from the given data, which can be of arbitrary type.
71 Creates an icon from an array of bits.
75 Creates a new icon.
81 Creates an icon from XPM data.
86 Loads an icon from a file or resource.
90 Loads an icon from the specified \helpref{location}{wxiconlocation}.
96 \docparam{width}{Specifies the width of the icon.}
98 \docparam{height}{Specifies the height of the icon.}
100 \docparam{desiredWidth}{Specifies the desired width of the icon. This
101 parameter only has an effect in Windows (32-bit) where icon resources can contain
104 \docparam{desiredWidth}{Specifies the desired height of the icon. This
105 parameter only has an effect in Windows (32-bit) where icon resources can contain
108 \docparam{depth}{Specifies the depth of the icon. If this is omitted, the display depth of the
114 \docparam{loc}{The object describing the location of the native icon, see
121 \twocolitem{\indexit{wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file.}
122 \twocolitem{\indexit{wxBITMAP\_TYPE\_ICO\_RESOURCE}}{Load a Windows icon from the resource database.}
136 The first form constructs an icon object with no data; an assignment or another member function such as Create
140 icon data, but instead a pointer to the data, keeping a reference count. They are therefore
143 The fourth form constructs an icon from data whose type and value depends on
146 The fifth form constructs a (usually monochrome) icon from an array of pixel values, under both
149 The sixth form constructs a new icon.
151 The seventh form constructs an icon from pixmap (XPM) data, if wxWidgets has been configured
163 wxIcon *icon = new wxIcon(mybitmap);
166 A macro, wxICON, is available which creates an icon using an XPM
167 on the appropriate platform, or an icon resource on Windows.
170 wxIcon icon(wxICON(mondrian));
175 wxIcon icon(mondrian_xpm);
179 wxIcon icon("mondrian");
183 The eighth form constructs an icon from a file or resource. {\it name} can refer
196 Copies {\it bmp} bitmap to this icon. Under MS Windows the bitmap
218 If the application omits to delete the icon explicitly, the icon will be
221 Do not delete an icon that is selected into a memory device context.
227 Gets the colour depth of the icon. A value of 1 indicates a
228 monochrome icon.
234 Gets the height of the icon in pixels.
240 Gets the width of the icon in pixels.
250 Loads an icon from a file or resource.
261 \twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file.}
262 \twocolitem{{\bf wxBITMAP\_TYPE\_ICO\_RESOURCE}}{Load a Windows icon from the resource database.}
282 Returns true if icon data is present.
289 Saves an icon in the named file.
299 \twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Save a Windows icon file.}
300 %\twocolitem{{\bf wxBITMAP\_TYPE\_GIF}}{Save a GIF icon file.}
307 \docparam{palette}{An optional palette used for saving the icon.}
326 Sets the depth member (does not affect the icon data).
336 Sets the height member (does not affect the icon data).
346 Sets the width member (does not affect the icon data).
354 \func{wxIcon\& }{operator $=$}{\param{const wxIcon\& }{icon}}
360 \docparam{icon}{Icon to assign.}