[wx] Generated types for all wx classes

1 files changed, 84 insertions, 39 deletions

diff --git a/lib/wx/src/gen/wxNotebook.erl b/lib/wx/src/gen/wxNotebook.erl
index b918de5bb4..da0b9c13bf 100644
--- a/lib/wx/src/gen/wxNotebook.erl
+++ b/lib/wx/src/gen/wxNotebook.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
@@ -74,27 +74,34 @@
   show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1,
   update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]).
 
+-export_type([wxNotebook/0]).
 %% @hidden
 parent_class(wxControl) -> true;
 parent_class(wxWindow) -> true;
 parent_class(wxEvtHandler) -> true;
 parent_class(_Class) -> erlang:error({badtype, ?MODULE}).
 
-%% @spec () -> wxNotebook()
+-type wxNotebook() :: wx:wx_object().
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookwxnotebook">external documentation</a>.
+-spec new() -> wxNotebook().
 new() ->
   wxe_util:construct(?wxNotebook_new_0,
   <<>>).
 
-%% @spec (Parent::wxWindow:wxWindow(), Winid::integer()) -> wxNotebook()
 %% @equiv new(Parent,Winid, [])
+-spec new(Parent, Winid) -> wxNotebook() when
+	Parent::wxWindow:wxWindow(), Winid::integer().
+
 new(Parent,Winid)
  when is_record(Parent, wx_ref),is_integer(Winid) ->
   new(Parent,Winid, []).
 
-%% @spec (Parent::wxWindow:wxWindow(), Winid::integer(), [Option]) -> wxNotebook()
-%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()}
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookwxnotebook">external documentation</a>.
+-spec new(Parent, Winid, [Option]) -> wxNotebook() when
+	Parent::wxWindow:wxWindow(), Winid::integer(),
+	Option :: {pos, {X::integer(), Y::integer()}}
+		 | {size, {W::integer(), H::integer()}}
+		 | {style, integer()}.
 new(#wx_ref{type=ParentT,ref=ParentRef},Winid, Options)
  when is_integer(Winid),is_list(Options) ->
   ?CLASS(ParentT,wxWindow),
@@ -106,15 +113,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Winid, Options)
   wxe_util:construct(?wxNotebook_new_3,
   <<ParentRef:32/?UI,Winid:32/?UI, BinOpt/binary>>).
 
-%% @spec (This::wxNotebook(), Page::wxWindow:wxWindow(), Text::string()) -> bool()
 %% @equiv addPage(This,Page,Text, [])
+-spec addPage(This, Page, Text) -> boolean() when
+	This::wxNotebook(), Page::wxWindow:wxWindow(), Text::string().
+
 addPage(This,Page,Text)
  when is_record(This, wx_ref),is_record(Page, wx_ref),is_list(Text) ->
   addPage(This,Page,Text, []).
 
-%% @spec (This::wxNotebook(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool()
-%% Option = {bSelect, bool()} | {imageId, integer()}
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookaddpage">external documentation</a>.
+-spec addPage(This, Page, Text, [Option]) -> boolean() when
+	This::wxNotebook(), Page::wxWindow:wxWindow(), Text::string(),
+	Option :: {bSelect, boolean()}
+		 | {imageId, integer()}.
 addPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageT,ref=PageRef},Text, Options)
  when is_list(Text),is_list(Options) ->
   ?CLASS(ThisT,wxNotebook),
@@ -127,15 +138,18 @@ addPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageT,ref=PageRef},Text, Op
   wxe_util:call(?wxNotebook_AddPage,
   <<ThisRef:32/?UI,PageRef: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::wxNotebook()) -> ok
 %% @equiv advanceSelection(This, [])
+-spec advanceSelection(This) -> ok when
+	This::wxNotebook().
+
 advanceSelection(This)
  when is_record(This, wx_ref) ->
   advanceSelection(This, []).
 
-%% @spec (This::wxNotebook(), [Option]) -> ok
-%% Option = {forward, bool()}
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookadvanceselection">external documentation</a>.
+-spec advanceSelection(This, [Option]) -> ok when
+	This::wxNotebook(),
+	Option :: {forward, boolean()}.
 advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options)
  when is_list(Options) ->
   ?CLASS(ThisT,wxNotebook),
@@ -145,23 +159,29 @@ advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options)
   wxe_util:cast(?wxNotebook_AdvanceSelection,
   <<ThisRef:32/?UI, 0:32,BinOpt/binary>>).
 
