diff options
Diffstat (limited to 'lib/wx/src/gen/wxImage.erl')
| -rw-r--r-- | lib/wx/src/gen/wxImage.erl | 452 |
1 files changed, 288 insertions, 164 deletions
diff --git a/lib/wx/src/gen/wxImage.erl b/lib/wx/src/gen/wxImage.erl index 5fe105fbb2..c21b5d4789 100644 --- a/lib/wx/src/gen/wxImage.erl +++ b/lib/wx/src/gen/wxImage.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2010. 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 @@ -47,30 +47,38 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxImage/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxImage() +-type wxImage() :: wx:wx_object(). %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagewximage">external documentation</a>. +-spec new() -> wxImage(). new() -> wxe_util:construct(?wxImage_new_0, <<>>). -%% @spec (Name::string()) -> wxImage() %% @equiv new(Name, []) +-spec new(Name) -> wxImage() when + Name::unicode:chardata(). + new(Name) when is_list(Name) -> new(Name, []). -%% @spec (X::integer()|string(),X::integer()|term()) -> wxImage() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagewximage">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% new(Width::integer(), Height::integer()) -> new(Width,Height, []) </c></p> -%% <p><c> -%% new(Name::string(), [Option]) -> wxImage() </c> -%%<br /> Option = {type, integer()} | {index, integer()} -%% </p> +%% <br /> Also:<br /> +%% new(Name, [Option]) -> wxImage() when<br /> +%% Name::unicode:chardata(),<br /> +%% Option :: {type, integer()}<br /> +%% | {index, integer()}.<br /> +%% +-spec new(Width, Height) -> wxImage() when + Width::integer(), Height::integer(); + (Name, [Option]) -> wxImage() when + Name::unicode:chardata(), + Option :: {type, integer()} + | {index, integer()}. new(Width,Height) when is_integer(Width),is_integer(Height) -> @@ -85,19 +93,23 @@ new(Name, Options) wxe_util:construct(?wxImage_new_2, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (X::integer()|string(),X::integer()|string(),X::binary()|term()) -> wxImage() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagewximage">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% new(Width::integer(), Height::integer(), Data::binary()) -> new(Width,Height,Data, []) </c></p> -%% <p><c> -%% new(Width::integer(), Height::integer(), [Option]) -> wxImage() </c> -%%<br /> Option = {clear, bool()} -%% </p> -%% <p><c> -%% new(Name::string(), Mimetype::string(), [Option]) -> wxImage() </c> -%%<br /> Option = {index, integer()} -%% </p> +%% <br /> Also:<br /> +%% new(Width, Height, [Option]) -> wxImage() when<br /> +%% Width::integer(), Height::integer(),<br /> +%% Option :: {clear, boolean()};<br /> +%% (Name, Mimetype, [Option]) -> wxImage() when<br /> +%% Name::unicode:chardata(), Mimetype::unicode:chardata(),<br /> +%% Option :: {index, integer()}.<br /> +%% +-spec new(Width, Height, Data) -> wxImage() when + Width::integer(), Height::integer(), Data::binary(); + (Width, Height, [Option]) -> wxImage() when + Width::integer(), Height::integer(), + Option :: {clear, boolean()}; + (Name, Mimetype, [Option]) -> wxImage() when + Name::unicode:chardata(), Mimetype::unicode:chardata(), + Option :: {index, integer()}. new(Width,Height,Data) when is_integer(Width),is_integer(Height),is_binary(Data) -> @@ -119,15 +131,17 @@ new(Name,Mimetype, Options) wxe_util:construct(?wxImage_new_3_1, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8,(byte_size(Mimetype_UC)):32/?UI,(Mimetype_UC)/binary, 0:(((8- ((4+byte_size(Mimetype_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (Width::integer(),Height::integer(),Data::binary(),X::binary()|term()) -> wxImage() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagewximage">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% new(Width::integer(), Height::integer(), Data::binary(), Alpha::binary()) -> new(Width,Height,Data,Alpha, []) </c></p> -%% <p><c> -%% new(Width::integer(), Height::integer(), Data::binary(), [Option]) -> wxImage() </c> -%%<br /> Option = {static_data, bool()} -%% </p> +%% <br /> Also:<br /> +%% new(Width, Height, Data, [Option]) -> wxImage() when<br /> +%% Width::integer(), Height::integer(), Data::binary(),<br /> +%% Option :: {static_data, boolean()}.<br /> +%% +-spec new(Width, Height, Data, Alpha) -> wxImage() when + Width::integer(), Height::integer(), Data::binary(), Alpha::binary(); + (Width, Height, Data, [Option]) -> wxImage() when + Width::integer(), Height::integer(), Data::binary(), + Option :: {static_data, boolean()}. new(Width,Height,Data,Alpha) when is_integer(Width),is_integer(Height),is_binary(Data),is_binary(Alpha) -> @@ -141,9 +155,10 @@ new(Width,Height,Data, Options) wxe_util:construct(?wxImage_new_4, <<Width:32/?UI,Height:32/?UI, BinOpt/binary>>). -%% @spec (Width::integer(), Height::integer(), Data::binary(), Alpha::binary(), [Option]) -> wxImage() -%% Option = {static_data, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagewximage">external documentation</a>. +-spec new(Width, Height, Data, Alpha, [Option]) -> wxImage() when + Width::integer(), Height::integer(), Data::binary(), Alpha::binary(), + Option :: {static_data, boolean()}. new(Width,Height,Data,Alpha, Options) when is_integer(Width),is_integer(Height),is_binary(Data),is_binary(Alpha),is_list(Options) -> wxe_util:send_bin(Data), @@ -154,39 +169,45 @@ new(Width,Height,Data,Alpha, Options) wxe_util:construct(?wxImage_new_5, <<Width:32/?UI,Height:32/?UI, BinOpt/binary>>). -%% @spec (This::wxImage(), Radius::integer()) -> wxImage() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageblur">external documentation</a>. +-spec blur(This, Radius) -> wxImage() when + This::wxImage(), Radius::integer(). blur(#wx_ref{type=ThisT,ref=ThisRef},Radius) when is_integer(Radius) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_Blur, <<ThisRef:32/?UI,Radius:32/?UI>>). -%% @spec (This::wxImage(), Radius::integer()) -> wxImage() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageblurhorizontal">external documentation</a>. +-spec blurHorizontal(This, Radius) -> wxImage() when + This::wxImage(), Radius::integer(). blurHorizontal(#wx_ref{type=ThisT,ref=ThisRef},Radius) when is_integer(Radius) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_BlurHorizontal, <<ThisRef:32/?UI,Radius:32/?UI>>). -%% @spec (This::wxImage(), Radius::integer()) -> wxImage() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageblurvertical">external documentation</a>. +-spec blurVertical(This, Radius) -> wxImage() when + This::wxImage(), Radius::integer(). blurVertical(#wx_ref{type=ThisT,ref=ThisRef},Radius) when is_integer(Radius) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_BlurVertical, <<ThisRef:32/?UI,Radius:32/?UI>>). -%% @spec (This::wxImage()) -> bool() %% @equiv convertAlphaToMask(This, []) +-spec convertAlphaToMask(This) -> boolean() when + This::wxImage(). + convertAlphaToMask(This) when is_record(This, wx_ref) -> convertAlphaToMask(This, []). -%% @spec (This::wxImage(), [Option]) -> bool() -%% Option = {threshold, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageconvertalphatomask">external documentation</a>. +-spec convertAlphaToMask(This, [Option]) -> boolean() when + This::wxImage(), + Option :: {threshold, integer()}. convertAlphaToMask(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -196,15 +217,20 @@ convertAlphaToMask(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_ConvertAlphaToMask, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage()) -> wxImage() %% @equiv convertToGreyscale(This, []) +-spec convertToGreyscale(This) -> wxImage() when + This::wxImage(). + convertToGreyscale(This) when is_record(This, wx_ref) -> convertToGreyscale(This, []). -%% @spec (This::wxImage(), [Option]) -> wxImage() -%% Option = {lr, float()} | {lg, float()} | {lb, float()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageconverttogreyscale">external documentation</a>. +-spec convertToGreyscale(This, [Option]) -> wxImage() when + This::wxImage(), + Option :: {lr, number()} + | {lg, number()} + | {lb, number()}. convertToGreyscale(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -216,36 +242,42 @@ convertToGreyscale(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_ConvertToGreyscale, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), R::integer(), G::integer(), B::integer()) -> wxImage() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageconverttomono">external documentation</a>. +-spec convertToMono(This, R, G, B) -> wxImage() when + This::wxImage(), R::integer(), G::integer(), B::integer(). convertToMono(#wx_ref{type=ThisT,ref=ThisRef},R,G,B) when is_integer(R),is_integer(G),is_integer(B) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_ConvertToMono, <<ThisRef:32/?UI,R:32/?UI,G:32/?UI,B:32/?UI>>). -%% @spec (This::wxImage()) -> wxImage() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagecopy">external documentation</a>. +-spec copy(This) -> wxImage() when + This::wxImage(). copy(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_Copy, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage(), Width::integer(), Height::integer()) -> bool() %% @equiv create(This,Width,Height, []) +-spec create(This, Width, Height) -> boolean() when + This::wxImage(), 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::wxImage(),Width::integer(),Height::integer(),X::binary()|term()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagecreate">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% create(This::wxImage(), Width::integer(), Height::integer(), Data::binary()) -> create(This,Width,Height,Data, []) </c></p> -%% <p><c> -%% create(This::wxImage(), Width::integer(), Height::integer(), [Option]) -> bool() </c> -%%<br /> Option = {clear, bool()} -%% </p> +%% <br /> Also:<br /> +%% create(This, Width, Height, [Option]) -> boolean() when<br /> +%% This::wxImage(), Width::integer(), Height::integer(),<br /> +%% Option :: {clear, boolean()}.<br /> +%% +-spec create(This, Width, Height, Data) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), Data::binary(); + (This, Width, Height, [Option]) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), + Option :: {clear, boolean()}. create(This,Width,Height,Data) when is_record(This, wx_ref),is_integer(Width),is_integer(Height),is_binary(Data) -> @@ -259,15 +291,17 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxImage_Create_3, <<ThisRef:32/?UI,Width:32/?UI,Height:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(),Width::integer(),Height::integer(),Data::binary(),X::binary()|term()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagecreate">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% create(This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary()) -> create(This,Width,Height,Data,Alpha, []) </c></p> -%% <p><c> -%% create(This::wxImage(), Width::integer(), Height::integer(), Data::binary(), [Option]) -> bool() </c> -%%<br /> Option = {static_data, bool()} -%% </p> +%% <br /> Also:<br /> +%% create(This, Width, Height, Data, [Option]) -> boolean() when<br /> +%% This::wxImage(), Width::integer(), Height::integer(), Data::binary(),<br /> +%% Option :: {static_data, boolean()}.<br /> +%% +-spec create(This, Width, Height, Data, Alpha) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary(); + (This, Width, Height, Data, [Option]) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), Data::binary(), + Option :: {static_data, boolean()}. create(This,Width,Height,Data,Alpha) when is_record(This, wx_ref),is_integer(Width),is_integer(Height),is_binary(Data),is_binary(Alpha) -> @@ -282,9 +316,10 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height,Data, Options) wxe_util:call(?wxImage_Create_4, <<ThisRef:32/?UI,Width:32/?UI,Height:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary(), [Option]) -> bool() -%% Option = {static_data, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagecreate">external documentation</a>. +-spec create(This, Width, Height, Data, Alpha, [Option]) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary(), + Option :: {static_data, boolean()}. create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height,Data,Alpha, Options) when is_integer(Width),is_integer(Height),is_binary(Data),is_binary(Alpha),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -296,22 +331,30 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height,Data,Alpha, Options) wxe_util:call(?wxImage_Create_5, <<ThisRef:32/?UI,Width:32/?UI,Height:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagedestroy">external documentation</a>. +-spec 'Destroy'(This) -> ok when + This::wxImage(). 'Destroy'(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_Destroy, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage()) -> {bool(),R::integer(),G::integer(),B::integer()} %% @equiv findFirstUnusedColour(This, []) +-spec findFirstUnusedColour(This) -> Result when + Result ::{Res ::boolean(), R::integer(), G::integer(), B::integer()}, + This::wxImage(). + findFirstUnusedColour(This) when is_record(This, wx_ref) -> findFirstUnusedColour(This, []). -%% @spec (This::wxImage(), [Option]) -> {bool(),R::integer(),G::integer(),B::integer()} -%% Option = {startR, integer()} | {startG, integer()} | {startB, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagefindfirstunusedcolour">external documentation</a>. +-spec findFirstUnusedColour(This, [Option]) -> Result when + Result :: {Res ::boolean(), R::integer(), G::integer(), B::integer()}, + This::wxImage(), + Option :: {startR, integer()} + | {startG, integer()} + | {startB, integer()}. findFirstUnusedColour(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -323,59 +366,67 @@ findFirstUnusedColour(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_FindFirstUnusedColour, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec () -> string() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetimageextwildcard">external documentation</a>. +-spec getImageExtWildcard() -> unicode:charlist(). getImageExtWildcard() -> wxe_util:call(?wxImage_GetImageExtWildcard, <<>>). -%% @spec (This::wxImage()) -> binary() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetalpha">external documentation</a>. +-spec getAlpha(This) -> binary() when + This::wxImage(). getAlpha(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetAlpha_0, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetalpha">external documentation</a>. +-spec getAlpha(This, X, Y) -> integer() when + This::wxImage(), X::integer(), Y::integer(). getAlpha(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetAlpha_2, <<ThisRef:32/?UI,X:32/?UI,Y:32/?UI>>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetblue">external documentation</a>. +-spec getBlue(This, X, Y) -> integer() when + This::wxImage(), X::integer(), Y::integer(). getBlue(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetBlue, <<ThisRef:32/?UI,X:32/?UI,Y:32/?UI>>). -%% @spec (This::wxImage()) -> binary() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetdata">external documentation</a>. +-spec getData(This) -> binary() when + This::wxImage(). getData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetData, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetgreen">external documentation</a>. +-spec getGreen(This, X, Y) -> integer() when + This::wxImage(), X::integer(), Y::integer(). getGreen(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetGreen, <<ThisRef:32/?UI,X:32/?UI,Y:32/?UI>>). -%% @spec (Name::string()) -> integer() %% @equiv getImageCount(Name, []) +-spec getImageCount(Name) -> integer() when + Name::unicode:chardata(). + getImageCount(Name) when is_list(Name) -> getImageCount(Name, []). -%% @spec (Name::string(), [Option]) -> integer() -%% Option = {type, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetimagecount">external documentation</a>. +-spec getImageCount(Name, [Option]) -> integer() when + Name::unicode:chardata(), + Option :: {type, integer()}. getImageCount(Name, Options) when is_list(Name),is_list(Options) -> Name_UC = unicode:characters_to_binary([Name,0]), @@ -385,87 +436,100 @@ getImageCount(Name, Options) wxe_util:call(?wxImage_GetImageCount, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxImage()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetheight">external documentation</a>. +-spec getHeight(This) -> integer() when + This::wxImage(). getHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetHeight, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetmaskblue">external documentation</a>. +-spec getMaskBlue(This) -> integer() when + This::wxImage(). getMaskBlue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetMaskBlue, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetmaskgreen">external documentation</a>. +-spec getMaskGreen(This) -> integer() when + This::wxImage(). getMaskGreen(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetMaskGreen, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetmaskred">external documentation</a>. +-spec getMaskRed(This) -> integer() when + This::wxImage(). getMaskRed(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetMaskRed, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage()) -> {bool(),R::integer(),G::integer(),B::integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetorfindmaskcolour">external documentation</a>. +-spec getOrFindMaskColour(This) -> Result when + Result ::{Res ::boolean(), R::integer(), G::integer(), B::integer()}, + This::wxImage(). getOrFindMaskColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetOrFindMaskColour, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage()) -> wxPalette:wxPalette() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetpalette">external documentation</a>. +-spec getPalette(This) -> wxPalette:wxPalette() when + This::wxImage(). getPalette(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetPalette, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetred">external documentation</a>. +-spec getRed(This, X, Y) -> integer() when + This::wxImage(), X::integer(), Y::integer(). getRed(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetRed, <<ThisRef:32/?UI,X:32/?UI,Y:32/?UI>>). -%% @spec (This::wxImage(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}) -> wxImage() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetsubimage">external documentation</a>. +-spec getSubImage(This, Rect) -> wxImage() when + This::wxImage(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. getSubImage(#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,wxImage), wxe_util:call(?wxImage_GetSubImage, <<ThisRef:32/?UI,RectX:32/?UI,RectY:32/?UI,RectW:32/?UI,RectH:32/?UI>>). -%% @spec (This::wxImage()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetwidth">external documentation</a>. +-spec getWidth(This) -> integer() when + This::wxImage(). getWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetWidth, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagehasalpha">external documentation</a>. +-spec hasAlpha(This) -> boolean() when + This::wxImage(). hasAlpha(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_HasAlpha, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagehasmask">external documentation</a>. +-spec hasMask(This) -> boolean() when + This::wxImage(). hasMask(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_HasMask, <<ThisRef:32/?UI>>). -%% @spec (This::wxImage(), Name::string()) -> string() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetoption">external documentation</a>. +-spec getOption(This, Name) -> unicode:charlist() when + This::wxImage(), Name::unicode:chardata(). getOption(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxImage), @@ -473,8 +537,9 @@ getOption(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxImage_GetOption, <<ThisRef:32/?UI,(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((0+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxImage(), Name::string()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagegetoptionint">external documentation</a>. +-spec getOptionInt(This, Name) -> integer() when + This::wxImage(), Name::unicode:chardata(). getOptionInt(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxImage), @@ -482,8 +547,9 @@ getOptionInt(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxImage_GetOptionInt, <<ThisRef:32/?UI,(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((0+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxImage(), Name::string()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagehasoption">external documentation</a>. +-spec hasOption(This, Name) -> boolean() when + This::wxImage(), Name::unicode:chardata(). hasOption(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxImage), @@ -491,28 +557,32 @@ hasOption(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxImage_HasOption, <<ThisRef:32/?UI,(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((0+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxImage()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageinitalpha">external documentation</a>. +-spec initAlpha(This) -> ok when + This::wxImage(). initAlpha(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_InitAlpha, <<ThisRef:32/?UI>>). -%% @spec () -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageinitstandardhandlers">external documentation</a>. +-spec initStandardHandlers() -> ok. initStandardHandlers() -> wxe_util:cast(?wxImage_InitStandardHandlers, <<>>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> bool() %% @equiv isTransparent(This,X,Y, []) +-spec isTransparent(This, X, Y) -> boolean() when + This::wxImage(), X::integer(), Y::integer(). + isTransparent(This,X,Y) when is_record(This, wx_ref),is_integer(X),is_integer(Y) -> isTransparent(This,X,Y, []). -%% @spec (This::wxImage(), X::integer(), Y::integer(), [Option]) -> bool() -%% Option = {threshold, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageistransparent">external documentation</a>. +-spec isTransparent(This, X, Y, [Option]) -> boolean() when + This::wxImage(), X::integer(), Y::integer(), + Option :: {threshold, integer()}. isTransparent(#wx_ref{type=ThisT,ref=ThisRef},X,Y, Options) when is_integer(X),is_integer(Y),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -522,15 +592,19 @@ isTransparent(#wx_ref{type=ThisT,ref=ThisRef},X,Y, Options) wxe_util:call(?wxImage_IsTransparent, <<ThisRef:32/?UI,X:32/?UI,Y:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), Name::string()) -> bool() %% @equiv loadFile(This,Name, []) +-spec loadFile(This, Name) -> boolean() when + This::wxImage(), Name::unicode:chardata(). + loadFile(This,Name) when is_record(This, wx_ref),is_list(Name) -> loadFile(This,Name, []). -%% @spec (This::wxImage(), Name::string(), [Option]) -> bool() -%% Option = {type, integer()} | {index, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageloadfile">external documentation</a>. +-spec loadFile(This, Name, [Option]) -> boolean() when + This::wxImage(), Name::unicode:chardata(), + Option :: {type, integer()} + | {index, integer()}. loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name, Options) when is_list(Name),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -542,9 +616,10 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name, Options) wxe_util:call(?wxImage_LoadFile_2, <<ThisRef:32/?UI,(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((0+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxImage(), Name::string(), Mimetype::string(), [Option]) -> bool() -%% Option = {index, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageloadfile">external documentation</a>. +-spec loadFile(This, Name, Mimetype, [Option]) -> boolean() when + This::wxImage(), Name::unicode:chardata(), Mimetype::unicode:chardata(), + Option :: {index, integer()}. loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Mimetype, Options) when is_list(Name),is_list(Mimetype),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -556,30 +631,35 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Mimetype, Options) wxe_util:call(?wxImage_LoadFile_3, <<ThisRef:32/?UI,(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((0+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8,(byte_size(Mimetype_UC)):32/?UI,(Mimetype_UC)/binary, 0:(((8- ((4+byte_size(Mimetype_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxImage()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageok">external documentation</a>. +-spec ok(This) -> boolean() when + This::wxImage(). ok(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_Ok, <<ThisRef:32/?UI>>). -%% @spec (Name::string()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageremovehandler">external documentation</a>. +-spec removeHandler(Name) -> boolean() when + Name::unicode:chardata(). removeHandler(Name) when is_list(Name) -> Name_UC = unicode:characters_to_binary([Name,0]), wxe_util:call(?wxImage_RemoveHandler, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxImage()) -> wxImage() %% @equiv mirror(This, []) +-spec mirror(This) -> wxImage() when + This::wxImage(). + mirror(This) when is_record(This, wx_ref) -> mirror(This, []). -%% @spec (This::wxImage(), [Option]) -> wxImage() -%% Option = {horizontally, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagemirror">external documentation</a>. +-spec mirror(This, [Option]) -> wxImage() when + This::wxImage(), + Option :: {horizontally, boolean()}. mirror(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -589,23 +669,27 @@ mirror(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_Mirror, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), R1::integer(), G1::integer(), B1::integer(), R2::integer(), G2::integer(), B2::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagereplace">external documentation</a>. +-spec replace(This, R1, G1, B1, R2, G2, B2) -> ok when + This::wxImage(), R1::integer(), G1::integer(), B1::integer(), R2::integer(), G2::integer(), B2::integer(). replace(#wx_ref{type=ThisT,ref=ThisRef},R1,G1,B1,R2,G2,B2) when is_integer(R1),is_integer(G1),is_integer(B1),is_integer(R2),is_integer(G2),is_integer(B2) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_Replace, <<ThisRef:32/?UI,R1:32/?UI,G1:32/?UI,B1:32/?UI,R2:32/?UI,G2:32/?UI,B2:32/?UI>>). -%% @spec (This::wxImage(), Width::integer(), Height::integer()) -> wxImage() %% @equiv rescale(This,Width,Height, []) +-spec rescale(This, Width, Height) -> wxImage() when + This::wxImage(), Width::integer(), Height::integer(). + rescale(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> rescale(This,Width,Height, []). -%% @spec (This::wxImage(), Width::integer(), Height::integer(), [Option]) -> wxImage() -%% Option = {quality, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagerescale">external documentation</a>. +-spec rescale(This, Width, Height, [Option]) -> wxImage() when + This::wxImage(), Width::integer(), Height::integer(), + Option :: {quality, integer()}. rescale(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -615,15 +699,20 @@ rescale(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxImage_Rescale, <<ThisRef:32/?UI,Width:32/?UI,Height:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), Size::{W::integer(),H::integer()}, Pos::{X::integer(),Y::integer()}) -> wxImage() %% @equiv resize(This,Size,Pos, []) +-spec resize(This, Size, Pos) -> wxImage() when + This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}. + resize(This,Size={SizeW,SizeH},Pos={PosX,PosY}) when is_record(This, wx_ref),is_integer(SizeW),is_integer(SizeH),is_integer(PosX),is_integer(PosY) -> resize(This,Size,Pos, []). -%% @spec (This::wxImage(), Size::{W::integer(),H::integer()}, Pos::{X::integer(),Y::integer()}, [Option]) -> wxImage() -%% Option = {r, integer()} | {g, integer()} | {b, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximageresize">external documentation</a>. +-spec resize(This, Size, Pos, [Option]) -> wxImage() when + This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}, + Option :: {r, integer()} + | {g, integer()} + | {b, integer()}. resize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH},{PosX,PosY}, Options) when is_integer(SizeW),is_integer(SizeH),is_integer(PosX),is_integer(PosY),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -635,17 +724,21 @@ resize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH},{PosX,PosY}, Options) wxe_util:call(?wxImage_Resize, <<ThisRef:32/?UI,SizeW:32/?UI,SizeH:32/?UI,PosX:32/?UI,PosY:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), Angle::float(), Centre_of_rotation::{X::integer(),Y::integer()}) -> wxImage() %% @equiv rotate(This,Angle,Centre_of_rotation, []) +-spec rotate(This, Angle, Centre_of_rotation) -> wxImage() when + This::wxImage(), Angle::number(), Centre_of_rotation::{X::integer(), Y::integer()}. + rotate(This,Angle,Centre_of_rotation={Centre_of_rotationX,Centre_of_rotationY}) - when is_record(This, wx_ref),is_float(Angle),is_integer(Centre_of_rotationX),is_integer(Centre_of_rotationY) -> + when is_record(This, wx_ref),is_number(Angle),is_integer(Centre_of_rotationX),is_integer(Centre_of_rotationY) -> rotate(This,Angle,Centre_of_rotation, []). -%% @spec (This::wxImage(), Angle::float(), Centre_of_rotation::{X::integer(),Y::integer()}, [Option]) -> wxImage() -%% Option = {interpolating, bool()} | {offset_after_rotation, {X::integer(),Y::integer()}} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagerotate">external documentation</a>. +-spec rotate(This, Angle, Centre_of_rotation, [Option]) -> wxImage() when + This::wxImage(), Angle::number(), Centre_of_rotation::{X::integer(), Y::integer()}, + Option :: {interpolating, boolean()} + | {offset_after_rotation, {X::integer(), Y::integer()}}. rotate(#wx_ref{type=ThisT,ref=ThisRef},Angle,{Centre_of_rotationX,Centre_of_rotationY}, Options) - when is_float(Angle),is_integer(Centre_of_rotationX),is_integer(Centre_of_rotationY),is_list(Options) -> + when is_number(Angle),is_integer(Centre_of_rotationX),is_integer(Centre_of_rotationY),is_list(Options) -> ?CLASS(ThisT,wxImage), MOpts = fun({interpolating, Interpolating}, Acc) -> [<<1:32/?UI,(wxe_util:from_bool(Interpolating)):32/?UI>>|Acc]; ({offset_after_rotation, {Offset_after_rotationX,Offset_after_rotationY}}, Acc) -> [<<2:32/?UI,Offset_after_rotationX:32/?UI,Offset_after_rotationY:32/?UI,0:32>>|Acc]; @@ -654,23 +747,27 @@ rotate(#wx_ref{type=ThisT,ref=ThisRef},Angle,{Centre_of_rotationX,Centre_of_rota wxe_util:call(?wxImage_Rotate, <<ThisRef:32/?UI,0:32,Angle:64/?F,Centre_of_rotationX:32/?UI,Centre_of_rotationY:32/?UI, BinOpt/binary>>). -%% @spec (This::wxImage(), Angle::float()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagerotatehue">external documentation</a>. +-spec rotateHue(This, Angle) -> ok when + This::wxImage(), Angle::number(). rotateHue(#wx_ref{type=ThisT,ref=ThisRef},Angle) - when is_float(Angle) -> + when is_number(Angle) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_RotateHue, <<ThisRef:32/?UI,0:32,Angle:64/?F>>). -%% @spec (This::wxImage()) -> wxImage() %% @equiv rotate90(This, []) +-spec rotate90(This) -> wxImage() when + This::wxImage(). + rotate90(This) when is_record(This, wx_ref) -> rotate90(This, []). -%% @spec (This::wxImage(), [Option]) -> wxImage() -%% Option = {clockwise, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagerotate90">external documentation</a>. +-spec rotate90(This, [Option]) -> wxImage() when + This::wxImage(), + Option :: {clockwise, boolean()}. rotate90(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -680,8 +777,9 @@ rotate90(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_Rotate90, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), Name::string()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesavefile">external documentation</a>. +-spec saveFile(This, Name) -> boolean() when + This::wxImage(), Name::unicode:chardata(). saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxImage), @@ -689,15 +787,15 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxImage_SaveFile_1, <<ThisRef:32/?UI,(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((0+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxImage(),Name::string(),X::integer()|string()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesavefile">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% saveFile(This::wxImage(), Name::string(), Type::integer()) -> bool() </c> -%% </p> -%% <p><c> -%% saveFile(This::wxImage(), Name::string(), Mimetype::string()) -> bool() </c> -%% </p> +%% <br /> Also:<br /> +%% saveFile(This, Name, Mimetype) -> boolean() when<br /> +%% This::wxImage(), Name::unicode:chardata(), Mimetype::unicode:chardata().<br /> +%% +-spec saveFile(This, Name, Type) -> boolean() when + This::wxImage(), Name::unicode:chardata(), Type::integer(); + (This, Name, Mimetype) -> boolean() when + This::wxImage(), Name::unicode:chardata(), Mimetype::unicode:chardata(). saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Type) when is_list(Name),is_integer(Type) -> ?CLASS(ThisT,wxImage), @@ -712,15 +810,18 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Mimetype) wxe_util:call(?wxImage_SaveFile_2_1, <<ThisRef:32/?UI,(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((0+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8,(byte_size(Mimetype_UC)):32/?UI,(Mimetype_UC)/binary, 0:(((8- ((4+byte_size(Mimetype_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxImage(), Width::integer(), Height::integer()) -> wxImage() %% @equiv scale(This,Width,Height, []) +-spec scale(This, Width, Height) -> wxImage() when + This::wxImage(), Width::integer(), Height::integer(). + scale(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> scale(This,Width,Height, []). -%% @spec (This::wxImage(), Width::integer(), Height::integer(), [Option]) -> wxImage() -%% Option = {quality, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagescale">external documentation</a>. +-spec scale(This, Width, Height, [Option]) -> wxImage() when + This::wxImage(), Width::integer(), Height::integer(), + Option :: {quality, integer()}. scale(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -730,15 +831,20 @@ scale(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxImage_Scale, <<ThisRef:32/?UI,Width:32/?UI,Height:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), Size::{W::integer(),H::integer()}, Pos::{X::integer(),Y::integer()}) -> wxImage() %% @equiv size(This,Size,Pos, []) +-spec size(This, Size, Pos) -> wxImage() when + This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}. + size(This,Size={SizeW,SizeH},Pos={PosX,PosY}) when is_record(This, wx_ref),is_integer(SizeW),is_integer(SizeH),is_integer(PosX),is_integer(PosY) -> size(This,Size,Pos, []). -%% @spec (This::wxImage(), Size::{W::integer(),H::integer()}, Pos::{X::integer(),Y::integer()}, [Option]) -> wxImage() -%% Option = {r, integer()} | {g, integer()} | {b, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesize">external documentation</a>. +-spec size(This, Size, Pos, [Option]) -> wxImage() when + This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}, + Option :: {r, integer()} + | {g, integer()} + | {b, integer()}. size(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH},{PosX,PosY}, Options) when is_integer(SizeW),is_integer(SizeH),is_integer(PosX),is_integer(PosY),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -750,15 +856,18 @@ size(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH},{PosX,PosY}, Options) wxe_util:call(?wxImage_Size, <<ThisRef:32/?UI,SizeW:32/?UI,SizeH:32/?UI,PosX:32/?UI,PosY:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), Alpha::binary()) -> ok %% @equiv setAlpha(This,Alpha, []) +-spec setAlpha(This, Alpha) -> ok when + This::wxImage(), Alpha::binary(). + setAlpha(This,Alpha) when is_record(This, wx_ref),is_binary(Alpha) -> setAlpha(This,Alpha, []). -%% @spec (This::wxImage(), Alpha::binary(), [Option]) -> ok -%% Option = {static_data, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetalpha">external documentation</a>. +-spec setAlpha(This, Alpha, [Option]) -> ok when + This::wxImage(), Alpha::binary(), + Option :: {static_data, boolean()}. setAlpha(#wx_ref{type=ThisT,ref=ThisRef},Alpha, Options) when is_binary(Alpha),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -769,23 +878,27 @@ setAlpha(#wx_ref{type=ThisT,ref=ThisRef},Alpha, Options) wxe_util:cast(?wxImage_SetAlpha_2, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), X::integer(), Y::integer(), Alpha::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetalpha">external documentation</a>. +-spec setAlpha(This, X, Y, Alpha) -> ok when + This::wxImage(), X::integer(), Y::integer(), Alpha::integer(). setAlpha(#wx_ref{type=ThisT,ref=ThisRef},X,Y,Alpha) when is_integer(X),is_integer(Y),is_integer(Alpha) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_SetAlpha_3, <<ThisRef:32/?UI,X:32/?UI,Y:32/?UI,Alpha:32/?UI>>). -%% @spec (This::wxImage(), Data::binary()) -> ok %% @equiv setData(This,Data, []) +-spec setData(This, Data) -> ok when + This::wxImage(), Data::binary(). + setData(This,Data) when is_record(This, wx_ref),is_binary(Data) -> setData(This,Data, []). -%% @spec (This::wxImage(), Data::binary(), [Option]) -> ok -%% Option = {static_data, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetdata">external documentation</a>. +-spec setData(This, Data, [Option]) -> ok when + This::wxImage(), Data::binary(), + Option :: {static_data, boolean()}. setData(#wx_ref{type=ThisT,ref=ThisRef},Data, Options) when is_binary(Data),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -796,15 +909,18 @@ setData(#wx_ref{type=ThisT,ref=ThisRef},Data, Options) wxe_util:cast(?wxImage_SetData_2, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), Data::binary(), New_width::integer(), New_height::integer()) -> ok %% @equiv setData(This,Data,New_width,New_height, []) +-spec setData(This, Data, New_width, New_height) -> ok when + This::wxImage(), Data::binary(), New_width::integer(), New_height::integer(). + setData(This,Data,New_width,New_height) when is_record(This, wx_ref),is_binary(Data),is_integer(New_width),is_integer(New_height) -> setData(This,Data,New_width,New_height, []). -%% @spec (This::wxImage(), Data::binary(), New_width::integer(), New_height::integer(), [Option]) -> ok -%% Option = {static_data, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetdata">external documentation</a>. +-spec setData(This, Data, New_width, New_height, [Option]) -> ok when + This::wxImage(), Data::binary(), New_width::integer(), New_height::integer(), + Option :: {static_data, boolean()}. setData(#wx_ref{type=ThisT,ref=ThisRef},Data,New_width,New_height, Options) when is_binary(Data),is_integer(New_width),is_integer(New_height),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -815,15 +931,18 @@ setData(#wx_ref{type=ThisT,ref=ThisRef},Data,New_width,New_height, Options) wxe_util:cast(?wxImage_SetData_4, <<ThisRef:32/?UI,New_width:32/?UI,New_height:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage()) -> ok %% @equiv setMask(This, []) +-spec setMask(This) -> ok when + This::wxImage(). + setMask(This) when is_record(This, wx_ref) -> setMask(This, []). -%% @spec (This::wxImage(), [Option]) -> ok -%% Option = {mask, bool()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetmask">external documentation</a>. +-spec setMask(This, [Option]) -> ok when + This::wxImage(), + Option :: {mask, boolean()}. setMask(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -833,16 +952,18 @@ setMask(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxImage_SetMask, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxImage(), R::integer(), G::integer(), B::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetmaskcolour">external documentation</a>. +-spec setMaskColour(This, R, G, B) -> ok when + This::wxImage(), R::integer(), G::integer(), B::integer(). setMaskColour(#wx_ref{type=ThisT,ref=ThisRef},R,G,B) when is_integer(R),is_integer(G),is_integer(B) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_SetMaskColour, <<ThisRef:32/?UI,R:32/?UI,G:32/?UI,B:32/?UI>>). -%% @spec (This::wxImage(), Mask::wxImage(), Mr::integer(), Mg::integer(), Mb::integer()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetmaskfromimage">external documentation</a>. +-spec setMaskFromImage(This, Mask, Mr, Mg, Mb) -> boolean() when + This::wxImage(), Mask::wxImage(), Mr::integer(), Mg::integer(), Mb::integer(). setMaskFromImage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MaskT,ref=MaskRef},Mr,Mg,Mb) when is_integer(Mr),is_integer(Mg),is_integer(Mb) -> ?CLASS(ThisT,wxImage), @@ -850,15 +971,15 @@ setMaskFromImage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MaskT,ref=MaskRef} wxe_util:call(?wxImage_SetMaskFromImage, <<ThisRef:32/?UI,MaskRef:32/?UI,Mr:32/?UI,Mg:32/?UI,Mb:32/?UI>>). -%% @spec (This::wxImage(),Name::string(),X::integer()|string()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetoption">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% setOption(This::wxImage(), Name::string(), Value::integer()) -> ok </c> -%% </p> -%% <p><c> -%% setOption(This::wxImage(), Name::string(), Value::string()) -> ok </c> -%% </p> +%% <br /> Also:<br /> +%% setOption(This, Name, Value) -> ok when<br /> +%% This::wxImage(), Name::unicode:chardata(), Value::unicode:chardata().<br /> +%% +-spec setOption(This, Name, Value) -> ok when + This::wxImage(), Name::unicode:chardata(), Value::integer(); + (This, Name, Value) -> ok when + This::wxImage(), Name::unicode:chardata(), Value::unicode:chardata(). setOption(#wx_ref{type=ThisT,ref=ThisRef},Name,Value) when is_list(Name),is_integer(Value) -> ?CLASS(ThisT,wxImage), @@ -873,32 +994,35 @@ setOption(#wx_ref{type=ThisT,ref=ThisRef},Name,Value) wxe_util:cast(?wxImage_SetOption_2_1, <<ThisRef:32/?UI,(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((0+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8,(byte_size(Value_UC)):32/?UI,(Value_UC)/binary, 0:(((8- ((4+byte_size(Value_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxImage(), Palette::wxPalette:wxPalette()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetpalette">external documentation</a>. +-spec setPalette(This, Palette) -> ok when + This::wxImage(), Palette::wxPalette:wxPalette(). setPalette(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PaletteT,ref=PaletteRef}) -> ?CLASS(ThisT,wxImage), ?CLASS(PaletteT,wxPalette), wxe_util:cast(?wxImage_SetPalette, <<ThisRef:32/?UI,PaletteRef:32/?UI>>). -%% @spec (This::wxImage(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}, R::integer(), G::integer(), B::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetrgb">external documentation</a>. +-spec setRGB(This, Rect, R, G, B) -> ok when + This::wxImage(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, R::integer(), G::integer(), B::integer(). setRGB(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH},R,G,B) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),is_integer(R),is_integer(G),is_integer(B) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_SetRGB_4, <<ThisRef:32/?UI,RectX:32/?UI,RectY:32/?UI,RectW:32/?UI,RectH:32/?UI,R:32/?UI,G:32/?UI,B:32/?UI>>). -%% @spec (This::wxImage(), X::integer(), Y::integer(), R::integer(), G::integer(), B::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wximage.html#wximagesetrgb">external documentation</a>. +-spec setRGB(This, X, Y, R, G, B) -> ok when + This::wxImage(), X::integer(), Y::integer(), R::integer(), G::integer(), B::integer(). setRGB(#wx_ref{type=ThisT,ref=ThisRef},X,Y,R,G,B) when is_integer(X),is_integer(Y),is_integer(R),is_integer(G),is_integer(B) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_SetRGB_5, <<ThisRef:32/?UI,X:32/?UI,Y:32/?UI,R:32/?UI,G:32/?UI,B:32/?UI>>). -%% @spec (This::wxImage()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxImage()) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxImage), wxe_util:destroy(?DESTROY_OBJECT,Obj), |