From a181c06152a3c935fdf63659322020fb7625b577 Mon Sep 17 00:00:00 2001 From: Dan Gudmundsson Date: Thu, 16 Feb 2012 11:04:18 +0100 Subject: [wx] Generated types for all wx classes --- lib/wx/src/gen/wxBitmap.erl | 133 ++++++++++++++++++++++++-------------------- 1 file changed, 73 insertions(+), 60 deletions(-) (limited to 'lib/wx/src/gen/wxBitmap.erl') diff --git a/lib/wx/src/gen/wxBitmap.erl b/lib/wx/src/gen/wxBitmap.erl index bd2f83c6eb..ac16700011 100644 --- a/lib/wx/src/gen/wxBitmap.erl +++ b/lib/wx/src/gen/wxBitmap.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2011. All Rights Reserved. +%% Copyright Ericsson AB 2008-2012. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -32,22 +32,22 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxBitmap/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxBitmap() +-type wxBitmap() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxBitmap(). new() -> wxe_util:construct(?wxBitmap_new_0, <<>>). -%% @spec (X::string()|term()) -> wxBitmap() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Filename::string()) -> new(Filename, [])

-%%

-%% new(Image::wxImage:wxImage()) -> new(Image, [])

+-spec new(Filename) -> wxBitmap() when + Filename::string(); + (Image) -> wxBitmap() when + Image::wxImage:wxImage(). new(Filename) when is_list(Filename) -> @@ -57,21 +57,15 @@ new(Image) when is_record(Image, wx_ref) -> new(Image, []). -%% @spec (X::integer()|string()|term(),X::integer()|term()) -> wxBitmap() %% @doc 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()} -%%

