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

NAME

6       wxBitmap - See external documentation: wxBitmap.
7

DESCRIPTION

9       See external documentation: wxBitmap.
10

DATA TYPES

12         wxBitmap():
13
14
15           An  object  reference,  The  representation  is internal and can be
16           changed without notice. It can't be used for comparsion  stored  on
17           disc or distributed for use on other nodes.
18

EXPORTS

20       new() -> wxBitmap()
21
22              See external documentation.
23
24       new(Filename) -> wxBitmap()
25
26              Types:
27
28                 Filename = unicode:chardata()
29
30              See external documentation.
31              Also:
32              new(Image) -> wxBitmap() when
33              Image::wxImage:wxImage().
34
35
36              Type    =    ?wxBITMAP_TYPE_INVALID   |   ?wxBITMAP_TYPE_BMP   |
37              ?wxBITMAP_TYPE_BMP_RESOURCE    |    ?wxBITMAP_TYPE_RESOURCE    |
38              ?wxBITMAP_TYPE_ICO      |      ?wxBITMAP_TYPE_ICO_RESOURCE     |
39              ?wxBITMAP_TYPE_CUR     |      ?wxBITMAP_TYPE_CUR_RESOURCE      |
40              ?wxBITMAP_TYPE_XBM       |       ?wxBITMAP_TYPE_XBM_DATA       |
41              ?wxBITMAP_TYPE_XPM       |       ?wxBITMAP_TYPE_XPM_DATA       |
42              ?wxBITMAP_TYPE_TIF      |      ?wxBITMAP_TYPE_TIF_RESOURCE     |
43              ?wxBITMAP_TYPE_GIF     |      ?wxBITMAP_TYPE_GIF_RESOURCE      |
44              ?wxBITMAP_TYPE_PNG      |      ?wxBITMAP_TYPE_PNG_RESOURCE     |
45              ?wxBITMAP_TYPE_JPEG     |     ?wxBITMAP_TYPE_JPEG_RESOURCE     |
46              ?wxBITMAP_TYPE_PNM      |      ?wxBITMAP_TYPE_PNM_RESOURCE     |
47              ?wxBITMAP_TYPE_PCX     |      ?wxBITMAP_TYPE_PCX_RESOURCE      |
48              ?wxBITMAP_TYPE_PICT     |     ?wxBITMAP_TYPE_PICT_RESOURCE     |
49              ?wxBITMAP_TYPE_ICON     |     ?wxBITMAP_TYPE_ICON_RESOURCE     |
50              ?wxBITMAP_TYPE_ANI  |  ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA |
51              ?wxBITMAP_TYPE_MACCURSOR |  ?wxBITMAP_TYPE_MACCURSOR_RESOURCE  |
52              ?wxBITMAP_TYPE_ANY
53
54       new(Width, Height) -> wxBitmap()
55
56              Types:
57
58                 Width = integer()
59                 Height = integer()
60
61              See external documentation.
62              Also:
63              new(Filename, [Option]) -> wxBitmap() when
64              Filename::unicode:chardata(),
65              Option :: {'type', wx:wx_enum()};
66              (Image, [Option]) -> wxBitmap() when
67              Image::wxImage:wxImage(),
68              Option :: {'depth', integer()}.
69
70
71              Type    =    ?wxBITMAP_TYPE_INVALID   |   ?wxBITMAP_TYPE_BMP   |
72              ?wxBITMAP_TYPE_BMP_RESOURCE    |    ?wxBITMAP_TYPE_RESOURCE    |
73              ?wxBITMAP_TYPE_ICO      |      ?wxBITMAP_TYPE_ICO_RESOURCE     |
74              ?wxBITMAP_TYPE_CUR     |      ?wxBITMAP_TYPE_CUR_RESOURCE      |
75              ?wxBITMAP_TYPE_XBM       |       ?wxBITMAP_TYPE_XBM_DATA       |
76              ?wxBITMAP_TYPE_XPM       |       ?wxBITMAP_TYPE_XPM_DATA       |
77              ?wxBITMAP_TYPE_TIF      |      ?wxBITMAP_TYPE_TIF_RESOURCE     |
78              ?wxBITMAP_TYPE_GIF     |      ?wxBITMAP_TYPE_GIF_RESOURCE      |
79              ?wxBITMAP_TYPE_PNG      |      ?wxBITMAP_TYPE_PNG_RESOURCE     |
80              ?wxBITMAP_TYPE_JPEG     |     ?wxBITMAP_TYPE_JPEG_RESOURCE     |
81              ?wxBITMAP_TYPE_PNM      |      ?wxBITMAP_TYPE_PNM_RESOURCE     |
82              ?wxBITMAP_TYPE_PCX     |      ?wxBITMAP_TYPE_PCX_RESOURCE      |
83              ?wxBITMAP_TYPE_PICT     |     ?wxBITMAP_TYPE_PICT_RESOURCE     |
84              ?wxBITMAP_TYPE_ICON     |     ?wxBITMAP_TYPE_ICON_RESOURCE     |
85              ?wxBITMAP_TYPE_ANI  |  ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA |
86              ?wxBITMAP_TYPE_MACCURSOR |  ?wxBITMAP_TYPE_MACCURSOR_RESOURCE  |
87              ?wxBITMAP_TYPE_ANY
88
89       new(Bits, Width, Height) -> wxBitmap()
90
91              Types:
92
93                 Bits = binary()
94                 Width = integer()
95                 Height = integer()
96
97              See external documentation.
98              Also:
99              new(Width, Height, [Option]) -> wxBitmap() when
100              Width::integer(), Height::integer(),
101              Option :: {'depth', integer()}.
102
103
104       new(Bits, Width, Height, Options::[Option]) -> wxBitmap()
105
106              Types:
107
108                 Bits = binary()
109                 Width = integer()
110                 Height = integer()
111                 Option = {depth, integer()}
112
113              See external documentation.
114
115       convertToImage(This) -> wxImage:wxImage()
116
117              Types:
118
119                 This = wxBitmap()
120
121              See external documentation.
122
123       copyFromIcon(This, Icon) -> boolean()
124
125              Types:
126
127                 This = wxBitmap()
128                 Icon = wxIcon:wxIcon()
129
130              See external documentation.
131
132       create(This, Width, Height) -> boolean()
133
134              Types:
135
136                 This = wxBitmap()
137                 Width = integer()
138                 Height = integer()
139
140              Equivalent to create(This, Width, Height, []).
141
142       create(This, Width, Height, Options::[Option]) -> boolean()
143
144              Types:
145
146                 This = wxBitmap()
147                 Width = integer()
148                 Height = integer()
149                 Option = {depth, integer()}
150
151              See external documentation.
152
153       getDepth(This) -> integer()
154
155              Types:
156
157                 This = wxBitmap()
158
159              See external documentation.
160
161       getHeight(This) -> integer()
162
163              Types:
164
165                 This = wxBitmap()
166
167              See external documentation.
168
169       getPalette(This) -> wxPalette:wxPalette()
170
171              Types:
172
173                 This = wxBitmap()
174
175              See external documentation.
176
177       getMask(This) -> wxMask:wxMask()
178
179              Types:
180
181                 This = wxBitmap()
182
183              See external documentation.
184
185       getWidth(This) -> integer()
186
187              Types:
188
189                 This = wxBitmap()
190
191              See external documentation.
192
193       getSubBitmap(This, Rect) -> wxBitmap()
194
195              Types:
196
197                 This = wxBitmap()
198                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
199                 ger()}
200
201              See external documentation.
202
203       loadFile(This, Name) -> boolean()
204
205              Types:
206
207                 This = wxBitmap()
208                 Name = unicode:chardata()
209
210              Equivalent to loadFile(This, Name, []).
211
212       loadFile(This, Name, Options::[Option]) -> boolean()
213
214              Types:
215
216                 This = wxBitmap()
217                 Name = unicode:chardata()
218                 Option = {type, wx:wx_enum()}
219
220              See external documentation.
221              Type   =   ?wxBITMAP_TYPE_INVALID   |    ?wxBITMAP_TYPE_BMP    |
222              ?wxBITMAP_TYPE_BMP_RESOURCE    |    ?wxBITMAP_TYPE_RESOURCE    |
223              ?wxBITMAP_TYPE_ICO     |      ?wxBITMAP_TYPE_ICO_RESOURCE      |
224              ?wxBITMAP_TYPE_CUR      |      ?wxBITMAP_TYPE_CUR_RESOURCE     |
225              ?wxBITMAP_TYPE_XBM       |       ?wxBITMAP_TYPE_XBM_DATA       |
226              ?wxBITMAP_TYPE_XPM       |       ?wxBITMAP_TYPE_XPM_DATA       |
227              ?wxBITMAP_TYPE_TIF     |      ?wxBITMAP_TYPE_TIF_RESOURCE      |
228              ?wxBITMAP_TYPE_GIF      |      ?wxBITMAP_TYPE_GIF_RESOURCE     |
229              ?wxBITMAP_TYPE_PNG     |      ?wxBITMAP_TYPE_PNG_RESOURCE      |
230              ?wxBITMAP_TYPE_JPEG     |     ?wxBITMAP_TYPE_JPEG_RESOURCE     |
231              ?wxBITMAP_TYPE_PNM     |      ?wxBITMAP_TYPE_PNM_RESOURCE      |
232              ?wxBITMAP_TYPE_PCX      |      ?wxBITMAP_TYPE_PCX_RESOURCE     |
233              ?wxBITMAP_TYPE_PICT     |     ?wxBITMAP_TYPE_PICT_RESOURCE     |
234              ?wxBITMAP_TYPE_ICON     |     ?wxBITMAP_TYPE_ICON_RESOURCE     |
235              ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF |  ?wxBITMAP_TYPE_TGA  |
236              ?wxBITMAP_TYPE_MACCURSOR  |  ?wxBITMAP_TYPE_MACCURSOR_RESOURCE |
237              ?wxBITMAP_TYPE_ANY
238
239       ok(This) -> boolean()
240
241              Types:
242
243                 This = wxBitmap()
244
245              See external documentation.
246
247       saveFile(This, Name, Type) -> boolean()
248
249              Types:
250
251                 This = wxBitmap()
252                 Name = unicode:chardata()
253                 Type = wx:wx_enum()
254
255              Equivalent to saveFile(This, Name, Type, []).
256
257       saveFile(This, Name, Type, Options::[Option]) -> boolean()
258
259              Types:
260
261                 This = wxBitmap()
262                 Name = unicode:chardata()
263                 Type = wx:wx_enum()
264                 Option = {palette, wxPalette:wxPalette()}
265
266              See external documentation.
267              Type   =   ?wxBITMAP_TYPE_INVALID   |    ?wxBITMAP_TYPE_BMP    |
268              ?wxBITMAP_TYPE_BMP_RESOURCE    |    ?wxBITMAP_TYPE_RESOURCE    |
269              ?wxBITMAP_TYPE_ICO     |      ?wxBITMAP_TYPE_ICO_RESOURCE      |
270              ?wxBITMAP_TYPE_CUR      |      ?wxBITMAP_TYPE_CUR_RESOURCE     |
271              ?wxBITMAP_TYPE_XBM       |       ?wxBITMAP_TYPE_XBM_DATA       |
272              ?wxBITMAP_TYPE_XPM       |       ?wxBITMAP_TYPE_XPM_DATA       |
273              ?wxBITMAP_TYPE_TIF     |      ?wxBITMAP_TYPE_TIF_RESOURCE      |
274              ?wxBITMAP_TYPE_GIF      |      ?wxBITMAP_TYPE_GIF_RESOURCE     |
275              ?wxBITMAP_TYPE_PNG     |      ?wxBITMAP_TYPE_PNG_RESOURCE      |
276              ?wxBITMAP_TYPE_JPEG     |     ?wxBITMAP_TYPE_JPEG_RESOURCE     |
277              ?wxBITMAP_TYPE_PNM     |      ?wxBITMAP_TYPE_PNM_RESOURCE      |
278              ?wxBITMAP_TYPE_PCX      |      ?wxBITMAP_TYPE_PCX_RESOURCE     |
279              ?wxBITMAP_TYPE_PICT     |     ?wxBITMAP_TYPE_PICT_RESOURCE     |
280              ?wxBITMAP_TYPE_ICON     |     ?wxBITMAP_TYPE_ICON_RESOURCE     |
281              ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF |  ?wxBITMAP_TYPE_TGA  |
282              ?wxBITMAP_TYPE_MACCURSOR  |  ?wxBITMAP_TYPE_MACCURSOR_RESOURCE |
283              ?wxBITMAP_TYPE_ANY
284
285       setDepth(This, Depth) -> ok
286
287              Types:
288
289                 This = wxBitmap()
290                 Depth = integer()
291
292              See external documentation.
293
294       setHeight(This, Height) -> ok
295
296              Types:
297
298                 This = wxBitmap()
299                 Height = integer()
300
301              See external documentation.
302
303       setMask(This, Mask) -> ok
304
305              Types:
306
307                 This = wxBitmap()
308                 Mask = wxMask:wxMask()
309
310              See external documentation.
311
312       setPalette(This, Palette) -> ok
313
314              Types:
315
316                 This = wxBitmap()
317                 Palette = wxPalette:wxPalette()
318
319              See external documentation.
320
321       setWidth(This, Width) -> ok
322
323              Types:
324
325                 This = wxBitmap()
326                 Width = integer()
327
328              See external documentation.
329
330       destroy(This::wxBitmap()) -> ok
331
332              Destroys this object, do not use object again
333

AUTHORS

335       <>
336
337
338
339                                   wx 1.8.3                        wxBitmap(3)