From ec9ee1b76343c146cec17d0642dd9d1db7bbf3d6 Mon Sep 17 00:00:00 2001 From: Dan Gudmundsson Date: Fri, 24 Feb 2012 11:53:41 +0100 Subject: [wx] Doc overloaded functions edoc do not handle overloaded type-specs, so doc them manually --- lib/wx/api_gen/wx_gen_erl.erl | 112 ++++++++++++++++--------------- lib/wx/src/gen/wxAcceleratorEntry.erl | 4 ++ lib/wx/src/gen/wxAuiManager.erl | 8 +++ lib/wx/src/gen/wxBitmap.erl | 19 ++++++ lib/wx/src/gen/wxBitmapDataObject.erl | 4 ++ lib/wx/src/gen/wxBrush.erl | 4 ++ lib/wx/src/gen/wxBufferedDC.erl | 12 ++++ lib/wx/src/gen/wxBufferedPaintDC.erl | 5 ++ lib/wx/src/gen/wxCalendarCtrl.erl | 2 +- lib/wx/src/gen/wxCalendarDateAttr.erl | 14 ++++ lib/wx/src/gen/wxColourPickerCtrl.erl | 4 ++ lib/wx/src/gen/wxCursor.erl | 4 ++ lib/wx/src/gen/wxDC.erl | 4 ++ lib/wx/src/gen/wxFont.erl | 2 +- lib/wx/src/gen/wxGLCanvas.erl | 11 +++ lib/wx/src/gen/wxGraphicsContext.erl | 4 ++ lib/wx/src/gen/wxGraphicsPath.erl | 5 ++ lib/wx/src/gen/wxGrid.erl | 24 +++++++ lib/wx/src/gen/wxGridBagSizer.erl | 45 +++++++++++++ lib/wx/src/gen/wxIcon.erl | 5 ++ lib/wx/src/gen/wxIconBundle.erl | 4 ++ lib/wx/src/gen/wxImage.erl | 37 ++++++++++ lib/wx/src/gen/wxImageList.erl | 4 ++ lib/wx/src/gen/wxListBox.erl | 4 ++ lib/wx/src/gen/wxListCtrl.erl | 12 ++++ lib/wx/src/gen/wxMask.erl | 8 +++ lib/wx/src/gen/wxMenu.erl | 48 +++++++++++++ lib/wx/src/gen/wxPageSetupDialogData.erl | 4 ++ lib/wx/src/gen/wxPrintDialog.erl | 4 ++ lib/wx/src/gen/wxRadioBox.erl | 10 +++ lib/wx/src/gen/wxRegion.erl | 24 +++++++ lib/wx/src/gen/wxSizer.erl | 74 ++++++++++++++++++++ lib/wx/src/gen/wxSizerItem.erl | 4 ++ lib/wx/src/gen/wxSpinCtrl.erl | 4 ++ lib/wx/src/gen/wxStaticBoxSizer.erl | 4 ++ lib/wx/src/gen/wxStyledTextCtrl.erl | 2 +- lib/wx/src/gen/wxSystemOptions.erl | 4 ++ lib/wx/src/gen/wxToolBar.erl | 41 +++++++++++ lib/wx/src/gen/wxWindow.erl | 41 +++++++++++ 39 files changed, 568 insertions(+), 57 deletions(-) (limited to 'lib/wx') diff --git a/lib/wx/api_gen/wx_gen_erl.erl b/lib/wx/api_gen/wx_gen_erl.erl index 3008a1d223..aac57586bc 100644 --- a/lib/wx/api_gen/wx_gen_erl.erl +++ b/lib/wx/api_gen/wx_gen_erl.erl @@ -640,70 +640,74 @@ gen_doc(_Class, [#method{method_type=destructor}]) -> skip; gen_doc(_Class,Ms=[#method{name=N,alias=A,params=Ps,where=erl_no_opt,method_type=MT}])-> w("%% @equiv ", []), gen_function_clause(erl_func_name(N,A),MT,Ps,empty_list,[no_guards,name_only]), - w("~n",[]), - write_specs(Ms); -gen_doc(Class,Ms=[#method{name=N,params=Ps,type=T}])-> + w("~n-spec ",[]), + write_specs(Ms, "\n"); +gen_doc(Class,Ms=[#method{name=N, type=T}|Rest])-> %%doc_optional(Optional, normal), doc_link(Class, N), - doc_enum_desc(doc_enum(T,Ps)), - write_specs(Ms); - -gen_doc(Class, Ms = [#method{name=N, type=T}|_]) -> - doc_link(Class, N), - Ps = lists:usort([Ps || #method{params=Ps} <- Ms]), - doc_enum_desc(doc_enum(T,Ps)), - write_specs(Ms), + gen_overload_doc(Rest), + Ps = lists:foldl(fun(#method{params=Ps}, Acc) -> Ps ++ Acc end,[],Ms), + doc_enum_desc(lists:usort(doc_enum(T,Ps))), + w("-spec ",[]), + write_specs(Ms, "\n"), ok. -write_specs(M=[#method{method_type=constructor}|_]) -> - w("-spec new", []), - write_specs1(M); -write_specs(M=[#method{name=N, alias=A}|_]) -> - w("-spec ~s", [erl_func_name(N,A)]), - write_specs1(M). - -write_specs1([M]) -> - write_spec(M), - w(".~n", []); -write_specs1([M|Next]) -> - write_spec(M), - w(";~n ", []), - write_specs1(Next). - -write_spec(#method{params=Ps,type=T,where=erl_no_opt}) -> +gen_overload_doc([]) -> ok; +%%gen_overload_doc(_) -> ok; +gen_overload_doc(Cs) -> + w("%%
Also:
~n%% ",[]), + write_specs(Cs, "
\n%% "), + w("~n", []). + +write_specs(M=[#method{method_type=constructor}|_], Eol) -> + w("new", []), + write_specs1(M, Eol); +write_specs(M=[#method{name=N, alias=A}|_], Eol) -> + w("~s", [erl_func_name(N,A)]), + write_specs1(M, Eol). + +write_specs1([M], Eol) -> + write_spec(M, Eol), + w(".~s", [Eol]); +write_specs1([M|Next], Eol) -> + write_spec(M, Eol), + w(";~s ", [Eol]), + write_specs1(Next, Eol). + +write_spec(#method{params=Ps,type=T,where=erl_no_opt}, Eol) -> {NonDef, _Optional} = split_optional(Ps), Res = doc_return_types(T,Ps), - write_spec(NonDef, [], Res); -write_spec(#method{params=Ps,type=T}) -> + write_spec(NonDef, [], Res, Eol); +write_spec(#method{params=Ps,type=T}, Eol) -> {NonDef, Optional} = split_optional(Ps), Res = doc_return_types(T,Ps), - write_spec(NonDef, Optional, Res). + write_spec(NonDef, Optional, Res, Eol). -write_spec([], [], {simple, Res}) -> +write_spec([], [], {simple, Res}, _Eol) -> w("() -> ~s", [Res]); -write_spec([], [], {complex, Res}) -> - w("() -> Resultwhen~n\tResult ::~s", [Res]); -write_spec(Args, [], {simple, Res}) -> - w("(~s) -> ~s when~n\t~s", - [erl_arg_names(Args), Res, doc_arg_types(Args)]); -write_spec(Args, [], {complex, Res}) -> - w("(~s) -> Result when~n\tResult ::~s,~n\t~s", - [erl_arg_names(Args), Res, doc_arg_types(Args)]); -write_spec([], Optional, {simple, Res}) -> - w("([Option]) -> ~s when~n\t~s", - [Res, optional_type(Optional)]); -write_spec([], Optional, {complex, Res}) -> - w("([Option]) -> Result when~n\tResult :: ~s,~n\t~s", - [Res, optional_type(Optional)]); -write_spec(Args, Optional, {simple, Res}) -> - w("(~s, [Option]) -> ~s when~n\t~s,~n\t~s", - [erl_arg_names(Args), Res, doc_arg_types(Args), optional_type(Optional)]); -write_spec(Args, Optional, {complex, Res}) -> - w("(~s, [Option]) -> Result when~n\tResult :: ~s,~n\t~s,~n\t~s", - [erl_arg_names(Args), Res, doc_arg_types(Args), optional_type(Optional)]). - -optional_type(Opts) -> - "Option :: " ++ args(fun optional_type2/1, "\n\t\t | ", Opts). +write_spec([], [], {complex, Res}, Eol) -> + w("() -> Resultwhen~s\tResult ::~s", [Eol,Res]); +write_spec(Args, [], {simple, Res}, Eol) -> + w("(~s) -> ~s when~s\t~s", + [erl_arg_names(Args), Res, Eol, doc_arg_types(Args)]); +write_spec(Args, [], {complex, Res}, Eol) -> + w("(~s) -> Result when~s\tResult ::~s,~s\t~s", + [erl_arg_names(Args), Eol, Res, Eol, doc_arg_types(Args)]); +write_spec([], Optional, {simple, Res}, Eol) -> + w("([Option]) -> ~s when~s\t~s", + [Res, Eol, optional_type(Optional, Eol)]); +write_spec([], Optional, {complex, Res}, Eol) -> + w("([Option]) -> Result when~s\tResult :: ~s,~s\t~s", + [Eol, Res, Eol, optional_type(Optional, Eol)]); +write_spec(Args, Optional, {simple, Res}, Eol) -> + w("(~s, [Option]) -> ~s when~s\t~s,~s\t~s", + [erl_arg_names(Args), Res, Eol, doc_arg_types(Args), Eol, optional_type(Optional, Eol)]); +write_spec(Args, Optional, {complex, Res}, Eol) -> + w("(~s, [Option]) -> Result when~s\tResult :: ~s,~s\t~s,~s\t~s", + [erl_arg_names(Args), Eol, Res, Eol, doc_arg_types(Args), Eol, optional_type(Optional, Eol)]). + +optional_type(Opts, Eol) -> + "Option :: " ++ args(fun optional_type2/1, Eol++"\t\t | ", Opts). optional_type2(#param{name=Name, def=Def, type=T}) -> "{" ++ erl_option_name(Name) ++ ", " ++ doc_arg_type2(T) ++ "}". %% %% Default: " ++ Def. diff --git a/lib/wx/src/gen/wxAcceleratorEntry.erl b/lib/wx/src/gen/wxAcceleratorEntry.erl index b5467ecab8..3cf50a2348 100644 --- a/lib/wx/src/gen/wxAcceleratorEntry.erl +++ b/lib/wx/src/gen/wxAcceleratorEntry.erl @@ -41,6 +41,10 @@ new() -> new([]). %% @doc See external documentation. +%%
Also:
+%% new(Entry) -> wxAcceleratorEntry() when
+%% Entry::wxAcceleratorEntry().
+%% -spec new([Option]) -> wxAcceleratorEntry() when Option :: {flags, integer()} | {keyCode, integer()} diff --git a/lib/wx/src/gen/wxAuiManager.erl b/lib/wx/src/gen/wxAuiManager.erl index 8a0a64f346..95dd5d64a5 100644 --- a/lib/wx/src/gen/wxAuiManager.erl +++ b/lib/wx/src/gen/wxAuiManager.erl @@ -71,6 +71,10 @@ addPane(This,Window) addPane(This,Window, []). %% @doc See external documentation. +%%
Also:
+%% addPane(This, Window, Pane_info) -> boolean() when
+%% This::wxAuiManager(), Window::wxWindow:wxWindow(), Pane_info::wxAuiPaneInfo:wxAuiPaneInfo().
+%% -spec addPane(This, Window, [Option]) -> boolean() when This::wxAuiManager(), Window::wxWindow:wxWindow(), Option :: {direction, integer()} @@ -163,6 +167,10 @@ getManager(#wx_ref{type=WindowT,ref=WindowRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% getPane(This, Window) -> wxAuiPaneInfo:wxAuiPaneInfo() when
+%% This::wxAuiManager(), Window::wxWindow:wxWindow().
+%% -spec getPane(This, Name) -> wxAuiPaneInfo:wxAuiPaneInfo() when This::wxAuiManager(), Name::unicode:chardata(); (This, Window) -> wxAuiPaneInfo:wxAuiPaneInfo() when diff --git a/lib/wx/src/gen/wxBitmap.erl b/lib/wx/src/gen/wxBitmap.erl index c363e22209..8816e27cdd 100644 --- a/lib/wx/src/gen/wxBitmap.erl +++ b/lib/wx/src/gen/wxBitmap.erl @@ -44,6 +44,11 @@ new() -> <<>>). %% @doc See external documentation. +%%
Also:
+%% new(Image) -> wxBitmap() when
+%% Image::wxImage:wxImage().
+%% +%%
Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY -spec new(Filename) -> wxBitmap() when Filename::unicode:chardata(); (Image) -> wxBitmap() when @@ -58,6 +63,15 @@ new(Image) new(Image, []). %% @doc See external documentation. +%%
Also:
+%% new(Filename, [Option]) -> wxBitmap() when
+%% Filename::unicode:chardata(),
+%% Option :: {type, wx:wx_enum()};
+%% (Image, [Option]) -> wxBitmap() when
+%% Image::wxImage:wxImage(),
+%% Option :: {depth, integer()}.
+%% +%%
Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY -spec new(Width, Height) -> wxBitmap() when Width::integer(), Height::integer(); (Filename, [Option]) -> wxBitmap() when @@ -88,6 +102,11 @@ new(#wx_ref{type=ImageT,ref=ImageRef}, Options) <>). %% @doc See external documentation. +%%
Also:
+%% new(Width, Height, [Option]) -> wxBitmap() when
+%% Width::integer(), Height::integer(),
+%% Option :: {depth, integer()}.
+%% -spec new(Bits, Width, Height) -> wxBitmap() when Bits::binary(), Width::integer(), Height::integer(); (Width, Height, [Option]) -> wxBitmap() when diff --git a/lib/wx/src/gen/wxBitmapDataObject.erl b/lib/wx/src/gen/wxBitmapDataObject.erl index 35ab146457..8f9701d3c2 100644 --- a/lib/wx/src/gen/wxBitmapDataObject.erl +++ b/lib/wx/src/gen/wxBitmapDataObject.erl @@ -45,6 +45,10 @@ new() -> new([]). %% @doc See external documentation. +%%
Also:
+%% new(Bitmap) -> wxBitmapDataObject() when
+%% Bitmap::wxBitmap:wxBitmap().
+%% -spec new([Option]) -> wxBitmapDataObject() when Option :: {bitmap, wxBitmap:wxBitmap()}; (Bitmap) -> wxBitmapDataObject() when diff --git a/lib/wx/src/gen/wxBrush.erl b/lib/wx/src/gen/wxBrush.erl index 3436fe0dde..40aa62297e 100644 --- a/lib/wx/src/gen/wxBrush.erl +++ b/lib/wx/src/gen/wxBrush.erl @@ -42,6 +42,10 @@ new() -> <<>>). %% @doc See external documentation. +%%
Also:
+%% new(StippleBitmap) -> wxBrush() when
+%% StippleBitmap::wxBitmap:wxBitmap().
+%% -spec new(Colour) -> wxBrush() when Colour::wx:wx_colour(); (StippleBitmap) -> wxBrush() when diff --git a/lib/wx/src/gen/wxBufferedDC.erl b/lib/wx/src/gen/wxBufferedDC.erl index 84dde6c67b..fd8955f4ed 100644 --- a/lib/wx/src/gen/wxBufferedDC.erl +++ b/lib/wx/src/gen/wxBufferedDC.erl @@ -75,6 +75,12 @@ new(Dc) new(Dc, []). %% @doc See external documentation. +%%
Also:
+%% new(Dc, [Option]) -> wxBufferedDC() when
+%% Dc::wxDC:wxDC(),
+%% Option :: {buffer, wxBitmap:wxBitmap()}
+%% | {style, integer()}.
+%% -spec new(Dc, Area) -> wxBufferedDC() when Dc::wxDC:wxDC(), Area::{W::integer(), H::integer()}; (Dc, [Option]) -> wxBufferedDC() when @@ -117,6 +123,12 @@ init(This,Dc) init(This,Dc, []). %% @doc See external documentation. +%%
Also:
+%% init(This, Dc, [Option]) -> ok when
+%% This::wxBufferedDC(), Dc::wxDC:wxDC(),
+%% Option :: {buffer, wxBitmap:wxBitmap()}
+%% | {style, integer()}.
+%% -spec init(This, Dc, Area) -> ok when This::wxBufferedDC(), Dc::wxDC:wxDC(), Area::{W::integer(), H::integer()}; (This, Dc, [Option]) -> ok when diff --git a/lib/wx/src/gen/wxBufferedPaintDC.erl b/lib/wx/src/gen/wxBufferedPaintDC.erl index 833d51c435..bff61ca678 100644 --- a/lib/wx/src/gen/wxBufferedPaintDC.erl +++ b/lib/wx/src/gen/wxBufferedPaintDC.erl @@ -72,6 +72,11 @@ new(Window) new(Window, []). %% @doc See external documentation. +%%
Also:
+%% new(Window, [Option]) -> wxBufferedPaintDC() when
+%% Window::wxWindow:wxWindow(),
+%% Option :: {style, integer()}.
+%% -spec new(Window, Buffer) -> wxBufferedPaintDC() when Window::wxWindow:wxWindow(), Buffer::wxBitmap:wxBitmap(); (Window, [Option]) -> wxBufferedPaintDC() when diff --git a/lib/wx/src/gen/wxCalendarCtrl.erl b/lib/wx/src/gen/wxCalendarCtrl.erl index 06dd4a0c91..01d171800b 100644 --- a/lib/wx/src/gen/wxCalendarCtrl.erl +++ b/lib/wx/src/gen/wxCalendarCtrl.erl @@ -336,8 +336,8 @@ resetAttr(#wx_ref{type=ThisT,ref=ThisRef},Day) <>). %% @doc See external documentation. -%%
Res = ?wxCAL_HITTEST_NOWHERE | ?wxCAL_HITTEST_HEADER | ?wxCAL_HITTEST_DAY | ?wxCAL_HITTEST_INCMONTH | ?wxCAL_HITTEST_DECMONTH | ?wxCAL_HITTEST_SURROUNDING_WEEK %%
Wd = ?wxDateTime_Sun | ?wxDateTime_Mon | ?wxDateTime_Tue | ?wxDateTime_Wed | ?wxDateTime_Thu | ?wxDateTime_Fri | ?wxDateTime_Sat | ?wxDateTime_Inv_WeekDay +%%
Res = ?wxCAL_HITTEST_NOWHERE | ?wxCAL_HITTEST_HEADER | ?wxCAL_HITTEST_DAY | ?wxCAL_HITTEST_INCMONTH | ?wxCAL_HITTEST_DECMONTH | ?wxCAL_HITTEST_SURROUNDING_WEEK -spec hitTest(This, Pos) -> Result when Result ::{Res ::wx:wx_enum(), Date::wx:wx_datetime(), Wd::wx:wx_enum()}, This::wxCalendarCtrl(), Pos::{X::integer(), Y::integer()}. diff --git a/lib/wx/src/gen/wxCalendarDateAttr.erl b/lib/wx/src/gen/wxCalendarDateAttr.erl index cfedb401ce..a1891df18b 100644 --- a/lib/wx/src/gen/wxCalendarDateAttr.erl +++ b/lib/wx/src/gen/wxCalendarDateAttr.erl @@ -44,6 +44,11 @@ new() -> <<>>). %% @doc See external documentation. +%%
Also:
+%% new(ColText) -> wxCalendarDateAttr() when
+%% ColText::wx:wx_colour().
+%% +%%
Border = ?wxCAL_BORDER_NONE | ?wxCAL_BORDER_SQUARE | ?wxCAL_BORDER_ROUND -spec new(Border) -> wxCalendarDateAttr() when Border::wx:wx_enum(); (ColText) -> wxCalendarDateAttr() when @@ -58,6 +63,15 @@ new(ColText) new(ColText, []). %% @doc See external documentation. +%%
Also:
+%% new(ColText, [Option]) -> wxCalendarDateAttr() when
+%% ColText::wx:wx_colour(),
+%% Option :: {colBack, wx:wx_colour()}
+%% | {colBorder, wx:wx_colour()}
+%% | {font, wxFont:wxFont()}
+%% | {border, wx:wx_enum()}.
+%% +%%
Border = ?wxCAL_BORDER_NONE | ?wxCAL_BORDER_SQUARE | ?wxCAL_BORDER_ROUND -spec new(Border, [Option]) -> wxCalendarDateAttr() when Border::wx:wx_enum(), Option :: {colBorder, wx:wx_colour()}; diff --git a/lib/wx/src/gen/wxColourPickerCtrl.erl b/lib/wx/src/gen/wxColourPickerCtrl.erl index d9e0d20df8..5fd51eba15 100644 --- a/lib/wx/src/gen/wxColourPickerCtrl.erl +++ b/lib/wx/src/gen/wxColourPickerCtrl.erl @@ -157,6 +157,10 @@ getColour(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% setColour(This, Col) -> ok when
+%% This::wxColourPickerCtrl(), Col::wx:wx_colour().
+%% -spec setColour(This, Text) -> boolean() when This::wxColourPickerCtrl(), Text::unicode:chardata(); (This, Col) -> ok when diff --git a/lib/wx/src/gen/wxCursor.erl b/lib/wx/src/gen/wxCursor.erl index 78becd48e8..b9e3a8e3f7 100644 --- a/lib/wx/src/gen/wxCursor.erl +++ b/lib/wx/src/gen/wxCursor.erl @@ -47,6 +47,10 @@ new() -> <<>>). %% @doc See external documentation. +%%
Also:
+%% new(Image) -> wxCursor() when
+%% Image::wxImage:wxImage().
+%% -spec new(CursorId) -> wxCursor() when CursorId::integer(); (Image) -> wxCursor() when diff --git a/lib/wx/src/gen/wxDC.erl b/lib/wx/src/gen/wxDC.erl index 9b2c21f4b0..9f57978849 100644 --- a/lib/wx/src/gen/wxDC.erl +++ b/lib/wx/src/gen/wxDC.erl @@ -798,6 +798,10 @@ setBrush(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% setClippingRegion(This, Rect) -> ok when
+%% This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec setClippingRegion(This, Region) -> ok when This::wxDC(), Region::wxRegion:wxRegion(); (This, Rect) -> ok when diff --git a/lib/wx/src/gen/wxFont.erl b/lib/wx/src/gen/wxFont.erl index f05ac62d8b..a168e15180 100644 --- a/lib/wx/src/gen/wxFont.erl +++ b/lib/wx/src/gen/wxFont.erl @@ -62,9 +62,9 @@ new(Size,Family,Style,Weight) new(Size,Family,Style,Weight, []). %% @doc See external documentation. +%%
Encoding = ?wxFONTENCODING_SYSTEM | ?wxFONTENCODING_DEFAULT | ?wxFONTENCODING_ISO8859_1 | ?wxFONTENCODING_ISO8859_2 | ?wxFONTENCODING_ISO8859_3 | ?wxFONTENCODING_ISO8859_4 | ?wxFONTENCODING_ISO8859_5 | ?wxFONTENCODING_ISO8859_6 | ?wxFONTENCODING_ISO8859_7 | ?wxFONTENCODING_ISO8859_8 | ?wxFONTENCODING_ISO8859_9 | ?wxFONTENCODING_ISO8859_10 | ?wxFONTENCODING_ISO8859_11 | ?wxFONTENCODING_ISO8859_12 | ?wxFONTENCODING_ISO8859_13 | ?wxFONTENCODING_ISO8859_14 | ?wxFONTENCODING_ISO8859_15 | ?wxFONTENCODING_ISO8859_MAX | ?wxFONTENCODING_KOI8 | ?wxFONTENCODING_KOI8_U | ?wxFONTENCODING_ALTERNATIVE | ?wxFONTENCODING_BULGARIAN | ?wxFONTENCODING_CP437 | ?wxFONTENCODING_CP850 | ?wxFONTENCODING_CP852 | ?wxFONTENCODING_CP855 | ?wxFONTENCODING_CP866 | ?wxFONTENCODING_CP874 | ?wxFONTENCODING_CP932 | ?wxFONTENCODING_CP936 | ?wxFONTENCODING_CP949 | ?wxFONTENCODING_CP950 | ?wxFONTENCODING_CP1250 | ?wxFONTENCODING_CP1251 | ?wxFONTENCODING_CP1252 | ?wxFONTENCODING_CP1253 | ?wxFONTENCODING_CP1254 | ?wxFONTENCODING_CP1255 | ?wxFONTENCODING_CP1256 | ?wxFONTENCODING_CP1257 | ?wxFONTENCODING_CP12_MAX | ?wxFONTENCODING_UTF7 | ?wxFONTENCODING_UTF8 | ?wxFONTENCODING_EUC_JP | ?wxFONTENCODING_UTF16BE | ?wxFONTENCODING_UTF16LE | ?wxFONTENCODING_UTF32BE | ?wxFONTENCODING_UTF32LE | ?wxFONTENCODING_MACROMAN | ?wxFONTENCODING_MACJAPANESE | ?wxFONTENCODING_MACCHINESETRAD | ?wxFONTENCODING_MACKOREAN | ?wxFONTENCODING_MACARABIC | ?wxFONTENCODING_MACHEBREW | ?wxFONTENCODING_MACGREEK | ?wxFONTENCODING_MACCYRILLIC | ?wxFONTENCODING_MACDEVANAGARI | ?wxFONTENCODING_MACGURMUKHI | ?wxFONTENCODING_MACGUJARATI | ?wxFONTENCODING_MACORIYA | ?wxFONTENCODING_MACBENGALI | ?wxFONTENCODING_MACTAMIL | ?wxFONTENCODING_MACTELUGU | ?wxFONTENCODING_MACKANNADA | ?wxFONTENCODING_MACMALAJALAM | ?wxFONTENCODING_MACSINHALESE | ?wxFONTENCODING_MACBURMESE | ?wxFONTENCODING_MACKHMER | ?wxFONTENCODING_MACTHAI | ?wxFONTENCODING_MACLAOTIAN | ?wxFONTENCODING_MACGEORGIAN | ?wxFONTENCODING_MACARMENIAN | ?wxFONTENCODING_MACCHINESESIMP | ?wxFONTENCODING_MACTIBETAN | ?wxFONTENCODING_MACMONGOLIAN | ?wxFONTENCODING_MACETHIOPIC | ?wxFONTENCODING_MACCENTRALEUR | ?wxFONTENCODING_MACVIATNAMESE | ?wxFONTENCODING_MACARABICEXT | ?wxFONTENCODING_MACSYMBOL | ?wxFONTENCODING_MACDINGBATS | ?wxFONTENCODING_MACTURKISH | ?wxFONTENCODING_MACCROATIAN | ?wxFONTENCODING_MACICELANDIC | ?wxFONTENCODING_MACROMANIAN | ?wxFONTENCODING_MACCELTIC | ?wxFONTENCODING_MACGAELIC | ?wxFONTENCODING_MACKEYBOARD | ?wxFONTENCODING_MAX | ?wxFONTENCODING_MACMIN | ?wxFONTENCODING_MACMAX | ?wxFONTENCODING_UTF16 | ?wxFONTENCODING_UTF32 | ?wxFONTENCODING_UNICODE | ?wxFONTENCODING_GB2312 | ?wxFONTENCODING_BIG5 | ?wxFONTENCODING_SHIFT_JIS %%
Family = ?wxFONTFAMILY_DEFAULT | ?wxFONTFAMILY_DECORATIVE | ?wxFONTFAMILY_ROMAN | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS | ?wxFONTFAMILY_MODERN | ?wxFONTFAMILY_TELETYPE | ?wxFONTFAMILY_MAX | ?wxFONTFAMILY_UNKNOWN %%
Style = ?wxFONTSTYLE_NORMAL | ?wxFONTSTYLE_ITALIC | ?wxFONTSTYLE_SLANT | ?wxFONTSTYLE_MAX -%%
Encoding = ?wxFONTENCODING_SYSTEM | ?wxFONTENCODING_DEFAULT | ?wxFONTENCODING_ISO8859_1 | ?wxFONTENCODING_ISO8859_2 | ?wxFONTENCODING_ISO8859_3 | ?wxFONTENCODING_ISO8859_4 | ?wxFONTENCODING_ISO8859_5 | ?wxFONTENCODING_ISO8859_6 | ?wxFONTENCODING_ISO8859_7 | ?wxFONTENCODING_ISO8859_8 | ?wxFONTENCODING_ISO8859_9 | ?wxFONTENCODING_ISO8859_10 | ?wxFONTENCODING_ISO8859_11 | ?wxFONTENCODING_ISO8859_12 | ?wxFONTENCODING_ISO8859_13 | ?wxFONTENCODING_ISO8859_14 | ?wxFONTENCODING_ISO8859_15 | ?wxFONTENCODING_ISO8859_MAX | ?wxFONTENCODING_KOI8 | ?wxFONTENCODING_KOI8_U | ?wxFONTENCODING_ALTERNATIVE | ?wxFONTENCODING_BULGARIAN | ?wxFONTENCODING_CP437 | ?wxFONTENCODING_CP850 | ?wxFONTENCODING_CP852 | ?wxFONTENCODING_CP855 | ?wxFONTENCODING_CP866 | ?wxFONTENCODING_CP874 | ?wxFONTENCODING_CP932 | ?wxFONTENCODING_CP936 | ?wxFONTENCODING_CP949 | ?wxFONTENCODING_CP950 | ?wxFONTENCODING_CP1250 | ?wxFONTENCODING_CP1251 | ?wxFONTENCODING_CP1252 | ?wxFONTENCODING_CP1253 | ?wxFONTENCODING_CP1254 | ?wxFONTENCODING_CP1255 | ?wxFONTENCODING_CP1256 | ?wxFONTENCODING_CP1257 | ?wxFONTENCODING_CP12_MAX | ?wxFONTENCODING_UTF7 | ?wxFONTENCODING_UTF8 | ?wxFONTENCODING_EUC_JP | ?wxFONTENCODING_UTF16BE | ?wxFONTENCODING_UTF16LE | ?wxFONTENCODING_UTF32BE | ?wxFONTENCODING_UTF32LE | ?wxFONTENCODING_MACROMAN | ?wxFONTENCODING_MACJAPANESE | ?wxFONTENCODING_MACCHINESETRAD | ?wxFONTENCODING_MACKOREAN | ?wxFONTENCODING_MACARABIC | ?wxFONTENCODING_MACHEBREW | ?wxFONTENCODING_MACGREEK | ?wxFONTENCODING_MACCYRILLIC | ?wxFONTENCODING_MACDEVANAGARI | ?wxFONTENCODING_MACGURMUKHI | ?wxFONTENCODING_MACGUJARATI | ?wxFONTENCODING_MACORIYA | ?wxFONTENCODING_MACBENGALI | ?wxFONTENCODING_MACTAMIL | ?wxFONTENCODING_MACTELUGU | ?wxFONTENCODING_MACKANNADA | ?wxFONTENCODING_MACMALAJALAM | ?wxFONTENCODING_MACSINHALESE | ?wxFONTENCODING_MACBURMESE | ?wxFONTENCODING_MACKHMER | ?wxFONTENCODING_MACTHAI | ?wxFONTENCODING_MACLAOTIAN | ?wxFONTENCODING_MACGEORGIAN | ?wxFONTENCODING_MACARMENIAN | ?wxFONTENCODING_MACCHINESESIMP | ?wxFONTENCODING_MACTIBETAN | ?wxFONTENCODING_MACMONGOLIAN | ?wxFONTENCODING_MACETHIOPIC | ?wxFONTENCODING_MACCENTRALEUR | ?wxFONTENCODING_MACVIATNAMESE | ?wxFONTENCODING_MACARABICEXT | ?wxFONTENCODING_MACSYMBOL | ?wxFONTENCODING_MACDINGBATS | ?wxFONTENCODING_MACTURKISH | ?wxFONTENCODING_MACCROATIAN | ?wxFONTENCODING_MACICELANDIC | ?wxFONTENCODING_MACROMANIAN | ?wxFONTENCODING_MACCELTIC | ?wxFONTENCODING_MACGAELIC | ?wxFONTENCODING_MACKEYBOARD | ?wxFONTENCODING_MAX | ?wxFONTENCODING_MACMIN | ?wxFONTENCODING_MACMAX | ?wxFONTENCODING_UTF16 | ?wxFONTENCODING_UTF32 | ?wxFONTENCODING_UNICODE | ?wxFONTENCODING_GB2312 | ?wxFONTENCODING_BIG5 | ?wxFONTENCODING_SHIFT_JIS -spec new(Size, Family, Style, Weight, [Option]) -> wxFont() when Size::integer(), Family::wx:wx_enum(), Style::wx:wx_enum(), Weight::integer(), Option :: {underlined, boolean()} diff --git a/lib/wx/src/gen/wxGLCanvas.erl b/lib/wx/src/gen/wxGLCanvas.erl index 5c0bda7ee4..3a9cb39020 100644 --- a/lib/wx/src/gen/wxGLCanvas.erl +++ b/lib/wx/src/gen/wxGLCanvas.erl @@ -84,6 +84,17 @@ new(Parent) new(Parent, []). %% @doc See external documentation. +%%
Also:
+%% new(Parent, [Option]) -> wxGLCanvas() when
+%% Parent::wxWindow:wxWindow(),
+%% Option :: {id, integer()}
+%% | {pos, {X::integer(), Y::integer()}}
+%% | {size, {W::integer(), H::integer()}}
+%% | {style, integer()}
+%% | {name, unicode:chardata()}
+%% | {attribList, [integer()]}
+%% | {palette, wxPalette:wxPalette()}.
+%% -spec new(Parent, Shared) -> wxGLCanvas() when Parent::wxWindow:wxWindow(), Shared::wxGLContext:wxGLContext() | wxGLCanvas(); (Parent, [Option]) -> wxGLCanvas() when diff --git a/lib/wx/src/gen/wxGraphicsContext.erl b/lib/wx/src/gen/wxGraphicsContext.erl index db69c278a7..1dfa0dd405 100644 --- a/lib/wx/src/gen/wxGraphicsContext.erl +++ b/lib/wx/src/gen/wxGraphicsContext.erl @@ -289,6 +289,10 @@ drawText(#wx_ref{type=ThisT,ref=ThisRef},Str,X,Y) <>). %% @doc See external documentation. +%%
Also:
+%% drawText(This, Str, X, Y, BackgroundBrush) -> ok when
+%% This::wxGraphicsContext(), Str::unicode:chardata(), X::number(), Y::number(), BackgroundBrush::wxGraphicsBrush:wxGraphicsBrush().
+%% -spec drawText(This, Str, X, Y, Angle) -> ok when This::wxGraphicsContext(), Str::unicode:chardata(), X::number(), Y::number(), Angle::number(); (This, Str, X, Y, BackgroundBrush) -> ok when diff --git a/lib/wx/src/gen/wxGraphicsPath.erl b/lib/wx/src/gen/wxGraphicsPath.erl index 32e9685895..56b853899a 100644 --- a/lib/wx/src/gen/wxGraphicsPath.erl +++ b/lib/wx/src/gen/wxGraphicsPath.erl @@ -194,6 +194,11 @@ contains(This,C={CX,CY}) contains(This,C, []). %% @doc See external documentation. +%%
Also:
+%% contains(This, C, [Option]) -> boolean() when
+%% This::wxGraphicsPath(), C::{X::float(), Y::float()},
+%% Option :: {fillStyle, integer()}.
+%% -spec contains(This, X, Y) -> boolean() when This::wxGraphicsPath(), X::number(), Y::number(); (This, C, [Option]) -> boolean() when diff --git a/lib/wx/src/gen/wxGrid.erl b/lib/wx/src/gen/wxGrid.erl index dd85c7b46d..2f4b45b1bc 100644 --- a/lib/wx/src/gen/wxGrid.erl +++ b/lib/wx/src/gen/wxGrid.erl @@ -149,6 +149,13 @@ new(Parent,Id) new(Parent,Id, []). %% @doc See external documentation. +%%
Also:
+%% new(Parent, Id, [Option]) -> wxGrid() when
+%% Parent::wxWindow:wxWindow(), Id::integer(),
+%% Option :: {pos, {X::integer(), Y::integer()}}
+%% | {size, {W::integer(), H::integer()}}
+%% | {style, integer()}.
+%% -spec new(Parent, X, Y) -> wxGrid() when Parent::wxWindow:wxWindow(), X::integer(), Y::integer(); (Parent, Id, [Option]) -> wxGrid() when @@ -1252,6 +1259,11 @@ isVisible(This,Coords={CoordsR,CoordsC}) isVisible(This,Coords, []). %% @doc See external documentation. +%%
Also:
+%% isVisible(This, Coords, [Option]) -> boolean() when
+%% This::wxGrid(), Coords::{R::integer(), C::integer()},
+%% Option :: {wholeCellVisible, boolean()}.
+%% -spec isVisible(This, Row, Col) -> boolean() when This::wxGrid(), Row::integer(), Col::integer(); (This, Coords, [Option]) -> boolean() when @@ -1538,6 +1550,10 @@ setCellBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Col) <>). %% @doc See external documentation. +%%
Also:
+%% setCellBackgroundColour(This, Colour, Row, Col) -> ok when
+%% This::wxGrid(), Colour::wx:wx_colour(), Row::integer(), Col::integer().
+%% -spec setCellBackgroundColour(This, Row, Col, Val) -> ok when This::wxGrid(), Row::integer(), Col::integer(), Val::wx:wx_colour(); (This, Colour, Row, Col) -> ok when @@ -1593,6 +1609,10 @@ setCellTextColour(#wx_ref{type=ThisT,ref=ThisRef},Col) <>). %% @doc See external documentation. +%%
Also:
+%% setCellTextColour(This, Val, Row, Col) -> ok when
+%% This::wxGrid(), Val::wx:wx_colour(), Row::integer(), Col::integer().
+%% -spec setCellTextColour(This, Row, Col, Val) -> ok when This::wxGrid(), Row::integer(), Col::integer(), Val::wx:wx_colour(); (This, Val, Row, Col) -> ok when @@ -1619,6 +1639,10 @@ setCellValue(#wx_ref{type=ThisT,ref=ThisRef},{CoordsR,CoordsC},S) <>). %% @doc See external documentation. +%%
Also:
+%% setCellValue(This, Val, Row, Col) -> ok when
+%% This::wxGrid(), Val::unicode:chardata(), Row::integer(), Col::integer().
+%% -spec setCellValue(This, Row, Col, S) -> ok when This::wxGrid(), Row::integer(), Col::integer(), S::unicode:chardata(); (This, Val, Row, Col) -> ok when diff --git a/lib/wx/src/gen/wxGridBagSizer.erl b/lib/wx/src/gen/wxGridBagSizer.erl index 4eea673c93..6a978efc85 100644 --- a/lib/wx/src/gen/wxGridBagSizer.erl +++ b/lib/wx/src/gen/wxGridBagSizer.erl @@ -90,6 +90,16 @@ add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% add(This, Window, Pos) -> wxSizerItem:wxSizerItem() when
+%% This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Pos::{R::integer(), C::integer()};
+%% (This, Window, [Option]) -> wxSizerItem:wxSizerItem() when
+%% This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(),
+%% Option :: {proportion, integer()}
+%% | {flag, integer()}
+%% | {border, integer()}
+%% | {userData, wx:wx()}.
+%% -spec add(This, Width, Height) -> wxSizerItem:wxSizerItem() when This::wxGridBagSizer(), Width::integer(), Height::integer(); (This, Window, Pos) -> wxSizerItem:wxSizerItem() when @@ -127,6 +137,20 @@ add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}, Options <>). %% @doc See external documentation. +%%
Also:
+%% add(This, Width, Height, [Option]) -> wxSizerItem:wxSizerItem() when
+%% This::wxGridBagSizer(), Width::integer(), Height::integer(),
+%% Option :: {proportion, integer()}
+%% | {flag, integer()}
+%% | {border, integer()}
+%% | {userData, wx:wx()};
+%% (This, Window, Pos, [Option]) -> wxSizerItem:wxSizerItem() when
+%% This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Pos::{R::integer(), C::integer()},
+%% Option :: {span, {RS::integer(), CS::integer()}}
+%% | {flag, integer()}
+%% | {border, integer()}
+%% | {userData, wx:wx()}.
+%% -spec add(This, Width, Height, Pos) -> wxSizerItem:wxSizerItem() when This::wxGridBagSizer(), Width::integer(), Height::integer(), Pos::{R::integer(), C::integer()}; (This, Width, Height, [Option]) -> wxSizerItem:wxSizerItem() when @@ -210,6 +234,11 @@ checkForIntersection(This,Item) checkForIntersection(This,Item, []). %% @doc See external documentation. +%%
Also:
+%% checkForIntersection(This, Item, [Option]) -> boolean() when
+%% This::wxGridBagSizer(), Item::wxGBSizerItem:wxGBSizerItem(),
+%% Option :: {excludeItem, wxGBSizerItem:wxGBSizerItem()}.
+%% -spec checkForIntersection(This, Pos, Span) -> boolean() when This::wxGridBagSizer(), Pos::{R::integer(), C::integer()}, Span::{RS::integer(), CS::integer()}; (This, Item, [Option]) -> boolean() when @@ -301,6 +330,10 @@ getEmptyCellSize(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% getItemPosition(This, Window) -> {R::integer(), C::integer()} when
+%% This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer().
+%% -spec getItemPosition(This, Index) -> {R::integer(), C::integer()} when This::wxGridBagSizer(), Index::integer(); (This, Window) -> {R::integer(), C::integer()} when @@ -322,6 +355,10 @@ getItemPosition(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowR <>). %% @doc See external documentation. +%%
Also:
+%% getItemSpan(This, Window) -> {RS::integer(), CS::integer()} when
+%% This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer().
+%% -spec getItemSpan(This, Index) -> {RS::integer(), CS::integer()} when This::wxGridBagSizer(), Index::integer(); (This, Window) -> {RS::integer(), CS::integer()} when @@ -352,6 +389,10 @@ setEmptyCellSize(#wx_ref{type=ThisT,ref=ThisRef},{SzW,SzH}) <>). %% @doc See external documentation. +%%
Also:
+%% setItemPosition(This, Window, Pos) -> boolean() when
+%% This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Pos::{R::integer(), C::integer()}.
+%% -spec setItemPosition(This, Index, Pos) -> boolean() when This::wxGridBagSizer(), Index::integer(), Pos::{R::integer(), C::integer()}; (This, Window, Pos) -> boolean() when @@ -374,6 +415,10 @@ setItemPosition(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowR <>). %% @doc See external documentation. +%%
Also:
+%% setItemSpan(This, Window, Span) -> boolean() when
+%% This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Span::{RS::integer(), CS::integer()}.
+%% -spec setItemSpan(This, Index, Span) -> boolean() when This::wxGridBagSizer(), Index::integer(), Span::{RS::integer(), CS::integer()}; (This, Window, Span) -> boolean() when diff --git a/lib/wx/src/gen/wxIcon.erl b/lib/wx/src/gen/wxIcon.erl index ac202130b3..c726f2ed4c 100644 --- a/lib/wx/src/gen/wxIcon.erl +++ b/lib/wx/src/gen/wxIcon.erl @@ -48,6 +48,11 @@ new() -> <<>>). %% @doc See external documentation. +%%
Also:
+%% new(Loc) -> wxIcon() when
+%% Loc::wx:wx().
+%% +%%
Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY -spec new(Filename) -> wxIcon() when Filename::unicode:chardata(); (Loc) -> wxIcon() when diff --git a/lib/wx/src/gen/wxIconBundle.erl b/lib/wx/src/gen/wxIconBundle.erl index 113511f3ee..5e8bb7cc74 100644 --- a/lib/wx/src/gen/wxIconBundle.erl +++ b/lib/wx/src/gen/wxIconBundle.erl @@ -90,6 +90,10 @@ getIcon(This) getIcon(This, []). %% @doc See external documentation. +%%
Also:
+%% getIcon(This, Size) -> wxIcon:wxIcon() when
+%% This::wxIconBundle(), Size::{W::integer(), H::integer()}.
+%% -spec getIcon(This, [Option]) -> wxIcon:wxIcon() when This::wxIconBundle(), Option :: {size, integer()}; diff --git a/lib/wx/src/gen/wxImage.erl b/lib/wx/src/gen/wxImage.erl index 535133e665..c21b5d4789 100644 --- a/lib/wx/src/gen/wxImage.erl +++ b/lib/wx/src/gen/wxImage.erl @@ -67,6 +67,12 @@ new(Name) new(Name, []). %% @doc See external documentation. +%%
Also:
+%% new(Name, [Option]) -> wxImage() when
+%% Name::unicode:chardata(),
+%% Option :: {type, integer()}
+%% | {index, integer()}.
+%% -spec new(Width, Height) -> wxImage() when Width::integer(), Height::integer(); (Name, [Option]) -> wxImage() when @@ -88,6 +94,14 @@ new(Name, Options) <<(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>>). %% @doc See external documentation. +%%
Also:
+%% new(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()}.
+%% -spec new(Width, Height, Data) -> wxImage() when Width::integer(), Height::integer(), Data::binary(); (Width, Height, [Option]) -> wxImage() when @@ -118,6 +132,11 @@ new(Name,Mimetype, Options) <<(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>>). %% @doc See external documentation. +%%
Also:
+%% new(Width, Height, Data, [Option]) -> wxImage() when
+%% Width::integer(), Height::integer(), Data::binary(),
+%% Option :: {static_data, boolean()}.
+%% -spec new(Width, Height, Data, Alpha) -> wxImage() when Width::integer(), Height::integer(), Data::binary(), Alpha::binary(); (Width, Height, Data, [Option]) -> wxImage() when @@ -249,6 +268,11 @@ create(This,Width,Height) create(This,Width,Height, []). %% @doc See external documentation. +%%
Also:
+%% create(This, Width, Height, [Option]) -> boolean() when
+%% This::wxImage(), Width::integer(), Height::integer(),
+%% Option :: {clear, boolean()}.
+%% -spec create(This, Width, Height, Data) -> boolean() when This::wxImage(), Width::integer(), Height::integer(), Data::binary(); (This, Width, Height, [Option]) -> boolean() when @@ -268,6 +292,11 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) <>). %% @doc See external documentation. +%%
Also:
+%% create(This, Width, Height, Data, [Option]) -> boolean() when
+%% This::wxImage(), Width::integer(), Height::integer(), Data::binary(),
+%% Option :: {static_data, boolean()}.
+%% -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 @@ -759,6 +788,10 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name) <>). %% @doc See external documentation. +%%
Also:
+%% saveFile(This, Name, Mimetype) -> boolean() when
+%% This::wxImage(), Name::unicode:chardata(), Mimetype::unicode:chardata().
+%% -spec saveFile(This, Name, Type) -> boolean() when This::wxImage(), Name::unicode:chardata(), Type::integer(); (This, Name, Mimetype) -> boolean() when @@ -939,6 +972,10 @@ setMaskFromImage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MaskT,ref=MaskRef} <>). %% @doc See external documentation. +%%
Also:
+%% setOption(This, Name, Value) -> ok when
+%% This::wxImage(), Name::unicode:chardata(), Value::unicode:chardata().
+%% -spec setOption(This, Name, Value) -> ok when This::wxImage(), Name::unicode:chardata(), Value::integer(); (This, Name, Value) -> ok when diff --git a/lib/wx/src/gen/wxImageList.erl b/lib/wx/src/gen/wxImageList.erl index e027d31b3d..e9d936d129 100644 --- a/lib/wx/src/gen/wxImageList.erl +++ b/lib/wx/src/gen/wxImageList.erl @@ -74,6 +74,10 @@ add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% add(This, Bitmap, MaskColour) -> integer() when
+%% This::wxImageList(), Bitmap::wxBitmap:wxBitmap(), MaskColour::wx:wx_colour().
+%% -spec add(This, Bitmap, Mask) -> integer() when This::wxImageList(), Bitmap::wxBitmap:wxBitmap(), Mask::wxBitmap:wxBitmap(); (This, Bitmap, MaskColour) -> integer() when diff --git a/lib/wx/src/gen/wxListBox.erl b/lib/wx/src/gen/wxListBox.erl index d09f37811d..bcaf5fad3b 100644 --- a/lib/wx/src/gen/wxListBox.erl +++ b/lib/wx/src/gen/wxListBox.erl @@ -203,6 +203,10 @@ hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PointX,PointY}) <>). %% @doc See external documentation. +%%
Also:
+%% setFirstItem(This, S) -> ok when
+%% This::wxListBox(), S::unicode:chardata().
+%% -spec setFirstItem(This, N) -> ok when This::wxListBox(), N::integer(); (This, S) -> ok when diff --git a/lib/wx/src/gen/wxListCtrl.erl b/lib/wx/src/gen/wxListCtrl.erl index 81a547b10f..16e8ae4508 100644 --- a/lib/wx/src/gen/wxListCtrl.erl +++ b/lib/wx/src/gen/wxListCtrl.erl @@ -270,6 +270,10 @@ findItem(This,Start,Str) findItem(This,Start,Str, []). %% @doc See external documentation. +%%
Also:
+%% findItem(This, Start, Pt, Direction) -> integer() when
+%% This::wxListCtrl(), Start::integer(), Pt::{X::integer(), Y::integer()}, Direction::integer().
+%% -spec findItem(This, Start, Str, [Option]) -> integer() when This::wxListCtrl(), Start::integer(), Str::unicode:chardata(), Option :: {partial, boolean()}; @@ -517,6 +521,10 @@ hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PointX,PointY}) <>). %% @doc See external documentation. +%%
Also:
+%% insertColumn(This, Col, Info) -> integer() when
+%% This::wxListCtrl(), Col::integer(), Info::wxListItem:wxListItem().
+%% -spec insertColumn(This, Col, Heading) -> integer() when This::wxListCtrl(), Col::integer(), Heading::unicode:chardata(); (This, Col, Info) -> integer() when @@ -558,6 +566,10 @@ insertItem(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=InfoT,ref=InfoRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% insertItem(This, Index, Label) -> integer() when
+%% This::wxListCtrl(), Index::integer(), Label::unicode:chardata().
+%% -spec insertItem(This, Index, ImageIndex) -> integer() when This::wxListCtrl(), Index::integer(), ImageIndex::integer(); (This, Index, Label) -> integer() when diff --git a/lib/wx/src/gen/wxMask.erl b/lib/wx/src/gen/wxMask.erl index 5bcd518556..296c7cbc83 100644 --- a/lib/wx/src/gen/wxMask.erl +++ b/lib/wx/src/gen/wxMask.erl @@ -49,6 +49,10 @@ new(#wx_ref{type=BitmapT,ref=BitmapRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% new(Bitmap, Colour) -> wxMask() when
+%% Bitmap::wxBitmap:wxBitmap(), Colour::wx:wx_colour().
+%% -spec new(Bitmap, PaletteIndex) -> wxMask() when Bitmap::wxBitmap:wxBitmap(), PaletteIndex::integer(); (Bitmap, Colour) -> wxMask() when @@ -74,6 +78,10 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% create(This, Bitmap, Colour) -> boolean() when
+%% This::wxMask(), Bitmap::wxBitmap:wxBitmap(), Colour::wx:wx_colour().
+%% -spec create(This, Bitmap, PaletteIndex) -> boolean() when This::wxMask(), Bitmap::wxBitmap:wxBitmap(), PaletteIndex::integer(); (This, Bitmap, Colour) -> boolean() when diff --git a/lib/wx/src/gen/wxMenu.erl b/lib/wx/src/gen/wxMenu.erl index 994855f805..d91863de82 100644 --- a/lib/wx/src/gen/wxMenu.erl +++ b/lib/wx/src/gen/wxMenu.erl @@ -94,6 +94,13 @@ append(This,Itemid,Text) append(This,Itemid,Text, []). %% @doc See external documentation. +%%
Also:
+%% append(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Itemid::integer(), Text::unicode:chardata(),
+%% Option :: {help, unicode:chardata()}
+%% | {kind, wx:wx_enum()}.
+%% +%%
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 @@ -116,6 +123,11 @@ append(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) <>). %% @doc See external documentation. +%%
Also:
+%% append(This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),
+%% Option :: {help, unicode:chardata()}.
+%% -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 @@ -209,6 +221,10 @@ check(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Check) <>). %% @doc See external documentation. +%%
Also:
+%% delete(This, Item) -> boolean() when
+%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().
+%% -spec delete(This, Itemid) -> boolean() when This::wxMenu(), Itemid::integer(); (This, Item) -> boolean() when @@ -225,6 +241,10 @@ delete(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% 'Destroy'(This, Item) -> boolean() when
+%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().
+%% -spec 'Destroy'(This, Itemid) -> boolean() when This::wxMenu(), Itemid::integer(); (This, Item) -> boolean() when @@ -250,6 +270,10 @@ enable(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Enable) <>). %% @doc See external documentation. +%%
Also:
+%% findItem(This, Item) -> integer() when
+%% This::wxMenu(), Item::unicode:chardata().
+%% -spec findItem(This, Itemid) -> wxMenuItem:wxMenuItem() when This::wxMenu(), Itemid::integer(); (This, Item) -> integer() when @@ -318,6 +342,11 @@ getTitle(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% insert(This, Pos, Item) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Pos::integer(), Item::wxMenuItem:wxMenuItem().
+%% +%%
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 @@ -360,6 +389,11 @@ insert(This,Pos,Itemid,Text,Submenu) insert(This,Pos,Itemid,Text,Submenu, []). %% @doc See external documentation. +%%
Also:
+%% insert(This, Pos, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Pos::integer(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),
+%% Option :: {help, unicode:chardata()}.
+%% -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 @@ -455,6 +489,11 @@ isEnabled(#wx_ref{type=ThisT,ref=ThisRef},Itemid) <>). %% @doc See external documentation. +%%
Also:
+%% prepend(This, Item) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().
+%% +%%
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 @@ -496,6 +535,11 @@ prepend(This,Itemid,Text,Submenu) prepend(This,Itemid,Text,Submenu, []). %% @doc See external documentation. +%%
Also:
+%% prepend(This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Itemid::integer(), Text::unicode:chardata(), Submenu::wxMenu(),
+%% Option :: {help, unicode:chardata()}.
+%% -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 @@ -572,6 +616,10 @@ prependSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% remove(This, Item) -> wxMenuItem:wxMenuItem() when
+%% This::wxMenu(), Item::wxMenuItem:wxMenuItem().
+%% -spec remove(This, Itemid) -> wxMenuItem:wxMenuItem() when This::wxMenu(), Itemid::integer(); (This, Item) -> wxMenuItem:wxMenuItem() when diff --git a/lib/wx/src/gen/wxPageSetupDialogData.erl b/lib/wx/src/gen/wxPageSetupDialogData.erl index 605e26c5d5..7c453a9872 100644 --- a/lib/wx/src/gen/wxPageSetupDialogData.erl +++ b/lib/wx/src/gen/wxPageSetupDialogData.erl @@ -289,6 +289,10 @@ setPaperId(#wx_ref{type=ThisT,ref=ThisRef},Id) <>). %% @doc See external documentation. +%%
Also:
+%% setPaperSize(This, Sz) -> ok when
+%% This::wxPageSetupDialogData(), Sz::{W::integer(), H::integer()}.
+%% -spec setPaperSize(This, Id) -> ok when This::wxPageSetupDialogData(), Id::integer(); (This, Sz) -> ok when diff --git a/lib/wx/src/gen/wxPrintDialog.erl b/lib/wx/src/gen/wxPrintDialog.erl index 1316ee2feb..34c8310e12 100644 --- a/lib/wx/src/gen/wxPrintDialog.erl +++ b/lib/wx/src/gen/wxPrintDialog.erl @@ -95,6 +95,10 @@ new(Parent) new(Parent, []). %% @doc See external documentation. +%%
Also:
+%% new(Parent, Data) -> wxPrintDialog() when
+%% Parent::wxWindow:wxWindow(), Data::wxPrintData:wxPrintData().
+%% -spec new(Parent, [Option]) -> wxPrintDialog() when Parent::wxWindow:wxWindow(), Option :: {data, wxPrintDialogData:wxPrintDialogData()}; diff --git a/lib/wx/src/gen/wxRadioBox.erl b/lib/wx/src/gen/wxRadioBox.erl index d70a554267..1b3717de23 100644 --- a/lib/wx/src/gen/wxRadioBox.erl +++ b/lib/wx/src/gen/wxRadioBox.erl @@ -146,6 +146,11 @@ enable(This) enable(This, []). %% @doc See external documentation. +%%
Also:
+%% enable(This, [Option]) -> boolean() when
+%% This::wxRadioBox(),
+%% Option :: {enable, boolean()}.
+%% -spec enable(This, N) -> boolean() when This::wxRadioBox(), N::integer(); (This, [Option]) -> boolean() when @@ -212,6 +217,11 @@ show(This) show(This, []). %% @doc See external documentation. +%%
Also:
+%% show(This, [Option]) -> boolean() when
+%% This::wxRadioBox(),
+%% Option :: {show, boolean()}.
+%% -spec show(This, N) -> boolean() when This::wxRadioBox(), N::integer(); (This, [Option]) -> boolean() when diff --git a/lib/wx/src/gen/wxRegion.erl b/lib/wx/src/gen/wxRegion.erl index 3397cc7e81..3e23623741 100644 --- a/lib/wx/src/gen/wxRegion.erl +++ b/lib/wx/src/gen/wxRegion.erl @@ -44,6 +44,10 @@ new() -> <<>>). %% @doc See external documentation. +%%
Also:
+%% new(Rect) -> wxRegion() when
+%% Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec new(Bmp) -> wxRegion() when Bmp::wxBitmap:wxBitmap(); (Rect) -> wxRegion() when @@ -82,6 +86,10 @@ clear(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% contains(This, Rect) -> wx:wx_enum() when
+%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% %%
Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion -spec contains(This, Pt) -> wx:wx_enum() when This::wxRegion(), Pt::{X::integer(), Y::integer()}; @@ -135,6 +143,10 @@ getBox(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% intersect(This, Rect) -> boolean() when
+%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec intersect(This, Region) -> boolean() when This::wxRegion(), Region::wxRegion(); (This, Rect) -> boolean() when @@ -168,6 +180,10 @@ isEmpty(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% subtract(This, Rect) -> boolean() when
+%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec subtract(This, Region) -> boolean() when This::wxRegion(), Region::wxRegion(); (This, Rect) -> boolean() when @@ -211,6 +227,10 @@ offset(#wx_ref{type=ThisT,ref=ThisRef},X,Y) <>). %% @doc See external documentation. +%%
Also:
+%% union(This, Rect) -> boolean() when
+%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec union(This, Region) -> boolean() when This::wxRegion(), Region::wxRegion() | wxBitmap:wxBitmap(); (This, Rect) -> boolean() when @@ -263,6 +283,10 @@ union(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) <>). %% @doc See external documentation. +%%
Also:
+%% 'Xor'(This, Rect) -> boolean() when
+%% This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec 'Xor'(This, Region) -> boolean() when This::wxRegion(), Region::wxRegion(); (This, Rect) -> boolean() when diff --git a/lib/wx/src/gen/wxSizer.erl b/lib/wx/src/gen/wxSizer.erl index 999724d38f..104e1bcdc9 100644 --- a/lib/wx/src/gen/wxSizer.erl +++ b/lib/wx/src/gen/wxSizer.erl @@ -50,6 +50,16 @@ add(This,Window) add(This,Window, []). %% @doc See external documentation. +%%
Also:
+%% add(This, Window, [Option]) -> wxSizerItem:wxSizerItem() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(),
+%% Option :: {proportion, integer()}
+%% | {flag, integer()}
+%% | {border, integer()}
+%% | {userData, wx:wx()};
+%% (This, Window, Flags) -> wxSizerItem:wxSizerItem() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Flags::wxSizerFlags:wxSizerFlags().
+%% -spec add(This, Width, Height) -> wxSizerItem:wxSizerItem() when This::wxSizer(), Width::integer(), Height::integer(); (This, Window, [Option]) -> wxSizerItem:wxSizerItem() when @@ -173,6 +183,10 @@ clear(#wx_ref{type=ThisT,ref=ThisRef}, Options) <>). %% @doc See external documentation. +%%
Also:
+%% detach(This, Window) -> boolean() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer().
+%% -spec detach(This, Index) -> boolean() when This::wxSizer(), Index::integer(); (This, Window) -> boolean() when @@ -220,6 +234,10 @@ getChildren(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% getItem(This, Index) -> wxSizerItem:wxSizerItem() when
+%% This::wxSizer(), Index::integer().
+%% -spec getItem(This, Window) -> wxSizerItem:wxSizerItem() when This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(); (This, Index) -> wxSizerItem:wxSizerItem() when @@ -278,6 +296,10 @@ getMinSize(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% hide(This, Index) -> boolean() when
+%% This::wxSizer(), Index::integer().
+%% -spec hide(This, Window) -> boolean() when This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(); (This, Index) -> boolean() when @@ -322,6 +344,16 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=ItemT,ref=ItemRef}) <>). %% @doc See external documentation. +%%
Also:
+%% insert(This, Index, Window, [Option]) -> wxSizerItem:wxSizerItem() when
+%% This::wxSizer(), Index::integer(), Window::wxWindow:wxWindow() | wxSizer(),
+%% Option :: {proportion, integer()}
+%% | {flag, integer()}
+%% | {border, integer()}
+%% | {userData, wx:wx()};
+%% (This, Index, Window, Flags) -> wxSizerItem:wxSizerItem() when
+%% This::wxSizer(), Index::integer(), Window::wxWindow:wxWindow() | wxSizer(), Flags::wxSizerFlags:wxSizerFlags().
+%% -spec insert(This, Index, Width, Height) -> wxSizerItem:wxSizerItem() when This::wxSizer(), Index::integer(), Width::integer(), Height::integer(); (This, Index, Window, [Option]) -> wxSizerItem:wxSizerItem() when @@ -417,6 +449,10 @@ insertStretchSpacer(#wx_ref{type=ThisT,ref=ThisRef},Index, Options) <>). %% @doc See external documentation. +%%
Also:
+%% isShown(This, Window) -> boolean() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer().
+%% -spec isShown(This, Index) -> boolean() when This::wxSizer(), Index::integer(); (This, Window) -> boolean() when @@ -455,6 +491,16 @@ prepend(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% prepend(This, Window, [Option]) -> wxSizerItem:wxSizerItem() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(),
+%% Option :: {proportion, integer()}
+%% | {flag, integer()}
+%% | {border, integer()}
+%% | {userData, wx:wx()};
+%% (This, Window, Flags) -> wxSizerItem:wxSizerItem() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Flags::wxSizerFlags:wxSizerFlags().
+%% -spec prepend(This, Width, Height) -> wxSizerItem:wxSizerItem() when This::wxSizer(), Width::integer(), Height::integer(); (This, Window, [Option]) -> wxSizerItem:wxSizerItem() when @@ -557,6 +603,10 @@ recalcSizes(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% remove(This, Sizer) -> boolean() when
+%% This::wxSizer(), Sizer::wxSizer().
+%% -spec remove(This, Index) -> boolean() when This::wxSizer(), Index::integer(); (This, Sizer) -> boolean() when @@ -573,6 +623,10 @@ remove(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SizerT,ref=SizerRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% replace(This, Index, Newitem) -> boolean() when
+%% This::wxSizer(), Index::integer(), Newitem::wxSizerItem:wxSizerItem().
+%% -spec replace(This, Oldwin, Newwin) -> boolean() when This::wxSizer(), Oldwin::wxWindow:wxWindow() | wxSizer(), Newwin::wxWindow:wxWindow() | wxSizer(); (This, Index, Newitem) -> boolean() when @@ -637,6 +691,10 @@ setMinSize(#wx_ref{type=ThisT,ref=ThisRef},Width,Height) <>). %% @doc See external documentation. +%%
Also:
+%% setItemMinSize(This, Window, Size) -> boolean() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Size::{W::integer(), H::integer()}.
+%% -spec setItemMinSize(This, Index, Size) -> boolean() when This::wxSizer(), Index::integer(), Size::{W::integer(), H::integer()}; (This, Window, Size) -> boolean() when @@ -659,6 +717,10 @@ setItemMinSize(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRe <>). %% @doc See external documentation. +%%
Also:
+%% setItemMinSize(This, Window, Width, Height) -> boolean() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Width::integer(), Height::integer().
+%% -spec setItemMinSize(This, Index, Width, Height) -> boolean() when This::wxSizer(), Index::integer(), Width::integer(), Height::integer(); (This, Window, Width, Height) -> boolean() when @@ -699,6 +761,12 @@ setVirtualSizeHints(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=Win <>). %% @doc See external documentation. +%%
Also:
+%% show(This, Window) -> boolean() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer();
+%% (This, Show) -> ok when
+%% This::wxSizer(), Show::boolean().
+%% -spec show(This, Index) -> boolean() when This::wxSizer(), Index::integer(); (This, Window) -> boolean() when @@ -720,6 +788,12 @@ show(#wx_ref{type=ThisT,ref=ThisRef},Show) <>). %% @doc See external documentation. +%%
Also:
+%% show(This, Window, [Option]) -> boolean() when
+%% This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(),
+%% Option :: {show, boolean()}
+%% | {recursive, boolean()}.
+%% -spec show(This, Index, [Option]) -> boolean() when This::wxSizer(), Index::integer(), Option :: {show, boolean()}; diff --git a/lib/wx/src/gen/wxSizerItem.erl b/lib/wx/src/gen/wxSizerItem.erl index 7a0ce1e508..22533500da 100644 --- a/lib/wx/src/gen/wxSizerItem.erl +++ b/lib/wx/src/gen/wxSizerItem.erl @@ -311,6 +311,10 @@ setProportion(#wx_ref{type=ThisT,ref=ThisRef},Proportion) <>). %% @doc See external documentation. +%%
Also:
+%% setRatio(This, Size) -> ok when
+%% This::wxSizerItem(), Size::{W::integer(), H::integer()}.
+%% -spec setRatio(This, Ratio) -> ok when This::wxSizerItem(), Ratio::number(); (This, Size) -> ok when diff --git a/lib/wx/src/gen/wxSpinCtrl.erl b/lib/wx/src/gen/wxSpinCtrl.erl index 17d7e49a8d..82e49da46d 100644 --- a/lib/wx/src/gen/wxSpinCtrl.erl +++ b/lib/wx/src/gen/wxSpinCtrl.erl @@ -156,6 +156,10 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti <>). %% @doc See external documentation. +%%
Also:
+%% setValue(This, Text) -> ok when
+%% This::wxSpinCtrl(), Text::unicode:chardata().
+%% -spec setValue(This, Value) -> ok when This::wxSpinCtrl(), Value::integer(); (This, Text) -> ok when diff --git a/lib/wx/src/gen/wxStaticBoxSizer.erl b/lib/wx/src/gen/wxStaticBoxSizer.erl index 32e6250502..fc8afc1146 100644 --- a/lib/wx/src/gen/wxStaticBoxSizer.erl +++ b/lib/wx/src/gen/wxStaticBoxSizer.erl @@ -49,6 +49,10 @@ parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -type wxStaticBoxSizer() :: wx:wx_object(). %% @doc See external documentation. +%%
Also:
+%% new(Box, Orient) -> wxStaticBoxSizer() when
+%% Box::wxStaticBox:wxStaticBox(), Orient::integer().
+%% -spec new(Orient, Win) -> wxStaticBoxSizer() when Orient::integer(), Win::wxWindow:wxWindow(); (Box, Orient) -> wxStaticBoxSizer() when diff --git a/lib/wx/src/gen/wxStyledTextCtrl.erl b/lib/wx/src/gen/wxStyledTextCtrl.erl index 0271548cad..586a2852e2 100644 --- a/lib/wx/src/gen/wxStyledTextCtrl.erl +++ b/lib/wx/src/gen/wxStyledTextCtrl.erl @@ -3967,8 +3967,8 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},Filename) <>). %% @doc See external documentation. -%%
Res = ?wxDragError | ?wxDragNone | ?wxDragCopy | ?wxDragMove | ?wxDragLink | ?wxDragCancel %%
Def = ?wxDragError | ?wxDragNone | ?wxDragCopy | ?wxDragMove | ?wxDragLink | ?wxDragCancel +%%
Res = ?wxDragError | ?wxDragNone | ?wxDragCopy | ?wxDragMove | ?wxDragLink | ?wxDragCancel -spec doDragOver(This, X, Y, Def) -> wx:wx_enum() when This::wxStyledTextCtrl(), X::integer(), Y::integer(), Def::wx:wx_enum(). doDragOver(#wx_ref{type=ThisT,ref=ThisRef},X,Y,Def) diff --git a/lib/wx/src/gen/wxSystemOptions.erl b/lib/wx/src/gen/wxSystemOptions.erl index 69ef70b2ef..757eb698a2 100644 --- a/lib/wx/src/gen/wxSystemOptions.erl +++ b/lib/wx/src/gen/wxSystemOptions.erl @@ -71,6 +71,10 @@ isFalse(Name) <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). %% @doc See external documentation. +%%
Also:
+%% setOption(Name, Value) -> ok when
+%% Name::unicode:chardata(), Value::unicode:chardata().
+%% -spec setOption(Name, Value) -> ok when Name::unicode:chardata(), Value::integer(); (Name, Value) -> ok when diff --git a/lib/wx/src/gen/wxToolBar.erl b/lib/wx/src/gen/wxToolBar.erl index dd03df5d18..e55becb748 100644 --- a/lib/wx/src/gen/wxToolBar.erl +++ b/lib/wx/src/gen/wxToolBar.erl @@ -120,6 +120,15 @@ addTool(This,Toolid,Bitmap) addTool(This,Toolid,Bitmap, []). %% @doc See external documentation. +%%
Also:
+%% addTool(This, Toolid, Bitmap, BmpDisabled) -> wx:wx() when
+%% This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap();
+%% (This, Toolid, Bitmap, [Option]) -> wx:wx() when
+%% This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(),
+%% Option :: {shortHelpString, unicode:chardata()}
+%% | {longHelpString, unicode:chardata()}.
+%% +%%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -spec addTool(This, Toolid, Label, Bitmap) -> wx:wx() when This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(); (This, Toolid, Bitmap, BmpDisabled) -> wx:wx() when @@ -148,6 +157,19 @@ addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,#wx_ref{type=BitmapT,ref=BitmapRe <>). %% @doc See external documentation. +%%
Also:
+%% addTool(This, Toolid, Label, Bitmap, [Option]) -> wx:wx() when
+%% This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(),
+%% Option :: {shortHelp, unicode:chardata()}
+%% | {kind, wx:wx_enum()};
+%% (This, Toolid, Bitmap, BmpDisabled, [Option]) -> wx:wx() when
+%% This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(),
+%% Option :: {toggle, boolean()}
+%% | {clientData, wx:wx()}
+%% | {shortHelpString, unicode:chardata()}
+%% | {longHelpString, unicode:chardata()}.
+%% +%%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -spec addTool(This, Toolid, Label, Bitmap, BmpDisabled) -> wx:wx() when This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(); (This, Toolid, Label, Bitmap, [Option]) -> wx:wx() when @@ -190,6 +212,15 @@ addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,#wx_ref{type=BitmapT,ref=BitmapRe <>). %% @doc See external documentation. +%%
Also:
+%% addTool(This, Toolid, Label, Bitmap, BmpDisabled, [Option]) -> wx:wx() when
+%% This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(),
+%% Option :: {kind, wx:wx_enum()}
+%% | {shortHelp, unicode:chardata()}
+%% | {longHelp, unicode:chardata()}
+%% | {data, wx:wx()}.
+%% +%%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -spec addTool(This, Toolid, Bitmap, BmpDisabled, Toggle, XPos) -> wx:wx() when This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), Toggle::boolean(), XPos::integer(); (This, Toolid, Label, Bitmap, BmpDisabled, [Option]) -> wx:wx() when @@ -473,6 +504,16 @@ insertTool(This,Pos,Toolid,Bitmap) insertTool(This,Pos,Toolid,Bitmap, []). %% @doc See external documentation. +%%
Also:
+%% insertTool(This, Pos, Toolid, Bitmap, [Option]) -> wx:wx() when
+%% This::wxToolBar(), Pos::integer(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(),
+%% Option :: {bmpDisabled, wxBitmap:wxBitmap()}
+%% | {toggle, boolean()}
+%% | {clientData, wx:wx()}
+%% | {shortHelp, unicode:chardata()}
+%% | {longHelp, unicode:chardata()}.
+%% +%%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -spec insertTool(This, Pos, Toolid, Label, Bitmap) -> wx:wx() when This::wxToolBar(), Pos::integer(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(); (This, Pos, Toolid, Bitmap, [Option]) -> wx:wx() when diff --git a/lib/wx/src/gen/wxWindow.erl b/lib/wx/src/gen/wxWindow.erl index ecae29ea5f..d31f489726 100644 --- a/lib/wx/src/gen/wxWindow.erl +++ b/lib/wx/src/gen/wxWindow.erl @@ -324,6 +324,10 @@ findFocus() -> <<>>). %% @doc See external documentation. +%%
Also:
+%% findWindow(This, Name) -> wxWindow() when
+%% This::wxWindow(), Name::unicode:chardata().
+%% -spec findWindow(This, Winid) -> wxWindow() when This::wxWindow(), Winid::integer(); (This, Name) -> wxWindow() when @@ -839,6 +843,10 @@ isEnabled(#wx_ref{type=ThisT,ref=ThisRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% isExposed(This, Rect) -> boolean() when
+%% This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec isExposed(This, Pt) -> boolean() when This::wxWindow(), Pt::{X::integer(), Y::integer()}; (This, Rect) -> boolean() when @@ -958,6 +966,11 @@ move(This,Pt={PtX,PtY}) move(This,Pt, []). %% @doc See external documentation. +%%
Also:
+%% move(This, Pt, [Option]) -> ok when
+%% This::wxWindow(), Pt::{X::integer(), Y::integer()},
+%% Option :: {flags, integer()}.
+%% -spec move(This, X, Y) -> ok when This::wxWindow(), X::integer(), Y::integer(); (This, Pt, [Option]) -> ok when @@ -1278,6 +1291,10 @@ setCaret(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CaretT,ref=CaretRef}) -> <>). %% @doc See external documentation. +%%
Also:
+%% setClientSize(This, Rect) -> ok when
+%% This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
+%% -spec setClientSize(This, Size) -> ok when This::wxWindow(), Size::{W::integer(), H::integer()}; (This, Rect) -> ok when @@ -1508,6 +1525,10 @@ setScrollPos(#wx_ref{type=ThisT,ref=ThisRef},Orient,Pos, Options) <>). %% @doc See external documentation. +%%
Also:
+%% setSize(This, Size) -> ok when
+%% This::wxWindow(), Size::{W::integer(), H::integer()}.
+%% -spec setSize(This, Rect) -> ok when This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}; (This, Size) -> ok when @@ -1523,6 +1544,11 @@ setSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) <>). %% @doc See external documentation. +%%
Also:
+%% setSize(This, Rect, [Option]) -> ok when
+%% This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()},
+%% Option :: {sizeFlags, integer()}.
+%% -spec setSize(This, Width, Height) -> ok when This::wxWindow(), Width::integer(), Height::integer(); (This, Rect, [Option]) -> ok when @@ -1572,6 +1598,12 @@ setSizeHints(This,MinSize={MinSizeW,MinSizeH}) setSizeHints(This,MinSize, []). %% @doc See external documentation. +%%
Also:
+%% setSizeHints(This, MinSize, [Option]) -> ok when
+%% This::wxWindow(), MinSize::{W::integer(), H::integer()},
+%% Option :: {maxSize, {W::integer(), H::integer()}}
+%% | {incSize, {W::integer(), H::integer()}}.
+%% -spec setSizeHints(This, MinW, MinH) -> ok when This::wxWindow(), MinW::integer(), MinH::integer(); (This, MinSize, [Option]) -> ok when @@ -1665,6 +1697,10 @@ setThemeEnabled(#wx_ref{type=ThisT,ref=ThisRef},EnableTheme) <>). %% @doc See external documentation. +%%
Also:
+%% setToolTip(This, Tip) -> ok when
+%% This::wxWindow(), Tip::wxToolTip:wxToolTip().
+%% -spec setToolTip(This, Tip) -> ok when This::wxWindow(), Tip::unicode:chardata(); (This, Tip) -> ok when @@ -1708,6 +1744,11 @@ setVirtualSizeHints(This,MinSize={MinSizeW,MinSizeH}) setVirtualSizeHints(This,MinSize, []). %% @doc See external documentation. +%%
Also:
+%% setVirtualSizeHints(This, MinSize, [Option]) -> ok when
+%% This::wxWindow(), MinSize::{W::integer(), H::integer()},
+%% Option :: {maxSize, {W::integer(), H::integer()}}.
+%% -spec setVirtualSizeHints(This, MinW, MinH) -> ok when This::wxWindow(), MinW::integer(), MinH::integer(); (This, MinSize, [Option]) -> ok when -- cgit v1.2.3