summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxIcon.xml
diff options
context:
space:
mode:
authorDan Gudmundsson <dgud@erlang.org>2021-04-23 11:28:20 +0200
committerDan Gudmundsson <dgud@erlang.org>2021-04-28 11:05:45 +0200
commite70c107cabfbe1b3b673cadf62b28a3fe47ba646 (patch)
tree9acde2a437bfc891041374406136a0458c6c8ff8 /lib/wx/doc/src/wxIcon.xml
parent55782925fd8dc7bec4dea654cb1a02a9554b1dff (diff)
downloaderlang-e70c107cabfbe1b3b673cadf62b28a3fe47ba646.tar.gz
Improve doc generation
Diffstat (limited to 'lib/wx/doc/src/wxIcon.xml')
-rw-r--r--lib/wx/doc/src/wxIcon.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/wx/doc/src/wxIcon.xml b/lib/wx/doc/src/wxIcon.xml
index a36c7e9e31..2c005dedd3 100644
--- a/lib/wx/doc/src/wxIcon.xml
+++ b/lib/wx/doc/src/wxIcon.xml
@@ -30,7 +30,7 @@
<description><p>An icon is a small rectangular bitmap usually used for denoting a minimized application.
</p><p>It differs from a <seeerl marker="wxBitmap"><c>wxBitmap</c></seeerl> in always having a mask associated with it for transparent drawing. On some platforms, icons and bitmaps are implemented identically, since there is no real distinction between a <seeerl marker="wxBitmap"><c>wxBitmap</c></seeerl> with a mask and an icon; and there is no specific icon format on some platforms (X-based applications usually standardize on XPMs for small bitmaps and icons). However, some platforms (such as Windows) make the distinction, so a separate class is provided.
</p><p>Remark: It is usually desirable to associate a pertinent icon with a frame. Icons can also be used for other purposes, for example with <seeerl marker="wxTreeCtrl"><c>wxTreeCtrl</c></seeerl> and <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl>. Icons have different formats on different platforms therefore separate icons will usually be created for the different environments. Platform-specific methods for creating a <seeerl marker="wxIcon"><c>wxIcon</c></seeerl> structure are catered for, and this is an occasion where conditional compilation will probably be required. Note that a new icon must be created for every time the icon is to be used for a new window. In Windows, the icon will not be reloaded if it has already been used. An icon allocated to a frame will be deleted when the frame is deleted. For more information please see overview_bitmap.
- </p><p>Predefined objects/pointers: ?wxNullIcon
+ </p><p>Predefined objects (include wx.hrl): ?wxNullIcon
</p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_bitmap.html#overview_bitmap">Overview bitmap</url>, <url href="https://docs.wxwidgets.org/3.1/overview_bitmap.html#overview_bitmap_supportedformats">Overview bitmap</url>, <seeerl marker="wxIconBundle"><c>wxIconBundle</c></seeerl>, <seemfa marker="wxDC#drawIcon/3"><c>wxDC:drawIcon/3</c></seemfa>, <seeerl marker="wxCursor"><c>wxCursor</c></seeerl>
</p>
<p>This class is derived (and can use functions) from: