diff options
Diffstat (limited to 'lib/wx/src/gen/wxMenu.erl')
| -rw-r--r-- | lib/wx/src/gen/wxMenu.erl | 334 |
1 files changed, 197 insertions, 137 deletions
diff --git a/lib/wx/src/gen/wxMenu.erl b/lib/wx/src/gen/wxMenu.erl index 615a845d11..d91863de82 100644 --- a/lib/wx/src/gen/wxMenu.erl +++ b/lib/wx/src/gen/wxMenu.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 @@ -40,18 +40,21 @@ %% inherited exports -export([connect/2,connect/3,disconnect/1,disconnect/2,disconnect/3,parent_class/1]). +-export_type([wxMenu/0]). %% @hidden parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMenu() +-type wxMenu() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxMenu(). + new() -> new([]). -%% @spec ([Option]) -> wxMenu() -%% Option = {style, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuwxmenu">external documentation</a>. +-spec new([Option]) -> wxMenu() when + Option :: {style, integer()}. new(Options) when is_list(Options) -> MOpts = fun({style, Style}, Acc) -> [<<1:32/?UI,Style:32/?UI>>|Acc]; @@ -60,9 +63,10 @@ new(Options) wxe_util:construct(?wxMenu_new_1, <<BinOpt/binary>>). -%% @spec (Title::string(), [Option]) -> wxMenu() -%% Option = {style, integer()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuwxmenu">external documentation</a>. +-spec new(Title, [Option]) -> wxMenu() when + Title::unicode:chardata(), + Option :: {style, integer()}. new(Title, Options) when is_list(Title),is_list(Options) -> Title_UC = unicode:characters_to_binary([Title,0]), @@ -72,31 +76,37 @@ new(Title, Options) wxe_util:construct(?wxMenu_new_2, <<(byte_size(Title_UC)):32/?UI,(Title_UC)/binary, 0:(((8- ((4+byte_size(Title_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuappend">external documentation</a>. +-spec append(This, Item) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Item::wxMenuItem:wxMenuItem(). append(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> ?CLASS(ThisT,wxMenu), ?CLASS(ItemT,wxMenuItem), wxe_util:call(?wxMenu_Append_1, <<ThisRef:32/?UI,ItemRef:32/?UI>>). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem:wxMenuItem() %% @equiv append(This,Itemid,Text, []) +-spec append(This, Itemid, Text) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(). + append(This,Itemid,Text) when is_record(This, wx_ref),is_integer(Itemid),is_list(Text) -> append(This,Itemid,Text, []). -%% @spec (This::wxMenu(),Itemid::integer(),Text::string(),X::wxMenu()|term()) -> wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuappend">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% append(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu()) -> append(This,Itemid,Text,Submenu, []) </c></p> -%% <p><c> -%% append(This::wxMenu(), Itemid::integer(), Text::string(), [Option]) -> wxMenuItem:wxMenuItem() </c> -%%<br /> Option = {help, string()} | {kind, WxItemKind} -%%<br /> WxItemKind = integer() -%%<br /> WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -%% </p> +%% <br /> Also:<br /> +%% append(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when<br /> +%% This::wxMenu(), Itemid::integer(), Text::unicode:chardata(),<br /> +%% Option :: {help, unicode:chardata()}<br /> +%% | {kind, wx:wx_enum()}.<br /> +%% +%%<br /> Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +-spec append(This, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(); + (This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), + Option :: {help, unicode:chardata()} + | {kind, wx:wx_enum()}. append(This,Itemid,Text,Submenu) when is_record(This, wx_ref),is_integer(Itemid),is_list(Text),is_record(Submenu, wx_ref) -> @@ -112,16 +122,17 @@ append(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_Append_3, <<ThisRef:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((4+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxMenu(),Itemid::integer(),Text::string(),X::string()|wxMenu(),X::bool()|term()) -> ok|wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuappend">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% append(This::wxMenu(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::bool()) -> ok </c> -%% </p> -%% <p><c> -%% append(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu(), [Option]) -> wxMenuItem:wxMenuItem() </c> -%%<br /> Option = {help, string()} -%% </p> +%% <br /> Also:<br /> +%% append(This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when<br /> +%% This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),<br /> +%% Option :: {help, unicode:chardata()}.<br /> +%% +-spec append(This, Itemid, Text, Help, IsCheckable) -> ok when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Help::unicode:chardata(), IsCheckable::boolean(); + (This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(), + Option :: {help, unicode:chardata()}. append(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text,Help,IsCheckable) when is_integer(Itemid),is_list(Text),is_list(Help),is_boolean(IsCheckable) -> ?CLASS(ThisT,wxMenu), @@ -140,15 +151,18 @@ append(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text,#wx_ref{type=SubmenuT,ref=Sub wxe_util:call(?wxMenu_Append_4_1, <<ThisRef:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((4+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8,SubmenuRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem:wxMenuItem() %% @equiv appendCheckItem(This,Itemid,Text, []) +-spec appendCheckItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(). + appendCheckItem(This,Itemid,Text) when is_record(This, wx_ref),is_integer(Itemid),is_list(Text) -> appendCheckItem(This,Itemid,Text, []). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {help, string()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuappendcheckitem">external documentation</a>. +-spec appendCheckItem(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), + Option :: {help, unicode:chardata()}. appendCheckItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) when is_integer(Itemid),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxMenu), @@ -159,15 +173,18 @@ appendCheckItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_AppendCheckItem, <<ThisRef:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((4+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem:wxMenuItem() %% @equiv appendRadioItem(This,Itemid,Text, []) +-spec appendRadioItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(). + appendRadioItem(This,Itemid,Text) when is_record(This, wx_ref),is_integer(Itemid),is_list(Text) -> appendRadioItem(This,Itemid,Text, []). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {help, string()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuappendradioitem">external documentation</a>. +-spec appendRadioItem(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), + Option :: {help, unicode:chardata()}. appendRadioItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) when is_integer(Itemid),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxMenu), @@ -178,37 +195,40 @@ appendRadioItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_AppendRadioItem, <<ThisRef:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((4+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxMenu()) -> wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuappendseparator">external documentation</a>. +-spec appendSeparator(This) -> wxMenuItem:wxMenuItem() when + This::wxMenu(). appendSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_AppendSeparator, <<ThisRef:32/?UI>>). -%% @spec (This::wxMenu()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenubreak">external documentation</a>. +-spec break(This) -> ok when + This::wxMenu(). break(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:cast(?wxMenu_Break, <<ThisRef:32/?UI>>). -%% @spec (This::wxMenu(), Itemid::integer(), Check::bool()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenucheck">external documentation</a>. +-spec check(This, Itemid, Check) -> ok when + This::wxMenu(), Itemid::integer(), Check::boolean(). check(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Check) when is_integer(Itemid),is_boolean(Check) -> ?CLASS(ThisT,wxMenu), wxe_util:cast(?wxMenu_Check, <<ThisRef:32/?UI,Itemid:32/?UI,(wxe_util:from_bool(Check)):32/?UI>>). -%% @spec (This::wxMenu(),X::integer()|term()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenudelete">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% delete(This::wxMenu(), Itemid::integer()) -> bool() </c> -%% </p> -%% <p><c> -%% delete(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> bool() </c> -%% </p> +%% <br /> Also:<br /> +%% delete(This, Item) -> boolean() when<br /> +%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().<br /> +%% +-spec delete(This, Itemid) -> boolean() when + This::wxMenu(), Itemid::integer(); + (This, Item) -> boolean() when + This::wxMenu(), Item::wxMenuItem:wxMenuItem(). delete(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenu), @@ -220,15 +240,15 @@ delete(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> wxe_util:call(?wxMenu_Delete_1_1, <<ThisRef:32/?UI,ItemRef:32/?UI>>). -%% @spec (This::wxMenu(),X::integer()|term()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenudestroy">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% 'Destroy'(This::wxMenu(), Itemid::integer()) -> bool() </c> -%% </p> -%% <p><c> -%% 'Destroy'(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> bool() </c> -%% </p> +%% <br /> Also:<br /> +%% 'Destroy'(This, Item) -> boolean() when<br /> +%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().<br /> +%% +-spec 'Destroy'(This, Itemid) -> boolean() when + This::wxMenu(), Itemid::integer(); + (This, Item) -> boolean() when + This::wxMenu(), Item::wxMenuItem:wxMenuItem(). 'Destroy'(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenu), @@ -240,23 +260,24 @@ delete(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> wxe_util:call(?wxMenu_Destroy_1_1, <<ThisRef:32/?UI,ItemRef:32/?UI>>). -%% @spec (This::wxMenu(), Itemid::integer(), Enable::bool()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuenable">external documentation</a>. +-spec enable(This, Itemid, Enable) -> ok when + This::wxMenu(), Itemid::integer(), Enable::boolean(). enable(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Enable) when is_integer(Itemid),is_boolean(Enable) -> ?CLASS(ThisT,wxMenu), wxe_util:cast(?wxMenu_Enable, <<ThisRef:32/?UI,Itemid:32/?UI,(wxe_util:from_bool(Enable)):32/?UI>>). -%% @spec (This::wxMenu(),X::integer()|string()) -> wxMenuItem:wxMenuItem()|integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenufinditem">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% findItem(This::wxMenu(), Itemid::integer()) -> wxMenuItem:wxMenuItem() </c> -%% </p> -%% <p><c> -%% findItem(This::wxMenu(), Item::string()) -> integer() </c> -%% </p> +%% <br /> Also:<br /> +%% findItem(This, Item) -> integer() when<br /> +%% This::wxMenu(), Item::unicode:chardata().<br /> +%% +-spec findItem(This, Itemid) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(); + (This, Item) -> integer() when + This::wxMenu(), Item::unicode:chardata(). findItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenu), @@ -269,59 +290,67 @@ findItem(#wx_ref{type=ThisT,ref=ThisRef},Item) wxe_util:call(?wxMenu_FindItem_1, <<ThisRef:32/?UI,(byte_size(Item_UC)):32/?UI,(Item_UC)/binary, 0:(((8- ((0+byte_size(Item_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxMenu(), Position::integer()) -> wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenufinditembyposition">external documentation</a>. +-spec findItemByPosition(This, Position) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Position::integer(). findItemByPosition(#wx_ref{type=ThisT,ref=ThisRef},Position) when is_integer(Position) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_FindItemByPosition, <<ThisRef:32/?UI,Position:32/?UI>>). -%% @spec (This::wxMenu(), Itemid::integer()) -> string() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenugethelpstring">external documentation</a>. +-spec getHelpString(This, Itemid) -> unicode:charlist() when + This::wxMenu(), Itemid::integer(). getHelpString(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_GetHelpString, <<ThisRef:32/?UI,Itemid:32/?UI>>). -%% @spec (This::wxMenu(), Itemid::integer()) -> string() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenugetlabel">external documentation</a>. +-spec getLabel(This, Itemid) -> unicode:charlist() when + This::wxMenu(), Itemid::integer(). getLabel(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_GetLabel, <<ThisRef:32/?UI,Itemid:32/?UI>>). -%% @spec (This::wxMenu()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenugetmenuitemcount">external documentation</a>. +-spec getMenuItemCount(This) -> integer() when + This::wxMenu(). getMenuItemCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_GetMenuItemCount, <<ThisRef:32/?UI>>). -%% @spec (This::wxMenu()) -> [wxMenuItem:wxMenuItem()] %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenugetmenuitems">external documentation</a>. +-spec getMenuItems(This) -> [wxMenuItem:wxMenuItem()] when + This::wxMenu(). getMenuItems(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_GetMenuItems, <<ThisRef:32/?UI>>). -%% @spec (This::wxMenu()) -> string() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenugettitle">external documentation</a>. +-spec getTitle(This) -> unicode:charlist() when + This::wxMenu(). getTitle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_GetTitle, <<ThisRef:32/?UI>>). -%% @spec (This::wxMenu(),Pos::integer(),X::integer()|term()) -> wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuinsert">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% insert(This::wxMenu(), Pos::integer(), Itemid::integer()) -> insert(This,Pos,Itemid, []) </c></p> -%% <p><c> -%% insert(This::wxMenu(), Pos::integer(), Item::wxMenuItem:wxMenuItem()) -> wxMenuItem:wxMenuItem() </c> -%% </p> +%% <br /> Also:<br /> +%% insert(This, Pos, Item) -> wxMenuItem:wxMenuItem() when<br /> +%% This::wxMenu(), Pos::integer(), Item::wxMenuItem:wxMenuItem().<br /> +%% +%%<br /> Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +-spec insert(This, Pos, Itemid) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(); + (This, Pos, Item) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Item::wxMenuItem:wxMenuItem(). insert(This,Pos,Itemid) when is_record(This, wx_ref),is_integer(Pos),is_integer(Itemid) -> @@ -333,11 +362,13 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=ItemT,ref=ItemRef}) wxe_util:call(?wxMenu_Insert_2, <<ThisRef:32/?UI,Pos:32/?UI,ItemRef:32/?UI>>). -%% @spec (This::wxMenu(), Pos::integer(), Itemid::integer(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {text, string()} | {help, string()} | {kind, WxItemKind} -%% WxItemKind = integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuinsert">external documentation</a>. -%%<br /> WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +%%<br /> Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +-spec insert(This, Pos, Itemid, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), + Option :: {text, unicode:chardata()} + | {help, unicode:chardata()} + | {kind, wx:wx_enum()}. insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid, Options) when is_integer(Pos),is_integer(Itemid),is_list(Options) -> ?CLASS(ThisT,wxMenu), @@ -349,22 +380,25 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid, Options) wxe_util:call(?wxMenu_Insert_3, <<ThisRef:32/?UI,Pos:32/?UI,Itemid:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Submenu::wxMenu()) -> wxMenuItem:wxMenuItem() %% @equiv insert(This,Pos,Itemid,Text,Submenu, []) +-spec insert(This, Pos, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(). + insert(This,Pos,Itemid,Text,Submenu) when is_record(This, wx_ref),is_integer(Pos),is_integer(Itemid),is_list(Text),is_record(Submenu, wx_ref) -> insert(This,Pos,Itemid,Text,Submenu, []). -%% @spec (This::wxMenu(),Pos::integer(),Itemid::integer(),Text::string(),X::string()|wxMenu(),X::bool()|term()) -> ok|wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuinsert">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% insert(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::bool()) -> ok </c> -%% </p> -%% <p><c> -%% insert(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Submenu::wxMenu(), [Option]) -> wxMenuItem:wxMenuItem() </c> -%%<br /> Option = {help, string()} -%% </p> +%% <br /> Also:<br /> +%% insert(This, Pos, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when<br /> +%% This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),<br /> +%% Option :: {help, unicode:chardata()}.<br /> +%% +-spec insert(This, Pos, Itemid, Text, Help, IsCheckable) -> ok when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), Help::unicode:chardata(), IsCheckable::boolean(); + (This, Pos, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(), + Option :: {help, unicode:chardata()}. insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid,Text,Help,IsCheckable) when is_integer(Pos),is_integer(Itemid),is_list(Text),is_list(Help),is_boolean(IsCheckable) -> ?CLASS(ThisT,wxMenu), @@ -383,15 +417,18 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid,Text,#wx_ref{type=SubmenuT,ref wxe_util:call(?wxMenu_Insert_5_1, <<ThisRef:32/?UI,Pos:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((0+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8,SubmenuRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string()) -> wxMenuItem:wxMenuItem() %% @equiv insertCheckItem(This,Pos,Itemid,Text, []) +-spec insertCheckItem(This, Pos, Itemid, Text) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(). + insertCheckItem(This,Pos,Itemid,Text) when is_record(This, wx_ref),is_integer(Pos),is_integer(Itemid),is_list(Text) -> insertCheckItem(This,Pos,Itemid,Text, []). -%% @spec (This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {help, string()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuinsertcheckitem">external documentation</a>. +-spec insertCheckItem(This, Pos, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), + Option :: {help, unicode:chardata()}. insertCheckItem(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid,Text, Options) when is_integer(Pos),is_integer(Itemid),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxMenu), @@ -402,15 +439,18 @@ insertCheckItem(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid,Text, Options) wxe_util:call(?wxMenu_InsertCheckItem, <<ThisRef:32/?UI,Pos:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((0+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string()) -> wxMenuItem:wxMenuItem() %% @equiv insertRadioItem(This,Pos,Itemid,Text, []) +-spec insertRadioItem(This, Pos, Itemid, Text) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(). + insertRadioItem(This,Pos,Itemid,Text) when is_record(This, wx_ref),is_integer(Pos),is_integer(Itemid),is_list(Text) -> insertRadioItem(This,Pos,Itemid,Text, []). -%% @spec (This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {help, string()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuinsertradioitem">external documentation</a>. +-spec insertRadioItem(This, Pos, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), + Option :: {help, unicode:chardata()}. insertRadioItem(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid,Text, Options) when is_integer(Pos),is_integer(Itemid),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxMenu), @@ -421,38 +461,43 @@ insertRadioItem(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid,Text, Options) wxe_util:call(?wxMenu_InsertRadioItem, <<ThisRef:32/?UI,Pos:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((0+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxMenu(), Pos::integer()) -> wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuinsertseparator">external documentation</a>. +-spec insertSeparator(This, Pos) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(). insertSeparator(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_InsertSeparator, <<ThisRef:32/?UI,Pos:32/?UI>>). -%% @spec (This::wxMenu(), Itemid::integer()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuischecked">external documentation</a>. +-spec isChecked(This, Itemid) -> boolean() when + This::wxMenu(), Itemid::integer(). isChecked(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_IsChecked, <<ThisRef:32/?UI,Itemid:32/?UI>>). -%% @spec (This::wxMenu(), Itemid::integer()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuisenabled">external documentation</a>. +-spec isEnabled(This, Itemid) -> boolean() when + This::wxMenu(), Itemid::integer(). isEnabled(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_IsEnabled, <<ThisRef:32/?UI,Itemid:32/?UI>>). -%% @spec (This::wxMenu(),X::integer()|term()) -> wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuprepend">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% prepend(This::wxMenu(), Itemid::integer()) -> prepend(This,Itemid, []) </c></p> -%% <p><c> -%% prepend(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> wxMenuItem:wxMenuItem() </c> -%% </p> +%% <br /> Also:<br /> +%% prepend(This, Item) -> wxMenuItem:wxMenuItem() when<br /> +%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().<br /> +%% +%%<br /> Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +-spec prepend(This, Itemid) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(); + (This, Item) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Item::wxMenuItem:wxMenuItem(). prepend(This,Itemid) when is_record(This, wx_ref),is_integer(Itemid) -> @@ -463,11 +508,13 @@ prepend(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> wxe_util:call(?wxMenu_Prepend_1, <<ThisRef:32/?UI,ItemRef:32/?UI>>). -%% @spec (This::wxMenu(), Itemid::integer(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {text, string()} | {help, string()} | {kind, WxItemKind} -%% WxItemKind = integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuprepend">external documentation</a>. -%%<br /> WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +%%<br /> Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +-spec prepend(This, Itemid, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), + Option :: {text, unicode:chardata()} + | {help, unicode:chardata()} + | {kind, wx:wx_enum()}. prepend(#wx_ref{type=ThisT,ref=ThisRef},Itemid, Options) when is_integer(Itemid),is_list(Options) -> ?CLASS(ThisT,wxMenu), @@ -479,22 +526,25 @@ prepend(#wx_ref{type=ThisT,ref=ThisRef},Itemid, Options) wxe_util:call(?wxMenu_Prepend_2, <<ThisRef:32/?UI,Itemid:32/?UI, BinOpt/binary>>). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu()) -> wxMenuItem:wxMenuItem() %% @equiv prepend(This,Itemid,Text,Submenu, []) +-spec prepend(This, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(). + prepend(This,Itemid,Text,Submenu) when is_record(This, wx_ref),is_integer(Itemid),is_list(Text),is_record(Submenu, wx_ref) -> prepend(This,Itemid,Text,Submenu, []). -%% @spec (This::wxMenu(),Itemid::integer(),Text::string(),X::string()|wxMenu(),X::bool()|term()) -> ok|wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuprepend">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% prepend(This::wxMenu(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::bool()) -> ok </c> -%% </p> -%% <p><c> -%% prepend(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu(), [Option]) -> wxMenuItem:wxMenuItem() </c> -%%<br /> Option = {help, string()} -%% </p> +%% <br /> Also:<br /> +%% prepend(This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when<br /> +%% This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),<br /> +%% Option :: {help, unicode:chardata()}.<br /> +%% +-spec prepend(This, Itemid, Text, Help, IsCheckable) -> ok when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Help::unicode:chardata(), IsCheckable::boolean(); + (This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(), + Option :: {help, unicode:chardata()}. prepend(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text,Help,IsCheckable) when is_integer(Itemid),is_list(Text),is_list(Help),is_boolean(IsCheckable) -> ?CLASS(ThisT,wxMenu), @@ -513,15 +563,18 @@ prepend(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text,#wx_ref{type=SubmenuT,ref=Su wxe_util:call(?wxMenu_Prepend_4_1, <<ThisRef:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((4+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8,SubmenuRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem:wxMenuItem() %% @equiv prependCheckItem(This,Itemid,Text, []) +-spec prependCheckItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(). + prependCheckItem(This,Itemid,Text) when is_record(This, wx_ref),is_integer(Itemid),is_list(Text) -> prependCheckItem(This,Itemid,Text, []). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {help, string()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuprependcheckitem">external documentation</a>. +-spec prependCheckItem(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), + Option :: {help, unicode:chardata()}. prependCheckItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) when is_integer(Itemid),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxMenu), @@ -532,15 +585,18 @@ prependCheckItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_PrependCheckItem, <<ThisRef:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((4+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string()) -> wxMenuItem:wxMenuItem() %% @equiv prependRadioItem(This,Itemid,Text, []) +-spec prependRadioItem(This, Itemid, Text) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(). + prependRadioItem(This,Itemid,Text) when is_record(This, wx_ref),is_integer(Itemid),is_list(Text) -> prependRadioItem(This,Itemid,Text, []). -%% @spec (This::wxMenu(), Itemid::integer(), Text::string(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {help, string()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuprependradioitem">external documentation</a>. +-spec prependRadioItem(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), + Option :: {help, unicode:chardata()}. prependRadioItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) when is_integer(Itemid),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxMenu), @@ -551,22 +607,23 @@ prependRadioItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_PrependRadioItem, <<ThisRef:32/?UI,Itemid:32/?UI,(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((4+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxMenu()) -> wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuprependseparator">external documentation</a>. +-spec prependSeparator(This) -> wxMenuItem:wxMenuItem() when + This::wxMenu(). prependSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_PrependSeparator, <<ThisRef:32/?UI>>). -%% @spec (This::wxMenu(),X::integer()|term()) -> wxMenuItem:wxMenuItem() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenuremove">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% remove(This::wxMenu(), Itemid::integer()) -> wxMenuItem:wxMenuItem() </c> -%% </p> -%% <p><c> -%% remove(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> wxMenuItem:wxMenuItem() </c> -%% </p> +%% <br /> Also:<br /> +%% remove(This, Item) -> wxMenuItem:wxMenuItem() when<br /> +%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().<br /> +%% +-spec remove(This, Itemid) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(); + (This, Item) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Item::wxMenuItem:wxMenuItem(). remove(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenu), @@ -578,8 +635,9 @@ remove(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> wxe_util:call(?wxMenu_Remove_1_1, <<ThisRef:32/?UI,ItemRef:32/?UI>>). -%% @spec (This::wxMenu(), Itemid::integer(), HelpString::string()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenusethelpstring">external documentation</a>. +-spec setHelpString(This, Itemid, HelpString) -> ok when + This::wxMenu(), Itemid::integer(), HelpString::unicode:chardata(). setHelpString(#wx_ref{type=ThisT,ref=ThisRef},Itemid,HelpString) when is_integer(Itemid),is_list(HelpString) -> ?CLASS(ThisT,wxMenu), @@ -587,8 +645,9 @@ setHelpString(#wx_ref{type=ThisT,ref=ThisRef},Itemid,HelpString) wxe_util:cast(?wxMenu_SetHelpString, <<ThisRef:32/?UI,Itemid:32/?UI,(byte_size(HelpString_UC)):32/?UI,(HelpString_UC)/binary, 0:(((8- ((4+byte_size(HelpString_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxMenu(), Itemid::integer(), Label::string()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenusetlabel">external documentation</a>. +-spec setLabel(This, Itemid, Label) -> ok when + This::wxMenu(), Itemid::integer(), Label::unicode:chardata(). setLabel(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Label) when is_integer(Itemid),is_list(Label) -> ?CLASS(ThisT,wxMenu), @@ -596,8 +655,9 @@ setLabel(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Label) wxe_util:cast(?wxMenu_SetLabel, <<ThisRef:32/?UI,Itemid:32/?UI,(byte_size(Label_UC)):32/?UI,(Label_UC)/binary, 0:(((8- ((4+byte_size(Label_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxMenu(), Title::string()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxmenu.html#wxmenusettitle">external documentation</a>. +-spec setTitle(This, Title) -> ok when + This::wxMenu(), Title::unicode:chardata(). setTitle(#wx_ref{type=ThisT,ref=ThisRef},Title) when is_list(Title) -> ?CLASS(ThisT,wxMenu), @@ -605,8 +665,8 @@ setTitle(#wx_ref{type=ThisT,ref=ThisRef},Title) wxe_util:cast(?wxMenu_SetTitle, <<ThisRef:32/?UI,(byte_size(Title_UC)):32/?UI,(Title_UC)/binary, 0:(((8- ((0+byte_size(Title_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxMenu()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMenu()) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMenu), wxe_util:destroy(?DESTROY_OBJECT,Obj), |