Module wxBitmap

See external documentation: wxBitmap.

Description

See external documentation: wxBitmap.

Data Types

wxBitmap()

abstract datatype: 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.

Function Index

convertToImage/1*See external documentation.
copyFromIcon/2*See external documentation.
create/3*Equivalent to create(This, Width, Height, []).
create/4*See external documentation.
destroy/1*Destroys this object, do not use object again.
getDepth/1*See external documentation.
getHeight/1*See external documentation.
getMask/1*See external documentation.
getPalette/1*See external documentation.
getSubBitmap/2*See external documentation.
getWidth/1*See external documentation.
loadFile/2*Equivalent to loadFile(This, Name, []).
loadFile/3*See external documentation.
new/0*See external documentation.
new/1*See external documentation.
new/2*See external documentation.
new/3*See external documentation.
new/4*See external documentation.
ok/1*See external documentation.
saveFile/3*Equivalent to saveFile(This, Name, Type, []).
saveFile/4*See external documentation.
setDepth/2*See external documentation.
setHeight/2*See external documentation.
setMask/2*See external documentation.
setPalette/2*See external documentation.
setWidth/2*See external documentation.

Function Details

convertToImage/1 *

convertToImage(This::wxBitmap()) -> wxImage:wxImage()

See external documentation.

copyFromIcon/2 *

copyFromIcon(This::wxBitmap(), Icon::wxIcon:wxIcon()) -> bool()

See external documentation.

create/3 *

create(This::wxBitmap(), Width::integer(), Height::integer()) -> bool()

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

create/4 *

create(This::wxBitmap(), Width::integer(), Height::integer(), Options::[Option]) -> bool()

See external documentation.

destroy/1 *

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

Destroys this object, do not use object again

getDepth/1 *

getDepth(This::wxBitmap()) -> integer()

See external documentation.

getHeight/1 *

getHeight(This::wxBitmap()) -> integer()

See external documentation.

getMask/1 *

getMask(This::wxBitmap()) -> wxMask:wxMask()

See external documentation.

getPalette/1 *

getPalette(This::wxBitmap()) -> wxPalette:wxPalette()

See external documentation.

getSubBitmap/2 *

getSubBitmap(This::wxBitmap(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> wxBitmap()

See external documentation.

getWidth/1 *

getWidth(This::wxBitmap()) -> integer()

See external documentation.

loadFile/2 *

loadFile(This::wxBitmap(), Name::string()) -> bool()

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

loadFile/3 *

loadFile(This::wxBitmap(), Name::string(), Options::[Option]) -> bool()

See external documentation.
WxBitmapType is one of ?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/0 *

new() -> wxBitmap()

See external documentation.

new/1 *

new(X::string() | term()) -> wxBitmap()

See external documentation.
Alternatives:

  • new(Filename::string()) -> new(Filename, [])
  • new(Image::wxImage:wxImage()) -> new(Image, [])
  • new/2 *

    new(X::integer() | string() | term(), X::integer() | term()) -> wxBitmap()

    See external documentation.
    Alternatives:

  • new(Width::integer(), Height::integer()) -> new(Width,Height, [])
  • new(Filename::string(), [Option]) -> wxBitmap()
    Option = {type, WxBitmapType}
    WxBitmapType = integer()
    WxBitmapType is one of ?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(Image::wxImage:wxImage(), [Option]) -> wxBitmap()
    Option = {depth, integer()}
  • new/3 *

    new(X::[binary()] | integer(), X::integer(), X::integer() | term()) -> wxBitmap()

    See external documentation.
    Alternatives:

  • new(Bits::[binary()], Width::integer(), Height::integer()) -> new(Bits,Width,Height, [])
  • new(Width::integer(), Height::integer(), [Option]) -> wxBitmap()
    Option = {depth, integer()}
  • new/4 *

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

    See external documentation.

    ok/1 *

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

    See external documentation.

    saveFile/3 *

    saveFile(This::wxBitmap(), Name::string(), Type::WxBitmapType) -> bool()

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

    saveFile/4 *

    saveFile(This::wxBitmap(), Name::string(), Type::WxBitmapType, Options::[Option]) -> bool()

    See external documentation.
    WxBitmapType is one of ?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/2 *

    setDepth(This::wxBitmap(), Depth::integer()) -> ok

    See external documentation.

    setHeight/2 *

    setHeight(This::wxBitmap(), Height::integer()) -> ok

    See external documentation.

    setMask/2 *

    setMask(This::wxBitmap(), Mask::wxMask:wxMask()) -> ok

    See external documentation.

    setPalette/2 *

    setPalette(This::wxBitmap(), Palette::wxPalette:wxPalette()) -> ok

    See external documentation.

    setWidth/2 *

    setWidth(This::wxBitmap(), Width::integer()) -> ok

    See external documentation.


    Generated by EDoc, May 26 2008, 12:35:33.