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

AUTHORS

347       <>
348
349
350
351                                  wx 1.9.3.1                       wxBitmap(3)