-%% @spec (This::wxNotebook(), ImageList::wxImageList:wxImageList()) -> ok
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookassignimagelist">external documentation</a>.
+-spec assignImageList(This, ImageList) -> ok when
+	This::wxNotebook(), ImageList::wxImageList:wxImageList().
 assignImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) ->
   ?CLASS(ThisT,wxNotebook),
   ?CLASS(ImageListT,wxImageList),
   wxe_util:cast(?wxNotebook_AssignImageList,
   <<ThisRef:32/?UI,ImageListRef:32/?UI>>).
 
-%% @spec (This::wxNotebook(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool()
 %% @equiv create(This,Parent,Id, [])
+-spec create(This, Parent, Id) -> boolean() when
+	This::wxNotebook(), Parent::wxWindow:wxWindow(), Id::integer().
+
 create(This,Parent,Id)
  when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id) ->
   create(This,Parent,Id, []).
 
-%% @spec (This::wxNotebook(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool()
-%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()}
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookcreate">external documentation</a>.
+-spec create(This, Parent, Id, [Option]) -> boolean() when
+	This::wxNotebook(), Parent::wxWindow:wxWindow(), Id::integer(),
+	Option :: {pos, {X::integer(), Y::integer()}}
+		 | {size, {W::integer(), H::integer()}}
+		 | {style, integer()}.
 create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, Options)
  when is_integer(Id),is_list(Options) ->
   ?CLASS(ThisT,wxNotebook),
@@ -174,112 +194,130 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O
   wxe_util:call(?wxNotebook_Create,
   <<ThisRef:32/?UI,ParentRef:32/?UI,Id:32/?UI, 0:32,BinOpt/binary>>).
 
-%% @spec (This::wxNotebook()) -> bool()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookdeleteallpages">external documentation</a>.
+-spec deleteAllPages(This) -> boolean() when
+	This::wxNotebook().
 deleteAllPages(#wx_ref{type=ThisT,ref=ThisRef}) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_DeleteAllPages,
   <<ThisRef:32/?UI>>).
 
-%% @spec (This::wxNotebook(), NPage::integer()) -> bool()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookdeletepage">external documentation</a>.
+-spec deletePage(This, NPage) -> boolean() when
+	This::wxNotebook(), NPage::integer().
 deletePage(#wx_ref{type=ThisT,ref=ThisRef},NPage)
  when is_integer(NPage) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_DeletePage,
   <<ThisRef:32/?UI,NPage:32/?UI>>).
 
-%% @spec (This::wxNotebook(), NPage::integer()) -> bool()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookremovepage">external documentation</a>.
+-spec removePage(This, NPage) -> boolean() when
+	This::wxNotebook(), NPage::integer().
 removePage(#wx_ref{type=ThisT,ref=ThisRef},NPage)
  when is_integer(NPage) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_RemovePage,
   <<ThisRef:32/?UI,NPage:32/?UI>>).
 
-%% @spec (This::wxNotebook()) -> wxWindow:wxWindow()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetcurrentpage">external documentation</a>.
+-spec getCurrentPage(This) -> wxWindow:wxWindow() when
+	This::wxNotebook().
 getCurrentPage(#wx_ref{type=ThisT,ref=ThisRef}) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_GetCurrentPage,
   <<ThisRef:32/?UI>>).
 
-%% @spec (This::wxNotebook()) -> wxImageList:wxImageList()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetimagelist">external documentation</a>.
+-spec getImageList(This) -> wxImageList:wxImageList() when
+	This::wxNotebook().
 getImageList(#wx_ref{type=ThisT,ref=ThisRef}) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_GetImageList,
   <<ThisRef:32/?UI>>).
 
-%% @spec (This::wxNotebook(), N::integer()) -> wxWindow:wxWindow()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetpage">external documentation</a>.
+-spec getPage(This, N) -> wxWindow:wxWindow() when
+	This::wxNotebook(), N::integer().
 getPage(#wx_ref{type=ThisT,ref=ThisRef},N)
  when is_integer(N) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_GetPage,
   <<ThisRef:32/?UI,N:32/?UI>>).
 
-%% @spec (This::wxNotebook()) -> integer()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetpagecount">external documentation</a>.
+-spec getPageCount(This) -> integer() when
+	This::wxNotebook().
 getPageCount(#wx_ref{type=ThisT,ref=ThisRef}) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_GetPageCount,
   <<ThisRef:32/?UI>>).
 
-%% @spec (This::wxNotebook(), NPage::integer()) -> integer()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetpageimage">external documentation</a>.
+-spec getPageImage(This, NPage) -> integer() when
+	This::wxNotebook(), NPage::integer().
 getPageImage(#wx_ref{type=ThisT,ref=ThisRef},NPage)
  when is_integer(NPage) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_GetPageImage,
   <<ThisRef:32/?UI,NPage:32/?UI>>).
 
-%% @spec (This::wxNotebook(), NPage::integer()) -> string()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetpagetext">external documentation</a>.
+-spec getPageText(This, NPage) -> string() when
+	This::wxNotebook(), NPage::integer().
 getPageText(#wx_ref{type=ThisT,ref=ThisRef},NPage)
  when is_integer(NPage) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_GetPageText,
   <<ThisRef:32/?UI,NPage:32/?UI>>).
 
-%% @spec (This::wxNotebook()) -> integer()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetrowcount">external documentation</a>.
+-spec getRowCount(This) -> integer() when
+	This::wxNotebook().
 getRowCount(#wx_ref{type=ThisT,ref=ThisRef}) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_GetRowCount,
   <<ThisRef:32/?UI>>).
 
-%% @spec (This::wxNotebook()) -> integer()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetselection">external documentation</a>.
+-spec getSelection(This) -> integer() when
+	This::wxNotebook().
 getSelection(#wx_ref{type=ThisT,ref=ThisRef}) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_GetSelection,
   <<ThisRef:32/?UI>>).
 
-%% @spec (This::wxNotebook()) -> wx:colour()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetthemebackgroundcolour">external documentation</a>.
+-spec getThemeBackgroundColour(This) -> wx:wx_colour() when
+	This::wxNotebook().
 getThemeBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_GetThemeBackgroundColour,
   <<ThisRef:32/?UI>>).
 
