1wxIconBundle(3)            Erlang Module Definition            wxIconBundle(3)
2
3
4

NAME

6       wxIconBundle - Functions for wxIconBundle class
7

DESCRIPTION

9       This  class  contains multiple copies of an icon in different sizes. It
10       is typically used in wxDialog::SetIcons (not implemented in wx) and wx‐
11       TopLevelWindow:setIcons/2.
12
13       Predefined objects (include wx.hrl): ?wxNullIconBundle
14
15       wxWidgets docs: wxIconBundle
16

DATA TYPES

18       wxIconBundle() = wx:wx_object()
19

EXPORTS

21       new() -> wxIconBundle()
22
23              Default ctor.
24
25       new(Ic) -> wxIconBundle()
26
27       new(File) -> wxIconBundle()
28
29              Types:
30
31                 File = unicode:chardata()
32
33              Initializes the bundle with the icon(s) found in the file.
34
35       new(File, Type) -> wxIconBundle()
36
37              Types:
38
39                 File = unicode:chardata()
40                 Type = wx:wx_enum()
41
42       destroy(This :: wxIconBundle()) -> ok
43
44              Destructor.
45
46       addIcon(This, File) -> ok
47
48       addIcon(This, Icon) -> ok
49
50              Types:
51
52                 This = wxIconBundle()
53                 Icon = wxIcon:wxIcon()
54
55              Adds  the icon to the collection; if the collection already con‐
56              tains an icon with the same width and height, it is replaced  by
57              the new one.
58
59       addIcon(This, File, Type) -> ok
60
61              Types:
62
63                 This = wxIconBundle()
64                 File = unicode:chardata()
65                 Type = wx:wx_enum()
66
67       getIcon(This) -> wxIcon:wxIcon()
68
69              Types:
70
71                 This = wxIconBundle()
72
73       getIcon(This, Size) -> wxIcon:wxIcon()
74
75       getIcon(This, Size :: [Option]) -> wxIcon:wxIcon()
76
77              Types:
78
79                 This = wxIconBundle()
80                 Option = {size, integer()} | {flags, integer()}
81
82              Same as.
83
84              .
85
86       getIcon(This, Size, Options :: [Option]) -> wxIcon:wxIcon()
87
88              Types:
89
90                 This = wxIconBundle()
91                 Size = {W :: integer(), H :: integer()}
92                 Option = {flags, integer()}
93
94              Returns the icon with the given size.
95
96              If  size  is  ?wxDefaultSize,  it is interpreted as the standard
97              system  icon  size,  i.e.  the  size  returned  by  wxSystemSet‐
98              tings:getMetric/2 for wxSYS_ICON_X and wxSYS_ICON_Y.
99
100              If  the bundle contains an icon with exactly the requested size,
101              it's always returned. Otherwise, the behaviour  depends  on  the
102              flags.  If  only wxIconBundle::FALLBACK_NONE (not implemented in
103              wx) is given, the function returns an invalid icon.  If  wxIcon‐
104              Bundle::FALLBACK_SYSTEM  (not  implemented  in  wx) is given, it
105              tries to find the icon of standard system  size,  regardless  of
106              the  size  passed as parameter. Otherwise, or if the icon system
107              size is  not  found  neither,  but  wxIconBundle::FALLBACK_NEAR‐
108              EST_LARGER  (not implemented in wx) flag is specified, the func‐
109              tion returns the smallest icon of the size larger than  the  re‐
110              quested  one or, if this fails too, just the icon closest to the
111              specified size.
112
113              The flags parameter is available only since wxWidgets 2.9.4.
114
115
116
117wxWidgets team.                    wx 2.2.1                    wxIconBundle(3)