+-spec new(Width, Height) -> wxBitmap() when + Width::integer(), Height::integer(); + (Filename, [Option]) -> wxBitmap() when + Filename::string(), + Option :: {type, wx:wx_enum()}; + (Image, [Option]) -> wxBitmap() when + Image::wxImage:wxImage(), + Option :: {depth, integer()}. new(Width,Height) when is_integer(Width),is_integer(Height) -> @@ -93,15 +87,12 @@ new(#wx_ref{type=ImageT,ref=ImageRef}, Options) wxe_util:construct(?wxBitmap_new_2_1, <>). -%% @spec (X::binary()|integer(),X::integer(),X::integer()|term()) -> wxBitmap() %% @doc 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()} -%%

+-spec new(Bits, Width, Height) -> wxBitmap() when + Bits::binary(), Width::integer(), Height::integer(); + (Width, Height, [Option]) -> wxBitmap() when + Width::integer(), Height::integer(), + Option :: {depth, integer()}. new(Bits,Width,Height) when is_binary(Bits),is_integer(Width),is_integer(Height) -> @@ -114,9 +105,10 @@ new(Width,Height, Options) wxe_util:construct(?wxBitmap_new_3, <>). -%% @spec (Bits::binary(), Width::integer(), Height::integer(), [Option]) -> wxBitmap() -%% Option = {depth, integer()} %% @doc See external documentation. +-spec new(Bits, Width, Height, [Option]) -> wxBitmap() when + Bits::binary(), Width::integer(), Height::integer(), + Option :: {depth, integer()}. new(Bits,Width,Height, Options) when is_binary(Bits),is_integer(Width),is_integer(Height),is_list(Options) -> wxe_util:send_bin(Bits), @@ -126,30 +118,35 @@ new(Bits,Width,Height, Options) wxe_util:construct(?wxBitmap_new_4, <>). -%% @spec (This::wxBitmap()) -> wxImage:wxImage() %% @doc See external documentation. +-spec convertToImage(This) -> wxImage:wxImage() when + This::wxBitmap(). convertToImage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_ConvertToImage, <>). -%% @spec (This::wxBitmap(), Icon::wxIcon:wxIcon()) -> bool() %% @doc See external documentation. +-spec copyFromIcon(This, Icon) -> boolean() when + This::wxBitmap(), Icon::wxIcon:wxIcon(). copyFromIcon(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconT,ref=IconRef}) -> ?CLASS(ThisT,wxBitmap), ?CLASS(IconT,wxIcon), wxe_util:call(?wxBitmap_CopyFromIcon, <>). -%% @spec (This::wxBitmap(), Width::integer(), Height::integer()) -> bool() %% @equiv create(This,Width,Height, []) +-spec create(This, Width, Height) -> boolean() when + This::wxBitmap(), Width::integer(), Height::integer(). + create(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> create(This,Width,Height, []). -%% @spec (This::wxBitmap(), Width::integer(), Height::integer(), [Option]) -> bool() -%% Option = {depth, integer()} %% @doc See external documentation. +-spec create(This, Width, Height, [Option]) -> boolean() when + This::wxBitmap(), Width::integer(), Height::integer(), + Option :: {depth, integer()}. create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxBitmap), @@ -159,60 +156,68 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxBitmap_Create, <>). -%% @spec (This::wxBitmap()) -> integer() %% @doc See external documentation. +-spec getDepth(This) -> integer() when + This::wxBitmap(). getDepth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetDepth, <>). -%% @spec (This::wxBitmap()) -> integer() %% @doc See external documentation. +-spec getHeight(This) -> integer() when + This::wxBitmap(). getHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetHeight, <>). -%% @spec (This::wxBitmap()) -> wxPalette:wxPalette() %% @doc See external documentation. +-spec getPalette(This) -> wxPalette:wxPalette() when + This::wxBitmap(). getPalette(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetPalette, <>). -%% @spec (This::wxBitmap()) -> wxMask:wxMask() %% @doc See external documentation. +-spec getMask(This) -> wxMask:wxMask() when + This::wxBitmap(). getMask(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetMask, <>). -%% @spec (This::wxBitmap()) -> integer() %% @doc See external documentation. +-spec getWidth(This) -> integer() when + This::wxBitmap(). getWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetWidth, <>). -%% @spec (This::wxBitmap(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> wxBitmap() %% @doc See external documentation. +-spec getSubBitmap(This, Rect) -> wxBitmap() when + This::wxBitmap(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. getSubBitmap(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetSubBitmap, <>). -%% @spec (This::wxBitmap(), Name::string()) -> bool() %% @equiv loadFile(This,Name, []) +-spec loadFile(This, Name) -> boolean() when + This::wxBitmap(), Name::string(). + loadFile(This,Name) when is_record(This, wx_ref),is_list(Name) -> loadFile(This,Name, []). -%% @spec (This::wxBitmap(), Name::string(), [Option]) -> bool() -%% Option = {type, WxBitmapType} -%% WxBitmapType = integer() %% @doc 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 +%%
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 +-spec loadFile(This, Name, [Option]) -> boolean() when + This::wxBitmap(), Name::string(), + Option :: {type, wx:wx_enum()}. loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name, Options) when is_list(Name),is_list(Options) -> ?CLASS(ThisT,wxBitmap), @@ -223,24 +228,27 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name, Options) wxe_util:call(?wxBitmap_LoadFile, <>). -%% @spec (This::wxBitmap()) -> bool() %% @doc See external documentation. +-spec ok(This) -> boolean() when + This::wxBitmap(). ok(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_Ok, <>). -%% @spec (This::wxBitmap(), Name::string(), Type::WxBitmapType) -> bool() %% @equiv saveFile(This,Name,Type, []) +-spec saveFile(This, Name, Type) -> boolean() when + This::wxBitmap(), Name::string(), Type::wx:wx_enum(). + saveFile(This,Name,Type) when is_record(This, wx_ref),is_list(Name),is_integer(Type) -> saveFile(This,Name,Type, []). -%% @spec (This::wxBitmap(), Name::string(), Type::WxBitmapType, [Option]) -> bool() -%% Option = {palette, wxPalette:wxPalette()} -%% WxBitmapType = integer() %% @doc 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 +%%
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 +-spec saveFile(This, Name, Type, [Option]) -> boolean() when + This::wxBitmap(), Name::string(), Type::wx:wx_enum(), + Option :: {palette, wxPalette:wxPalette()}. saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Type, Options) when is_list(Name),is_integer(Type),is_list(Options) -> ?CLASS(ThisT,wxBitmap), @@ -251,48 +259,53 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Type, Options) wxe_util:call(?wxBitmap_SaveFile, <>). -%% @spec (This::wxBitmap(), Depth::integer()) -> ok %% @doc See external documentation. +-spec setDepth(This, Depth) -> ok when + This::wxBitmap(), Depth::integer(). setDepth(#wx_ref{type=ThisT,ref=ThisRef},Depth) when is_integer(Depth) -> ?CLASS(ThisT,wxBitmap), wxe_util:cast(?wxBitmap_SetDepth, <>). -%% @spec (This::wxBitmap(), Height::integer()) -> ok %% @doc See external documentation. +-spec setHeight(This, Height) -> ok when + This::wxBitmap(), Height::integer(). setHeight(#wx_ref{type=ThisT,ref=ThisRef},Height) when is_integer(Height) -> ?CLASS(ThisT,wxBitmap), wxe_util:cast(?wxBitmap_SetHeight, <>). -%% @spec (This::wxBitmap(), Mask::wxMask:wxMask()) -> ok %% @doc See external documentation. +-spec setMask(This, Mask) -> ok when + This::wxBitmap(), Mask::wxMask:wxMask(). setMask(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MaskT,ref=MaskRef}) -> ?CLASS(ThisT,wxBitmap), ?CLASS(MaskT,wxMask), wxe_util:cast(?wxBitmap_SetMask, <>). -%% @spec (This::wxBitmap(), Palette::wxPalette:wxPalette()) -> ok %% @doc See external documentation. +-spec setPalette(This, Palette) -> ok when + This::wxBitmap(), Palette::wxPalette:wxPalette(). setPalette(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PaletteT,ref=PaletteRef}) -> ?CLASS(ThisT,wxBitmap), ?CLASS(PaletteT,wxPalette), wxe_util:cast(?wxBitmap_SetPalette, <>). -%% @spec (This::wxBitmap(), Width::integer()) -> ok %% @doc See external documentation. +-spec setWidth(This, Width) -> ok when + This::wxBitmap(), Width::integer(). setWidth(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxBitmap), wxe_util:cast(?wxBitmap_SetWidth, <>). -%% @spec (This::wxBitmap()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxBitmap) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxBitmap), wxe_util:destroy(?DESTROY_OBJECT,Obj), -- cgit v1.2.3