-%% @spec (This::wxNotebook(), Pt::{X::integer(), Y::integer()}) -> {integer(), Flags::integer()}
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookhittest">external documentation</a>.
+-spec hitTest(This, Pt) -> Result when
+	Result ::{Res ::integer(), Flags::integer()},
+	This::wxNotebook(), Pt::{X::integer(), Y::integer()}.
 hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY})
  when is_integer(PtX),is_integer(PtY) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_HitTest,
   <<ThisRef:32/?UI,PtX:32/?UI,PtY:32/?UI>>).
 
-%% @spec (This::wxNotebook(), Position::integer(), Win::wxWindow:wxWindow(), StrText::string()) -> bool()
 %% @equiv insertPage(This,Position,Win,StrText, [])
+-spec insertPage(This, Position, Win, StrText) -> boolean() when
+	This::wxNotebook(), Position::integer(), Win::wxWindow:wxWindow(), StrText::string().
+
 insertPage(This,Position,Win,StrText)
  when is_record(This, wx_ref),is_integer(Position),is_record(Win, wx_ref),is_list(StrText) ->
   insertPage(This,Position,Win,StrText, []).
 
-%% @spec (This::wxNotebook(), Position::integer(), Win::wxWindow:wxWindow(), StrText::string(), [Option]) -> bool()
-%% Option = {bSelect, bool()} | {imageId, integer()}
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookinsertpage">external documentation</a>.
+-spec insertPage(This, Position, Win, StrText, [Option]) -> boolean() when
+	This::wxNotebook(), Position::integer(), Win::wxWindow:wxWindow(), StrText::string(),
+	Option :: {bSelect, boolean()}
+		 | {imageId, integer()}.
 insertPage(#wx_ref{type=ThisT,ref=ThisRef},Position,#wx_ref{type=WinT,ref=WinRef},StrText, Options)
  when is_integer(Position),is_list(StrText),is_list(Options) ->
   ?CLASS(ThisT,wxNotebook),
@@ -292,40 +330,45 @@ insertPage(#wx_ref{type=ThisT,ref=ThisRef},Position,#wx_ref{type=WinT,ref=WinRef
   wxe_util:call(?wxNotebook_InsertPage,
   <<ThisRef:32/?UI,Position:32/?UI,WinRef:32/?UI,(byte_size(StrText_UC)):32/?UI,(StrText_UC)/binary, 0:(((8- ((0+byte_size(StrText_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>).
 
-%% @spec (This::wxNotebook(), ImageList::wxImageList:wxImageList()) -> ok
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetimagelist">external documentation</a>.
+-spec setImageList(This, ImageList) -> ok when
+	This::wxNotebook(), ImageList::wxImageList:wxImageList().
 setImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) ->
   ?CLASS(ThisT,wxNotebook),
   ?CLASS(ImageListT,wxImageList),
   wxe_util:cast(?wxNotebook_SetImageList,
   <<ThisRef:32/?UI,ImageListRef:32/?UI>>).
 
-%% @spec (This::wxNotebook(), Padding::{W::integer(), H::integer()}) -> ok
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetpadding">external documentation</a>.
+-spec setPadding(This, Padding) -> ok when
+	This::wxNotebook(), Padding::{W::integer(), H::integer()}.
 setPadding(#wx_ref{type=ThisT,ref=ThisRef},{PaddingW,PaddingH})
  when is_integer(PaddingW),is_integer(PaddingH) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:cast(?wxNotebook_SetPadding,
   <<ThisRef:32/?UI,PaddingW:32/?UI,PaddingH:32/?UI>>).
 
-%% @spec (This::wxNotebook(), Size::{W::integer(), H::integer()}) -> ok
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetpagesize">external documentation</a>.
+-spec setPageSize(This, Size) -> ok when
+	This::wxNotebook(), Size::{W::integer(), H::integer()}.
 setPageSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH})
  when is_integer(SizeW),is_integer(SizeH) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:cast(?wxNotebook_SetPageSize,
   <<ThisRef:32/?UI,SizeW:32/?UI,SizeH:32/?UI>>).
 
-%% @spec (This::wxNotebook(), NPage::integer(), NImage::integer()) -> bool()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetpageimage">external documentation</a>.
+-spec setPageImage(This, NPage, NImage) -> boolean() when
+	This::wxNotebook(), NPage::integer(), NImage::integer().
 setPageImage(#wx_ref{type=ThisT,ref=ThisRef},NPage,NImage)
  when is_integer(NPage),is_integer(NImage) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_SetPageImage,
   <<ThisRef:32/?UI,NPage:32/?UI,NImage:32/?UI>>).
 
-%% @spec (This::wxNotebook(), NPage::integer(), StrText::string()) -> bool()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetpagetext">external documentation</a>.
+-spec setPageText(This, NPage, StrText) -> boolean() when
+	This::wxNotebook(), NPage::integer(), StrText::string().
 setPageText(#wx_ref{type=ThisT,ref=ThisRef},NPage,StrText)
  when is_integer(NPage),is_list(StrText) ->
   ?CLASS(ThisT,wxNotebook),
@@ -333,24 +376,26 @@ setPageText(#wx_ref{type=ThisT,ref=ThisRef},NPage,StrText)
   wxe_util:call(?wxNotebook_SetPageText,
   <<ThisRef:32/?UI,NPage:32/?UI,(byte_size(StrText_UC)):32/?UI,(StrText_UC)/binary, 0:(((8- ((4+byte_size(StrText_UC)) band 16#7)) band 16#7))/unit:8>>).
 
-%% @spec (This::wxNotebook(), NPage::integer()) -> integer()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetselection">external documentation</a>.
+-spec setSelection(This, NPage) -> integer() when
+	This::wxNotebook(), NPage::integer().
 setSelection(#wx_ref{type=ThisT,ref=ThisRef},NPage)
  when is_integer(NPage) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_SetSelection,
   <<ThisRef:32/?UI,NPage:32/?UI>>).
 
-%% @spec (This::wxNotebook(), NPage::integer()) -> integer()
 %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookchangeselection">external documentation</a>.
+-spec changeSelection(This, NPage) -> integer() when
+	This::wxNotebook(), NPage::integer().
 changeSelection(#wx_ref{type=ThisT,ref=ThisRef},NPage)
  when is_integer(NPage) ->
   ?CLASS(ThisT,wxNotebook),
   wxe_util:call(?wxNotebook_ChangeSelection,
   <<ThisRef:32/?UI,NPage:32/?UI>>).
 
-%% @spec (This::wxNotebook()) -> ok
 %% @doc Destroys this object, do not use object again
+-spec destroy(This::wxNotebook) -> ok.
 destroy(Obj=#wx_ref{type=Type}) ->
   ?CLASS(Type,wxNotebook),
   wxe_util:destroy(?DESTROY_OBJECT,Obj),