Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.8


Expand All
Contract All

Table of Contents

wxBitmap

MODULE

wxBitmap

MODULE SUMMARY

See external documentation: wxBitmap.

DESCRIPTION

See external documentation: wxBitmap.

DATA TYPES

wxBitmap()

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

new() -> wxBitmap()

See external documentation.

new(Filename) -> wxBitmap()

Types:

Filename = unicode:chardata()

See external documentation.
Also:
new(Image) -> wxBitmap() when
Image::wxImage:wxImage().


Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY

new(Width, Height) -> wxBitmap()

Types:

Width = integer()
Height = integer()

See external documentation.
Also:
new(Filename, [Option]) -> wxBitmap() when
Filename::unicode:chardata(),
Option :: {'type', wx:wx_enum()};
(Image, [Option]) -> wxBitmap() when
Image::wxImage:wxImage(),
Option :: {'depth', integer()}.


Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY

new(Bits, Width, Height) -> wxBitmap()

Types:

Bits = binary()
Width = integer()
Height = integer()

See external documentation.
Also:
new(Width, Height, [Option]) -> wxBitmap() when
Width::integer(), Height::integer(),
Option :: {'depth', integer()}.

new(Bits, Width, Height, Options::[Option]) -> wxBitmap()

Types:

Bits = binary()
Width = integer()
Height = integer()
Option = {depth, integer()}

See external documentation.

convertToImage(This) -> wxImage:wxImage()

Types:

This = wxBitmap()

See external documentation.

copyFromIcon(This, Icon) -> boolean()

Types:

This = wxBitmap()
Icon = wxIcon:wxIcon()

See external documentation.

create(This, Width, Height) -> boolean()

Types:

This = wxBitmap()
Width = integer()
Height = integer()

Equivalent to create(This, Width, Height, []).

create(This, Width, Height, Options::[Option]) -> boolean()

Types:

This = wxBitmap()
Width = integer()
Height = integer()
Option = {depth, integer()}

See external documentation.

getDepth(This) -> integer()

Types:

This = wxBitmap()

See external documentation.

getHeight(This) -> integer()

Types:

This = wxBitmap()

See external documentation.

getPalette(This) -> wxPalette:wxPalette()

Types:

This = wxBitmap()

See external documentation.

getMask(This) -> wxMask:wxMask()

Types:

This = wxBitmap()

See external documentation.

getWidth(This) -> integer()

Types:

This = wxBitmap()

See external documentation.

getSubBitmap(This, Rect) -> wxBitmap()

Types:

This = wxBitmap()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}

See external documentation.

loadFile(This, Name) -> boolean()

Types:

This = wxBitmap()
Name = unicode:chardata()

Equivalent to loadFile(This, Name, []).

loadFile(This, Name, Options::[Option]) -> boolean()

Types:

This = wxBitmap()
Name = unicode:chardata()
Option = {type, wx:wx_enum()}

See external documentation.
Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY

ok(This) -> boolean()

Types:

This = wxBitmap()

See external documentation.

saveFile(This, Name, Type) -> boolean()

Types:

This = wxBitmap()
Name = unicode:chardata()
Type = wx:wx_enum()

Equivalent to saveFile(This, Name, Type, []).

saveFile(This, Name, Type, Options::[Option]) -> boolean()

Types:

This = wxBitmap()
Name = unicode:chardata()
Type = wx:wx_enum()
Option = {palette, wxPalette:wxPalette()}

See external documentation.
Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY

setDepth(This, Depth) -> ok

Types:

This = wxBitmap()
Depth = integer()

See external documentation.

setHeight(This, Height) -> ok

Types:

This = wxBitmap()
Height = integer()

See external documentation.

setMask(This, Mask) -> ok

Types:

This = wxBitmap()
Mask = wxMask:wxMask()

See external documentation.

setPalette(This, Palette) -> ok

Types:

This = wxBitmap()
Palette = wxPalette:wxPalette()

See external documentation.

setWidth(This, Width) -> ok

Types:

This = wxBitmap()
Width = integer()

See external documentation.

destroy(This::wxBitmap()) -> ok

Destroys this object, do not use object again

Copyright © 2009-2017 Ericsson AB. All Rights Reserved.