wxIconBundle - Functions for wxIconBundle class
Please see following description for synopsis
wxIconBundle(3) Erlang Module Definition wxIconBundle(3)
NAME
wxIconBundle - Functions for wxIconBundle class
DESCRIPTION
This class contains multiple copies of an icon in different sizes. It
is typically used in wxDialog::SetIcons (not implemented in wx) and
wxTopLevelWindow:setIcons/2.
Predefined objects (include wx.hrl): ?wxNullIconBundle
wxWidgets docs: wxIconBundle
DATA TYPES
wxIconBundle() = wx:wx_object()
EXPORTS
new() -> wxIconBundle()
Default ctor.
new(Ic) -> wxIconBundle()
new(File) -> wxIconBundle()
Types:
File = unicode:chardata()
Initializes the bundle with the icon(s) found in the file.
new(File, Type) -> wxIconBundle()
Types:
File = unicode:chardata()
Type = wx:wx_enum()
destroy(This :: wxIconBundle()) -> ok
Destructor.
addIcon(This, File) -> ok
addIcon(This, Icon) -> ok
Types:
This = wxIconBundle()
Icon = wxIcon:wxIcon()
Adds the icon to the collection; if the collection already con-
tains an icon with the same width and height, it is replaced by
the new one.
addIcon(This, File, Type) -> ok
Types:
This = wxIconBundle()
File = unicode:chardata()
Type = wx:wx_enum()
getIcon(This) -> wxIcon:wxIcon()
Types:
This = wxIconBundle()
getIcon(This, Size) -> wxIcon:wxIcon()
getIcon(This, Size :: [Option]) -> wxIcon:wxIcon()
Types:
This = wxIconBundle()
Option = {size, integer()} | {flags, integer()}
Same as.
.
getIcon(This, Size, Options :: [Option]) -> wxIcon:wxIcon()
Types:
This = wxIconBundle()
Size = {W :: integer(), H :: integer()}
Option = {flags, integer()}
Returns the icon with the given size.
If size is ?wxDefaultSize, it is interpreted as the standard
system icon size, i.e. the size returned by wxSystemSet-
tings:getMetric/2 for wxSYS_ICON_X and wxSYS_ICON_Y.
If the bundle contains an icon with exactly the requested size,
it's always returned. Otherwise, the behaviour depends on the
flags. If only wxIconBundle::FALLBACK_NONE (not implemented in
wx) is given, the function returns an invalid icon. If wxIcon-
Bundle::FALLBACK_SYSTEM (not implemented in wx) is given, it
tries to find the icon of standard system size, regardless of
the size passed as parameter. Otherwise, or if the icon system
size is not found neither, but wxIconBundle::FALLBACK_NEAR-
EST_LARGER (not implemented in wx) flag is specified, the func-
tion returns the smallest icon of the size larger than the
requested one or, if this fails too, just the icon closest to
the specified size.
The flags parameter is available only since wxWidgets 2.9.4.
wxWidgets team. wx 2.1.1 wxIconBundle(3)