From a181c06152a3c935fdf63659322020fb7625b577 Mon Sep 17 00:00:00 2001 From: Dan Gudmundsson Date: Thu, 16 Feb 2012 11:04:18 +0100 Subject: [wx] Generated types for all wx classes --- lib/wx/api_gen/wx_extra/wxEvtHandler.erl | 26 +- lib/wx/api_gen/wx_gen_erl.erl | 412 ++++---- lib/wx/doc/src/Makefile | 4 +- lib/wx/include/wx.hrl | 433 ++++---- lib/wx/src/gen/wxAcceleratorEntry.erl | 43 +- lib/wx/src/gen/wxAcceleratorTable.erl | 14 +- lib/wx/src/gen/wxArtProvider.erl | 24 +- lib/wx/src/gen/wxAuiDockArt.erl | 4 +- lib/wx/src/gen/wxAuiManager.erl | 120 ++- lib/wx/src/gen/wxAuiManagerEvent.erl | 46 +- lib/wx/src/gen/wxAuiNotebook.erl | 100 +- lib/wx/src/gen/wxAuiNotebookEvent.erl | 22 +- lib/wx/src/gen/wxAuiPaneInfo.erl | 332 ++++-- lib/wx/src/gen/wxAuiTabArt.erl | 4 +- lib/wx/src/gen/wxBitmap.erl | 133 +-- lib/wx/src/gen/wxBitmapButton.erl | 56 +- lib/wx/src/gen/wxBitmapDataObject.erl | 28 +- lib/wx/src/gen/wxBoxSizer.erl | 12 +- lib/wx/src/gen/wxBrush.erl | 51 +- lib/wx/src/gen/wxBufferedDC.erl | 54 +- lib/wx/src/gen/wxBufferedPaintDC.erl | 28 +- lib/wx/src/gen/wxButton.erl | 42 +- lib/wx/src/gen/wxCalendarCtrl.erl | 114 +- lib/wx/src/gen/wxCalendarDateAttr.erl | 98 +- lib/wx/src/gen/wxCalendarEvent.erl | 10 +- lib/wx/src/gen/wxCaret.erl | 62 +- lib/wx/src/gen/wxCheckBox.erl | 59 +- lib/wx/src/gen/wxCheckListBox.erl | 33 +- lib/wx/src/gen/wxChildFocusEvent.erl | 7 +- lib/wx/src/gen/wxChoice.erl | 46 +- lib/wx/src/gen/wxChoicebook.erl | 114 +- lib/wx/src/gen/wxClientDC.erl | 11 +- lib/wx/src/gen/wxClipboard.erl | 46 +- lib/wx/src/gen/wxCloseEvent.erl | 25 +- lib/wx/src/gen/wxColourData.erl | 29 +- lib/wx/src/gen/wxColourDialog.erl | 29 +- lib/wx/src/gen/wxColourPickerCtrl.erl | 49 +- lib/wx/src/gen/wxColourPickerEvent.erl | 7 +- lib/wx/src/gen/wxComboBox.erl | 92 +- lib/wx/src/gen/wxCommandEvent.erl | 31 +- lib/wx/src/gen/wxContextMenuEvent.erl | 10 +- lib/wx/src/gen/wxControl.erl | 10 +- lib/wx/src/gen/wxControlWithItems.erl | 67 +- lib/wx/src/gen/wxCursor.erl | 33 +- lib/wx/src/gen/wxDC.erl | 333 +++--- lib/wx/src/gen/wxDataObject.erl | 4 +- lib/wx/src/gen/wxDateEvent.erl | 7 +- lib/wx/src/gen/wxDatePickerCtrl.erl | 33 +- lib/wx/src/gen/wxDialog.erl | 66 +- lib/wx/src/gen/wxDirDialog.erl | 31 +- lib/wx/src/gen/wxDirPickerCtrl.erl | 42 +- lib/wx/src/gen/wxDisplayChangedEvent.erl | 4 +- lib/wx/src/gen/wxEraseEvent.erl | 7 +- lib/wx/src/gen/wxEvent.erl | 34 +- lib/wx/src/gen/wxEvtHandler.erl | 28 +- lib/wx/src/gen/wxFileDataObject.erl | 14 +- lib/wx/src/gen/wxFileDialog.erl | 63 +- lib/wx/src/gen/wxFileDirPickerEvent.erl | 7 +- lib/wx/src/gen/wxFilePickerCtrl.erl | 44 +- lib/wx/src/gen/wxFindReplaceData.erl | 29 +- lib/wx/src/gen/wxFindReplaceDialog.erl | 29 +- lib/wx/src/gen/wxFlexGridSizer.erl | 61 +- lib/wx/src/gen/wxFocusEvent.erl | 7 +- lib/wx/src/gen/wxFont.erl | 102 +- lib/wx/src/gen/wxFontData.erl | 50 +- lib/wx/src/gen/wxFontDialog.erl | 17 +- lib/wx/src/gen/wxFontPickerCtrl.erl | 46 +- lib/wx/src/gen/wxFontPickerEvent.erl | 7 +- lib/wx/src/gen/wxFrame.erl | 96 +- lib/wx/src/gen/wxGBSizerItem.erl | 4 +- lib/wx/src/gen/wxGLCanvas.erl | 49 +- lib/wx/src/gen/wxGauge.erl | 62 +- lib/wx/src/gen/wxGenericDirCtrl.erl | 83 +- lib/wx/src/gen/wxGraphicsBrush.erl | 4 +- lib/wx/src/gen/wxGraphicsContext.erl | 168 +-- lib/wx/src/gen/wxGraphicsFont.erl | 4 +- lib/wx/src/gen/wxGraphicsMatrix.erl | 52 +- lib/wx/src/gen/wxGraphicsObject.erl | 10 +- lib/wx/src/gen/wxGraphicsPath.erl | 83 +- lib/wx/src/gen/wxGraphicsPen.erl | 4 +- lib/wx/src/gen/wxGraphicsRenderer.erl | 47 +- lib/wx/src/gen/wxGrid.erl | 772 +++++++++----- lib/wx/src/gen/wxGridBagSizer.erl | 165 +-- lib/wx/src/gen/wxGridCellAttr.erl | 73 +- lib/wx/src/gen/wxGridCellBoolEditor.erl | 19 +- lib/wx/src/gen/wxGridCellBoolRenderer.erl | 8 +- lib/wx/src/gen/wxGridCellChoiceEditor.erl | 18 +- lib/wx/src/gen/wxGridCellEditor.erl | 43 +- lib/wx/src/gen/wxGridCellFloatEditor.erl | 17 +- lib/wx/src/gen/wxGridCellFloatRenderer.erl | 29 +- lib/wx/src/gen/wxGridCellNumberEditor.erl | 20 +- lib/wx/src/gen/wxGridCellNumberRenderer.erl | 8 +- lib/wx/src/gen/wxGridCellRenderer.erl | 10 +- lib/wx/src/gen/wxGridCellStringRenderer.erl | 8 +- lib/wx/src/gen/wxGridCellTextEditor.erl | 11 +- lib/wx/src/gen/wxGridEvent.erl | 28 +- lib/wx/src/gen/wxGridSizer.erl | 43 +- lib/wx/src/gen/wxHelpEvent.erl | 22 +- lib/wx/src/gen/wxHtmlEasyPrinting.erl | 74 +- lib/wx/src/gen/wxHtmlLinkEvent.erl | 7 +- lib/wx/src/gen/wxHtmlWindow.erl | 92 +- lib/wx/src/gen/wxIcon.erl | 32 +- lib/wx/src/gen/wxIconBundle.erl | 38 +- lib/wx/src/gen/wxIconizeEvent.erl | 7 +- lib/wx/src/gen/wxIdleEvent.erl | 30 +- lib/wx/src/gen/wxImage.erl | 409 +++++--- lib/wx/src/gen/wxImageList.erl | 78 +- lib/wx/src/gen/wxJoystickEvent.erl | 55 +- lib/wx/src/gen/wxKeyEvent.erl | 46 +- lib/wx/src/gen/wxLayoutAlgorithm.erl | 35 +- lib/wx/src/gen/wxListBox.erl | 62 +- lib/wx/src/gen/wxListCtrl.erl | 256 +++-- lib/wx/src/gen/wxListEvent.erl | 43 +- lib/wx/src/gen/wxListItem.erl | 89 +- lib/wx/src/gen/wxListItemAttr.erl | 38 +- lib/wx/src/gen/wxListView.erl | 34 +- lib/wx/src/gen/wxListbook.erl | 114 +- lib/wx/src/gen/wxLogNull.erl | 8 +- lib/wx/src/gen/wxMDIChildFrame.erl | 45 +- lib/wx/src/gen/wxMDIClientWindow.erl | 26 +- lib/wx/src/gen/wxMDIParentFrame.erl | 60 +- lib/wx/src/gen/wxMask.erl | 38 +- lib/wx/src/gen/wxMaximizeEvent.erl | 4 +- lib/wx/src/gen/wxMemoryDC.erl | 17 +- lib/wx/src/gen/wxMenu.erl | 286 ++--- lib/wx/src/gen/wxMenuBar.erl | 89 +- lib/wx/src/gen/wxMenuEvent.erl | 13 +- lib/wx/src/gen/wxMenuItem.erl | 99 +- lib/wx/src/gen/wxMessageDialog.erl | 17 +- lib/wx/src/gen/wxMiniFrame.erl | 30 +- lib/wx/src/gen/wxMirrorDC.erl | 9 +- lib/wx/src/gen/wxMouseCaptureChangedEvent.erl | 7 +- lib/wx/src/gen/wxMouseEvent.erl | 127 ++- lib/wx/src/gen/wxMoveEvent.erl | 7 +- lib/wx/src/gen/wxMultiChoiceDialog.erl | 24 +- lib/wx/src/gen/wxNavigationKeyEvent.erl | 28 +- lib/wx/src/gen/wxNcPaintEvent.erl | 4 +- lib/wx/src/gen/wxNotebook.erl | 123 ++- lib/wx/src/gen/wxNotebookEvent.erl | 16 +- lib/wx/src/gen/wxNotifyEvent.erl | 13 +- lib/wx/src/gen/wxPageSetupDialog.erl | 21 +- lib/wx/src/gen/wxPageSetupDialogData.erl | 107 +- lib/wx/src/gen/wxPaintDC.erl | 11 +- lib/wx/src/gen/wxPaintEvent.erl | 4 +- lib/wx/src/gen/wxPalette.erl | 27 +- lib/wx/src/gen/wxPaletteChangedEvent.erl | 10 +- lib/wx/src/gen/wxPanel.erl | 32 +- lib/wx/src/gen/wxPasswordEntryDialog.erl | 18 +- lib/wx/src/gen/wxPen.erl | 54 +- lib/wx/src/gen/wxPickerBase.erl | 52 +- lib/wx/src/gen/wxPostScriptDC.erl | 16 +- lib/wx/src/gen/wxPreviewCanvas.erl | 4 +- lib/wx/src/gen/wxPreviewControlBar.erl | 29 +- lib/wx/src/gen/wxPreviewFrame.erl | 30 +- lib/wx/src/gen/wxPrintData.erl | 80 +- lib/wx/src/gen/wxPrintDialog.erl | 30 +- lib/wx/src/gen/wxPrintDialogData.erl | 83 +- lib/wx/src/gen/wxPrintPreview.erl | 67 +- lib/wx/src/gen/wxPrinter.erl | 45 +- lib/wx/src/gen/wxPrintout.erl | 66 +- lib/wx/src/gen/wxProgressDialog.erl | 32 +- lib/wx/src/gen/wxQueryNewPaletteEvent.erl | 10 +- lib/wx/src/gen/wxRadioBox.erl | 108 +- lib/wx/src/gen/wxRadioButton.erl | 38 +- lib/wx/src/gen/wxRegion.erl | 142 ++- lib/wx/src/gen/wxSashEvent.erl | 19 +- lib/wx/src/gen/wxSashLayoutWindow.erl | 59 +- lib/wx/src/gen/wxSashWindow.erl | 56 +- lib/wx/src/gen/wxScreenDC.erl | 8 +- lib/wx/src/gen/wxScrollBar.erl | 56 +- lib/wx/src/gen/wxScrollEvent.erl | 10 +- lib/wx/src/gen/wxScrollWinEvent.erl | 10 +- lib/wx/src/gen/wxScrolledWindow.erl | 67 +- lib/wx/src/gen/wxSetCursorEvent.erl | 19 +- lib/wx/src/gen/wxShowEvent.erl | 10 +- lib/wx/src/gen/wxSingleChoiceDialog.erl | 27 +- lib/wx/src/gen/wxSizeEvent.erl | 7 +- lib/wx/src/gen/wxSizer.erl | 328 +++--- lib/wx/src/gen/wxSizerFlags.erl | 46 +- lib/wx/src/gen/wxSizerItem.erl | 128 ++- lib/wx/src/gen/wxSlider.erl | 65 +- lib/wx/src/gen/wxSpinButton.erl | 47 +- lib/wx/src/gen/wxSpinCtrl.erl | 67 +- lib/wx/src/gen/wxSpinEvent.erl | 10 +- lib/wx/src/gen/wxSplashScreen.erl | 25 +- lib/wx/src/gen/wxSplitterEvent.erl | 19 +- lib/wx/src/gen/wxSplitterWindow.erl | 113 +- lib/wx/src/gen/wxStaticBitmap.erl | 36 +- lib/wx/src/gen/wxStaticBox.erl | 30 +- lib/wx/src/gen/wxStaticBoxSizer.erl | 25 +- lib/wx/src/gen/wxStaticLine.erl | 37 +- lib/wx/src/gen/wxStaticText.erl | 39 +- lib/wx/src/gen/wxStatusBar.erl | 88 +- lib/wx/src/gen/wxStdDialogButtonSizer.erl | 23 +- lib/wx/src/gen/wxStyledTextCtrl.erl | 1389 ++++++++++++++++--------- lib/wx/src/gen/wxStyledTextEvent.erl | 76 +- lib/wx/src/gen/wxSysColourChangedEvent.erl | 4 +- lib/wx/src/gen/wxSystemOptions.erl | 28 +- lib/wx/src/gen/wxSystemSettings.erl | 33 +- lib/wx/src/gen/wxTextAttr.erl | 103 +- lib/wx/src/gen/wxTextCtrl.erl | 186 ++-- lib/wx/src/gen/wxTextDataObject.erl | 22 +- lib/wx/src/gen/wxTextEntryDialog.erl | 24 +- lib/wx/src/gen/wxToggleButton.erl | 38 +- lib/wx/src/gen/wxToolBar.erl | 228 ++-- lib/wx/src/gen/wxToolTip.erl | 24 +- lib/wx/src/gen/wxToolbook.erl | 114 +- lib/wx/src/gen/wxTopLevelWindow.erl | 91 +- lib/wx/src/gen/wxTreeCtrl.erl | 318 ++++-- lib/wx/src/gen/wxTreeEvent.erl | 28 +- lib/wx/src/gen/wxTreebook.erl | 136 ++- lib/wx/src/gen/wxUpdateUIEvent.erl | 61 +- lib/wx/src/gen/wxWindow.erl | 755 +++++++++----- lib/wx/src/gen/wxWindowCreateEvent.erl | 4 +- lib/wx/src/gen/wxWindowDC.erl | 11 +- lib/wx/src/gen/wxWindowDestroyEvent.erl | 4 +- lib/wx/src/gen/wxXmlResource.erl | 103 +- lib/wx/src/gen/wx_misc.erl | 78 +- lib/wx/src/wx.erl | 150 +-- 219 files changed, 9629 insertions(+), 5593 deletions(-) diff --git a/lib/wx/api_gen/wx_extra/wxEvtHandler.erl b/lib/wx/api_gen/wx_extra/wxEvtHandler.erl index 080ebfa49f..23a34225ca 100644 --- a/lib/wx/api_gen/wx_extra/wxEvtHandler.erl +++ b/lib/wx/api_gen/wx_extra/wxEvtHandler.erl @@ -18,10 +18,7 @@ %% %% The orginal documentation. %% -%% @headerfile "../../include/wx.hrl" %% -%%@type wxEvtHandler(). An object reference - -module(wxEvtHandler). -include("wxe.hrl"). -include("../include/wx.hrl"). @@ -34,17 +31,16 @@ new_evt_listener/0, destroy_evt_listener/1, get_callback/1, replace_fun_with_id/2]). --record(evh, {et=null,id=?wxID_ANY,lastId=?wxID_ANY,skip=undefined,userdata=[],cb=0}). - +-export_type([wxEvtHandler/0, wx/0, event/0]). +-type wxEvtHandler() :: wx:wx_object(). +-record(evh, {et=null,id=?wxID_ANY,lastId=?wxID_ANY,skip=undefined,userdata=[],cb=0}). -%% @spec (This::wxEvtHandler(), EventType::wxEventType()) -> ok %% @doc Equivalent to {@link connect/3. connect(This, EventType, [])} - +-spec connect(This::wxEvtHandler(), EventType::wxEventType()) -> ok. connect(This, EventType) -> connect(This, EventType, []). -%% @spec (This::wxEvtHandler(), EventType::wxEventType(), [Options]) -> ok %% @doc This function subscribes the to events of EventType, %% in the range id, lastId. The events will be received as messages %% if no callback is supplied. @@ -63,6 +59,9 @@ connect(This, EventType) -> %% to process the event. Default not specfied i.e. a message will %% be delivered to the process calling this function. %% {userData, term()} An erlang term that will be sent with the event. Default: []. +-spec connect(This::wxEvtHandler(), EventType::wxEventType(), [Option]) -> ok when + Option :: {id, integer()} | {lastId, integer()} | {skip, boolean()} | + {callback, function()} | {userData, term()}. connect(This=#wx_ref{type=ThisT}, EventType, Options) -> EvH = parse_opts(Options, #evh{et=EventType}), ?CLASS(ThisT,wxEvtHandler), @@ -99,26 +98,27 @@ parse_opts([], Opts = #evh{id=Id,lastId=Lid,skip=Skip, cb=CB}) -> Opts end. -%% @spec (This::wxEvtHandler()) -> true | false + %% @doc Equivalent to {@link disconnect/3. disconnect(This, null, [])} %% Can also have an optional callback Fun() as an additional last argument. - +-spec disconnect(This::wxEvtHandler()) -> boolean(). disconnect(This=#wx_ref{type=ThisT,ref=_ThisRef}) -> ?CLASS(ThisT,wxEvtHandler), disconnect(This, null, []). -%% @spec (This::wxEvtHandler(), EventType::wxEventType()) -> true | false %% @doc Equivalent to {@link disconnect/3. disconnect(This, EventType, [])} +-spec disconnect(This::wxEvtHandler(), EventType::wxEventType()) -> boolean(). disconnect(This=#wx_ref{type=ThisT,ref=_ThisRef}, EventType) when is_atom(EventType) -> ?CLASS(ThisT,wxEvtHandler), disconnect(This, EventType, []). -%% @spec (This::wxEvtHandler(), EventType::wxEventType(), Opts) -> true | false %% @doc See external documentation %% This function unsubscribes the process or callback fun from the event handler. %% EventType may be the atom 'null' to match any eventtype. %% Notice that the options skip and userdata is not used to match the eventhandler. -disconnect(This=#wx_ref{type=ThisT,ref=_ThisRef}, EventType, Opts) -> +-spec disconnect(This::wxEvtHandler(), EventType::wxEventType(), [Option]) -> boolean() when + Option :: {id, integer()} | {lastId, integer()} | {callback, function()}. +disconnect(This=#wx_ref{type=ThisT,ref=_ThisRef}, EventType, Opts) -> ?CLASS(ThisT,wxEvtHandler), EvH = parse_opts(Opts, #evh{et=EventType}), case wxe_util:disconnect_cb(This, EvH) of diff --git a/lib/wx/api_gen/wx_gen_erl.erl b/lib/wx/api_gen/wx_gen_erl.erl index 5d73d93ead..5e35631589 100644 --- a/lib/wx/api_gen/wx_gen_erl.erl +++ b/lib/wx/api_gen/wx_gen_erl.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 @@ -28,12 +28,16 @@ -include("wx_gen.hrl"). --compile(export_all). +%%-compile(export_all). +-export([gen/1]). +-export([parents/1, get_unique_names/0, get_unique_name/1, + event_type_name/1, event_rec_name/1, filter_attrs/1]). --import(lists, [foldl/3,foldr/3,reverse/1, keysearch/3, map/2, filter/2]). --import(gen_util, [lowercase/1, lowercase_all/1, uppercase/1, uppercase_all/1, + +-import(lists, [foldl/3,reverse/1, filter/2]). +-import(gen_util, [lowercase/1, lowercase_all/1, uppercase/1, open_write/1, close/0, erl_copyright/0, w/2, - args/3, args/4, strip_name/2]). + args/3, args/4]). gen(Defs) -> [put({class,N},C) || C=#class{name=N} <- Defs], @@ -128,8 +132,6 @@ gen_class1(C=#class{name=Name,parent=Parent,methods=Ms,options=Opts}) -> w("%% stored on disc or distributed for use on other nodes.~n~n", []), w("-module(~s).~n", [Name]), w("-include(\"wxe.hrl\").~n",[]), - %% w("-compile(export_all).~n~n", []), %% XXXX remove ??? - %% w("-compile(nowarn_unused_vars).~n~n", []), %% XXXX remove ??? Exp = fun(M) -> gen_export(C,M) end, ExportList = lists:usort(lists:append(lists:map(Exp,reverse(Ms)))), w("-export([~s]).~n~n", [args(fun(EF) -> EF end, ",", ExportList, 60)]), @@ -140,10 +142,10 @@ gen_class1(C=#class{name=Name,parent=Parent,methods=Ms,options=Opts}) -> w("-export([~s]).~n~n", [args(fun(EF) -> EF end, ",", lists:usort(["parent_class/1"|InExported]), 60)]), - + w("-export_type([~s/0]).~n", [Name]), w("%% @hidden~n", []), parents_check(Parents), - + w("-type ~s() :: wx:wx_object().~n", [Name]), Gen = fun(M) -> gen_method(Name,M) end, NewMs = lists:map(Gen,reverse(Ms)), gen_dest(C, Ms), @@ -317,8 +319,8 @@ gen_dest(#class{name=CName,abstract=Abs}, Ms) -> end. gen_dest2(Class, Id) -> - w("%% @spec (This::~s()) -> ok~n", [Class]), w("%% @doc Destroys this object, do not use object again~n", []), + w("-spec destroy(This::~s) -> ok.~n", [Class]), w("destroy(Obj=#wx_ref{type=Type}) ->~n", []), w(" ?CLASS(Type,~s),~n",[Class]), case Id of @@ -635,142 +637,88 @@ guard_test(#param{name=N,type={class,ignore}}) -> guard_test(T) -> ?error({unknown_type,T}). gen_doc(_Class, [#method{method_type=destructor}]) -> skip; -gen_doc(_Class,[#method{name=N,alias=A,params=Ps,type=T,where=erl_no_opt,method_type=MT}])-> - w("%% @spec (~s~s) -> ~s~n",[doc_arg_types(Ps),"",doc_return_types(T,Ps)]), +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]); -gen_doc(Class,[#method{name=N,params=Ps,type=T}])-> - {_, Optional} = split_optional(Ps), - NonDef = [Arg || Arg = #param{def=Def,in=In, where=Where} <- Ps, - Def =:= none, In =/= false, Where =/= c], - OptsType = case Optional of - [] -> ""; - _ when NonDef =:= [] -> "[Option]"; - _ -> ", [Option]" - end, - w("%% @spec (~s~s) -> ~s~n", - [doc_arg_types(Ps),OptsType,doc_return_types(T,Ps)]), - doc_optional(Optional, normal), - DocEnum = doc_enum(T,Ps, normal), - case Class of - "utils" -> - w("%% @doc See " - "external documentation.~n", - [lowercase_all(N)]); - _ -> - w("%% @doc See " - "external documentation.~n", - [lowercase_all(Class),lowercase_all(Class),lowercase_all(N)]) - end, - doc_enum_desc(DocEnum); -gen_doc(Class, Cs = [#method{name=N, alias=A,method_type=MT}|_]) -> - GetRet = fun(#method{params=Ps,type=T}) -> - doc_return_types(T,Ps) - end, - GetArgs = fun(#method{params=Ps, where=Where}) -> - Opt = case Where of - erl_no_opt -> []; - _ -> - case split_optional(Ps) of - {_, []} -> []; - _ -> ["[Option]"] - end - end, - [doc_arg_type(P) || - P=#param{in=In,def=none,where=W} <- Ps, - In =/= false, W =/= c] ++ Opt - end, - Args = zip(lists:map(GetArgs, Cs)), - Ret = lists:map(GetRet, Cs), - w("%% @spec (~s) -> ~s~n",[args(fun doc_arg/1,",",Args),doc_ret(Ret)]), - case Class of - "utils" -> - w("%% @doc See " - "external documentation.~n", - [lowercase_all(N)]); - _ -> - w("%% @doc See " - "external documentation.~n", - [lowercase_all(Class),lowercase_all(Class),lowercase_all(N)]) - end, - Name = case MT of constructor -> "new"; _ -> erl_func_name(N,A) end, - w("%%
Alternatives:~n",[]), - [gen_doc2(Name, Clause) || Clause <- Cs], + 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}])-> + %%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), ok. -gen_doc2(Name,#method{params=Ps,where=erl_no_opt,method_type=MT}) -> - w("%%

~n",[]), - w("%% ~s(~s) -> ", [Name,doc_arg_types(Ps)]), - gen_function_clause(Name,MT,Ps,empty_list,[no_guards,name_only]), - w("

~n",[]); -gen_doc2(Name,#method{params=Ps,type=T}) -> +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}) -> + {NonDef, _Optional} = split_optional(Ps), + Res = doc_return_types(T,Ps), + write_spec(NonDef, [], Res); +write_spec(#method{params=Ps,type=T}) -> {NonDef, Optional} = split_optional(Ps), - OptsType = case Optional of - [] -> ""; - _ when NonDef =:= [] -> "[Option]"; - _ -> ", [Option]" - end, - w("%%

~n",[]), - w("%% ~s(~s~s) -> ~s ~n", - [Name,doc_arg_types(Ps),OptsType,doc_return_types(T,Ps)]), - doc_optional(Optional, xhtml), - DocEnum = doc_enum(T,Ps, xhtml), - doc_enum_desc(DocEnum), - w("%%

~n",[]). - -doc_arg(ArgList) -> - case all_eq(ArgList) of - true -> hd(ArgList); - false -> - Get = fun(Str) -> - [_Name|Types] = string:tokens(Str, ":"), - case Types of - [Type] -> Type; - _ -> - "term()" - end - end, - Args0 = lists:map(Get, ArgList), - Args = unique(Args0, []), - "X::" ++ args(fun(A) -> A end, "|", Args) - end. - -doc_ret(ArgList) -> - case all_eq(ArgList) of - true -> hd(ArgList); - false -> - args(fun(A) -> A end, "|", ArgList) - end. - -unique([], U) -> reverse(U); -unique([H|R], U) -> - case lists:member(H,U) of - false -> unique(R,[H|U]); - true -> unique(R,U) - end. - -all_eq([H|R]) -> all_eq(R,H). - -all_eq([H|R],H) -> all_eq(R,H); -all_eq([],_) -> true; -all_eq(_,_) -> false. - -zip(List) -> - zip(List, [], [], []). - -zip([[F|L1]|List], Rest, AccL, Acc) -> - zip(List, [L1|Rest], [F|AccL], Acc); -zip(Empty, Rest, AccL, Acc) -> - true = empty(Empty), - case empty(Rest) andalso empty(AccL) of - true -> reverse(Acc); - false -> - zip(reverse(Rest), [], [], [reverse(AccL)|Acc]) - end. - -empty([[]|R]) -> empty(R); -empty([]) -> true; -empty(_) -> false. + Res = doc_return_types(T,Ps), + write_spec(NonDef, Optional, Res). + +write_spec([], [], {simple, Res}) -> + 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). +optional_type2(#param{name=Name, def=Def, type=T}) -> + "{" ++ erl_option_name(Name) ++ ", " ++ doc_arg_type2(T) ++ "}". %% %% Default: " ++ Def. + +doc_link("utils", Func) -> + w("%% @doc See " + "external documentation.~n", + [lowercase_all(Func)]); +doc_link(Class, Func) -> + w("%% @doc See " + "external documentation.~n", + [lowercase_all(Class),lowercase_all(Class),lowercase_all(Func)]). + +erl_arg_names(Ps0) -> + Ps = [Name || #param{name=Name, in=In, where=Where} <- Ps0,In =/= false, Where =/= c], + args(fun erl_arg_name/1, ", ", Ps). doc_arg_types(Ps0) -> Ps = [P || P=#param{in=In, where=Where} <- Ps0,In =/= false, Where =/= c], @@ -789,13 +737,13 @@ doc_arg_type2(T) -> doc_arg_type3(#type{base=string}) -> "string()"; doc_arg_type3(#type{name="wxChar", single=S}) when S =/= true -> "string()"; doc_arg_type3(#type{name="wxArrayString"}) -> "[string()]"; -doc_arg_type3(#type{name="wxDateTime"}) -> "wx:datetime()"; +doc_arg_type3(#type{name="wxDateTime"}) -> "wx:wx_datetime()"; doc_arg_type3(#type{name="wxArtClient"}) -> "string()"; doc_arg_type3(#type{base=int}) -> "integer()"; doc_arg_type3(#type{base=int64}) -> "integer()"; doc_arg_type3(#type{base=long}) -> "integer()"; doc_arg_type3(#type{name="wxTreeItemId"}) -> "wxTreeCtrl:treeItemId()"; -doc_arg_type3(#type{base=bool}) -> "bool()"; +doc_arg_type3(#type{base=bool}) -> "boolean()"; doc_arg_type3(#type{base=float}) -> "float()"; doc_arg_type3(#type{base=double}) -> "float()"; doc_arg_type3(#type{base=binary}) -> "binary()"; @@ -820,12 +768,13 @@ doc_arg_type3({merged,_,T1=#type{base={class,N1}},_,_,T2=#type{base={class,N2}}, true -> N1++":" ++ N1++"() | "++ N2++":" ++ N2++"()" end; -doc_arg_type3(#type{base={enum,{_,N}}}) -> uppercase(N); -doc_arg_type3(#type{base={enum,N}}) -> uppercase(N); +%% doc_arg_type3(#type{base={enum,{_,N}}}) -> uppercase(N); +%% doc_arg_type3(#type{base={enum,N}}) -> uppercase(N); +doc_arg_type3(#type{base={enum,_N}}) -> "wx:wx_enum()"; doc_arg_type3(#type{base={comp,"wxColour",_Tup}}) -> - "wx:colour()"; + "wx:wx_colour()"; doc_arg_type3(#type{base={comp,_,{record,Name}}}) -> - "wx:" ++ atom_to_list(Name) ++ "()"; + "wx:wx_" ++ atom_to_list(Name) ++ "()"; doc_arg_type3(#type{base={comp,_,Tup}}) -> Doc = fun({int,V}) -> V ++ "::integer()"; ({double,V}) -> V ++ "::float()" @@ -835,45 +784,36 @@ doc_arg_type3(T) -> ?error({unknown_type,T}). doc_return_types(T, Ps) -> doc_return_types2(T, [P || P=#param{in=In} <- Ps,In =/= true]). -doc_return_types2(void, []) -> "ok"; -doc_return_types2(void, [#param{type=T}]) -> doc_arg_type2(T); -doc_return_types2(T, []) -> doc_arg_type2(T); +doc_return_types2(void, []) -> {simple, "ok"}; +doc_return_types2(void, [#param{type=T}]) -> {simple, doc_arg_type2(T)}; +doc_return_types2(T, []) -> {simple, doc_arg_type2(T)}; +doc_return_types2(void, Ps) when length(Ps) < 4 -> + {simple, "{" ++ args(fun doc_arg_type/1,", ",Ps) ++ "}"}; doc_return_types2(void, Ps) -> - "{" ++ args(fun doc_arg_type/1,", ",Ps) ++ "}"; + {complex, "{" ++ args(fun doc_arg_type/1,", ",Ps) ++ "}"}; doc_return_types2(T, Ps) -> - "{" ++ doc_arg_type2(T) ++ ", " ++ args(fun doc_arg_type/1,", ",Ps) ++ "}". - -break(xhtml) -> "
"; -break(_) -> "". + {complex, "{Res ::" ++ doc_arg_type2(T) ++ ", " ++ args(fun doc_arg_type/1,", ",Ps) ++ "}"}. -doc_optional([],_) -> ok; -doc_optional(Opts,Type) -> - w("%%~s Option = ~s~n", [break(Type),args(fun doc_optional2/1, " | ", Opts)]). +doc_enum(#type{base={enum,Enum}},Ps) -> + [doc_enum_type(Enum, "res") | + [doc_enum_type(Type,Name) || #param{name=Name, type=#type{base={enum,Type}}} <- Ps]]; +doc_enum(_,Ps) -> + [doc_enum_type(Type,Name) || #param{name=Name, type=#type{base={enum,Type}}} <- Ps]. -doc_optional2(#param{name=Name, def=_Def, type=T}) -> - "{" ++ erl_option_name(Name) ++ ", " ++ doc_arg_type2(T) ++ "}". - -doc_enum(#type{base={enum,Enum}},Ps,Break) -> - [doc_enum_type(Enum,Break) | - [doc_enum_type(Type,Break) || #param{type=#type{base={enum,Type}}} <- Ps]]; -doc_enum(_,Ps,Break) -> - [doc_enum_type(Type,Break) || #param{type=#type{base={enum,Type}}} <- Ps]. - -doc_enum_type(Type,Break) -> +doc_enum_type(Type, Name) -> {Enum0, #enum{vals=Vals}} = wx_gen:get_enum(Type), - case Enum0 of {_, Enum} -> Enum; Enum -> Enum end, + Enum = case Enum0 of {_, E} -> E; E -> E end, Consts = get(consts), - Format = fun({Name,_What}) -> - #const{name=Name} = gb_trees:get(Name, Consts), - "?" ++ enum_name(Name) + Format = fun({N,_What}) -> + #const{name=N} = gb_trees:get(N, Consts), + "?" ++ enum_name(N) end, Vs = args(Format, " | ", Vals), - w("%%~s ~s = integer()~n", [break(Break),uppercase(Enum)]), - {uppercase(Enum),Vs}. + {uppercase(Enum),Name, Vs}. doc_enum_desc([]) -> ok; -doc_enum_desc([{Enum,Vs}|R]) -> - w("%%
~s is one of ~s~n", [Enum,Vs]), +doc_enum_desc([{_Enum,Name,Vs}|R]) -> + w("%%
~s = ~s~n", [erl_arg_name(Name),Vs]), doc_enum_desc(R). %% Misc functions prefixed with wx @@ -1126,82 +1066,53 @@ gen_event_recs() -> "%% they contain the widget id and a specialized event record.~n" "%% Each event record may be sent for one or more event types.~n" "%% The mapping to wxWidgets is one record per class.~n~n",[]), - w("%% @type wx() = #wx{id=integer(), obj=wx:wxObject(), userData=term(), event=Rec}. Rec is a event record.~n",[]), - w("-record(wx, {id, %% Integer Identity of object.~n" - " obj, %% Object reference that was used in the connect call.~n" - " userData, %% User data specified in the connect call.~n" - " event}).%% The event record~n~n",[]), + w("-record(wx, {id :: integer(), %% Integer Identity of object.~n" + " obj :: wx:wx_object(), %% Object reference that was used in the connect call.~n" + " userData :: term(), %% User data specified in the connect call.~n" + " event :: event() %% The event record~n" + " }).~n~n", []), + w("-type wx() :: #wx{}. %% wx event record ~n",[]), w("%% Here comes the definitions of all event records.~n" "%% they contain the event type and possible some extra information.~n~n",[]), - Types = [build_event_rec(C) || {_,C=#class{event=Evs}} <- get(), Evs =/= false], - w("%% @type wxEventType() = ~s.~n", - [args(fun(Ev) -> Ev end, " | ", lists:sort(lists:append(Types)))]), + Events = [build_event_rec(C) || {_,C=#class{event=Evs}} <- get(), Evs =/= false], + EventSubTypes = [Type || {_Rec, Type} <- Events], + EventRecs = [Rec || {Rec, _Type} <- Events], + w("-type event() :: ~s.~n", + [args(fun(Ev) -> Ev++"()" end, " | ", lists:sort(EventRecs))]), + + w("-type wxEventType() :: ~s.~n", + [args(fun(Ev) -> Ev++"()" end, " | ", lists:sort(EventSubTypes))]), %% close(), closed in gen_enums_ints ok. -find_inherited_attr(Param = {PName,_}, Name) -> - #class{parent=Parent, attributes=Attrs} = get({class, Name}), - case lists:keysearch(atom_to_list(PName), #param.name, Attrs) of - {value, P=#param{}} -> - P; - _ -> - find_inherited_attr(Param, Parent) - end. - -filter_attrs(#class{name=Name, parent=Parent,attributes=Attrs}) -> - Attr1 = lists:foldl(fun(#param{acc=skip},Acc) -> Acc; - (P=#param{prot=public},Acc) -> [P|Acc]; - (#param{acc=undefined},Acc) -> Acc; - ({inherited, PName},Acc) -> - case find_inherited_attr(PName, Parent) of - undefined -> - io:format("~p:~p: Missing Event Attr ~p in ~p~n", - [?MODULE,?LINE, PName, Name]), - Acc; - P -> - [P|Acc] - end; - (P, Acc) -> [P|Acc] - end, [], Attrs), - lists:reverse(Attr1). - build_event_rec(Class=#class{name=Name, event=Evs}) -> EvTypes = [event_type_name(Ev) || Ev <- Evs], - Str = args(fun(Ev) -> ""++Ev++"" end, ", ", EvTypes), + Str = args(fun(Ev) -> Ev end, " | ", EvTypes), Attr = filter_attrs(Class), Rec = event_rec_name(Name), - GetName = fun(#param{name=N}) ->event_attr_name(N) end, + %%GetName = fun(#param{name=N}) ->event_attr_name(N) end, GetType = fun(#param{name=N,type=T}) -> - event_attr_name(N) ++ "=" ++ doc_arg_type2(T) + event_attr_name(N) ++ " :: " ++ doc_arg_type2(T) end, + EventType = Name ++ "Type", case Attr =:= [] of true -> - w("%% @type ~s() = #~s{type=wxEventType()}.~n", [Rec,Rec]), - w("%%
EventType:
~s
~n",[Str]), -%% case is_command_event(Name) of -%% true -> w("%% This event skips other event handlers.~n",[]); -%% false -> w("%% This event will be handled by other handlers~n",[]) -%% end, - w("%% Callback event: {@link ~s}~n", [Name]), - w("-record(~s, {type}).~n~n", [Rec]); + %% w("%%
EventType:
~s
~n",[Str]), + %% w("%% Callback event: {@link ~s}~n", [Name]), + w("-record(~s, {type :: ~s()}). %% Callback event: {@link ~s}~n", + [Rec, EventType, Name]), + w("-type ~s() :: ~s.~n", [EventType, Str]); false -> - w("%% @type ~s() = #~s{type=wxEventType(),~s}.~n", - [Rec,Rec,args(GetType,",",Attr)]), - w("%%
EventType:
~s
~n",[Str]), -%% case is_command_event(Name) of -%% true -> w("%% This event skips other event handlers.~n",[]); -%% false -> w("%% This event will be handled by other handlers~n",[]) -%% end, - w("%% Callback event: {@link ~s}~n", [Name]), - w("-record(~s,{type, ~s}).~n~n", [Rec,args(GetName,",",Attr)]) + %% w("%% @type ~s() = #~s{type=wxEventType(),~s}.~n", + %% [Rec,Rec,args(GetType,",",Attr)]), + %% w("%%
EventType:
~s
~n",[Str]), + %% w("%% Callback event: {@link ~s}~n", [Name]), + w("-record(~s,{type :: ~s(), %% Callback event: {@link ~s}~n\t~s}).~n", + [Rec,EventType, Name, args(GetType,",\n\t",Attr)]), + w("-type ~s() :: ~s.~n", [EventType, Str]) end, - EvTypes. - -is_command_event(Name) -> - case lists:member("wxCommandEvent", parents(Name)) of - true -> true; - false -> false - end. + w("-type ~s() :: #~s{}. %% Callback event: {@link ~s}~n~n", [Rec,Rec,Name]), + {Rec, EventType}. event_rec_name(Name0 = "wx" ++ _) -> "tnevE" ++ Name1 = reverse(Name0), @@ -1218,6 +1129,31 @@ event_attr_name("m_" ++ Attr) -> event_attr_name(Attr) -> lowercase(Attr). +find_inherited_attr(Param = {PName,_}, Name) -> + #class{parent=Parent, attributes=Attrs} = get({class, Name}), + case lists:keysearch(atom_to_list(PName), #param.name, Attrs) of + {value, P=#param{}} -> + P; + _ -> + find_inherited_attr(Param, Parent) + end. + +filter_attrs(#class{name=Name, parent=Parent,attributes=Attrs}) -> + Attr1 = lists:foldl(fun(#param{acc=skip},Acc) -> Acc; + (P=#param{prot=public},Acc) -> [P|Acc]; + (#param{acc=undefined},Acc) -> Acc; + ({inherited, PName},Acc) -> + case find_inherited_attr(PName, Parent) of + undefined -> + io:format("~p:~p: Missing Event Attr ~p in ~p~n", + [?MODULE,?LINE, PName, Name]), + Acc; + P -> + [P|Acc] + end; + (P, Acc) -> [P|Acc] + end, [], Attrs), + lists:reverse(Attr1). gen_funcnames() -> open_write("../src/gen/wxe_debug.hrl"), diff --git a/lib/wx/doc/src/Makefile b/lib/wx/doc/src/Makefile index 663a400dd0..834f887076 100644 --- a/lib/wx/doc/src/Makefile +++ b/lib/wx/doc/src/Makefile @@ -96,10 +96,10 @@ ref_man.xml: ref_man.xml.src @echo $(ErlMods:%.erl=%.xml): - escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(VSN) -sort_functions false ../../src/$(@:%.xml=%.erl) + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(VSN) -preprocess true -sort_functions false ../../src/$(@:%.xml=%.erl) $(GenMods:%.erl=%.xml): - escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(VSN) -sort_functions false ../../src/gen/$(@:%.xml=%.erl) + escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(VSN) -i ../../src -preprocess true -sort_functions false ../../src/gen/$(@:%.xml=%.erl) $(XML_CHAPTER_FILES): escript $(DOCGEN)/priv/bin/xml_from_edoc.escript -def vsn $(VSN) -chapter ../overview.edoc diff --git a/lib/wx/include/wx.hrl b/lib/wx/include/wx.hrl index 029b9a88df..98d7cce0d2 100644 --- a/lib/wx/include/wx.hrl +++ b/lib/wx/include/wx.hrl @@ -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 @@ -22,251 +22,294 @@ %% Each event record may be sent for one or more event types. %% The mapping to wxWidgets is one record per class. -%% @type wx() = #wx{id=integer(), obj=wx:wxObject(), userData=term(), event=Rec}. Rec is a event record. --record(wx, {id, %% Integer Identity of object. - obj, %% Object reference that was used in the connect call. - userData, %% User data specified in the connect call. - event}).%% The event record +-record(wx, {id :: integer(), %% Integer Identity of object. + obj :: wx:wx_object(), %% Object reference that was used in the connect call. + userData :: term(), %% User data specified in the connect call. + event :: event() %% The event record + }). +-type wx() :: #wx{}. %% wx event record %% Here comes the definitions of all event records. %% they contain the event type and possible some extra information. -%% @type wxNavigationKey() = #wxNavigationKey{type=wxEventType(),flags=integer(),focus=wxWindow:wxWindow()}. -%%
EventType:
navigation_key
-%% Callback event: {@link wxNavigationKeyEvent} --record(wxNavigationKey,{type, flags,focus}). +-record(wxNavigationKey,{type :: wxNavigationKeyEventType(), %% Callback event: {@link wxNavigationKeyEvent} + flags :: integer(), + focus :: wxWindow:wxWindow()}). +-type wxNavigationKeyEventType() :: navigation_key. +-type wxNavigationKey() :: #wxNavigationKey{}. %% Callback event: {@link wxNavigationKeyEvent} -%% @type wxSash() = #wxSash{type=wxEventType(),edge=WxSashEdgePosition,dragRect={X::integer(), Y::integer(), W::integer(), H::integer()},dragStatus=WxSashDragStatus}. -%%
EventType:
sash_dragged
-%% Callback event: {@link wxSashEvent} --record(wxSash,{type, edge,dragRect,dragStatus}). +-record(wxSash,{type :: wxSashEventType(), %% Callback event: {@link wxSashEvent} + edge :: wx:wx_enum(), + dragRect :: {X::integer(), Y::integer(), W::integer(), H::integer()}, + dragStatus :: wx:wx_enum()}). +-type wxSashEventType() :: sash_dragged. +-type wxSash() :: #wxSash{}. %% Callback event: {@link wxSashEvent} -%% @type wxList() = #wxList{type=wxEventType(),code=integer(),oldItemIndex=integer(),itemIndex=integer(),col=integer(),pointDrag={X::integer(), Y::integer()}}. -%%
EventType:
command_list_begin_drag, command_list_begin_rdrag, command_list_begin_label_edit, command_list_end_label_edit, command_list_delete_item, command_list_delete_all_items, command_list_key_down, command_list_insert_item, command_list_col_click, command_list_col_right_click, command_list_col_begin_drag, command_list_col_dragging, command_list_col_end_drag, command_list_item_selected, command_list_item_deselected, command_list_item_right_click, command_list_item_middle_click, command_list_item_activated, command_list_item_focused, command_list_cache_hint
-%% Callback event: {@link wxListEvent} --record(wxList,{type, code,oldItemIndex,itemIndex,col,pointDrag}). +-record(wxList,{type :: wxListEventType(), %% Callback event: {@link wxListEvent} + code :: integer(), + oldItemIndex :: integer(), + itemIndex :: integer(), + col :: integer(), + pointDrag :: {X::integer(), Y::integer()}}). +-type wxListEventType() :: command_list_begin_drag | command_list_begin_rdrag | command_list_begin_label_edit | command_list_end_label_edit | command_list_delete_item | command_list_delete_all_items | command_list_key_down | command_list_insert_item | command_list_col_click | command_list_col_right_click | command_list_col_begin_drag | command_list_col_dragging | command_list_col_end_drag | command_list_item_selected | command_list_item_deselected | command_list_item_right_click | command_list_item_middle_click | command_list_item_activated | command_list_item_focused | command_list_cache_hint. +-type wxList() :: #wxList{}. %% Callback event: {@link wxListEvent} -%% @type wxNotebook() = #wxNotebook{type=wxEventType()}. -%%
EventType:
command_notebook_page_changed, command_notebook_page_changing
-%% Callback event: {@link wxNotebookEvent} --record(wxNotebook, {type}). +-record(wxNotebook, {type :: wxNotebookEventType()}). %% Callback event: {@link wxNotebookEvent} +-type wxNotebookEventType() :: command_notebook_page_changed | command_notebook_page_changing. +-type wxNotebook() :: #wxNotebook{}. %% Callback event: {@link wxNotebookEvent} -%% @type wxDisplayChanged() = #wxDisplayChanged{type=wxEventType()}. -%%
EventType:
display_changed
-%% Callback event: {@link wxDisplayChangedEvent} --record(wxDisplayChanged, {type}). +-record(wxDisplayChanged, {type :: wxDisplayChangedEventType()}). %% Callback event: {@link wxDisplayChangedEvent} +-type wxDisplayChangedEventType() :: display_changed. +-type wxDisplayChanged() :: #wxDisplayChanged{}. %% Callback event: {@link wxDisplayChangedEvent} -%% @type wxErase() = #wxErase{type=wxEventType(),dc=wxDC:wxDC()}. -%%
EventType:
erase_background
-%% Callback event: {@link wxEraseEvent} --record(wxErase,{type, dc}). +-record(wxErase,{type :: wxEraseEventType(), %% Callback event: {@link wxEraseEvent} + dc :: wxDC:wxDC()}). +-type wxEraseEventType() :: erase_background. +-type wxErase() :: #wxErase{}. %% Callback event: {@link wxEraseEvent} -%% @type wxKey() = #wxKey{type=wxEventType(),x=integer(),y=integer(),keyCode=integer(),controlDown=bool(),shiftDown=bool(),altDown=bool(),metaDown=bool(),scanCode=bool(),uniChar=integer(),rawCode=integer(),rawFlags=integer()}. -%%
EventType:
char, char_hook, key_down, key_up
-%% Callback event: {@link wxKeyEvent} --record(wxKey,{type, x,y,keyCode,controlDown,shiftDown,altDown,metaDown,scanCode,uniChar,rawCode,rawFlags}). +-record(wxKey,{type :: wxKeyEventType(), %% Callback event: {@link wxKeyEvent} + x :: integer(), + y :: integer(), + keyCode :: integer(), + controlDown :: boolean(), + shiftDown :: boolean(), + altDown :: boolean(), + metaDown :: boolean(), + scanCode :: boolean(), + uniChar :: integer(), + rawCode :: integer(), + rawFlags :: integer()}). +-type wxKeyEventType() :: char | char_hook | key_down | key_up. +-type wxKey() :: #wxKey{}. %% Callback event: {@link wxKeyEvent} -%% @type wxWindowDestroy() = #wxWindowDestroy{type=wxEventType()}. -%%
EventType:
destroy
-%% Callback event: {@link wxWindowDestroyEvent} --record(wxWindowDestroy, {type}). +-record(wxWindowDestroy, {type :: wxWindowDestroyEventType()}). %% Callback event: {@link wxWindowDestroyEvent} +-type wxWindowDestroyEventType() :: destroy. +-type wxWindowDestroy() :: #wxWindowDestroy{}. %% Callback event: {@link wxWindowDestroyEvent} -%% @type wxCalendar() = #wxCalendar{type=wxEventType()}. -%%
EventType:
calendar_sel_changed, calendar_day_changed, calendar_month_changed, calendar_year_changed, calendar_doubleclicked, calendar_weekday_clicked
-%% Callback event: {@link wxCalendarEvent} --record(wxCalendar, {type}). +-record(wxCalendar, {type :: wxCalendarEventType()}). %% Callback event: {@link wxCalendarEvent} +-type wxCalendarEventType() :: calendar_sel_changed | calendar_day_changed | calendar_month_changed | calendar_year_changed | calendar_doubleclicked | calendar_weekday_clicked. +-type wxCalendar() :: #wxCalendar{}. %% Callback event: {@link wxCalendarEvent} -%% @type wxSplitter() = #wxSplitter{type=wxEventType()}. -%%
EventType:
command_splitter_sash_pos_changed, command_splitter_sash_pos_changing, command_splitter_doubleclicked, command_splitter_unsplit
-%% Callback event: {@link wxSplitterEvent} --record(wxSplitter, {type}). +-record(wxSplitter, {type :: wxSplitterEventType()}). %% Callback event: {@link wxSplitterEvent} +-type wxSplitterEventType() :: command_splitter_sash_pos_changed | command_splitter_sash_pos_changing | command_splitter_doubleclicked | command_splitter_unsplit. +-type wxSplitter() :: #wxSplitter{}. %% Callback event: {@link wxSplitterEvent} -%% @type wxScroll() = #wxScroll{type=wxEventType(),commandInt=integer(),extraLong=integer()}. -%%
EventType:
scroll_top, scroll_bottom, scroll_lineup, scroll_linedown, scroll_pageup, scroll_pagedown, scroll_thumbtrack, scroll_thumbrelease, scroll_changed
-%% Callback event: {@link wxScrollEvent} --record(wxScroll,{type, commandInt,extraLong}). +-record(wxScroll,{type :: wxScrollEventType(), %% Callback event: {@link wxScrollEvent} + commandInt :: integer(), + extraLong :: integer()}). +-type wxScrollEventType() :: scroll_top | scroll_bottom | scroll_lineup | scroll_linedown | scroll_pageup | scroll_pagedown | scroll_thumbtrack | scroll_thumbrelease | scroll_changed. +-type wxScroll() :: #wxScroll{}. %% Callback event: {@link wxScrollEvent} -%% @type wxMenu() = #wxMenu{type=wxEventType()}. -%%
EventType:
menu_open, menu_close, menu_highlight
-%% Callback event: {@link wxMenuEvent} --record(wxMenu, {type}). +-record(wxMenu, {type :: wxMenuEventType()}). %% Callback event: {@link wxMenuEvent} +-type wxMenuEventType() :: menu_open | menu_close | menu_highlight. +-type wxMenu() :: #wxMenu{}. %% Callback event: {@link wxMenuEvent} -%% @type wxContextMenu() = #wxContextMenu{type=wxEventType()}. -%%
EventType:
context_menu
-%% Callback event: {@link wxContextMenuEvent} --record(wxContextMenu, {type}). +-record(wxContextMenu, {type :: wxContextMenuEventType()}). %% Callback event: {@link wxContextMenuEvent} +-type wxContextMenuEventType() :: context_menu. +-type wxContextMenu() :: #wxContextMenu{}. %% Callback event: {@link wxContextMenuEvent} -%% @type wxShow() = #wxShow{type=wxEventType()}. -%%
EventType:
show
-%% Callback event: {@link wxShowEvent} --record(wxShow, {type}). +-record(wxShow, {type :: wxShowEventType()}). %% Callback event: {@link wxShowEvent} +-type wxShowEventType() :: show. +-type wxShow() :: #wxShow{}. %% Callback event: {@link wxShowEvent} -%% @type wxSpin() = #wxSpin{type=wxEventType(),commandInt=integer()}. -%%
EventType:
command_spinctrl_updated, spin_up, spin_down, spin
-%% Callback event: {@link wxSpinEvent} --record(wxSpin,{type, commandInt}). +-record(wxSpin,{type :: wxSpinEventType(), %% Callback event: {@link wxSpinEvent} + commandInt :: integer()}). +-type wxSpinEventType() :: command_spinctrl_updated | spin_up | spin_down | spin. +-type wxSpin() :: #wxSpin{}. %% Callback event: {@link wxSpinEvent} -%% @type wxSetCursor() = #wxSetCursor{type=wxEventType()}. -%%
EventType:
set_cursor
-%% Callback event: {@link wxSetCursorEvent} --record(wxSetCursor, {type}). +-record(wxSetCursor, {type :: wxSetCursorEventType()}). %% Callback event: {@link wxSetCursorEvent} +-type wxSetCursorEventType() :: set_cursor. +-type wxSetCursor() :: #wxSetCursor{}. %% Callback event: {@link wxSetCursorEvent} -%% @type wxFontPicker() = #wxFontPicker{type=wxEventType(),font=wxFont:wxFont()}. -%%
EventType:
command_fontpicker_changed
-%% Callback event: {@link wxFontPickerEvent} --record(wxFontPicker,{type, font}). +-record(wxFontPicker,{type :: wxFontPickerEventType(), %% Callback event: {@link wxFontPickerEvent} + font :: wxFont:wxFont()}). +-type wxFontPickerEventType() :: command_fontpicker_changed. +-type wxFontPicker() :: #wxFontPicker{}. %% Callback event: {@link wxFontPickerEvent} -%% @type wxScrollWin() = #wxScrollWin{type=wxEventType()}. -%%
EventType:
scrollwin_top, scrollwin_bottom, scrollwin_lineup, scrollwin_linedown, scrollwin_pageup, scrollwin_pagedown, scrollwin_thumbtrack, scrollwin_thumbrelease
-%% Callback event: {@link wxScrollWinEvent} --record(wxScrollWin, {type}). +-record(wxScrollWin, {type :: wxScrollWinEventType()}). %% Callback event: {@link wxScrollWinEvent} +-type wxScrollWinEventType() :: scrollwin_top | scrollwin_bottom | scrollwin_lineup | scrollwin_linedown | scrollwin_pageup | scrollwin_pagedown | scrollwin_thumbtrack | scrollwin_thumbrelease. +-type wxScrollWin() :: #wxScrollWin{}. %% Callback event: {@link wxScrollWinEvent} -%% @type wxPaint() = #wxPaint{type=wxEventType()}. -%%
EventType:
paint, paint_icon
-%% Callback event: {@link wxPaintEvent} --record(wxPaint, {type}). +-record(wxPaint, {type :: wxPaintEventType()}). %% Callback event: {@link wxPaintEvent} +-type wxPaintEventType() :: paint | paint_icon. +-type wxPaint() :: #wxPaint{}. %% Callback event: {@link wxPaintEvent} -%% @type wxChildFocus() = #wxChildFocus{type=wxEventType()}. -%%
EventType:
child_focus
-%% Callback event: {@link wxChildFocusEvent} --record(wxChildFocus, {type}). +-record(wxChildFocus, {type :: wxChildFocusEventType()}). %% Callback event: {@link wxChildFocusEvent} +-type wxChildFocusEventType() :: child_focus. +-type wxChildFocus() :: #wxChildFocus{}. %% Callback event: {@link wxChildFocusEvent} -%% @type wxMaximize() = #wxMaximize{type=wxEventType()}. -%%
EventType:
maximize
-%% Callback event: {@link wxMaximizeEvent} --record(wxMaximize, {type}). +-record(wxMaximize, {type :: wxMaximizeEventType()}). %% Callback event: {@link wxMaximizeEvent} +-type wxMaximizeEventType() :: maximize. +-type wxMaximize() :: #wxMaximize{}. %% Callback event: {@link wxMaximizeEvent} -%% @type wxFileDirPicker() = #wxFileDirPicker{type=wxEventType(),path=string()}. -%%
EventType:
command_filepicker_changed, command_dirpicker_changed
-%% Callback event: {@link wxFileDirPickerEvent} --record(wxFileDirPicker,{type, path}). +-record(wxFileDirPicker,{type :: wxFileDirPickerEventType(), %% Callback event: {@link wxFileDirPickerEvent} + path :: string()}). +-type wxFileDirPickerEventType() :: command_filepicker_changed | command_dirpicker_changed. +-type wxFileDirPicker() :: #wxFileDirPicker{}. %% Callback event: {@link wxFileDirPickerEvent} -%% @type wxFocus() = #wxFocus{type=wxEventType()}. -%%
EventType:
set_focus, kill_focus
-%% Callback event: {@link wxFocusEvent} --record(wxFocus, {type}). +-record(wxFocus, {type :: wxFocusEventType()}). %% Callback event: {@link wxFocusEvent} +-type wxFocusEventType() :: set_focus | kill_focus. +-type wxFocus() :: #wxFocus{}. %% Callback event: {@link wxFocusEvent} -%% @type wxDate() = #wxDate{type=wxEventType(),date=wx:datetime()}. -%%
EventType:
date_changed
-%% Callback event: {@link wxDateEvent} --record(wxDate,{type, date}). +-record(wxDate,{type :: wxDateEventType(), %% Callback event: {@link wxDateEvent} + date :: wx:wx_datetime()}). +-type wxDateEventType() :: date_changed. +-type wxDate() :: #wxDate{}. %% Callback event: {@link wxDateEvent} -%% @type wxHtmlLink() = #wxHtmlLink{type=wxEventType(),linkInfo=wx:wxHtmlLinkInfo()}. -%%
EventType:
command_html_link_clicked
-%% Callback event: {@link wxHtmlLinkEvent} --record(wxHtmlLink,{type, linkInfo}). +-record(wxHtmlLink,{type :: wxHtmlLinkEventType(), %% Callback event: {@link wxHtmlLinkEvent} + linkInfo :: wx:wx_wxHtmlLinkInfo()}). +-type wxHtmlLinkEventType() :: command_html_link_clicked. +-type wxHtmlLink() :: #wxHtmlLink{}. %% Callback event: {@link wxHtmlLinkEvent} -%% @type wxHelp() = #wxHelp{type=wxEventType()}. -%%
EventType:
help, detailed_help
-%% Callback event: {@link wxHelpEvent} --record(wxHelp, {type}). +-record(wxHelp, {type :: wxHelpEventType()}). %% Callback event: {@link wxHelpEvent} +-type wxHelpEventType() :: help | detailed_help. +-type wxHelp() :: #wxHelp{}. %% Callback event: {@link wxHelpEvent} -%% @type wxStyledText() = #wxStyledText{type=wxEventType(),position=integer(),key=integer(),modifiers=integer(),modificationType=integer(),text=string(),length=integer(),linesAdded=integer(),line=integer(),foldLevelNow=integer(),foldLevelPrev=integer(),margin=integer(),message=integer(),wParam=integer(),lParam=integer(),listType=integer(),x=integer(),y=integer(),dragText=string(),dragAllowMove=bool(),dragResult=WxDragResult}. -%%
EventType:
stc_change, stc_styleneeded, stc_charadded, stc_savepointreached, stc_savepointleft, stc_romodifyattempt, stc_key, stc_doubleclick, stc_updateui, stc_modified, stc_macrorecord, stc_marginclick, stc_needshown, stc_painted, stc_userlistselection, stc_uridropped, stc_dwellstart, stc_dwellend, stc_start_drag, stc_drag_over, stc_do_drop, stc_zoom, stc_hotspot_click, stc_hotspot_dclick, stc_calltip_click, stc_autocomp_selection
-%% Callback event: {@link wxStyledTextEvent} --record(wxStyledText,{type, position,key,modifiers,modificationType,text,length,linesAdded,line,foldLevelNow,foldLevelPrev,margin,message,wParam,lParam,listType,x,y,dragText,dragAllowMove,dragResult}). +-record(wxStyledText,{type :: wxStyledTextEventType(), %% Callback event: {@link wxStyledTextEvent} + position :: integer(), + key :: integer(), + modifiers :: integer(), + modificationType :: integer(), + text :: string(), + length :: integer(), + linesAdded :: integer(), + line :: integer(), + foldLevelNow :: integer(), + foldLevelPrev :: integer(), + margin :: integer(), + message :: integer(), + wParam :: integer(), + lParam :: integer(), + listType :: integer(), + x :: integer(), + y :: integer(), + dragText :: string(), + dragAllowMove :: boolean(), + dragResult :: wx:wx_enum()}). +-type wxStyledTextEventType() :: stc_change | stc_styleneeded | stc_charadded | stc_savepointreached | stc_savepointleft | stc_romodifyattempt | stc_key | stc_doubleclick | stc_updateui | stc_modified | stc_macrorecord | stc_marginclick | stc_needshown | stc_painted | stc_userlistselection | stc_uridropped | stc_dwellstart | stc_dwellend | stc_start_drag | stc_drag_over | stc_do_drop | stc_zoom | stc_hotspot_click | stc_hotspot_dclick | stc_calltip_click | stc_autocomp_selection. +-type wxStyledText() :: #wxStyledText{}. %% Callback event: {@link wxStyledTextEvent} -%% @type wxSysColourChanged() = #wxSysColourChanged{type=wxEventType()}. -%%
EventType:
sys_colour_changed
-%% Callback event: {@link wxSysColourChangedEvent} --record(wxSysColourChanged, {type}). +-record(wxSysColourChanged, {type :: wxSysColourChangedEventType()}). %% Callback event: {@link wxSysColourChangedEvent} +-type wxSysColourChangedEventType() :: sys_colour_changed. +-type wxSysColourChanged() :: #wxSysColourChanged{}. %% Callback event: {@link wxSysColourChangedEvent} -%% @type wxGrid() = #wxGrid{type=wxEventType(),row=integer(),col=integer(),x=integer(),y=integer(),selecting=bool(),control=bool(),meta=bool(),shift=bool(),alt=bool()}. -%%
EventType:
grid_cell_left_click, grid_cell_right_click, grid_cell_left_dclick, grid_cell_right_dclick, grid_label_left_click, grid_label_right_click, grid_label_left_dclick, grid_label_right_dclick, grid_row_size, grid_col_size, grid_range_select, grid_cell_change, grid_select_cell, grid_editor_shown, grid_editor_hidden, grid_editor_created, grid_cell_begin_drag
-%% Callback event: {@link wxGridEvent} --record(wxGrid,{type, row,col,x,y,selecting,control,meta,shift,alt}). +-record(wxGrid,{type :: wxGridEventType(), %% Callback event: {@link wxGridEvent} + row :: integer(), + col :: integer(), + x :: integer(), + y :: integer(), + selecting :: boolean(), + control :: boolean(), + meta :: boolean(), + shift :: boolean(), + alt :: boolean()}). +-type wxGridEventType() :: grid_cell_left_click | grid_cell_right_click | grid_cell_left_dclick | grid_cell_right_dclick | grid_label_left_click | grid_label_right_click | grid_label_left_dclick | grid_label_right_dclick | grid_row_size | grid_col_size | grid_range_select | grid_cell_change | grid_select_cell | grid_editor_shown | grid_editor_hidden | grid_editor_created | grid_cell_begin_drag. +-type wxGrid() :: #wxGrid{}. %% Callback event: {@link wxGridEvent} -%% @type wxPaletteChanged() = #wxPaletteChanged{type=wxEventType()}. -%%
EventType:
palette_changed
-%% Callback event: {@link wxPaletteChangedEvent} --record(wxPaletteChanged, {type}). +-record(wxPaletteChanged, {type :: wxPaletteChangedEventType()}). %% Callback event: {@link wxPaletteChangedEvent} +-type wxPaletteChangedEventType() :: palette_changed. +-type wxPaletteChanged() :: #wxPaletteChanged{}. %% Callback event: {@link wxPaletteChangedEvent} -%% @type wxUpdateUI() = #wxUpdateUI{type=wxEventType()}. -%%
EventType:
update_ui
-%% Callback event: {@link wxUpdateUIEvent} --record(wxUpdateUI, {type}). +-record(wxUpdateUI, {type :: wxUpdateUIEventType()}). %% Callback event: {@link wxUpdateUIEvent} +-type wxUpdateUIEventType() :: update_ui. +-type wxUpdateUI() :: #wxUpdateUI{}. %% Callback event: {@link wxUpdateUIEvent} -%% @type wxSize() = #wxSize{type=wxEventType(),size={W::integer(), H::integer()},rect={X::integer(), Y::integer(), W::integer(), H::integer()}}. -%%
EventType:
size
-%% Callback event: {@link wxSizeEvent} --record(wxSize,{type, size,rect}). +-record(wxSize,{type :: wxSizeEventType(), %% Callback event: {@link wxSizeEvent} + size :: {W::integer(), H::integer()}, + rect :: {X::integer(), Y::integer(), W::integer(), H::integer()}}). +-type wxSizeEventType() :: size. +-type wxSize() :: #wxSize{}. %% Callback event: {@link wxSizeEvent} -%% @type wxIconize() = #wxIconize{type=wxEventType()}. -%%
EventType:
iconize
-%% Callback event: {@link wxIconizeEvent} --record(wxIconize, {type}). +-record(wxIconize, {type :: wxIconizeEventType()}). %% Callback event: {@link wxIconizeEvent} +-type wxIconizeEventType() :: iconize. +-type wxIconize() :: #wxIconize{}. %% Callback event: {@link wxIconizeEvent} -%% @type wxAuiNotebook() = #wxAuiNotebook{type=wxEventType(),old_selection=integer(),selection=integer(),drag_source=wxAuiNotebook:wxAuiNotebook()}. -%%
EventType:
command_auinotebook_page_close, command_auinotebook_page_changed, command_auinotebook_page_changing, command_auinotebook_button, command_auinotebook_begin_drag, command_auinotebook_end_drag, command_auinotebook_drag_motion, command_auinotebook_allow_dnd, command_auinotebook_tab_middle_down, command_auinotebook_tab_middle_up, command_auinotebook_tab_right_down, command_auinotebook_tab_right_up, command_auinotebook_page_closed, command_auinotebook_drag_done, command_auinotebook_bg_dclick
-%% Callback event: {@link wxAuiNotebookEvent} --record(wxAuiNotebook,{type, old_selection,selection,drag_source}). +-record(wxAuiNotebook,{type :: wxAuiNotebookEventType(), %% Callback event: {@link wxAuiNotebookEvent} + old_selection :: integer(), + selection :: integer(), + drag_source :: wxAuiNotebook:wxAuiNotebook()}). +-type wxAuiNotebookEventType() :: command_auinotebook_page_close | command_auinotebook_page_changed | command_auinotebook_page_changing | command_auinotebook_button | command_auinotebook_begin_drag | command_auinotebook_end_drag | command_auinotebook_drag_motion | command_auinotebook_allow_dnd | command_auinotebook_tab_middle_down | command_auinotebook_tab_middle_up | command_auinotebook_tab_right_down | command_auinotebook_tab_right_up | command_auinotebook_page_closed | command_auinotebook_drag_done | command_auinotebook_bg_dclick. +-type wxAuiNotebook() :: #wxAuiNotebook{}. %% Callback event: {@link wxAuiNotebookEvent} -%% @type wxClose() = #wxClose{type=wxEventType()}. -%%
EventType:
close_window, end_session, query_end_session
-%% Callback event: {@link wxCloseEvent} --record(wxClose, {type}). +-record(wxClose, {type :: wxCloseEventType()}). %% Callback event: {@link wxCloseEvent} +-type wxCloseEventType() :: close_window | end_session | query_end_session. +-type wxClose() :: #wxClose{}. %% Callback event: {@link wxCloseEvent} -%% @type wxMouseCaptureChanged() = #wxMouseCaptureChanged{type=wxEventType()}. -%%
EventType:
mouse_capture_changed
-%% Callback event: {@link wxMouseCaptureChangedEvent} --record(wxMouseCaptureChanged, {type}). +-record(wxMouseCaptureChanged, {type :: wxMouseCaptureChangedEventType()}). %% Callback event: {@link wxMouseCaptureChangedEvent} +-type wxMouseCaptureChangedEventType() :: mouse_capture_changed. +-type wxMouseCaptureChanged() :: #wxMouseCaptureChanged{}. %% Callback event: {@link wxMouseCaptureChangedEvent} -%% @type wxMouse() = #wxMouse{type=wxEventType(),x=integer(),y=integer(),leftDown=bool(),middleDown=bool(),rightDown=bool(),controlDown=bool(),shiftDown=bool(),altDown=bool(),metaDown=bool(),wheelRotation=integer(),wheelDelta=integer(),linesPerAction=integer()}. -%%
EventType:
left_down, left_up, middle_down, middle_up, right_down, right_up, motion, enter_window, leave_window, left_dclick, middle_dclick, right_dclick, mousewheel, nc_left_down, nc_left_up, nc_middle_down, nc_middle_up, nc_right_down, nc_right_up, nc_motion, nc_enter_window, nc_leave_window, nc_left_dclick, nc_middle_dclick, nc_right_dclick
-%% Callback event: {@link wxMouseEvent} --record(wxMouse,{type, x,y,leftDown,middleDown,rightDown,controlDown,shiftDown,altDown,metaDown,wheelRotation,wheelDelta,linesPerAction}). +-record(wxMouse,{type :: wxMouseEventType(), %% Callback event: {@link wxMouseEvent} + x :: integer(), + y :: integer(), + leftDown :: boolean(), + middleDown :: boolean(), + rightDown :: boolean(), + controlDown :: boolean(), + shiftDown :: boolean(), + altDown :: boolean(), + metaDown :: boolean(), + wheelRotation :: integer(), + wheelDelta :: integer(), + linesPerAction :: integer()}). +-type wxMouseEventType() :: left_down | left_up | middle_down | middle_up | right_down | right_up | motion | enter_window | leave_window | left_dclick | middle_dclick | right_dclick | mousewheel | nc_left_down | nc_left_up | nc_middle_down | nc_middle_up | nc_right_down | nc_right_up | nc_motion | nc_enter_window | nc_leave_window | nc_left_dclick | nc_middle_dclick | nc_right_dclick. +-type wxMouse() :: #wxMouse{}. %% Callback event: {@link wxMouseEvent} -%% @type wxWindowCreate() = #wxWindowCreate{type=wxEventType()}. -%%
EventType:
create
-%% Callback event: {@link wxWindowCreateEvent} --record(wxWindowCreate, {type}). +-record(wxWindowCreate, {type :: wxWindowCreateEventType()}). %% Callback event: {@link wxWindowCreateEvent} +-type wxWindowCreateEventType() :: create. +-type wxWindowCreate() :: #wxWindowCreate{}. %% Callback event: {@link wxWindowCreateEvent} -%% @type wxAuiManager() = #wxAuiManager{type=wxEventType(),manager=wxAuiManager:wxAuiManager(),pane=wxAuiPaneInfo:wxAuiPaneInfo(),button=integer(),veto_flag=bool(),canveto_flag=bool(),dc=wxDC:wxDC()}. -%%
EventType:
aui_pane_button, aui_pane_close, aui_pane_maximize, aui_pane_restore, aui_render, aui_find_manager
-%% Callback event: {@link wxAuiManagerEvent} --record(wxAuiManager,{type, manager,pane,button,veto_flag,canveto_flag,dc}). +-record(wxAuiManager,{type :: wxAuiManagerEventType(), %% Callback event: {@link wxAuiManagerEvent} + manager :: wxAuiManager:wxAuiManager(), + pane :: wxAuiPaneInfo:wxAuiPaneInfo(), + button :: integer(), + veto_flag :: boolean(), + canveto_flag :: boolean(), + dc :: wxDC:wxDC()}). +-type wxAuiManagerEventType() :: aui_pane_button | aui_pane_close | aui_pane_maximize | aui_pane_restore | aui_render | aui_find_manager. +-type wxAuiManager() :: #wxAuiManager{}. %% Callback event: {@link wxAuiManagerEvent} -%% @type wxCommand() = #wxCommand{type=wxEventType(),cmdString=string(),commandInt=integer(),extraLong=integer()}. -%%
EventType:
command_button_clicked, command_checkbox_clicked, command_choice_selected, command_listbox_selected, command_listbox_doubleclicked, command_text_updated, command_text_enter, command_menu_selected, command_slider_updated, command_radiobox_selected, command_radiobutton_selected, command_scrollbar_updated, command_vlbox_selected, command_combobox_selected, command_tool_rclicked, command_tool_enter, command_checklistbox_toggled, command_togglebutton_clicked, command_left_click, command_left_dclick, command_right_click, command_set_focus, command_kill_focus, command_enter
-%% Callback event: {@link wxCommandEvent} --record(wxCommand,{type, cmdString,commandInt,extraLong}). +-record(wxCommand,{type :: wxCommandEventType(), %% Callback event: {@link wxCommandEvent} + cmdString :: string(), + commandInt :: integer(), + extraLong :: integer()}). +-type wxCommandEventType() :: command_button_clicked | command_checkbox_clicked | command_choice_selected | command_listbox_selected | command_listbox_doubleclicked | command_text_updated | command_text_enter | command_menu_selected | command_slider_updated | command_radiobox_selected | command_radiobutton_selected | command_scrollbar_updated | command_vlbox_selected | command_combobox_selected | command_tool_rclicked | command_tool_enter | command_checklistbox_toggled | command_togglebutton_clicked | command_left_click | command_left_dclick | command_right_click | command_set_focus | command_kill_focus | command_enter. +-type wxCommand() :: #wxCommand{}. %% Callback event: {@link wxCommandEvent} -%% @type wxJoystick() = #wxJoystick{type=wxEventType()}. -%%
EventType:
joy_button_down, joy_button_up, joy_move, joy_zmove
-%% Callback event: {@link wxJoystickEvent} --record(wxJoystick, {type}). +-record(wxJoystick, {type :: wxJoystickEventType()}). %% Callback event: {@link wxJoystickEvent} +-type wxJoystickEventType() :: joy_button_down | joy_button_up | joy_move | joy_zmove. +-type wxJoystick() :: #wxJoystick{}. %% Callback event: {@link wxJoystickEvent} -%% @type wxQueryNewPalette() = #wxQueryNewPalette{type=wxEventType()}. -%%
EventType:
query_new_palette
-%% Callback event: {@link wxQueryNewPaletteEvent} --record(wxQueryNewPalette, {type}). +-record(wxQueryNewPalette, {type :: wxQueryNewPaletteEventType()}). %% Callback event: {@link wxQueryNewPaletteEvent} +-type wxQueryNewPaletteEventType() :: query_new_palette. +-type wxQueryNewPalette() :: #wxQueryNewPalette{}. %% Callback event: {@link wxQueryNewPaletteEvent} -%% @type wxMove() = #wxMove{type=wxEventType()}. -%%
EventType:
move
-%% Callback event: {@link wxMoveEvent} --record(wxMove, {type}). +-record(wxMove, {type :: wxMoveEventType()}). %% Callback event: {@link wxMoveEvent} +-type wxMoveEventType() :: move. +-type wxMove() :: #wxMove{}. %% Callback event: {@link wxMoveEvent} -%% @type wxIdle() = #wxIdle{type=wxEventType()}. -%%
EventType:
idle
-%% Callback event: {@link wxIdleEvent} --record(wxIdle, {type}). +-record(wxIdle, {type :: wxIdleEventType()}). %% Callback event: {@link wxIdleEvent} +-type wxIdleEventType() :: idle. +-type wxIdle() :: #wxIdle{}. %% Callback event: {@link wxIdleEvent} -%% @type wxNcPaint() = #wxNcPaint{type=wxEventType()}. -%%
EventType:
nc_paint
-%% Callback event: {@link wxNcPaintEvent} --record(wxNcPaint, {type}). +-record(wxNcPaint, {type :: wxNcPaintEventType()}). %% Callback event: {@link wxNcPaintEvent} +-type wxNcPaintEventType() :: nc_paint. +-type wxNcPaint() :: #wxNcPaint{}. %% Callback event: {@link wxNcPaintEvent} -%% @type wxColourPicker() = #wxColourPicker{type=wxEventType(),colour=wx:colour()}. -%%
EventType:
command_colourpicker_changed
-%% Callback event: {@link wxColourPickerEvent} --record(wxColourPicker,{type, colour}). +-record(wxColourPicker,{type :: wxColourPickerEventType(), %% Callback event: {@link wxColourPickerEvent} + colour :: wx:wx_colour()}). +-type wxColourPickerEventType() :: command_colourpicker_changed. +-type wxColourPicker() :: #wxColourPicker{}. %% Callback event: {@link wxColourPickerEvent} -%% @type wxTree() = #wxTree{type=wxEventType(),item=integer(),itemOld=integer(),pointDrag={X::integer(), Y::integer()}}. -%%
EventType:
command_tree_begin_drag, command_tree_begin_rdrag, command_tree_begin_label_edit, command_tree_end_label_edit, command_tree_delete_item, command_tree_get_info, command_tree_set_info, command_tree_item_expanded, command_tree_item_expanding, command_tree_item_collapsed, command_tree_item_collapsing, command_tree_sel_changed, command_tree_sel_changing, command_tree_key_down, command_tree_item_activated, command_tree_item_right_click, command_tree_item_middle_click, command_tree_end_drag, command_tree_state_image_click, command_tree_item_gettooltip, command_tree_item_menu
-%% Callback event: {@link wxTreeEvent} --record(wxTree,{type, item,itemOld,pointDrag}). +-record(wxTree,{type :: wxTreeEventType(), %% Callback event: {@link wxTreeEvent} + item :: integer(), + itemOld :: integer(), + pointDrag :: {X::integer(), Y::integer()}}). +-type wxTreeEventType() :: command_tree_begin_drag | command_tree_begin_rdrag | command_tree_begin_label_edit | command_tree_end_label_edit | command_tree_delete_item | command_tree_get_info | command_tree_set_info | command_tree_item_expanded | command_tree_item_expanding | command_tree_item_collapsed | command_tree_item_collapsing | command_tree_sel_changed | command_tree_sel_changing | command_tree_key_down | command_tree_item_activated | command_tree_item_right_click | command_tree_item_middle_click | command_tree_end_drag | command_tree_state_image_click | command_tree_item_gettooltip | command_tree_item_menu. +-type wxTree() :: #wxTree{}. %% Callback event: {@link wxTreeEvent} -%% @type wxEventType() = aui_find_manager | aui_pane_button | aui_pane_close | aui_pane_maximize | aui_pane_restore | aui_render | calendar_day_changed | calendar_doubleclicked | calendar_month_changed | calendar_sel_changed | calendar_weekday_clicked | calendar_year_changed | char | char_hook | child_focus | close_window | command_auinotebook_allow_dnd | command_auinotebook_begin_drag | command_auinotebook_bg_dclick | command_auinotebook_button | command_auinotebook_drag_done | command_auinotebook_drag_motion | command_auinotebook_end_drag | command_auinotebook_page_changed | command_auinotebook_page_changing | command_auinotebook_page_close | command_auinotebook_page_closed | command_auinotebook_tab_middle_down | command_auinotebook_tab_middle_up | command_auinotebook_tab_right_down | command_auinotebook_tab_right_up | command_button_clicked | command_checkbox_clicked | command_checklistbox_toggled | command_choice_selected | command_colourpicker_changed | command_combobox_selected | command_dirpicker_changed | command_enter | command_filepicker_changed | command_fontpicker_changed | command_html_link_clicked | command_kill_focus | command_left_click | command_left_dclick | command_list_begin_drag | command_list_begin_label_edit | command_list_begin_rdrag | command_list_cache_hint | command_list_col_begin_drag | command_list_col_click | command_list_col_dragging | command_list_col_end_drag | command_list_col_right_click | command_list_delete_all_items | command_list_delete_item | command_list_end_label_edit | command_list_insert_item | command_list_item_activated | command_list_item_deselected | command_list_item_focused | command_list_item_middle_click | command_list_item_right_click | command_list_item_selected | command_list_key_down | command_listbox_doubleclicked | command_listbox_selected | command_menu_selected | command_notebook_page_changed | command_notebook_page_changing | command_radiobox_selected | command_radiobutton_selected | command_right_click | command_scrollbar_updated | command_set_focus | command_slider_updated | command_spinctrl_updated | command_splitter_doubleclicked | command_splitter_sash_pos_changed | command_splitter_sash_pos_changing | command_splitter_unsplit | command_text_enter | command_text_updated | command_togglebutton_clicked | command_tool_enter | command_tool_rclicked | command_tree_begin_drag | command_tree_begin_label_edit | command_tree_begin_rdrag | command_tree_delete_item | command_tree_end_drag | command_tree_end_label_edit | command_tree_get_info | command_tree_item_activated | command_tree_item_collapsed | command_tree_item_collapsing | command_tree_item_expanded | command_tree_item_expanding | command_tree_item_gettooltip | command_tree_item_menu | command_tree_item_middle_click | command_tree_item_right_click | command_tree_key_down | command_tree_sel_changed | command_tree_sel_changing | command_tree_set_info | command_tree_state_image_click | command_vlbox_selected | context_menu | create | date_changed | destroy | detailed_help | display_changed | end_session | enter_window | erase_background | grid_cell_begin_drag | grid_cell_change | grid_cell_left_click | grid_cell_left_dclick | grid_cell_right_click | grid_cell_right_dclick | grid_col_size | grid_editor_created | grid_editor_hidden | grid_editor_shown | grid_label_left_click | grid_label_left_dclick | grid_label_right_click | grid_label_right_dclick | grid_range_select | grid_row_size | grid_select_cell | help | iconize | idle | joy_button_down | joy_button_up | joy_move | joy_zmove | key_down | key_up | kill_focus | leave_window | left_dclick | left_down | left_up | maximize | menu_close | menu_highlight | menu_open | middle_dclick | middle_down | middle_up | motion | mouse_capture_changed | mousewheel | move | navigation_key | nc_enter_window | nc_leave_window | nc_left_dclick | nc_left_down | nc_left_up | nc_middle_dclick | nc_middle_down | nc_middle_up | nc_motion | nc_paint | nc_right_dclick | nc_right_down | nc_right_up | paint | paint_icon | palette_changed | query_end_session | query_new_palette | right_dclick | right_down | right_up | sash_dragged | scroll_bottom | scroll_changed | scroll_linedown | scroll_lineup | scroll_pagedown | scroll_pageup | scroll_thumbrelease | scroll_thumbtrack | scroll_top | scrollwin_bottom | scrollwin_linedown | scrollwin_lineup | scrollwin_pagedown | scrollwin_pageup | scrollwin_thumbrelease | scrollwin_thumbtrack | scrollwin_top | set_cursor | set_focus | show | size | spin | spin_down | spin_up | stc_autocomp_selection | stc_calltip_click | stc_change | stc_charadded | stc_do_drop | stc_doubleclick | stc_drag_over | stc_dwellend | stc_dwellstart | stc_hotspot_click | stc_hotspot_dclick | stc_key | stc_macrorecord | stc_marginclick | stc_modified | stc_needshown | stc_painted | stc_romodifyattempt | stc_savepointleft | stc_savepointreached | stc_start_drag | stc_styleneeded | stc_updateui | stc_uridropped | stc_userlistselection | stc_zoom | sys_colour_changed | update_ui. +-type event() :: wxAuiManager() | wxAuiNotebook() | wxCalendar() | wxChildFocus() | wxClose() | wxColourPicker() | wxCommand() | wxContextMenu() | wxDate() | wxDisplayChanged() | wxErase() | wxFileDirPicker() | wxFocus() | wxFontPicker() | wxGrid() | wxHelp() | wxHtmlLink() | wxIconize() | wxIdle() | wxJoystick() | wxKey() | wxList() | wxMaximize() | wxMenu() | wxMouse() | wxMouseCaptureChanged() | wxMove() | wxNavigationKey() | wxNcPaint() | wxNotebook() | wxPaint() | wxPaletteChanged() | wxQueryNewPalette() | wxSash() | wxScroll() | wxScrollWin() | wxSetCursor() | wxShow() | wxSize() | wxSpin() | wxSplitter() | wxStyledText() | wxSysColourChanged() | wxTree() | wxUpdateUI() | wxWindowCreate() | wxWindowDestroy(). +-type wxEventType() :: wxAuiManagerEventType() | wxAuiNotebookEventType() | wxCalendarEventType() | wxChildFocusEventType() | wxCloseEventType() | wxColourPickerEventType() | wxCommandEventType() | wxContextMenuEventType() | wxDateEventType() | wxDisplayChangedEventType() | wxEraseEventType() | wxFileDirPickerEventType() | wxFocusEventType() | wxFontPickerEventType() | wxGridEventType() | wxHelpEventType() | wxHtmlLinkEventType() | wxIconizeEventType() | wxIdleEventType() | wxJoystickEventType() | wxKeyEventType() | wxListEventType() | wxMaximizeEventType() | wxMenuEventType() | wxMouseCaptureChangedEventType() | wxMouseEventType() | wxMoveEventType() | wxNavigationKeyEventType() | wxNcPaintEventType() | wxNotebookEventType() | wxPaintEventType() | wxPaletteChangedEventType() | wxQueryNewPaletteEventType() | wxSashEventType() | wxScrollEventType() | wxScrollWinEventType() | wxSetCursorEventType() | wxShowEventType() | wxSizeEventType() | wxSpinEventType() | wxSplitterEventType() | wxStyledTextEventType() | wxSysColourChangedEventType() | wxTreeEventType() | wxUpdateUIEventType() | wxWindowCreateEventType() | wxWindowDestroyEventType(). %% Hardcoded Records -record(wxMouseState, {x, y, %% integer() diff --git a/lib/wx/src/gen/wxAcceleratorEntry.erl b/lib/wx/src/gen/wxAcceleratorEntry.erl index d76299b300..6185a1891b 100644 --- a/lib/wx/src/gen/wxAcceleratorEntry.erl +++ b/lib/wx/src/gen/wxAcceleratorEntry.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 @@ -29,24 +29,25 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxAcceleratorEntry/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxAcceleratorEntry() +-type wxAcceleratorEntry() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxAcceleratorEntry(). + new() -> new([]). -%% @spec (X::term()|wxAcceleratorEntry()) -> wxAcceleratorEntry() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new([Option]) -> wxAcceleratorEntry() -%%
Option = {flags, integer()} | {keyCode, integer()} | {cmd, integer()} | {item, wxMenuItem:wxMenuItem()} -%%

-%%

-%% new(Entry::wxAcceleratorEntry()) -> wxAcceleratorEntry() -%%

+-spec new([Option]) -> wxAcceleratorEntry() when + Option :: {flags, integer()} + | {keyCode, integer()} + | {cmd, integer()} + | {item, wxMenuItem:wxMenuItem()}; + (Entry) -> wxAcceleratorEntry() when + Entry::wxAcceleratorEntry(). new(Options) when is_list(Options) -> MOpts = fun({flags, Flags}, Acc) -> [<<1:32/?UI,Flags:32/?UI>>|Acc]; @@ -62,36 +63,42 @@ new(#wx_ref{type=EntryT,ref=EntryRef}) -> wxe_util:construct(?wxAcceleratorEntry_new_1_1, <>). -%% @spec (This::wxAcceleratorEntry()) -> integer() %% @doc See external documentation. +-spec getCommand(This) -> integer() when + This::wxAcceleratorEntry(). getCommand(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAcceleratorEntry), wxe_util:call(?wxAcceleratorEntry_GetCommand, <>). -%% @spec (This::wxAcceleratorEntry()) -> integer() %% @doc See external documentation. +-spec getFlags(This) -> integer() when + This::wxAcceleratorEntry(). getFlags(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAcceleratorEntry), wxe_util:call(?wxAcceleratorEntry_GetFlags, <>). -%% @spec (This::wxAcceleratorEntry()) -> integer() %% @doc See external documentation. +-spec getKeyCode(This) -> integer() when + This::wxAcceleratorEntry(). getKeyCode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAcceleratorEntry), wxe_util:call(?wxAcceleratorEntry_GetKeyCode, <>). -%% @spec (This::wxAcceleratorEntry(), Flags::integer(), KeyCode::integer(), Cmd::integer()) -> ok %% @equiv set(This,Flags,KeyCode,Cmd, []) +-spec set(This, Flags, KeyCode, Cmd) -> ok when + This::wxAcceleratorEntry(), Flags::integer(), KeyCode::integer(), Cmd::integer(). + set(This,Flags,KeyCode,Cmd) when is_record(This, wx_ref),is_integer(Flags),is_integer(KeyCode),is_integer(Cmd) -> set(This,Flags,KeyCode,Cmd, []). -%% @spec (This::wxAcceleratorEntry(), Flags::integer(), KeyCode::integer(), Cmd::integer(), [Option]) -> ok -%% Option = {item, wxMenuItem:wxMenuItem()} %% @doc See external documentation. +-spec set(This, Flags, KeyCode, Cmd, [Option]) -> ok when + This::wxAcceleratorEntry(), Flags::integer(), KeyCode::integer(), Cmd::integer(), + Option :: {item, wxMenuItem:wxMenuItem()}. set(#wx_ref{type=ThisT,ref=ThisRef},Flags,KeyCode,Cmd, Options) when is_integer(Flags),is_integer(KeyCode),is_integer(Cmd),is_list(Options) -> ?CLASS(ThisT,wxAcceleratorEntry), @@ -101,8 +108,8 @@ set(#wx_ref{type=ThisT,ref=ThisRef},Flags,KeyCode,Cmd, Options) wxe_util:cast(?wxAcceleratorEntry_Set, <>). -%% @spec (This::wxAcceleratorEntry()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxAcceleratorEntry) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxAcceleratorEntry), wxe_util:destroy(?wxAcceleratorEntry_destroy,Obj), diff --git a/lib/wx/src/gen/wxAcceleratorTable.erl b/lib/wx/src/gen/wxAcceleratorTable.erl index 5d070294e2..15915daa5a 100644 --- a/lib/wx/src/gen/wxAcceleratorTable.erl +++ b/lib/wx/src/gen/wxAcceleratorTable.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 @@ -29,17 +29,20 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxAcceleratorTable/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxAcceleratorTable() +-type wxAcceleratorTable() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxAcceleratorTable(). new() -> wxe_util:construct(?wxAcceleratorTable_new_0, <<>>). -%% @spec (N::integer(), Entries::[wxAcceleratorEntry:wxAcceleratorEntry()]) -> wxAcceleratorTable() %% @doc See external documentation. +-spec new(N, Entries) -> wxAcceleratorTable() when + N::integer(), Entries::[wxAcceleratorEntry:wxAcceleratorEntry()]. new(N,Entries) when is_integer(N),is_list(Entries) -> [?CLASS(EntriesT,wxAcceleratorEntry) || #wx_ref{type=EntriesT} <- Entries], @@ -47,15 +50,16 @@ new(N,Entries) <> || C <- Entries>>)/binary, 0:(((0+length(Entries)) rem 2)*32)>>). -%% @spec (This::wxAcceleratorTable()) -> bool() %% @doc See external documentation. +-spec ok(This) -> boolean() when + This::wxAcceleratorTable(). ok(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAcceleratorTable), wxe_util:call(?wxAcceleratorTable_Ok, <>). -%% @spec (This::wxAcceleratorTable()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxAcceleratorTable) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxAcceleratorTable), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxArtProvider.erl b/lib/wx/src/gen/wxArtProvider.erl index 1955bd2e29..584e240879 100644 --- a/lib/wx/src/gen/wxArtProvider.erl +++ b/lib/wx/src/gen/wxArtProvider.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 @@ -29,18 +29,24 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxArtProvider/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Id::string()) -> wxBitmap:wxBitmap() +-type wxArtProvider() :: wx:wx_object(). %% @equiv getBitmap(Id, []) +-spec getBitmap(Id) -> wxBitmap:wxBitmap() when + Id::string(). + getBitmap(Id) when is_list(Id) -> getBitmap(Id, []). -%% @spec (Id::string(), [Option]) -> wxBitmap:wxBitmap() -%% Option = {client, string()} | {size, {W::integer(), H::integer()}} %% @doc See external documentation. +-spec getBitmap(Id, [Option]) -> wxBitmap:wxBitmap() when + Id::string(), + Option :: {client, string()} + | {size, {W::integer(), H::integer()}}. getBitmap(Id, Options) when is_list(Id),is_list(Options) -> Id_UC = unicode:characters_to_binary([Id,0]), @@ -51,15 +57,19 @@ getBitmap(Id, Options) wxe_util:call(?wxArtProvider_GetBitmap, <<(byte_size(Id_UC)):32/?UI,(Id_UC)/binary, 0:(((8- ((4+byte_size(Id_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (Id::string()) -> wxIcon:wxIcon() %% @equiv getIcon(Id, []) +-spec getIcon(Id) -> wxIcon:wxIcon() when + Id::string(). + getIcon(Id) when is_list(Id) -> getIcon(Id, []). -%% @spec (Id::string(), [Option]) -> wxIcon:wxIcon() -%% Option = {client, string()} | {size, {W::integer(), H::integer()}} %% @doc See external documentation. +-spec getIcon(Id, [Option]) -> wxIcon:wxIcon() when + Id::string(), + Option :: {client, string()} + | {size, {W::integer(), H::integer()}}. getIcon(Id, Options) when is_list(Id),is_list(Options) -> Id_UC = unicode:characters_to_binary([Id,0]), diff --git a/lib/wx/src/gen/wxAuiDockArt.erl b/lib/wx/src/gen/wxAuiDockArt.erl index f2be643dd9..d3cf1ebd0d 100644 --- a/lib/wx/src/gen/wxAuiDockArt.erl +++ b/lib/wx/src/gen/wxAuiDockArt.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 @@ -29,6 +29,8 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxAuiDockArt/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxAuiDockArt() :: wx:wx_object(). diff --git a/lib/wx/src/gen/wxAuiManager.erl b/lib/wx/src/gen/wxAuiManager.erl index 893867cec1..456c435a8c 100644 --- a/lib/wx/src/gen/wxAuiManager.erl +++ b/lib/wx/src/gen/wxAuiManager.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 @@ -37,18 +37,22 @@ %% inherited exports -export([connect/2,connect/3,disconnect/1,disconnect/2,disconnect/3,parent_class/1]). +-export_type([wxAuiManager/0]). %% @hidden parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxAuiManager() +-type wxAuiManager() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxAuiManager(). + new() -> new([]). -%% @spec ([Option]) -> wxAuiManager() -%% Option = {managed_wnd, wxWindow:wxWindow()} | {flags, integer()} %% @doc See external documentation. +-spec new([Option]) -> wxAuiManager() when + Option :: {managed_wnd, wxWindow:wxWindow()} + | {flags, integer()}. new(Options) when is_list(Options) -> MOpts = fun({managed_wnd, #wx_ref{type=Managed_wndT,ref=Managed_wndRef}}, Acc) -> ?CLASS(Managed_wndT,wxWindow),[<<1:32/?UI,Managed_wndRef:32/?UI>>|Acc]; @@ -58,22 +62,21 @@ new(Options) wxe_util:construct(?wxAuiManager_new, <>). -%% @spec (This::wxAuiManager(), Window::wxWindow:wxWindow()) -> bool() %% @equiv addPane(This,Window, []) +-spec addPane(This, Window) -> boolean() when + This::wxAuiManager(), Window::wxWindow:wxWindow(). + addPane(This,Window) when is_record(This, wx_ref),is_record(Window, wx_ref) -> addPane(This,Window, []). -%% @spec (This::wxAuiManager(),Window::wxWindow:wxWindow(),X::term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% addPane(This::wxAuiManager(), Window::wxWindow:wxWindow(), [Option]) -> bool() -%%
Option = {direction, integer()} | {caption, string()} -%%

-%%

-%% addPane(This::wxAuiManager(), Window::wxWindow:wxWindow(), Pane_info::wxAuiPaneInfo:wxAuiPaneInfo()) -> bool() -%%

+-spec addPane(This, Window, [Option]) -> boolean() when + This::wxAuiManager(), Window::wxWindow:wxWindow(), + Option :: {direction, integer()} + | {caption, string()}; + (This, Window, Pane_info) -> boolean() when + This::wxAuiManager(), Window::wxWindow:wxWindow(), Pane_info::wxAuiPaneInfo:wxAuiPaneInfo(). addPane(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiManager), @@ -91,8 +94,9 @@ addPane(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},#wx_ wxe_util:call(?wxAuiManager_AddPane_2_1, <>). -%% @spec (This::wxAuiManager(), Window::wxWindow:wxWindow(), Pane_info::wxAuiPaneInfo:wxAuiPaneInfo(), Drop_pos::{X::integer(), Y::integer()}) -> bool() %% @doc See external documentation. +-spec addPane(This, Window, Pane_info, Drop_pos) -> boolean() when + This::wxAuiManager(), Window::wxWindow:wxWindow(), Pane_info::wxAuiPaneInfo:wxAuiPaneInfo(), Drop_pos::{X::integer(), Y::integer()}. addPane(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},#wx_ref{type=Pane_infoT,ref=Pane_infoRef},{Drop_posX,Drop_posY}) when is_integer(Drop_posX),is_integer(Drop_posY) -> ?CLASS(ThisT,wxAuiManager), @@ -101,65 +105,68 @@ addPane(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},#wx_ wxe_util:call(?wxAuiManager_AddPane_3, <>). -%% @spec (This::wxAuiManager(), Window::wxWindow:wxWindow()) -> bool() %% @doc See external documentation. +-spec detachPane(This, Window) -> boolean() when + This::wxAuiManager(), Window::wxWindow:wxWindow(). detachPane(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(ThisT,wxAuiManager), ?CLASS(WindowT,wxWindow), wxe_util:call(?wxAuiManager_DetachPane, <>). -%% @spec (This::wxAuiManager()) -> wxAuiPaneInfoArray:wxAuiPaneInfoArray() %% @doc See external documentation. +-spec getAllPanes(This) -> wxAuiPaneInfoArray:wxAuiPaneInfoArray() when + This::wxAuiManager(). getAllPanes(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_GetAllPanes, <>). -%% @spec (This::wxAuiManager()) -> wxAuiDockArt:wxAuiDockArt() %% @doc See external documentation. +-spec getArtProvider(This) -> wxAuiDockArt:wxAuiDockArt() when + This::wxAuiManager(). getArtProvider(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_GetArtProvider, <>). -%% @spec (This::wxAuiManager()) -> {Width_pct::float(), Height_pct::float()} %% @doc See external documentation. +-spec getDockSizeConstraint(This) -> {Width_pct::float(), Height_pct::float()} when + This::wxAuiManager(). getDockSizeConstraint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_GetDockSizeConstraint, <>). -%% @spec (This::wxAuiManager()) -> integer() %% @doc See external documentation. +-spec getFlags(This) -> integer() when + This::wxAuiManager(). getFlags(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_GetFlags, <>). -%% @spec (This::wxAuiManager()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getManagedWindow(This) -> wxWindow:wxWindow() when + This::wxAuiManager(). getManagedWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_GetManagedWindow, <>). -%% @spec (Window::wxWindow:wxWindow()) -> wxAuiManager() %% @doc See external documentation. +-spec getManager(Window) -> wxAuiManager() when + Window::wxWindow:wxWindow(). getManager(#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(WindowT,wxWindow), wxe_util:call(?wxAuiManager_GetManager, <>). -%% @spec (This::wxAuiManager(),X::string()|term()) -> wxAuiPaneInfo:wxAuiPaneInfo() %% @doc See external documentation. -%%
Alternatives: -%%

-%% getPane(This::wxAuiManager(), Name::string()) -> wxAuiPaneInfo:wxAuiPaneInfo() -%%

-%%

-%% getPane(This::wxAuiManager(), Window::wxWindow:wxWindow()) -> wxAuiPaneInfo:wxAuiPaneInfo() -%%

+-spec getPane(This, Name) -> wxAuiPaneInfo:wxAuiPaneInfo() when + This::wxAuiManager(), Name::string(); + (This, Window) -> wxAuiPaneInfo:wxAuiPaneInfo() when + This::wxAuiManager(), Window::wxWindow:wxWindow(). getPane(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxAuiManager), @@ -172,22 +179,26 @@ getPane(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> wxe_util:call(?wxAuiManager_GetPane_1_1, <>). -%% @spec (This::wxAuiManager()) -> ok %% @doc See external documentation. +-spec hideHint(This) -> ok when + This::wxAuiManager(). hideHint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:cast(?wxAuiManager_HideHint, <>). -%% @spec (This::wxAuiManager(), Window::wxWindow:wxWindow(), Insert_location::wxAuiPaneInfo:wxAuiPaneInfo()) -> bool() %% @equiv insertPane(This,Window,Insert_location, []) +-spec insertPane(This, Window, Insert_location) -> boolean() when + This::wxAuiManager(), Window::wxWindow:wxWindow(), Insert_location::wxAuiPaneInfo:wxAuiPaneInfo(). + insertPane(This,Window,Insert_location) when is_record(This, wx_ref),is_record(Window, wx_ref),is_record(Insert_location, wx_ref) -> insertPane(This,Window,Insert_location, []). -%% @spec (This::wxAuiManager(), Window::wxWindow:wxWindow(), Insert_location::wxAuiPaneInfo:wxAuiPaneInfo(), [Option]) -> bool() -%% Option = {insert_level, integer()} %% @doc See external documentation. +-spec insertPane(This, Window, Insert_location, [Option]) -> boolean() when + This::wxAuiManager(), Window::wxWindow:wxWindow(), Insert_location::wxAuiPaneInfo:wxAuiPaneInfo(), + Option :: {insert_level, integer()}. insertPane(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},#wx_ref{type=Insert_locationT,ref=Insert_locationRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiManager), @@ -199,8 +210,9 @@ insertPane(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},# wxe_util:call(?wxAuiManager_InsertPane, <>). -%% @spec (This::wxAuiManager(), Pane_part::string(), Pane::wxAuiPaneInfo:wxAuiPaneInfo()) -> ok %% @doc See external documentation. +-spec loadPaneInfo(This, Pane_part, Pane) -> ok when + This::wxAuiManager(), Pane_part::string(), Pane::wxAuiPaneInfo:wxAuiPaneInfo(). loadPaneInfo(#wx_ref{type=ThisT,ref=ThisRef},Pane_part,#wx_ref{type=PaneT,ref=PaneRef}) when is_list(Pane_part) -> ?CLASS(ThisT,wxAuiManager), @@ -209,15 +221,18 @@ loadPaneInfo(#wx_ref{type=ThisT,ref=ThisRef},Pane_part,#wx_ref{type=PaneT,ref=Pa wxe_util:cast(?wxAuiManager_LoadPaneInfo, <>). -%% @spec (This::wxAuiManager(), Perspective::string()) -> bool() %% @equiv loadPerspective(This,Perspective, []) +-spec loadPerspective(This, Perspective) -> boolean() when + This::wxAuiManager(), Perspective::string(). + loadPerspective(This,Perspective) when is_record(This, wx_ref),is_list(Perspective) -> loadPerspective(This,Perspective, []). -%% @spec (This::wxAuiManager(), Perspective::string(), [Option]) -> bool() -%% Option = {update, bool()} %% @doc See external documentation. +-spec loadPerspective(This, Perspective, [Option]) -> boolean() when + This::wxAuiManager(), Perspective::string(), + Option :: {update, boolean()}. loadPerspective(#wx_ref{type=ThisT,ref=ThisRef},Perspective, Options) when is_list(Perspective),is_list(Options) -> ?CLASS(ThisT,wxAuiManager), @@ -228,77 +243,86 @@ loadPerspective(#wx_ref{type=ThisT,ref=ThisRef},Perspective, Options) wxe_util:call(?wxAuiManager_LoadPerspective, <>). -%% @spec (This::wxAuiManager(), Pane::wxAuiPaneInfo:wxAuiPaneInfo()) -> string() %% @doc See external documentation. +-spec savePaneInfo(This, Pane) -> string() when + This::wxAuiManager(), Pane::wxAuiPaneInfo:wxAuiPaneInfo(). savePaneInfo(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PaneT,ref=PaneRef}) -> ?CLASS(ThisT,wxAuiManager), ?CLASS(PaneT,wxAuiPaneInfo), wxe_util:call(?wxAuiManager_SavePaneInfo, <>). -%% @spec (This::wxAuiManager()) -> string() %% @doc See external documentation. +-spec savePerspective(This) -> string() when + This::wxAuiManager(). savePerspective(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_SavePerspective, <>). -%% @spec (This::wxAuiManager(), Art_provider::wxAuiDockArt:wxAuiDockArt()) -> ok %% @doc See external documentation. +-spec setArtProvider(This, Art_provider) -> ok when + This::wxAuiManager(), Art_provider::wxAuiDockArt:wxAuiDockArt(). setArtProvider(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=Art_providerT,ref=Art_providerRef}) -> ?CLASS(ThisT,wxAuiManager), ?CLASS(Art_providerT,wxAuiDockArt), wxe_util:cast(?wxAuiManager_SetArtProvider, <>). -%% @spec (This::wxAuiManager(), Width_pct::float(), Height_pct::float()) -> ok %% @doc See external documentation. +-spec setDockSizeConstraint(This, Width_pct, Height_pct) -> ok when + This::wxAuiManager(), Width_pct::float(), Height_pct::float(). setDockSizeConstraint(#wx_ref{type=ThisT,ref=ThisRef},Width_pct,Height_pct) when is_float(Width_pct),is_float(Height_pct) -> ?CLASS(ThisT,wxAuiManager), wxe_util:cast(?wxAuiManager_SetDockSizeConstraint, <>). -%% @spec (This::wxAuiManager(), Flags::integer()) -> ok %% @doc See external documentation. +-spec setFlags(This, Flags) -> ok when + This::wxAuiManager(), Flags::integer(). setFlags(#wx_ref{type=ThisT,ref=ThisRef},Flags) when is_integer(Flags) -> ?CLASS(ThisT,wxAuiManager), wxe_util:cast(?wxAuiManager_SetFlags, <>). -%% @spec (This::wxAuiManager(), Managed_wnd::wxWindow:wxWindow()) -> ok %% @doc See external documentation. +-spec setManagedWindow(This, Managed_wnd) -> ok when + This::wxAuiManager(), Managed_wnd::wxWindow:wxWindow(). setManagedWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=Managed_wndT,ref=Managed_wndRef}) -> ?CLASS(ThisT,wxAuiManager), ?CLASS(Managed_wndT,wxWindow), wxe_util:cast(?wxAuiManager_SetManagedWindow, <>). -%% @spec (This::wxAuiManager(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec showHint(This, Rect) -> ok when + This::wxAuiManager(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. showHint(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxAuiManager), wxe_util:cast(?wxAuiManager_ShowHint, <>). -%% @spec (This::wxAuiManager()) -> ok %% @doc See external documentation. +-spec unInit(This) -> ok when + This::wxAuiManager(). unInit(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:cast(?wxAuiManager_UnInit, <>). -%% @spec (This::wxAuiManager()) -> ok %% @doc See external documentation. +-spec update(This) -> ok when + This::wxAuiManager(). update(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:cast(?wxAuiManager_Update, <>). -%% @spec (This::wxAuiManager()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxAuiManager) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxAuiManager), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxAuiManagerEvent.erl b/lib/wx/src/gen/wxAuiManagerEvent.erl index b5e45f1860..feb3931696 100644 --- a/lib/wx/src/gen/wxAuiManagerEvent.erl +++ b/lib/wx/src/gen/wxAuiManagerEvent.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -38,79 +38,92 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxAuiManagerEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxAuiManagerEvent(), Mgr::wxAuiManager:wxAuiManager()) -> ok +-type wxAuiManagerEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec setManager(This, Mgr) -> ok when + This::wxAuiManagerEvent(), Mgr::wxAuiManager:wxAuiManager(). setManager(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MgrT,ref=MgrRef}) -> ?CLASS(ThisT,wxAuiManagerEvent), ?CLASS(MgrT,wxAuiManager), wxe_util:cast(?wxAuiManagerEvent_SetManager, <>). -%% @spec (This::wxAuiManagerEvent()) -> wxAuiManager:wxAuiManager() %% @doc See external documentation. +-spec getManager(This) -> wxAuiManager:wxAuiManager() when + This::wxAuiManagerEvent(). getManager(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManagerEvent), wxe_util:call(?wxAuiManagerEvent_GetManager, <>). -%% @spec (This::wxAuiManagerEvent(), P::wxAuiPaneInfo:wxAuiPaneInfo()) -> ok %% @doc See external documentation. +-spec setPane(This, P) -> ok when + This::wxAuiManagerEvent(), P::wxAuiPaneInfo:wxAuiPaneInfo(). setPane(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PT,ref=PRef}) -> ?CLASS(ThisT,wxAuiManagerEvent), ?CLASS(PT,wxAuiPaneInfo), wxe_util:cast(?wxAuiManagerEvent_SetPane, <>). -%% @spec (This::wxAuiManagerEvent()) -> wxAuiPaneInfo:wxAuiPaneInfo() %% @doc See external documentation. +-spec getPane(This) -> wxAuiPaneInfo:wxAuiPaneInfo() when + This::wxAuiManagerEvent(). getPane(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManagerEvent), wxe_util:call(?wxAuiManagerEvent_GetPane, <>). -%% @spec (This::wxAuiManagerEvent(), B::integer()) -> ok %% @doc See external documentation. +-spec setButton(This, B) -> ok when + This::wxAuiManagerEvent(), B::integer(). setButton(#wx_ref{type=ThisT,ref=ThisRef},B) when is_integer(B) -> ?CLASS(ThisT,wxAuiManagerEvent), wxe_util:cast(?wxAuiManagerEvent_SetButton, <>). -%% @spec (This::wxAuiManagerEvent()) -> integer() %% @doc See external documentation. +-spec getButton(This) -> integer() when + This::wxAuiManagerEvent(). getButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManagerEvent), wxe_util:call(?wxAuiManagerEvent_GetButton, <>). -%% @spec (This::wxAuiManagerEvent(), Pdc::wxDC:wxDC()) -> ok %% @doc See external documentation. +-spec setDC(This, Pdc) -> ok when + This::wxAuiManagerEvent(), Pdc::wxDC:wxDC(). setDC(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PdcT,ref=PdcRef}) -> ?CLASS(ThisT,wxAuiManagerEvent), ?CLASS(PdcT,wxDC), wxe_util:cast(?wxAuiManagerEvent_SetDC, <>). -%% @spec (This::wxAuiManagerEvent()) -> wxDC:wxDC() %% @doc See external documentation. +-spec getDC(This) -> wxDC:wxDC() when + This::wxAuiManagerEvent(). getDC(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManagerEvent), wxe_util:call(?wxAuiManagerEvent_GetDC, <>). -%% @spec (This::wxAuiManagerEvent()) -> ok %% @equiv veto(This, []) +-spec veto(This) -> ok when + This::wxAuiManagerEvent(). + veto(This) when is_record(This, wx_ref) -> veto(This, []). -%% @spec (This::wxAuiManagerEvent(), [Option]) -> ok -%% Option = {veto, bool()} %% @doc See external documentation. +-spec veto(This, [Option]) -> ok when + This::wxAuiManagerEvent(), + Option :: {veto, boolean()}. veto(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiManagerEvent), @@ -120,23 +133,26 @@ veto(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxAuiManagerEvent_Veto, <>). -%% @spec (This::wxAuiManagerEvent()) -> bool() %% @doc See external documentation. +-spec getVeto(This) -> boolean() when + This::wxAuiManagerEvent(). getVeto(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManagerEvent), wxe_util:call(?wxAuiManagerEvent_GetVeto, <>). -%% @spec (This::wxAuiManagerEvent(), Can_veto::bool()) -> ok %% @doc See external documentation. +-spec setCanVeto(This, Can_veto) -> ok when + This::wxAuiManagerEvent(), Can_veto::boolean(). setCanVeto(#wx_ref{type=ThisT,ref=ThisRef},Can_veto) when is_boolean(Can_veto) -> ?CLASS(ThisT,wxAuiManagerEvent), wxe_util:cast(?wxAuiManagerEvent_SetCanVeto, <>). -%% @spec (This::wxAuiManagerEvent()) -> bool() %% @doc See external documentation. +-spec canVeto(This) -> boolean() when + This::wxAuiManagerEvent(). canVeto(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManagerEvent), wxe_util:call(?wxAuiManagerEvent_CanVeto, diff --git a/lib/wx/src/gen/wxAuiNotebook.erl b/lib/wx/src/gen/wxAuiNotebook.erl index 5862bb26c7..6741feccb9 100644 --- a/lib/wx/src/gen/wxAuiNotebook.erl +++ b/lib/wx/src/gen/wxAuiNotebook.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 @@ -73,27 +73,35 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxAuiNotebook/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxAuiNotebook() +-type wxAuiNotebook() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxAuiNotebook(). new() -> wxe_util:construct(?wxAuiNotebook_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxAuiNotebook() %% @equiv new(Parent, []) +-spec new(Parent) -> wxAuiNotebook() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxAuiNotebook() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxAuiNotebook() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -106,15 +114,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxAuiNotebook_new_2, <>). -%% @spec (This::wxAuiNotebook(), Page::wxWindow:wxWindow(), Caption::string()) -> bool() %% @equiv addPage(This,Page,Caption, []) +-spec addPage(This, Page, Caption) -> boolean() when + This::wxAuiNotebook(), Page::wxWindow:wxWindow(), Caption::string(). + addPage(This,Page,Caption) when is_record(This, wx_ref),is_record(Page, wx_ref),is_list(Caption) -> addPage(This,Page,Caption, []). -%% @spec (This::wxAuiNotebook(), Page::wxWindow:wxWindow(), Caption::string(), [Option]) -> bool() -%% Option = {select, bool()} | {bitmap, wxBitmap:wxBitmap()} %% @doc See external documentation. +-spec addPage(This, Page, Caption, [Option]) -> boolean() when + This::wxAuiNotebook(), Page::wxWindow:wxWindow(), Caption::string(), + Option :: {select, boolean()} + | {bitmap, wxBitmap:wxBitmap()}. addPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageT,ref=PageRef},Caption, Options) when is_list(Caption),is_list(Options) -> ?CLASS(ThisT,wxAuiNotebook), @@ -127,15 +139,21 @@ addPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageT,ref=PageRef},Caption, wxe_util:call(?wxAuiNotebook_AddPage, <>). -%% @spec (This::wxAuiNotebook(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxAuiNotebook(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxAuiNotebook(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxAuiNotebook(), Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {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}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiNotebook), @@ -149,76 +167,88 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxAuiNotebook_Create, <>). -%% @spec (This::wxAuiNotebook(), Page::integer()) -> bool() %% @doc See external documentation. +-spec deletePage(This, Page) -> boolean() when + This::wxAuiNotebook(), Page::integer(). deletePage(#wx_ref{type=ThisT,ref=ThisRef},Page) when is_integer(Page) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:call(?wxAuiNotebook_DeletePage, <>). -%% @spec (This::wxAuiNotebook()) -> wxAuiTabArt:wxAuiTabArt() %% @doc See external documentation. +-spec getArtProvider(This) -> wxAuiTabArt:wxAuiTabArt() when + This::wxAuiNotebook(). getArtProvider(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:call(?wxAuiNotebook_GetArtProvider, <>). -%% @spec (This::wxAuiNotebook(), Page_idx::integer()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getPage(This, Page_idx) -> wxWindow:wxWindow() when + This::wxAuiNotebook(), Page_idx::integer(). getPage(#wx_ref{type=ThisT,ref=ThisRef},Page_idx) when is_integer(Page_idx) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:call(?wxAuiNotebook_GetPage, <>). -%% @spec (This::wxAuiNotebook(), Page_idx::integer()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getPageBitmap(This, Page_idx) -> wxBitmap:wxBitmap() when + This::wxAuiNotebook(), Page_idx::integer(). getPageBitmap(#wx_ref{type=ThisT,ref=ThisRef},Page_idx) when is_integer(Page_idx) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:call(?wxAuiNotebook_GetPageBitmap, <>). -%% @spec (This::wxAuiNotebook()) -> integer() %% @doc See external documentation. +-spec getPageCount(This) -> integer() when + This::wxAuiNotebook(). getPageCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:call(?wxAuiNotebook_GetPageCount, <>). -%% @spec (This::wxAuiNotebook(), Page_wnd::wxWindow:wxWindow()) -> integer() %% @doc See external documentation. +-spec getPageIndex(This, Page_wnd) -> integer() when + This::wxAuiNotebook(), Page_wnd::wxWindow:wxWindow(). getPageIndex(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=Page_wndT,ref=Page_wndRef}) -> ?CLASS(ThisT,wxAuiNotebook), ?CLASS(Page_wndT,wxWindow), wxe_util:call(?wxAuiNotebook_GetPageIndex, <>). -%% @spec (This::wxAuiNotebook(), Page_idx::integer()) -> string() %% @doc See external documentation. +-spec getPageText(This, Page_idx) -> string() when + This::wxAuiNotebook(), Page_idx::integer(). getPageText(#wx_ref{type=ThisT,ref=ThisRef},Page_idx) when is_integer(Page_idx) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:call(?wxAuiNotebook_GetPageText, <>). -%% @spec (This::wxAuiNotebook()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxAuiNotebook(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:call(?wxAuiNotebook_GetSelection, <>). -%% @spec (This::wxAuiNotebook(), Page_idx::integer(), Page::wxWindow:wxWindow(), Caption::string()) -> bool() %% @equiv insertPage(This,Page_idx,Page,Caption, []) +-spec insertPage(This, Page_idx, Page, Caption) -> boolean() when + This::wxAuiNotebook(), Page_idx::integer(), Page::wxWindow:wxWindow(), Caption::string(). + insertPage(This,Page_idx,Page,Caption) when is_record(This, wx_ref),is_integer(Page_idx),is_record(Page, wx_ref),is_list(Caption) -> insertPage(This,Page_idx,Page,Caption, []). -%% @spec (This::wxAuiNotebook(), Page_idx::integer(), Page::wxWindow:wxWindow(), Caption::string(), [Option]) -> bool() -%% Option = {select, bool()} | {bitmap, wxBitmap:wxBitmap()} %% @doc See external documentation. +-spec insertPage(This, Page_idx, Page, Caption, [Option]) -> boolean() when + This::wxAuiNotebook(), Page_idx::integer(), Page::wxWindow:wxWindow(), Caption::string(), + Option :: {select, boolean()} + | {bitmap, wxBitmap:wxBitmap()}. insertPage(#wx_ref{type=ThisT,ref=ThisRef},Page_idx,#wx_ref{type=PageT,ref=PageRef},Caption, Options) when is_integer(Page_idx),is_list(Caption),is_list(Options) -> ?CLASS(ThisT,wxAuiNotebook), @@ -231,32 +261,36 @@ insertPage(#wx_ref{type=ThisT,ref=ThisRef},Page_idx,#wx_ref{type=PageT,ref=PageR wxe_util:call(?wxAuiNotebook_InsertPage, <>). -%% @spec (This::wxAuiNotebook(), Page::integer()) -> bool() %% @doc See external documentation. +-spec removePage(This, Page) -> boolean() when + This::wxAuiNotebook(), Page::integer(). removePage(#wx_ref{type=ThisT,ref=ThisRef},Page) when is_integer(Page) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:call(?wxAuiNotebook_RemovePage, <>). -%% @spec (This::wxAuiNotebook(), Art::wxAuiTabArt:wxAuiTabArt()) -> ok %% @doc See external documentation. +-spec setArtProvider(This, Art) -> ok when + This::wxAuiNotebook(), Art::wxAuiTabArt:wxAuiTabArt(). setArtProvider(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ArtT,ref=ArtRef}) -> ?CLASS(ThisT,wxAuiNotebook), ?CLASS(ArtT,wxAuiTabArt), wxe_util:cast(?wxAuiNotebook_SetArtProvider, <>). -%% @spec (This::wxAuiNotebook(), Font::wxFont:wxFont()) -> bool() %% @doc See external documentation. +-spec setFont(This, Font) -> boolean() when + This::wxAuiNotebook(), Font::wxFont:wxFont(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxAuiNotebook), ?CLASS(FontT,wxFont), wxe_util:call(?wxAuiNotebook_SetFont, <>). -%% @spec (This::wxAuiNotebook(), Page::integer(), Bitmap::wxBitmap:wxBitmap()) -> bool() %% @doc See external documentation. +-spec setPageBitmap(This, Page, Bitmap) -> boolean() when + This::wxAuiNotebook(), Page::integer(), Bitmap::wxBitmap:wxBitmap(). setPageBitmap(#wx_ref{type=ThisT,ref=ThisRef},Page,#wx_ref{type=BitmapT,ref=BitmapRef}) when is_integer(Page) -> ?CLASS(ThisT,wxAuiNotebook), @@ -264,8 +298,9 @@ setPageBitmap(#wx_ref{type=ThisT,ref=ThisRef},Page,#wx_ref{type=BitmapT,ref=Bitm wxe_util:call(?wxAuiNotebook_SetPageBitmap, <>). -%% @spec (This::wxAuiNotebook(), Page::integer(), Text::string()) -> bool() %% @doc See external documentation. +-spec setPageText(This, Page, Text) -> boolean() when + This::wxAuiNotebook(), Page::integer(), Text::string(). setPageText(#wx_ref{type=ThisT,ref=ThisRef},Page,Text) when is_integer(Page),is_list(Text) -> ?CLASS(ThisT,wxAuiNotebook), @@ -273,32 +308,35 @@ setPageText(#wx_ref{type=ThisT,ref=ThisRef},Page,Text) wxe_util:call(?wxAuiNotebook_SetPageText, <>). -%% @spec (This::wxAuiNotebook(), New_page::integer()) -> integer() %% @doc See external documentation. +-spec setSelection(This, New_page) -> integer() when + This::wxAuiNotebook(), New_page::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},New_page) when is_integer(New_page) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:call(?wxAuiNotebook_SetSelection, <>). -%% @spec (This::wxAuiNotebook(), Height::integer()) -> ok %% @doc See external documentation. +-spec setTabCtrlHeight(This, Height) -> ok when + This::wxAuiNotebook(), Height::integer(). setTabCtrlHeight(#wx_ref{type=ThisT,ref=ThisRef},Height) when is_integer(Height) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:cast(?wxAuiNotebook_SetTabCtrlHeight, <>). -%% @spec (This::wxAuiNotebook(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setUniformBitmapSize(This, Size) -> ok when + This::wxAuiNotebook(), Size::{W::integer(), H::integer()}. setUniformBitmapSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxAuiNotebook), wxe_util:cast(?wxAuiNotebook_SetUniformBitmapSize, <>). -%% @spec (This::wxAuiNotebook()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxAuiNotebook) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxAuiNotebook), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxAuiNotebookEvent.erl b/lib/wx/src/gen/wxAuiNotebookEvent.erl index 09a2abf214..6a86464369 100644 --- a/lib/wx/src/gen/wxAuiNotebookEvent.erl +++ b/lib/wx/src/gen/wxAuiNotebookEvent.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -42,52 +42,60 @@ isSelection/1,parent_class/1,resumePropagation/2,setInt/2,setString/2, shouldPropagate/1,skip/1,skip/2,stopPropagation/1,veto/1]). +-export_type([wxAuiNotebookEvent/0]). %% @hidden parent_class(wxNotifyEvent) -> true; parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxAuiNotebookEvent(), S::integer()) -> ok +-type wxAuiNotebookEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec setSelection(This, S) -> ok when + This::wxAuiNotebookEvent(), S::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},S) when is_integer(S) -> ?CLASS(ThisT,wxAuiNotebookEvent), wxe_util:cast(?wxAuiNotebookEvent_SetSelection, <>). -%% @spec (This::wxAuiNotebookEvent()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxAuiNotebookEvent(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiNotebookEvent), wxe_util:call(?wxAuiNotebookEvent_GetSelection, <>). -%% @spec (This::wxAuiNotebookEvent(), S::integer()) -> ok %% @doc See external documentation. +-spec setOldSelection(This, S) -> ok when + This::wxAuiNotebookEvent(), S::integer(). setOldSelection(#wx_ref{type=ThisT,ref=ThisRef},S) when is_integer(S) -> ?CLASS(ThisT,wxAuiNotebookEvent), wxe_util:cast(?wxAuiNotebookEvent_SetOldSelection, <>). -%% @spec (This::wxAuiNotebookEvent()) -> integer() %% @doc See external documentation. +-spec getOldSelection(This) -> integer() when + This::wxAuiNotebookEvent(). getOldSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiNotebookEvent), wxe_util:call(?wxAuiNotebookEvent_GetOldSelection, <>). -%% @spec (This::wxAuiNotebookEvent(), S::wxAuiNotebook:wxAuiNotebook()) -> ok %% @doc See external documentation. +-spec setDragSource(This, S) -> ok when + This::wxAuiNotebookEvent(), S::wxAuiNotebook:wxAuiNotebook(). setDragSource(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ST,ref=SRef}) -> ?CLASS(ThisT,wxAuiNotebookEvent), ?CLASS(ST,wxAuiNotebook), wxe_util:cast(?wxAuiNotebookEvent_SetDragSource, <>). -%% @spec (This::wxAuiNotebookEvent()) -> wxAuiNotebook:wxAuiNotebook() %% @doc See external documentation. +-spec getDragSource(This) -> wxAuiNotebook:wxAuiNotebook() when + This::wxAuiNotebookEvent(). getDragSource(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiNotebookEvent), wxe_util:call(?wxAuiNotebookEvent_GetDragSource, diff --git a/lib/wx/src/gen/wxAuiPaneInfo.erl b/lib/wx/src/gen/wxAuiPaneInfo.erl index b15f91c675..47e86947d4 100644 --- a/lib/wx/src/gen/wxAuiPaneInfo.erl +++ b/lib/wx/src/gen/wxAuiPaneInfo.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 @@ -44,54 +44,63 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxAuiPaneInfo/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxAuiPaneInfo() +-type wxAuiPaneInfo() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxAuiPaneInfo(). new() -> wxe_util:construct(?wxAuiPaneInfo_new_0, <<>>). -%% @spec (C::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec new(C) -> wxAuiPaneInfo() when + C::wxAuiPaneInfo(). new(#wx_ref{type=CT,ref=CRef}) -> ?CLASS(CT,wxAuiPaneInfo), wxe_util:construct(?wxAuiPaneInfo_new_1, <>). -%% @spec (This::wxAuiPaneInfo(), Size::{W::integer(), H::integer()}) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec bestSize(This, Size) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Size::{W::integer(), H::integer()}. bestSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_BestSize_1, <>). -%% @spec (This::wxAuiPaneInfo(), X::integer(), Y::integer()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec bestSize(This, X, Y) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), X::integer(), Y::integer(). bestSize(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_BestSize_2, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec bottom(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). bottom(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Bottom, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv bottomDockable(This, []) +-spec bottomDockable(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + bottomDockable(This) when is_record(This, wx_ref) -> bottomDockable(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {b, bool()} %% @doc See external documentation. +-spec bottomDockable(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {b, boolean()}. bottomDockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -101,8 +110,9 @@ bottomDockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_BottomDockable, <>). -%% @spec (This::wxAuiPaneInfo(), C::string()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec caption(This, C) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), C::string(). caption(#wx_ref{type=ThisT,ref=ThisRef},C) when is_list(C) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -110,15 +120,18 @@ caption(#wx_ref{type=ThisT,ref=ThisRef},C) wxe_util:call(?wxAuiPaneInfo_Caption, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv captionVisible(This, []) +-spec captionVisible(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + captionVisible(This) when is_record(This, wx_ref) -> captionVisible(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {visible, bool()} %% @doc See external documentation. +-spec captionVisible(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {visible, boolean()}. captionVisible(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -128,29 +141,34 @@ captionVisible(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_CaptionVisible, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec centre(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). centre(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Centre, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec centrePane(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). centrePane(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_CentrePane, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv closeButton(This, []) +-spec closeButton(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + closeButton(This) when is_record(This, wx_ref) -> closeButton(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {visible, bool()} %% @doc See external documentation. +-spec closeButton(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {visible, boolean()}. closeButton(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -160,22 +178,26 @@ closeButton(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_CloseButton, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec defaultPane(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). defaultPane(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_DefaultPane, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv destroyOnClose(This, []) +-spec destroyOnClose(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + destroyOnClose(This) when is_record(This, wx_ref) -> destroyOnClose(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {b, bool()} %% @doc See external documentation. +-spec destroyOnClose(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {b, boolean()}. destroyOnClose(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -185,30 +207,35 @@ destroyOnClose(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_DestroyOnClose, <>). -%% @spec (This::wxAuiPaneInfo(), Direction::integer()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec direction(This, Direction) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Direction::integer(). direction(#wx_ref{type=ThisT,ref=ThisRef},Direction) when is_integer(Direction) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Direction, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec dock(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). dock(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Dock, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv dockable(This, []) +-spec dockable(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + dockable(This) when is_record(This, wx_ref) -> dockable(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {b, bool()} %% @doc See external documentation. +-spec dockable(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {b, boolean()}. dockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -218,29 +245,34 @@ dockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_Dockable, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec fixed(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). fixed(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Fixed, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec float(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). float(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Float, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv floatable(This, []) +-spec floatable(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + floatable(This) when is_record(This, wx_ref) -> floatable(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {b, bool()} %% @doc See external documentation. +-spec floatable(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {b, boolean()}. floatable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -250,47 +282,54 @@ floatable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_Floatable, <>). -%% @spec (This::wxAuiPaneInfo(), Pos::{X::integer(), Y::integer()}) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec floatingPosition(This, Pos) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Pos::{X::integer(), Y::integer()}. floatingPosition(#wx_ref{type=ThisT,ref=ThisRef},{PosX,PosY}) when is_integer(PosX),is_integer(PosY) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_FloatingPosition_1, <>). -%% @spec (This::wxAuiPaneInfo(), X::integer(), Y::integer()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec floatingPosition(This, X, Y) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), X::integer(), Y::integer(). floatingPosition(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_FloatingPosition_2, <>). -%% @spec (This::wxAuiPaneInfo(), Size::{W::integer(), H::integer()}) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec floatingSize(This, Size) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Size::{W::integer(), H::integer()}. floatingSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_FloatingSize_1, <>). -%% @spec (This::wxAuiPaneInfo(), X::integer(), Y::integer()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec floatingSize(This, X, Y) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), X::integer(), Y::integer(). floatingSize(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_FloatingSize_2, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv gripper(This, []) +-spec gripper(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + gripper(This) when is_record(This, wx_ref) -> gripper(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {visible, bool()} %% @doc See external documentation. +-spec gripper(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {visible, boolean()}. gripper(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -300,15 +339,18 @@ gripper(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_Gripper, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv gripperTop(This, []) +-spec gripperTop(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + gripperTop(This) when is_record(This, wx_ref) -> gripperTop(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {attop, bool()} %% @doc See external documentation. +-spec gripperTop(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {attop, boolean()}. gripperTop(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -318,192 +360,220 @@ gripperTop(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_GripperTop, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec hasBorder(This) -> boolean() when + This::wxAuiPaneInfo(). hasBorder(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_HasBorder, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec hasCaption(This) -> boolean() when + This::wxAuiPaneInfo(). hasCaption(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_HasCaption, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec hasCloseButton(This) -> boolean() when + This::wxAuiPaneInfo(). hasCloseButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_HasCloseButton, <>). -%% @spec (This::wxAuiPaneInfo(), Flag::integer()) -> bool() %% @doc See external documentation. +-spec hasFlag(This, Flag) -> boolean() when + This::wxAuiPaneInfo(), Flag::integer(). hasFlag(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_integer(Flag) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_HasFlag, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec hasGripper(This) -> boolean() when + This::wxAuiPaneInfo(). hasGripper(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_HasGripper, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec hasGripperTop(This) -> boolean() when + This::wxAuiPaneInfo(). hasGripperTop(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_HasGripperTop, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec hasMaximizeButton(This) -> boolean() when + This::wxAuiPaneInfo(). hasMaximizeButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_HasMaximizeButton, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec hasMinimizeButton(This) -> boolean() when + This::wxAuiPaneInfo(). hasMinimizeButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_HasMinimizeButton, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec hasPinButton(This) -> boolean() when + This::wxAuiPaneInfo(). hasPinButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_HasPinButton, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec hide(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). hide(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Hide, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isBottomDockable(This) -> boolean() when + This::wxAuiPaneInfo(). isBottomDockable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsBottomDockable, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isDocked(This) -> boolean() when + This::wxAuiPaneInfo(). isDocked(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsDocked, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isFixed(This) -> boolean() when + This::wxAuiPaneInfo(). isFixed(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsFixed, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isFloatable(This) -> boolean() when + This::wxAuiPaneInfo(). isFloatable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsFloatable, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isFloating(This) -> boolean() when + This::wxAuiPaneInfo(). isFloating(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsFloating, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isLeftDockable(This) -> boolean() when + This::wxAuiPaneInfo(). isLeftDockable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsLeftDockable, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isMovable(This) -> boolean() when + This::wxAuiPaneInfo(). isMovable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsMovable, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxAuiPaneInfo(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsOk, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isResizable(This) -> boolean() when + This::wxAuiPaneInfo(). isResizable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsResizable, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isRightDockable(This) -> boolean() when + This::wxAuiPaneInfo(). isRightDockable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsRightDockable, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isShown(This) -> boolean() when + This::wxAuiPaneInfo(). isShown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsShown, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isToolbar(This) -> boolean() when + This::wxAuiPaneInfo(). isToolbar(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsToolbar, <>). -%% @spec (This::wxAuiPaneInfo()) -> bool() %% @doc See external documentation. +-spec isTopDockable(This) -> boolean() when + This::wxAuiPaneInfo(). isTopDockable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_IsTopDockable, <>). -%% @spec (This::wxAuiPaneInfo(), Layer::integer()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec layer(This, Layer) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Layer::integer(). layer(#wx_ref{type=ThisT,ref=ThisRef},Layer) when is_integer(Layer) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Layer, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec left(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). left(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Left, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv leftDockable(This, []) +-spec leftDockable(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + leftDockable(This) when is_record(This, wx_ref) -> leftDockable(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {b, bool()} %% @doc See external documentation. +-spec leftDockable(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {b, boolean()}. leftDockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -513,31 +583,36 @@ leftDockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_LeftDockable, <>). -%% @spec (This::wxAuiPaneInfo(), Size::{W::integer(), H::integer()}) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec maxSize(This, Size) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Size::{W::integer(), H::integer()}. maxSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_MaxSize_1, <>). -%% @spec (This::wxAuiPaneInfo(), X::integer(), Y::integer()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec maxSize(This, X, Y) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), X::integer(), Y::integer(). maxSize(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_MaxSize_2, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv maximizeButton(This, []) +-spec maximizeButton(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + maximizeButton(This) when is_record(This, wx_ref) -> maximizeButton(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {visible, bool()} %% @doc See external documentation. +-spec maximizeButton(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {visible, boolean()}. maximizeButton(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -547,31 +622,36 @@ maximizeButton(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_MaximizeButton, <>). -%% @spec (This::wxAuiPaneInfo(), Size::{W::integer(), H::integer()}) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec minSize(This, Size) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Size::{W::integer(), H::integer()}. minSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_MinSize_1, <>). -%% @spec (This::wxAuiPaneInfo(), X::integer(), Y::integer()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec minSize(This, X, Y) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), X::integer(), Y::integer(). minSize(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_MinSize_2, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv minimizeButton(This, []) +-spec minimizeButton(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + minimizeButton(This) when is_record(This, wx_ref) -> minimizeButton(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {visible, bool()} %% @doc See external documentation. +-spec minimizeButton(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {visible, boolean()}. minimizeButton(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -581,15 +661,18 @@ minimizeButton(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_MinimizeButton, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv movable(This, []) +-spec movable(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + movable(This) when is_record(This, wx_ref) -> movable(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {b, bool()} %% @doc See external documentation. +-spec movable(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {b, boolean()}. movable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -599,8 +682,9 @@ movable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_Movable, <>). -%% @spec (This::wxAuiPaneInfo(), N::string()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec name(This, N) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), N::string(). name(#wx_ref{type=ThisT,ref=ThisRef},N) when is_list(N) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -608,15 +692,18 @@ name(#wx_ref{type=ThisT,ref=ThisRef},N) wxe_util:call(?wxAuiPaneInfo_Name, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv paneBorder(This, []) +-spec paneBorder(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + paneBorder(This) when is_record(This, wx_ref) -> paneBorder(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {visible, bool()} %% @doc See external documentation. +-spec paneBorder(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {visible, boolean()}. paneBorder(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -626,15 +713,18 @@ paneBorder(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_PaneBorder, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv pinButton(This, []) +-spec pinButton(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + pinButton(This) when is_record(This, wx_ref) -> pinButton(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {visible, bool()} %% @doc See external documentation. +-spec pinButton(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {visible, boolean()}. pinButton(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -644,23 +734,27 @@ pinButton(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_PinButton, <>). -%% @spec (This::wxAuiPaneInfo(), Pos::integer()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec position(This, Pos) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Pos::integer(). position(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Position, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv resizable(This, []) +-spec resizable(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + resizable(This) when is_record(This, wx_ref) -> resizable(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {resizable, bool()} %% @doc See external documentation. +-spec resizable(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {resizable, boolean()}. resizable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -670,22 +764,26 @@ resizable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_Resizable, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec right(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). right(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Right, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv rightDockable(This, []) +-spec rightDockable(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + rightDockable(This) when is_record(This, wx_ref) -> rightDockable(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {b, bool()} %% @doc See external documentation. +-spec rightDockable(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {b, boolean()}. rightDockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -695,39 +793,45 @@ rightDockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_RightDockable, <>). -%% @spec (This::wxAuiPaneInfo(), Row::integer()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec row(This, Row) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Row::integer(). row(#wx_ref{type=ThisT,ref=ThisRef},Row) when is_integer(Row) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Row, <>). -%% @spec (This::wxAuiPaneInfo(), Source::wxAuiPaneInfo()) -> ok %% @doc See external documentation. +-spec safeSet(This, Source) -> ok when + This::wxAuiPaneInfo(), Source::wxAuiPaneInfo(). safeSet(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SourceT,ref=SourceRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), ?CLASS(SourceT,wxAuiPaneInfo), wxe_util:cast(?wxAuiPaneInfo_SafeSet, <>). -%% @spec (This::wxAuiPaneInfo(), Flag::integer(), Option_state::bool()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec setFlag(This, Flag, Option_state) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), Flag::integer(), Option_state::boolean(). setFlag(#wx_ref{type=ThisT,ref=ThisRef},Flag,Option_state) when is_integer(Flag),is_boolean(Option_state) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_SetFlag, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv show(This, []) +-spec show(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + show(This) when is_record(This, wx_ref) -> show(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {show, bool()} %% @doc See external documentation. +-spec show(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {show, boolean()}. show(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -737,29 +841,34 @@ show(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_Show, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec toolbarPane(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). toolbarPane(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_ToolbarPane, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec top(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). top(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), wxe_util:call(?wxAuiPaneInfo_Top, <>). -%% @spec (This::wxAuiPaneInfo()) -> wxAuiPaneInfo() %% @equiv topDockable(This, []) +-spec topDockable(This) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(). + topDockable(This) when is_record(This, wx_ref) -> topDockable(This, []). -%% @spec (This::wxAuiPaneInfo(), [Option]) -> wxAuiPaneInfo() -%% Option = {b, bool()} %% @doc See external documentation. +-spec topDockable(This, [Option]) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), + Option :: {b, boolean()}. topDockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxAuiPaneInfo), @@ -769,16 +878,17 @@ topDockable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxAuiPaneInfo_TopDockable, <>). -%% @spec (This::wxAuiPaneInfo(), W::wxWindow:wxWindow()) -> wxAuiPaneInfo() %% @doc See external documentation. +-spec window(This, W) -> wxAuiPaneInfo() when + This::wxAuiPaneInfo(), W::wxWindow:wxWindow(). window(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WT,ref=WRef}) -> ?CLASS(ThisT,wxAuiPaneInfo), ?CLASS(WT,wxWindow), wxe_util:call(?wxAuiPaneInfo_Window, <>). -%% @spec (This::wxAuiPaneInfo()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxAuiPaneInfo) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxAuiPaneInfo), wxe_util:destroy(?wxAuiPaneInfo_destruct,Obj), diff --git a/lib/wx/src/gen/wxAuiTabArt.erl b/lib/wx/src/gen/wxAuiTabArt.erl index 725bac9664..a65c6dc8cf 100644 --- a/lib/wx/src/gen/wxAuiTabArt.erl +++ b/lib/wx/src/gen/wxAuiTabArt.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 @@ -29,6 +29,8 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxAuiTabArt/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxAuiTabArt() :: wx:wx_object(). diff --git a/lib/wx/src/gen/wxBitmap.erl b/lib/wx/src/gen/wxBitmap.erl index bd2f83c6eb..ac16700011 100644 --- a/lib/wx/src/gen/wxBitmap.erl +++ b/lib/wx/src/gen/wxBitmap.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2011. All Rights Reserved. +%% Copyright Ericsson AB 2008-2012. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -32,22 +32,22 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxBitmap/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxBitmap() +-type wxBitmap() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxBitmap(). new() -> wxe_util:construct(?wxBitmap_new_0, <<>>). -%% @spec (X::string()|term()) -> wxBitmap() %% @doc See external documentation. -%%
Alternatives: -%%

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

-%%

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

+-spec new(Filename) -> wxBitmap() when + Filename::string(); + (Image) -> wxBitmap() when + Image::wxImage:wxImage(). new(Filename) when is_list(Filename) -> @@ -57,21 +57,15 @@ new(Image) when is_record(Image, wx_ref) -> new(Image, []). -%% @spec (X::integer()|string()|term(),X::integer()|term()) -> wxBitmap() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Width::integer(), Height::integer()) -> new(Width,Height, [])

-%%

-%% new(Filename::string(), [Option]) -> wxBitmap() -%%
Option = {type, WxBitmapType} -%%
WxBitmapType = integer() -%%
WxBitmapType is one of ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY -%%

-%%

-%% new(Image::wxImage:wxImage(), [Option]) -> wxBitmap() -%%
Option = {depth, integer()} -%%

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

-%% new(Bits::binary(), Width::integer(), Height::integer()) -> new(Bits,Width,Height, [])

-%%

-%% new(Width::integer(), Height::integer(), [Option]) -> wxBitmap() -%%
Option = {depth, integer()} -%%

+-spec new(Bits, Width, Height) -> wxBitmap() when + Bits::binary(), Width::integer(), Height::integer(); + (Width, Height, [Option]) -> wxBitmap() when + Width::integer(), Height::integer(), + Option :: {depth, integer()}. new(Bits,Width,Height) when is_binary(Bits),is_integer(Width),is_integer(Height) -> @@ -114,9 +105,10 @@ new(Width,Height, Options) wxe_util:construct(?wxBitmap_new_3, <>). -%% @spec (Bits::binary(), Width::integer(), Height::integer(), [Option]) -> wxBitmap() -%% Option = {depth, integer()} %% @doc See external documentation. +-spec new(Bits, Width, Height, [Option]) -> wxBitmap() when + Bits::binary(), Width::integer(), Height::integer(), + Option :: {depth, integer()}. new(Bits,Width,Height, Options) when is_binary(Bits),is_integer(Width),is_integer(Height),is_list(Options) -> wxe_util:send_bin(Bits), @@ -126,30 +118,35 @@ new(Bits,Width,Height, Options) wxe_util:construct(?wxBitmap_new_4, <>). -%% @spec (This::wxBitmap()) -> wxImage:wxImage() %% @doc See external documentation. +-spec convertToImage(This) -> wxImage:wxImage() when + This::wxBitmap(). convertToImage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_ConvertToImage, <>). -%% @spec (This::wxBitmap(), Icon::wxIcon:wxIcon()) -> bool() %% @doc See external documentation. +-spec copyFromIcon(This, Icon) -> boolean() when + This::wxBitmap(), Icon::wxIcon:wxIcon(). copyFromIcon(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconT,ref=IconRef}) -> ?CLASS(ThisT,wxBitmap), ?CLASS(IconT,wxIcon), wxe_util:call(?wxBitmap_CopyFromIcon, <>). -%% @spec (This::wxBitmap(), Width::integer(), Height::integer()) -> bool() %% @equiv create(This,Width,Height, []) +-spec create(This, Width, Height) -> boolean() when + This::wxBitmap(), Width::integer(), Height::integer(). + create(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> create(This,Width,Height, []). -%% @spec (This::wxBitmap(), Width::integer(), Height::integer(), [Option]) -> bool() -%% Option = {depth, integer()} %% @doc See external documentation. +-spec create(This, Width, Height, [Option]) -> boolean() when + This::wxBitmap(), Width::integer(), Height::integer(), + Option :: {depth, integer()}. create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxBitmap), @@ -159,60 +156,68 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxBitmap_Create, <>). -%% @spec (This::wxBitmap()) -> integer() %% @doc See external documentation. +-spec getDepth(This) -> integer() when + This::wxBitmap(). getDepth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetDepth, <>). -%% @spec (This::wxBitmap()) -> integer() %% @doc See external documentation. +-spec getHeight(This) -> integer() when + This::wxBitmap(). getHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetHeight, <>). -%% @spec (This::wxBitmap()) -> wxPalette:wxPalette() %% @doc See external documentation. +-spec getPalette(This) -> wxPalette:wxPalette() when + This::wxBitmap(). getPalette(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetPalette, <>). -%% @spec (This::wxBitmap()) -> wxMask:wxMask() %% @doc See external documentation. +-spec getMask(This) -> wxMask:wxMask() when + This::wxBitmap(). getMask(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetMask, <>). -%% @spec (This::wxBitmap()) -> integer() %% @doc See external documentation. +-spec getWidth(This) -> integer() when + This::wxBitmap(). getWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetWidth, <>). -%% @spec (This::wxBitmap(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> wxBitmap() %% @doc See external documentation. +-spec getSubBitmap(This, Rect) -> wxBitmap() when + This::wxBitmap(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. getSubBitmap(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_GetSubBitmap, <>). -%% @spec (This::wxBitmap(), Name::string()) -> bool() %% @equiv loadFile(This,Name, []) +-spec loadFile(This, Name) -> boolean() when + This::wxBitmap(), Name::string(). + loadFile(This,Name) when is_record(This, wx_ref),is_list(Name) -> loadFile(This,Name, []). -%% @spec (This::wxBitmap(), Name::string(), [Option]) -> bool() -%% Option = {type, WxBitmapType} -%% WxBitmapType = integer() %% @doc See external documentation. -%%
WxBitmapType is one of ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY +%%
Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY +-spec loadFile(This, Name, [Option]) -> boolean() when + This::wxBitmap(), Name::string(), + Option :: {type, wx:wx_enum()}. loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name, Options) when is_list(Name),is_list(Options) -> ?CLASS(ThisT,wxBitmap), @@ -223,24 +228,27 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name, Options) wxe_util:call(?wxBitmap_LoadFile, <>). -%% @spec (This::wxBitmap()) -> bool() %% @doc See external documentation. +-spec ok(This) -> boolean() when + This::wxBitmap(). ok(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmap), wxe_util:call(?wxBitmap_Ok, <>). -%% @spec (This::wxBitmap(), Name::string(), Type::WxBitmapType) -> bool() %% @equiv saveFile(This,Name,Type, []) +-spec saveFile(This, Name, Type) -> boolean() when + This::wxBitmap(), Name::string(), Type::wx:wx_enum(). + saveFile(This,Name,Type) when is_record(This, wx_ref),is_list(Name),is_integer(Type) -> saveFile(This,Name,Type, []). -%% @spec (This::wxBitmap(), Name::string(), Type::WxBitmapType, [Option]) -> bool() -%% Option = {palette, wxPalette:wxPalette()} -%% WxBitmapType = integer() %% @doc See external documentation. -%%
WxBitmapType is one of ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY +%%
Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY +-spec saveFile(This, Name, Type, [Option]) -> boolean() when + This::wxBitmap(), Name::string(), Type::wx:wx_enum(), + Option :: {palette, wxPalette:wxPalette()}. saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Type, Options) when is_list(Name),is_integer(Type),is_list(Options) -> ?CLASS(ThisT,wxBitmap), @@ -251,48 +259,53 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Type, Options) wxe_util:call(?wxBitmap_SaveFile, <>). -%% @spec (This::wxBitmap(), Depth::integer()) -> ok %% @doc See external documentation. +-spec setDepth(This, Depth) -> ok when + This::wxBitmap(), Depth::integer(). setDepth(#wx_ref{type=ThisT,ref=ThisRef},Depth) when is_integer(Depth) -> ?CLASS(ThisT,wxBitmap), wxe_util:cast(?wxBitmap_SetDepth, <>). -%% @spec (This::wxBitmap(), Height::integer()) -> ok %% @doc See external documentation. +-spec setHeight(This, Height) -> ok when + This::wxBitmap(), Height::integer(). setHeight(#wx_ref{type=ThisT,ref=ThisRef},Height) when is_integer(Height) -> ?CLASS(ThisT,wxBitmap), wxe_util:cast(?wxBitmap_SetHeight, <>). -%% @spec (This::wxBitmap(), Mask::wxMask:wxMask()) -> ok %% @doc See external documentation. +-spec setMask(This, Mask) -> ok when + This::wxBitmap(), Mask::wxMask:wxMask(). setMask(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MaskT,ref=MaskRef}) -> ?CLASS(ThisT,wxBitmap), ?CLASS(MaskT,wxMask), wxe_util:cast(?wxBitmap_SetMask, <>). -%% @spec (This::wxBitmap(), Palette::wxPalette:wxPalette()) -> ok %% @doc See external documentation. +-spec setPalette(This, Palette) -> ok when + This::wxBitmap(), Palette::wxPalette:wxPalette(). setPalette(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PaletteT,ref=PaletteRef}) -> ?CLASS(ThisT,wxBitmap), ?CLASS(PaletteT,wxPalette), wxe_util:cast(?wxBitmap_SetPalette, <>). -%% @spec (This::wxBitmap(), Width::integer()) -> ok %% @doc See external documentation. +-spec setWidth(This, Width) -> ok when + This::wxBitmap(), Width::integer(). setWidth(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxBitmap), wxe_util:cast(?wxBitmap_SetWidth, <>). -%% @spec (This::wxBitmap()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxBitmap) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxBitmap), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxBitmapButton.erl b/lib/wx/src/gen/wxBitmapButton.erl index d2353466e7..47ba575fb4 100644 --- a/lib/wx/src/gen/wxBitmapButton.erl +++ b/lib/wx/src/gen/wxBitmapButton.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 @@ -72,6 +72,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxBitmapButton/0]). %% @hidden parent_class(wxButton) -> true; parent_class(wxControl) -> true; @@ -79,21 +80,28 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxBitmapButton() +-type wxBitmapButton() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxBitmapButton(). new() -> wxe_util:construct(?wxBitmapButton_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Bitmap::wxBitmap:wxBitmap()) -> wxBitmapButton() %% @equiv new(Parent,Id,Bitmap, []) +-spec new(Parent, Id, Bitmap) -> wxBitmapButton() when + Parent::wxWindow:wxWindow(), Id::integer(), Bitmap::wxBitmap:wxBitmap(). + new(Parent,Id,Bitmap) when is_record(Parent, wx_ref),is_integer(Id),is_record(Bitmap, wx_ref) -> new(Parent,Id,Bitmap, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wxBitmapButton() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, Bitmap, [Option]) -> wxBitmapButton() when + Parent::wxWindow:wxWindow(), Id::integer(), Bitmap::wxBitmap:wxBitmap(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,#wx_ref{type=BitmapT,ref=BitmapRef}, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -107,15 +115,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,#wx_ref{type=BitmapT,ref=BitmapRef}, wxe_util:construct(?wxBitmapButton_new_4, <>). -%% @spec (This::wxBitmapButton(), Parent::wxWindow:wxWindow(), Id::integer(), Bitmap::wxBitmap:wxBitmap()) -> bool() %% @equiv create(This,Parent,Id,Bitmap, []) +-spec create(This, Parent, Id, Bitmap) -> boolean() when + This::wxBitmapButton(), Parent::wxWindow:wxWindow(), Id::integer(), Bitmap::wxBitmap:wxBitmap(). + create(This,Parent,Id,Bitmap) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_record(Bitmap, wx_ref) -> create(This,Parent,Id,Bitmap, []). -%% @spec (This::wxBitmapButton(), Parent::wxWindow:wxWindow(), Id::integer(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Bitmap, [Option]) -> boolean() when + This::wxBitmapButton(), Parent::wxWindow:wxWindow(), Id::integer(), Bitmap::wxBitmap:wxBitmap(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,#wx_ref{type=BitmapT,ref=BitmapRef}, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxBitmapButton), @@ -130,68 +144,76 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,#w wxe_util:call(?wxBitmapButton_Create, <>). -%% @spec (This::wxBitmapButton()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getBitmapDisabled(This) -> wxBitmap:wxBitmap() when + This::wxBitmapButton(). getBitmapDisabled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmapButton), wxe_util:call(?wxBitmapButton_GetBitmapDisabled, <>). -%% @spec (This::wxBitmapButton()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getBitmapFocus(This) -> wxBitmap:wxBitmap() when + This::wxBitmapButton(). getBitmapFocus(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmapButton), wxe_util:call(?wxBitmapButton_GetBitmapFocus, <>). -%% @spec (This::wxBitmapButton()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getBitmapLabel(This) -> wxBitmap:wxBitmap() when + This::wxBitmapButton(). getBitmapLabel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmapButton), wxe_util:call(?wxBitmapButton_GetBitmapLabel, <>). -%% @spec (This::wxBitmapButton()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getBitmapSelected(This) -> wxBitmap:wxBitmap() when + This::wxBitmapButton(). getBitmapSelected(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmapButton), wxe_util:call(?wxBitmapButton_GetBitmapSelected, <>). -%% @spec (This::wxBitmapButton(), Disabled::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec setBitmapDisabled(This, Disabled) -> ok when + This::wxBitmapButton(), Disabled::wxBitmap:wxBitmap(). setBitmapDisabled(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DisabledT,ref=DisabledRef}) -> ?CLASS(ThisT,wxBitmapButton), ?CLASS(DisabledT,wxBitmap), wxe_util:cast(?wxBitmapButton_SetBitmapDisabled, <>). -%% @spec (This::wxBitmapButton(), Focus::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec setBitmapFocus(This, Focus) -> ok when + This::wxBitmapButton(), Focus::wxBitmap:wxBitmap(). setBitmapFocus(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FocusT,ref=FocusRef}) -> ?CLASS(ThisT,wxBitmapButton), ?CLASS(FocusT,wxBitmap), wxe_util:cast(?wxBitmapButton_SetBitmapFocus, <>). -%% @spec (This::wxBitmapButton(), Bitmap::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec setBitmapLabel(This, Bitmap) -> ok when + This::wxBitmapButton(), Bitmap::wxBitmap:wxBitmap(). setBitmapLabel(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef}) -> ?CLASS(ThisT,wxBitmapButton), ?CLASS(BitmapT,wxBitmap), wxe_util:cast(?wxBitmapButton_SetBitmapLabel, <>). -%% @spec (This::wxBitmapButton(), Sel::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec setBitmapSelected(This, Sel) -> ok when + This::wxBitmapButton(), Sel::wxBitmap:wxBitmap(). setBitmapSelected(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SelT,ref=SelRef}) -> ?CLASS(ThisT,wxBitmapButton), ?CLASS(SelT,wxBitmap), wxe_util:cast(?wxBitmapButton_SetBitmapSelected, <>). -%% @spec (This::wxBitmapButton()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxBitmapButton) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxBitmapButton), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxBitmapDataObject.erl b/lib/wx/src/gen/wxBitmapDataObject.erl index b5207072e3..7f6bc973ef 100644 --- a/lib/wx/src/gen/wxBitmapDataObject.erl +++ b/lib/wx/src/gen/wxBitmapDataObject.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 @@ -32,25 +32,23 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxBitmapDataObject/0]). %% @hidden parent_class(wxDataObject) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxBitmapDataObject() +-type wxBitmapDataObject() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxBitmapDataObject(). + new() -> new([]). -%% @spec (X::term()) -> wxBitmapDataObject() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new([Option]) -> wxBitmapDataObject() -%%
Option = {bitmap, wxBitmap:wxBitmap()} -%%

-%%

-%% new(Bitmap::wxBitmap:wxBitmap()) -> wxBitmapDataObject() -%%

+-spec new([Option]) -> wxBitmapDataObject() when + Option :: {bitmap, wxBitmap:wxBitmap()}; + (Bitmap) -> wxBitmapDataObject() when + Bitmap::wxBitmap:wxBitmap(). new(Options) when is_list(Options) -> MOpts = fun({bitmap, #wx_ref{type=BitmapT,ref=BitmapRef}}, Acc) -> ?CLASS(BitmapT,wxBitmap),[<<1:32/?UI,BitmapRef:32/?UI>>|Acc]; @@ -63,23 +61,25 @@ new(#wx_ref{type=BitmapT,ref=BitmapRef}) -> wxe_util:construct(?wxBitmapDataObject_new_1_1, <>). -%% @spec (This::wxBitmapDataObject()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getBitmap(This) -> wxBitmap:wxBitmap() when + This::wxBitmapDataObject(). getBitmap(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBitmapDataObject), wxe_util:call(?wxBitmapDataObject_GetBitmap, <>). -%% @spec (This::wxBitmapDataObject(), Bitmap::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec setBitmap(This, Bitmap) -> ok when + This::wxBitmapDataObject(), Bitmap::wxBitmap:wxBitmap(). setBitmap(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef}) -> ?CLASS(ThisT,wxBitmapDataObject), ?CLASS(BitmapT,wxBitmap), wxe_util:cast(?wxBitmapDataObject_SetBitmap, <>). -%% @spec (This::wxBitmapDataObject()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxBitmapDataObject) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxBitmapDataObject), wxe_util:destroy(?wxBitmapDataObject_destroy,Obj), diff --git a/lib/wx/src/gen/wxBoxSizer.erl b/lib/wx/src/gen/wxBoxSizer.erl index e6287945a9..d6d8aadf30 100644 --- a/lib/wx/src/gen/wxBoxSizer.erl +++ b/lib/wx/src/gen/wxBoxSizer.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 @@ -40,26 +40,30 @@ setMinSize/2,setMinSize/3,setSizeHints/2,setVirtualSizeHints/2,show/2, show/3]). +-export_type([wxBoxSizer/0]). %% @hidden parent_class(wxSizer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Orient::integer()) -> wxBoxSizer() +-type wxBoxSizer() :: wx:wx_object(). %% @doc See external documentation. +-spec new(Orient) -> wxBoxSizer() when + Orient::integer(). new(Orient) when is_integer(Orient) -> wxe_util:construct(?wxBoxSizer_new, <>). -%% @spec (This::wxBoxSizer()) -> integer() %% @doc See external documentation. +-spec getOrientation(This) -> integer() when + This::wxBoxSizer(). getOrientation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBoxSizer), wxe_util:call(?wxBoxSizer_GetOrientation, <>). -%% @spec (This::wxBoxSizer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxBoxSizer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxBoxSizer), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxBrush.erl b/lib/wx/src/gen/wxBrush.erl index e42edd62e3..5f67d35310 100644 --- a/lib/wx/src/gen/wxBrush.erl +++ b/lib/wx/src/gen/wxBrush.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 @@ -30,23 +30,22 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxBrush/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxBrush() +-type wxBrush() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxBrush(). new() -> wxe_util:construct(?wxBrush_new_0, <<>>). -%% @spec (X::term()) -> wxBrush() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Colour::wx:colour()) -> new(Colour, [])

-%%

-%% new(StippleBitmap::wxBitmap:wxBitmap()) -> wxBrush() -%%

+-spec new(Colour) -> wxBrush() when + Colour::wx:wx_colour(); + (StippleBitmap) -> wxBrush() when + StippleBitmap::wxBitmap:wxBitmap(). new(Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> @@ -56,9 +55,10 @@ new(#wx_ref{type=StippleBitmapT,ref=StippleBitmapRef}) -> wxe_util:construct(?wxBrush_new_1, <>). -%% @spec (Colour::wx:colour(), [Option]) -> wxBrush() -%% Option = {style, integer()} %% @doc See external documentation. +-spec new(Colour, [Option]) -> wxBrush() when + Colour::wx:wx_colour(), + Option :: {style, integer()}. new(Colour, Options) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4,is_list(Options) -> MOpts = fun({style, Style}, Acc) -> [<<1:32/?UI,Style:32/?UI>>|Acc]; @@ -67,75 +67,84 @@ new(Colour, Options) wxe_util:construct(?wxBrush_new_2, <<(wxe_util:colour_bin(Colour)):16/binary, BinOpt/binary>>). -%% @spec (This::wxBrush()) -> wx:colour() %% @doc See external documentation. +-spec getColour(This) -> wx:wx_colour() when + This::wxBrush(). getColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBrush), wxe_util:call(?wxBrush_GetColour, <>). -%% @spec (This::wxBrush()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getStipple(This) -> wxBitmap:wxBitmap() when + This::wxBrush(). getStipple(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBrush), wxe_util:call(?wxBrush_GetStipple, <>). -%% @spec (This::wxBrush()) -> integer() %% @doc See external documentation. +-spec getStyle(This) -> integer() when + This::wxBrush(). getStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBrush), wxe_util:call(?wxBrush_GetStyle, <>). -%% @spec (This::wxBrush()) -> bool() %% @doc See external documentation. +-spec isHatch(This) -> boolean() when + This::wxBrush(). isHatch(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBrush), wxe_util:call(?wxBrush_IsHatch, <>). -%% @spec (This::wxBrush()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxBrush(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxBrush), wxe_util:call(?wxBrush_IsOk, <>). -%% @spec (This::wxBrush(), Col::wx:colour()) -> ok %% @doc See external documentation. +-spec setColour(This, Col) -> ok when + This::wxBrush(), Col::wx:wx_colour(). setColour(#wx_ref{type=ThisT,ref=ThisRef},Col) when tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxBrush), wxe_util:cast(?wxBrush_SetColour_1, <>). -%% @spec (This::wxBrush(), R::integer(), G::integer(), B::integer()) -> ok %% @doc See external documentation. +-spec setColour(This, R, G, B) -> ok when + This::wxBrush(), R::integer(), G::integer(), B::integer(). setColour(#wx_ref{type=ThisT,ref=ThisRef},R,G,B) when is_integer(R),is_integer(G),is_integer(B) -> ?CLASS(ThisT,wxBrush), wxe_util:cast(?wxBrush_SetColour_3, <>). -%% @spec (This::wxBrush(), Stipple::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec setStipple(This, Stipple) -> ok when + This::wxBrush(), Stipple::wxBitmap:wxBitmap(). setStipple(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=StippleT,ref=StippleRef}) -> ?CLASS(ThisT,wxBrush), ?CLASS(StippleT,wxBitmap), wxe_util:cast(?wxBrush_SetStipple, <>). -%% @spec (This::wxBrush(), Style::integer()) -> ok %% @doc See external documentation. +-spec setStyle(This, Style) -> ok when + This::wxBrush(), Style::integer(). setStyle(#wx_ref{type=ThisT,ref=ThisRef},Style) when is_integer(Style) -> ?CLASS(ThisT,wxBrush), wxe_util:cast(?wxBrush_SetStyle, <>). -%% @spec (This::wxBrush()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxBrush) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxBrush), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxBufferedDC.erl b/lib/wx/src/gen/wxBufferedDC.erl index 9096f95612..4dc11dcddd 100644 --- a/lib/wx/src/gen/wxBufferedDC.erl +++ b/lib/wx/src/gen/wxBufferedDC.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 @@ -53,32 +53,34 @@ setMapMode/2,setPalette/2,setPen/2,setTextBackground/2,setTextForeground/2, setUserScale/3,startDoc/2,startPage/1]). +-export_type([wxBufferedDC/0]). %% @hidden parent_class(wxMemoryDC) -> true; parent_class(wxDC) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxBufferedDC() +-type wxBufferedDC() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxBufferedDC(). new() -> wxe_util:construct(?wxBufferedDC_new_0, <<>>). -%% @spec (Dc::wxDC:wxDC()) -> wxBufferedDC() %% @equiv new(Dc, []) +-spec new(Dc) -> wxBufferedDC() when + Dc::wxDC:wxDC(). + new(Dc) when is_record(Dc, wx_ref) -> new(Dc, []). -%% @spec (Dc::wxDC:wxDC(),X::term()) -> wxBufferedDC() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Dc::wxDC:wxDC(), Area::{W::integer(), H::integer()}) -> new(Dc,Area, [])

-%%

-%% new(Dc::wxDC:wxDC(), [Option]) -> wxBufferedDC() -%%
Option = {buffer, wxBitmap:wxBitmap()} | {style, integer()} -%%

+-spec new(Dc, Area) -> wxBufferedDC() when + Dc::wxDC:wxDC(), Area::{W::integer(), H::integer()}; + (Dc, [Option]) -> wxBufferedDC() when + Dc::wxDC:wxDC(), + Option :: {buffer, wxBitmap:wxBitmap()} + | {style, integer()}. new(Dc,Area={AreaW,AreaH}) when is_record(Dc, wx_ref),is_integer(AreaW),is_integer(AreaH) -> @@ -93,9 +95,10 @@ new(#wx_ref{type=DcT,ref=DcRef}, Options) wxe_util:construct(?wxBufferedDC_new_2, <>). -%% @spec (Dc::wxDC:wxDC(), Area::{W::integer(), H::integer()}, [Option]) -> wxBufferedDC() -%% Option = {style, integer()} %% @doc See external documentation. +-spec new(Dc, Area, [Option]) -> wxBufferedDC() when + Dc::wxDC:wxDC(), Area::{W::integer(), H::integer()}, + Option :: {style, integer()}. new(#wx_ref{type=DcT,ref=DcRef},{AreaW,AreaH}, Options) when is_integer(AreaW),is_integer(AreaH),is_list(Options) -> ?CLASS(DcT,wxDC), @@ -105,21 +108,21 @@ new(#wx_ref{type=DcT,ref=DcRef},{AreaW,AreaH}, Options) wxe_util:construct(?wxBufferedDC_new_3, <>). -%% @spec (This::wxBufferedDC(), Dc::wxDC:wxDC()) -> ok %% @equiv init(This,Dc, []) +-spec init(This, Dc) -> ok when + This::wxBufferedDC(), Dc::wxDC:wxDC(). + init(This,Dc) when is_record(This, wx_ref),is_record(Dc, wx_ref) -> init(This,Dc, []). -%% @spec (This::wxBufferedDC(),Dc::wxDC:wxDC(),X::term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% init(This::wxBufferedDC(), Dc::wxDC:wxDC(), Area::{W::integer(), H::integer()}) -> init(This,Dc,Area, [])

-%%

-%% init(This::wxBufferedDC(), Dc::wxDC:wxDC(), [Option]) -> ok -%%
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 + This::wxBufferedDC(), Dc::wxDC:wxDC(), + Option :: {buffer, wxBitmap:wxBitmap()} + | {style, integer()}. init(This,Dc,Area={AreaW,AreaH}) when is_record(This, wx_ref),is_record(Dc, wx_ref),is_integer(AreaW),is_integer(AreaH) -> @@ -135,9 +138,10 @@ init(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DcT,ref=DcRef}, Options) wxe_util:cast(?wxBufferedDC_Init_2, <>). -%% @spec (This::wxBufferedDC(), Dc::wxDC:wxDC(), Area::{W::integer(), H::integer()}, [Option]) -> ok -%% Option = {style, integer()} %% @doc See external documentation. +-spec init(This, Dc, Area, [Option]) -> ok when + This::wxBufferedDC(), Dc::wxDC:wxDC(), Area::{W::integer(), H::integer()}, + Option :: {style, integer()}. init(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DcT,ref=DcRef},{AreaW,AreaH}, Options) when is_integer(AreaW),is_integer(AreaH),is_list(Options) -> ?CLASS(ThisT,wxBufferedDC), @@ -148,8 +152,8 @@ init(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DcT,ref=DcRef},{AreaW,AreaH}, wxe_util:cast(?wxBufferedDC_Init_3, <>). -%% @spec (This::wxBufferedDC()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxBufferedDC) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxBufferedDC), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxBufferedPaintDC.erl b/lib/wx/src/gen/wxBufferedPaintDC.erl index 2712394dd8..421fa2635d 100644 --- a/lib/wx/src/gen/wxBufferedPaintDC.erl +++ b/lib/wx/src/gen/wxBufferedPaintDC.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 @@ -55,27 +55,28 @@ setPen/2,setTextBackground/2,setTextForeground/2,setUserScale/3,startDoc/2, startPage/1]). +-export_type([wxBufferedPaintDC/0]). %% @hidden parent_class(wxBufferedDC) -> true; parent_class(wxMemoryDC) -> true; parent_class(wxDC) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Window::wxWindow:wxWindow()) -> wxBufferedPaintDC() +-type wxBufferedPaintDC() :: wx:wx_object(). %% @equiv new(Window, []) +-spec new(Window) -> wxBufferedPaintDC() when + Window::wxWindow:wxWindow(). + new(Window) when is_record(Window, wx_ref) -> new(Window, []). -%% @spec (Window::wxWindow:wxWindow(),X::term()) -> wxBufferedPaintDC() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Window::wxWindow:wxWindow(), Buffer::wxBitmap:wxBitmap()) -> new(Window,Buffer, [])

-%%

-%% new(Window::wxWindow:wxWindow(), [Option]) -> wxBufferedPaintDC() -%%
Option = {style, integer()} -%%

+-spec new(Window, Buffer) -> wxBufferedPaintDC() when + Window::wxWindow:wxWindow(), Buffer::wxBitmap:wxBitmap(); + (Window, [Option]) -> wxBufferedPaintDC() when + Window::wxWindow:wxWindow(), + Option :: {style, integer()}. new(Window,Buffer) when is_record(Window, wx_ref),is_record(Buffer, wx_ref) -> @@ -89,9 +90,10 @@ new(#wx_ref{type=WindowT,ref=WindowRef}, Options) wxe_util:construct(?wxBufferedPaintDC_new_2, <>). -%% @spec (Window::wxWindow:wxWindow(), Buffer::wxBitmap:wxBitmap(), [Option]) -> wxBufferedPaintDC() -%% Option = {style, integer()} %% @doc See external documentation. +-spec new(Window, Buffer, [Option]) -> wxBufferedPaintDC() when + Window::wxWindow:wxWindow(), Buffer::wxBitmap:wxBitmap(), + Option :: {style, integer()}. new(#wx_ref{type=WindowT,ref=WindowRef},#wx_ref{type=BufferT,ref=BufferRef}, Options) when is_list(Options) -> ?CLASS(WindowT,wxWindow), @@ -102,8 +104,8 @@ new(#wx_ref{type=WindowT,ref=WindowRef},#wx_ref{type=BufferT,ref=BufferRef}, Opt wxe_util:construct(?wxBufferedPaintDC_new_3, <>). -%% @spec (This::wxBufferedPaintDC()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxBufferedPaintDC) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxBufferedPaintDC), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxButton.erl b/lib/wx/src/gen/wxButton.erl index a75c45c5a3..facd885175 100644 --- a/lib/wx/src/gen/wxButton.erl +++ b/lib/wx/src/gen/wxButton.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 @@ -70,27 +70,36 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxButton/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxButton() +-type wxButton() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxButton(). new() -> wxe_util:construct(?wxButton_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxButton() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxButton() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxButton() -%% Option = {label, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxButton() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {label, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -104,15 +113,22 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxButton_new_3, <>). -%% @spec (This::wxButton(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxButton(), 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::wxButton(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {label, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxButton(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {label, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxButton), @@ -127,21 +143,23 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxButton_Create, <>). -%% @spec () -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getDefaultSize() -> {W::integer(), H::integer()}. getDefaultSize() -> wxe_util:call(?wxButton_GetDefaultSize, <<>>). -%% @spec (This::wxButton()) -> ok %% @doc See external documentation. +-spec setDefault(This) -> ok when + This::wxButton(). setDefault(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxButton), wxe_util:cast(?wxButton_SetDefault, <>). -%% @spec (This::wxButton(), Label::string()) -> ok %% @doc See external documentation. +-spec setLabel(This, Label) -> ok when + This::wxButton(), Label::string(). setLabel(#wx_ref{type=ThisT,ref=ThisRef},Label) when is_list(Label) -> ?CLASS(ThisT,wxButton), @@ -149,8 +167,8 @@ setLabel(#wx_ref{type=ThisT,ref=ThisRef},Label) wxe_util:cast(?wxButton_SetLabel, <>). -%% @spec (This::wxButton()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxButton) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxButton), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxCalendarCtrl.erl b/lib/wx/src/gen/wxCalendarCtrl.erl index 1bb4ecb1fa..7762e7f318 100644 --- a/lib/wx/src/gen/wxCalendarCtrl.erl +++ b/lib/wx/src/gen/wxCalendarCtrl.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,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxCalendarCtrl/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxCalendarCtrl() +-type wxCalendarCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxCalendarCtrl(). new() -> wxe_util:construct(?wxCalendarCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxCalendarCtrl() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxCalendarCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxCalendarCtrl() -%% Option = {date, wx:datetime()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxCalendarCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {date, wx:wx_datetime()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -107,15 +115,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxCalendarCtrl_new_3, <>). -%% @spec (This::wxCalendarCtrl(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxCalendarCtrl(), 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::wxCalendarCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {date, wx:datetime()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxCalendarCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {date, wx:wx_datetime()} + | {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,wxCalendarCtrl), @@ -129,30 +143,35 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxCalendarCtrl_Create, <>). -%% @spec (This::wxCalendarCtrl(), Date::wx:datetime()) -> bool() %% @doc See external documentation. +-spec setDate(This, Date) -> boolean() when + This::wxCalendarCtrl(), Date::wx:wx_datetime(). setDate(#wx_ref{type=ThisT,ref=ThisRef},Date) when tuple_size(Date) =:= 2 -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_SetDate, <>). -%% @spec (This::wxCalendarCtrl()) -> wx:datetime() %% @doc See external documentation. +-spec getDate(This) -> wx:wx_datetime() when + This::wxCalendarCtrl(). getDate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetDate, <>). -%% @spec (This::wxCalendarCtrl()) -> ok %% @equiv enableYearChange(This, []) +-spec enableYearChange(This) -> ok when + This::wxCalendarCtrl(). + enableYearChange(This) when is_record(This, wx_ref) -> enableYearChange(This, []). -%% @spec (This::wxCalendarCtrl(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enableYearChange(This, [Option]) -> ok when + This::wxCalendarCtrl(), + Option :: {enable, boolean()}. enableYearChange(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxCalendarCtrl), @@ -162,15 +181,18 @@ enableYearChange(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxCalendarCtrl_EnableYearChange, <>). -%% @spec (This::wxCalendarCtrl()) -> ok %% @equiv enableMonthChange(This, []) +-spec enableMonthChange(This) -> ok when + This::wxCalendarCtrl(). + enableMonthChange(This) when is_record(This, wx_ref) -> enableMonthChange(This, []). -%% @spec (This::wxCalendarCtrl(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enableMonthChange(This, [Option]) -> ok when + This::wxCalendarCtrl(), + Option :: {enable, boolean()}. enableMonthChange(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxCalendarCtrl), @@ -180,15 +202,18 @@ enableMonthChange(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxCalendarCtrl_EnableMonthChange, <>). -%% @spec (This::wxCalendarCtrl()) -> ok %% @equiv enableHolidayDisplay(This, []) +-spec enableHolidayDisplay(This) -> ok when + This::wxCalendarCtrl(). + enableHolidayDisplay(This) when is_record(This, wx_ref) -> enableHolidayDisplay(This, []). -%% @spec (This::wxCalendarCtrl(), [Option]) -> ok -%% Option = {display, bool()} %% @doc See external documentation. +-spec enableHolidayDisplay(This, [Option]) -> ok when + This::wxCalendarCtrl(), + Option :: {display, boolean()}. enableHolidayDisplay(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxCalendarCtrl), @@ -198,82 +223,93 @@ enableHolidayDisplay(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxCalendarCtrl_EnableHolidayDisplay, <>). -%% @spec (This::wxCalendarCtrl(), ColFg::wx:colour(), ColBg::wx:colour()) -> ok %% @doc See external documentation. +-spec setHeaderColours(This, ColFg, ColBg) -> ok when + This::wxCalendarCtrl(), ColFg::wx:wx_colour(), ColBg::wx:wx_colour(). setHeaderColours(#wx_ref{type=ThisT,ref=ThisRef},ColFg,ColBg) when tuple_size(ColFg) =:= 3; tuple_size(ColFg) =:= 4,tuple_size(ColBg) =:= 3; tuple_size(ColBg) =:= 4 -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_SetHeaderColours, <>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getHeaderColourFg(This) -> wx:wx_colour() when + This::wxCalendarCtrl(). getHeaderColourFg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHeaderColourFg, <>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getHeaderColourBg(This) -> wx:wx_colour() when + This::wxCalendarCtrl(). getHeaderColourBg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHeaderColourBg, <>). -%% @spec (This::wxCalendarCtrl(), ColFg::wx:colour(), ColBg::wx:colour()) -> ok %% @doc See external documentation. +-spec setHighlightColours(This, ColFg, ColBg) -> ok when + This::wxCalendarCtrl(), ColFg::wx:wx_colour(), ColBg::wx:wx_colour(). setHighlightColours(#wx_ref{type=ThisT,ref=ThisRef},ColFg,ColBg) when tuple_size(ColFg) =:= 3; tuple_size(ColFg) =:= 4,tuple_size(ColBg) =:= 3; tuple_size(ColBg) =:= 4 -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_SetHighlightColours, <>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getHighlightColourFg(This) -> wx:wx_colour() when + This::wxCalendarCtrl(). getHighlightColourFg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHighlightColourFg, <>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getHighlightColourBg(This) -> wx:wx_colour() when + This::wxCalendarCtrl(). getHighlightColourBg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHighlightColourBg, <>). -%% @spec (This::wxCalendarCtrl(), ColFg::wx:colour(), ColBg::wx:colour()) -> ok %% @doc See external documentation. +-spec setHolidayColours(This, ColFg, ColBg) -> ok when + This::wxCalendarCtrl(), ColFg::wx:wx_colour(), ColBg::wx:wx_colour(). setHolidayColours(#wx_ref{type=ThisT,ref=ThisRef},ColFg,ColBg) when tuple_size(ColFg) =:= 3; tuple_size(ColFg) =:= 4,tuple_size(ColBg) =:= 3; tuple_size(ColBg) =:= 4 -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_SetHolidayColours, <>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getHolidayColourFg(This) -> wx:wx_colour() when + This::wxCalendarCtrl(). getHolidayColourFg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHolidayColourFg, <>). -%% @spec (This::wxCalendarCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getHolidayColourBg(This) -> wx:wx_colour() when + This::wxCalendarCtrl(). getHolidayColourBg(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetHolidayColourBg, <>). -%% @spec (This::wxCalendarCtrl(), Day::integer()) -> wxCalendarDateAttr:wxCalendarDateAttr() %% @doc See external documentation. +-spec getAttr(This, Day) -> wxCalendarDateAttr:wxCalendarDateAttr() when + This::wxCalendarCtrl(), Day::integer(). getAttr(#wx_ref{type=ThisT,ref=ThisRef},Day) when is_integer(Day) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_GetAttr, <>). -%% @spec (This::wxCalendarCtrl(), Day::integer(), Attr::wxCalendarDateAttr:wxCalendarDateAttr()) -> ok %% @doc See external documentation. +-spec setAttr(This, Day, Attr) -> ok when + This::wxCalendarCtrl(), Day::integer(), Attr::wxCalendarDateAttr:wxCalendarDateAttr(). setAttr(#wx_ref{type=ThisT,ref=ThisRef},Day,#wx_ref{type=AttrT,ref=AttrRef}) when is_integer(Day) -> ?CLASS(ThisT,wxCalendarCtrl), @@ -281,36 +317,38 @@ setAttr(#wx_ref{type=ThisT,ref=ThisRef},Day,#wx_ref{type=AttrT,ref=AttrRef}) wxe_util:cast(?wxCalendarCtrl_SetAttr, <>). -%% @spec (This::wxCalendarCtrl(), Day::integer()) -> ok %% @doc See external documentation. +-spec setHoliday(This, Day) -> ok when + This::wxCalendarCtrl(), Day::integer(). setHoliday(#wx_ref{type=ThisT,ref=ThisRef},Day) when is_integer(Day) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_SetHoliday, <>). -%% @spec (This::wxCalendarCtrl(), Day::integer()) -> ok %% @doc See external documentation. +-spec resetAttr(This, Day) -> ok when + This::wxCalendarCtrl(), Day::integer(). resetAttr(#wx_ref{type=ThisT,ref=ThisRef},Day) when is_integer(Day) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:cast(?wxCalendarCtrl_ResetAttr, <>). -%% @spec (This::wxCalendarCtrl(), Pos::{X::integer(), Y::integer()}) -> {WxCalendarHitTestResult, Date::wx:datetime(), Wd::WeekDay} -%% WxCalendarHitTestResult = integer() -%% WeekDay = integer() %% @doc See external documentation. -%%
WxCalendarHitTestResult is one of ?wxCAL_HITTEST_NOWHERE | ?wxCAL_HITTEST_HEADER | ?wxCAL_HITTEST_DAY | ?wxCAL_HITTEST_INCMONTH | ?wxCAL_HITTEST_DECMONTH | ?wxCAL_HITTEST_SURROUNDING_WEEK -%%
WeekDay is one of ?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 +%%
Wd = ?wxDateTime_Sun | ?wxDateTime_Mon | ?wxDateTime_Tue | ?wxDateTime_Wed | ?wxDateTime_Thu | ?wxDateTime_Fri | ?wxDateTime_Sat | ?wxDateTime_Inv_WeekDay +-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()}. hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PosX,PosY}) when is_integer(PosX),is_integer(PosY) -> ?CLASS(ThisT,wxCalendarCtrl), wxe_util:call(?wxCalendarCtrl_HitTest, <>). -%% @spec (This::wxCalendarCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxCalendarCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxCalendarCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxCalendarDateAttr.erl b/lib/wx/src/gen/wxCalendarDateAttr.erl index aea8abbe54..c674aee8d6 100644 --- a/lib/wx/src/gen/wxCalendarDateAttr.erl +++ b/lib/wx/src/gen/wxCalendarDateAttr.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 @@ -32,22 +32,22 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxCalendarDateAttr/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxCalendarDateAttr() +-type wxCalendarDateAttr() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxCalendarDateAttr(). new() -> wxe_util:construct(?wxCalendarDateAttr_new_0, <<>>). -%% @spec (X::WxCalendarDateBorder|term()) -> wxCalendarDateAttr() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Border::WxCalendarDateBorder) -> new(Border, [])

-%%

-%% new(ColText::wx:colour()) -> new(ColText, [])

+-spec new(Border) -> wxCalendarDateAttr() when + Border::wx:wx_enum(); + (ColText) -> wxCalendarDateAttr() when + ColText::wx:wx_colour(). new(Border) when is_integer(Border) -> @@ -57,21 +57,16 @@ new(ColText) when tuple_size(ColText) =:= 3; tuple_size(ColText) =:= 4 -> new(ColText, []). -%% @spec (X::WxCalendarDateBorder|term(),[Option]) -> wxCalendarDateAttr() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Border::WxCalendarDateBorder, [Option]) -> wxCalendarDateAttr() -%%
Option = {colBorder, wx:colour()} -%%
WxCalendarDateBorder = integer() -%%
WxCalendarDateBorder is one of ?wxCAL_BORDER_NONE | ?wxCAL_BORDER_SQUARE | ?wxCAL_BORDER_ROUND -%%

-%%

-%% new(ColText::wx:colour(), [Option]) -> wxCalendarDateAttr() -%%
Option = {colBack, wx:colour()} | {colBorder, wx:colour()} | {font, wxFont:wxFont()} | {border, WxCalendarDateBorder} -%%
WxCalendarDateBorder = integer() -%%
WxCalendarDateBorder is one of ?wxCAL_BORDER_NONE | ?wxCAL_BORDER_SQUARE | ?wxCAL_BORDER_ROUND -%%

+-spec new(Border, [Option]) -> wxCalendarDateAttr() when + Border::wx:wx_enum(), + Option :: {colBorder, wx:wx_colour()}; + (ColText, [Option]) -> wxCalendarDateAttr() when + ColText::wx:wx_colour(), + Option :: {colBack, wx:wx_colour()} + | {colBorder, wx:wx_colour()} + | {font, wxFont:wxFont()} + | {border, wx:wx_enum()}. new(Border, Options) when is_integer(Border),is_list(Options) -> MOpts = fun({colBorder, ColBorder}, Acc) -> [<<1:32/?UI,(wxe_util:colour_bin(ColBorder)):16/binary,0:32>>|Acc]; @@ -90,137 +85,152 @@ new(ColText, Options) wxe_util:construct(?wxCalendarDateAttr_new_2_1, <<(wxe_util:colour_bin(ColText)):16/binary, BinOpt/binary>>). -%% @spec (This::wxCalendarDateAttr(), ColText::wx:colour()) -> ok %% @doc See external documentation. +-spec setTextColour(This, ColText) -> ok when + This::wxCalendarDateAttr(), ColText::wx:wx_colour(). setTextColour(#wx_ref{type=ThisT,ref=ThisRef},ColText) when tuple_size(ColText) =:= 3; tuple_size(ColText) =:= 4 -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:cast(?wxCalendarDateAttr_SetTextColour, <>). -%% @spec (This::wxCalendarDateAttr(), ColBack::wx:colour()) -> ok %% @doc See external documentation. +-spec setBackgroundColour(This, ColBack) -> ok when + This::wxCalendarDateAttr(), ColBack::wx:wx_colour(). setBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},ColBack) when tuple_size(ColBack) =:= 3; tuple_size(ColBack) =:= 4 -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:cast(?wxCalendarDateAttr_SetBackgroundColour, <>). -%% @spec (This::wxCalendarDateAttr(), Col::wx:colour()) -> ok %% @doc See external documentation. +-spec setBorderColour(This, Col) -> ok when + This::wxCalendarDateAttr(), Col::wx:wx_colour(). setBorderColour(#wx_ref{type=ThisT,ref=ThisRef},Col) when tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:cast(?wxCalendarDateAttr_SetBorderColour, <>). -%% @spec (This::wxCalendarDateAttr(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setFont(This, Font) -> ok when + This::wxCalendarDateAttr(), Font::wxFont:wxFont(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), ?CLASS(FontT,wxFont), wxe_util:cast(?wxCalendarDateAttr_SetFont, <>). -%% @spec (This::wxCalendarDateAttr(), Border::WxCalendarDateBorder) -> ok -%% WxCalendarDateBorder = integer() %% @doc See external documentation. -%%
WxCalendarDateBorder is one of ?wxCAL_BORDER_NONE | ?wxCAL_BORDER_SQUARE | ?wxCAL_BORDER_ROUND +%%
Border = ?wxCAL_BORDER_NONE | ?wxCAL_BORDER_SQUARE | ?wxCAL_BORDER_ROUND +-spec setBorder(This, Border) -> ok when + This::wxCalendarDateAttr(), Border::wx:wx_enum(). setBorder(#wx_ref{type=ThisT,ref=ThisRef},Border) when is_integer(Border) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:cast(?wxCalendarDateAttr_SetBorder, <>). -%% @spec (This::wxCalendarDateAttr(), Holiday::bool()) -> ok %% @doc See external documentation. +-spec setHoliday(This, Holiday) -> ok when + This::wxCalendarDateAttr(), Holiday::boolean(). setHoliday(#wx_ref{type=ThisT,ref=ThisRef},Holiday) when is_boolean(Holiday) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:cast(?wxCalendarDateAttr_SetHoliday, <>). -%% @spec (This::wxCalendarDateAttr()) -> bool() %% @doc See external documentation. +-spec hasTextColour(This) -> boolean() when + This::wxCalendarDateAttr(). hasTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_HasTextColour, <>). -%% @spec (This::wxCalendarDateAttr()) -> bool() %% @doc See external documentation. +-spec hasBackgroundColour(This) -> boolean() when + This::wxCalendarDateAttr(). hasBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_HasBackgroundColour, <>). -%% @spec (This::wxCalendarDateAttr()) -> bool() %% @doc See external documentation. +-spec hasBorderColour(This) -> boolean() when + This::wxCalendarDateAttr(). hasBorderColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_HasBorderColour, <>). -%% @spec (This::wxCalendarDateAttr()) -> bool() %% @doc See external documentation. +-spec hasFont(This) -> boolean() when + This::wxCalendarDateAttr(). hasFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_HasFont, <>). -%% @spec (This::wxCalendarDateAttr()) -> bool() %% @doc See external documentation. +-spec hasBorder(This) -> boolean() when + This::wxCalendarDateAttr(). hasBorder(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_HasBorder, <>). -%% @spec (This::wxCalendarDateAttr()) -> bool() %% @doc See external documentation. +-spec isHoliday(This) -> boolean() when + This::wxCalendarDateAttr(). isHoliday(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_IsHoliday, <>). -%% @spec (This::wxCalendarDateAttr()) -> wx:colour() %% @doc See external documentation. +-spec getTextColour(This) -> wx:wx_colour() when + This::wxCalendarDateAttr(). getTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_GetTextColour, <>). -%% @spec (This::wxCalendarDateAttr()) -> wx:colour() %% @doc See external documentation. +-spec getBackgroundColour(This) -> wx:wx_colour() when + This::wxCalendarDateAttr(). getBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_GetBackgroundColour, <>). -%% @spec (This::wxCalendarDateAttr()) -> wx:colour() %% @doc See external documentation. +-spec getBorderColour(This) -> wx:wx_colour() when + This::wxCalendarDateAttr(). getBorderColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_GetBorderColour, <>). -%% @spec (This::wxCalendarDateAttr()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getFont(This) -> wxFont:wxFont() when + This::wxCalendarDateAttr(). getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_GetFont, <>). -%% @spec (This::wxCalendarDateAttr()) -> WxCalendarDateBorder -%% WxCalendarDateBorder = integer() %% @doc See external documentation. -%%
WxCalendarDateBorder is one of ?wxCAL_BORDER_NONE | ?wxCAL_BORDER_SQUARE | ?wxCAL_BORDER_ROUND +%%
Res = ?wxCAL_BORDER_NONE | ?wxCAL_BORDER_SQUARE | ?wxCAL_BORDER_ROUND +-spec getBorder(This) -> wx:wx_enum() when + This::wxCalendarDateAttr(). getBorder(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarDateAttr), wxe_util:call(?wxCalendarDateAttr_GetBorder, <>). -%% @spec (This::wxCalendarDateAttr()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxCalendarDateAttr) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxCalendarDateAttr), wxe_util:destroy(?wxCalendarDateAttr_destroy,Obj), diff --git a/lib/wx/src/gen/wxCalendarEvent.erl b/lib/wx/src/gen/wxCalendarEvent.erl index 40723711af..c062a7fa0d 100644 --- a/lib/wx/src/gen/wxCalendarEvent.erl +++ b/lib/wx/src/gen/wxCalendarEvent.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 @@ -41,16 +41,18 @@ isSelection/1,parent_class/1,resumePropagation/2,setInt/2,setString/2, shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxCalendarEvent/0]). %% @hidden parent_class(wxDateEvent) -> true; parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxCalendarEvent()) -> WeekDay -%% WeekDay = integer() +-type wxCalendarEvent() :: wx:wx_object(). %% @doc See external documentation. -%%
WeekDay is one of ?wxDateTime_Sun | ?wxDateTime_Mon | ?wxDateTime_Tue | ?wxDateTime_Wed | ?wxDateTime_Thu | ?wxDateTime_Fri | ?wxDateTime_Sat | ?wxDateTime_Inv_WeekDay +%%
Res = ?wxDateTime_Sun | ?wxDateTime_Mon | ?wxDateTime_Tue | ?wxDateTime_Wed | ?wxDateTime_Thu | ?wxDateTime_Fri | ?wxDateTime_Sat | ?wxDateTime_Inv_WeekDay +-spec getWeekDay(This) -> wx:wx_enum() when + This::wxCalendarEvent(). getWeekDay(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCalendarEvent), wxe_util:call(?wxCalendarEvent_GetWeekDay, diff --git a/lib/wx/src/gen/wxCaret.erl b/lib/wx/src/gen/wxCaret.erl index cbd868f388..a1f8c29a7f 100644 --- a/lib/wx/src/gen/wxCaret.erl +++ b/lib/wx/src/gen/wxCaret.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 @@ -31,27 +31,32 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxCaret/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Window::wxWindow:wxWindow(), Size::{W::integer(), H::integer()}) -> wxCaret() +-type wxCaret() :: wx:wx_object(). %% @doc See external documentation. +-spec new(Window, Size) -> wxCaret() when + Window::wxWindow:wxWindow(), Size::{W::integer(), H::integer()}. new(#wx_ref{type=WindowT,ref=WindowRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(WindowT,wxWindow), wxe_util:construct(?wxCaret_new_2, <>). -%% @spec (Window::wxWindow:wxWindow(), Width::integer(), Height::integer()) -> wxCaret() %% @doc See external documentation. +-spec new(Window, Width, Height) -> wxCaret() when + Window::wxWindow:wxWindow(), Width::integer(), Height::integer(). new(#wx_ref{type=WindowT,ref=WindowRef},Width,Height) when is_integer(Width),is_integer(Height) -> ?CLASS(WindowT,wxWindow), wxe_util:construct(?wxCaret_new_3, <>). -%% @spec (This::wxCaret(), Window::wxWindow:wxWindow(), Size::{W::integer(), H::integer()}) -> bool() %% @doc See external documentation. +-spec create(This, Window, Size) -> boolean() when + This::wxCaret(), Window::wxWindow:wxWindow(), Size::{W::integer(), H::integer()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxCaret), @@ -59,8 +64,9 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},{Size wxe_util:call(?wxCaret_Create_2, <>). -%% @spec (This::wxCaret(), Window::wxWindow:wxWindow(), Width::integer(), Height::integer()) -> bool() %% @doc See external documentation. +-spec create(This, Window, Width, Height) -> boolean() when + This::wxCaret(), Window::wxWindow:wxWindow(), Width::integer(), Height::integer(). create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},Width,Height) when is_integer(Width),is_integer(Height) -> ?CLASS(ThisT,wxCaret), @@ -68,102 +74,116 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},Width wxe_util:call(?wxCaret_Create_3, <>). -%% @spec () -> integer() %% @doc See external documentation. +-spec getBlinkTime() -> integer(). getBlinkTime() -> wxe_util:call(?wxCaret_GetBlinkTime, <<>>). -%% @spec (This::wxCaret()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxCaret(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCaret), wxe_util:call(?wxCaret_GetPosition, <>). -%% @spec (This::wxCaret()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getSize(This) -> {W::integer(), H::integer()} when + This::wxCaret(). getSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCaret), wxe_util:call(?wxCaret_GetSize, <>). -%% @spec (This::wxCaret()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getWindow(This) -> wxWindow:wxWindow() when + This::wxCaret(). getWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCaret), wxe_util:call(?wxCaret_GetWindow, <>). -%% @spec (This::wxCaret()) -> ok %% @doc See external documentation. +-spec hide(This) -> ok when + This::wxCaret(). hide(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCaret), wxe_util:cast(?wxCaret_Hide, <>). -%% @spec (This::wxCaret()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxCaret(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCaret), wxe_util:call(?wxCaret_IsOk, <>). -%% @spec (This::wxCaret()) -> bool() %% @doc See external documentation. +-spec isVisible(This) -> boolean() when + This::wxCaret(). isVisible(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCaret), wxe_util:call(?wxCaret_IsVisible, <>). -%% @spec (This::wxCaret(), Pt::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec move(This, Pt) -> ok when + This::wxCaret(), Pt::{X::integer(), Y::integer()}. move(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxCaret), wxe_util:cast(?wxCaret_Move_1, <>). -%% @spec (This::wxCaret(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec move(This, X, Y) -> ok when + This::wxCaret(), X::integer(), Y::integer(). move(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxCaret), wxe_util:cast(?wxCaret_Move_2, <>). -%% @spec (Milliseconds::integer()) -> ok %% @doc See external documentation. +-spec setBlinkTime(Milliseconds) -> ok when + Milliseconds::integer(). setBlinkTime(Milliseconds) when is_integer(Milliseconds) -> wxe_util:cast(?wxCaret_SetBlinkTime, <>). -%% @spec (This::wxCaret(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setSize(This, Size) -> ok when + This::wxCaret(), Size::{W::integer(), H::integer()}. setSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxCaret), wxe_util:cast(?wxCaret_SetSize_1, <>). -%% @spec (This::wxCaret(), Width::integer(), Height::integer()) -> ok %% @doc See external documentation. +-spec setSize(This, Width, Height) -> ok when + This::wxCaret(), Width::integer(), Height::integer(). setSize(#wx_ref{type=ThisT,ref=ThisRef},Width,Height) when is_integer(Width),is_integer(Height) -> ?CLASS(ThisT,wxCaret), wxe_util:cast(?wxCaret_SetSize_2, <>). -%% @spec (This::wxCaret()) -> ok %% @equiv show(This, []) +-spec show(This) -> ok when + This::wxCaret(). + show(This) when is_record(This, wx_ref) -> show(This, []). -%% @spec (This::wxCaret(), [Option]) -> ok -%% Option = {show, bool()} %% @doc See external documentation. +-spec show(This, [Option]) -> ok when + This::wxCaret(), + Option :: {show, boolean()}. show(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxCaret), @@ -173,8 +193,8 @@ show(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxCaret_Show, <>). -%% @spec (This::wxCaret()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxCaret) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxCaret), wxe_util:destroy(?wxCaret_destruct,Obj), diff --git a/lib/wx/src/gen/wxCheckBox.erl b/lib/wx/src/gen/wxCheckBox.erl index 19f01645c1..c629af6488 100644 --- a/lib/wx/src/gen/wxCheckBox.erl +++ b/lib/wx/src/gen/wxCheckBox.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 @@ -71,27 +71,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxCheckBox/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxCheckBox() +-type wxCheckBox() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxCheckBox(). new() -> wxe_util:construct(?wxCheckBox_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> wxCheckBox() %% @equiv new(Parent,Id,Label, []) +-spec new(Parent, Id, Label) -> wxCheckBox() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + new(Parent,Id,Label) when is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> new(Parent,Id,Label, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> wxCheckBox() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, Label, [Option]) -> wxCheckBox() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -105,15 +113,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) wxe_util:construct(?wxCheckBox_new_4, <>). -%% @spec (This::wxCheckBox(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> bool() %% @equiv create(This,Parent,Id,Label, []) +-spec create(This, Parent, Id, Label) -> boolean() when + This::wxCheckBox(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + create(This,Parent,Id,Label) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> create(This,Parent,Id,Label, []). -%% @spec (This::wxCheckBox(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Label, [Option]) -> boolean() when + This::wxCheckBox(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ThisT,wxCheckBox), @@ -128,63 +142,68 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,La wxe_util:call(?wxCheckBox_Create, <>). -%% @spec (This::wxCheckBox()) -> bool() %% @doc See external documentation. +-spec getValue(This) -> boolean() when + This::wxCheckBox(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCheckBox), wxe_util:call(?wxCheckBox_GetValue, <>). -%% @spec (This::wxCheckBox()) -> WxCheckBoxState -%% WxCheckBoxState = integer() %% @doc See external documentation. -%%
WxCheckBoxState is one of ?wxCHK_UNCHECKED | ?wxCHK_CHECKED | ?wxCHK_UNDETERMINED +%%
Res = ?wxCHK_UNCHECKED | ?wxCHK_CHECKED | ?wxCHK_UNDETERMINED +-spec get3StateValue(This) -> wx:wx_enum() when + This::wxCheckBox(). get3StateValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCheckBox), wxe_util:call(?wxCheckBox_Get3StateValue, <>). -%% @spec (This::wxCheckBox()) -> bool() %% @doc See external documentation. +-spec is3rdStateAllowedForUser(This) -> boolean() when + This::wxCheckBox(). is3rdStateAllowedForUser(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCheckBox), wxe_util:call(?wxCheckBox_Is3rdStateAllowedForUser, <>). -%% @spec (This::wxCheckBox()) -> bool() %% @doc See external documentation. +-spec is3State(This) -> boolean() when + This::wxCheckBox(). is3State(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCheckBox), wxe_util:call(?wxCheckBox_Is3State, <>). -%% @spec (This::wxCheckBox()) -> bool() %% @doc See external documentation. +-spec isChecked(This) -> boolean() when + This::wxCheckBox(). isChecked(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCheckBox), wxe_util:call(?wxCheckBox_IsChecked, <>). -%% @spec (This::wxCheckBox(), State::bool()) -> ok %% @doc See external documentation. +-spec setValue(This, State) -> ok when + This::wxCheckBox(), State::boolean(). setValue(#wx_ref{type=ThisT,ref=ThisRef},State) when is_boolean(State) -> ?CLASS(ThisT,wxCheckBox), wxe_util:cast(?wxCheckBox_SetValue, <>). -%% @spec (This::wxCheckBox(), State::WxCheckBoxState) -> ok -%% WxCheckBoxState = integer() %% @doc See external documentation. -%%
WxCheckBoxState is one of ?wxCHK_UNCHECKED | ?wxCHK_CHECKED | ?wxCHK_UNDETERMINED +%%
State = ?wxCHK_UNCHECKED | ?wxCHK_CHECKED | ?wxCHK_UNDETERMINED +-spec set3StateValue(This, State) -> ok when + This::wxCheckBox(), State::wx:wx_enum(). set3StateValue(#wx_ref{type=ThisT,ref=ThisRef},State) when is_integer(State) -> ?CLASS(ThisT,wxCheckBox), wxe_util:cast(?wxCheckBox_Set3StateValue, <>). -%% @spec (This::wxCheckBox()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxCheckBox) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxCheckBox), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxCheckListBox.erl b/lib/wx/src/gen/wxCheckListBox.erl index a1a07e1eec..457d58eebc 100644 --- a/lib/wx/src/gen/wxCheckListBox.erl +++ b/lib/wx/src/gen/wxCheckListBox.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 @@ -75,6 +75,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxCheckListBox/0]). %% @hidden parent_class(wxListBox) -> true; parent_class(wxControlWithItems) -> true; @@ -83,21 +84,29 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxCheckListBox() +-type wxCheckListBox() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxCheckListBox(). new() -> wxe_util:construct(?wxCheckListBox_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxCheckListBox() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxCheckListBox() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxCheckListBox() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {choices, [[string()]]} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxCheckListBox() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {choices, [[string()]]} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -111,15 +120,18 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxCheckListBox_new_3, <>). -%% @spec (This::wxCheckListBox(), Index::integer()) -> ok %% @equiv check(This,Index, []) +-spec check(This, Index) -> ok when + This::wxCheckListBox(), Index::integer(). + check(This,Index) when is_record(This, wx_ref),is_integer(Index) -> check(This,Index, []). -%% @spec (This::wxCheckListBox(), Index::integer(), [Option]) -> ok -%% Option = {check, bool()} %% @doc See external documentation. +-spec check(This, Index, [Option]) -> ok when + This::wxCheckListBox(), Index::integer(), + Option :: {check, boolean()}. check(#wx_ref{type=ThisT,ref=ThisRef},Index, Options) when is_integer(Index),is_list(Options) -> ?CLASS(ThisT,wxCheckListBox), @@ -129,16 +141,17 @@ check(#wx_ref{type=ThisT,ref=ThisRef},Index, Options) wxe_util:cast(?wxCheckListBox_Check, <>). -%% @spec (This::wxCheckListBox(), Index::integer()) -> bool() %% @doc See external documentation. +-spec isChecked(This, Index) -> boolean() when + This::wxCheckListBox(), Index::integer(). isChecked(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxCheckListBox), wxe_util:call(?wxCheckListBox_IsChecked, <>). -%% @spec (This::wxCheckListBox()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxCheckListBox) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxCheckListBox), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxChildFocusEvent.erl b/lib/wx/src/gen/wxChildFocusEvent.erl index a20071cbf5..642db88c06 100644 --- a/lib/wx/src/gen/wxChildFocusEvent.erl +++ b/lib/wx/src/gen/wxChildFocusEvent.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,13 +40,16 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxChildFocusEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxChildFocusEvent()) -> wxWindow:wxWindow() +-type wxChildFocusEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getWindow(This) -> wxWindow:wxWindow() when + This::wxChildFocusEvent(). getWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxChildFocusEvent), wxe_util:call(?wxChildFocusEvent_GetWindow, diff --git a/lib/wx/src/gen/wxChoice.erl b/lib/wx/src/gen/wxChoice.erl index fa967d8487..983e74e65a 100644 --- a/lib/wx/src/gen/wxChoice.erl +++ b/lib/wx/src/gen/wxChoice.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,6 +74,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxChoice/0]). %% @hidden parent_class(wxControlWithItems) -> true; parent_class(wxControl) -> true; @@ -81,21 +82,29 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxChoice() +-type wxChoice() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxChoice(). new() -> wxe_util:construct(?wxChoice_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxChoice() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxChoice() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxChoice() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {choices, [[string()]]} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxChoice() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {choices, [[string()]]} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -109,15 +118,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxChoice_new_3, <>). -%% @spec (This::wxChoice(), Parent::wxWindow:wxWindow(), Id::integer(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]) -> bool() %% @equiv create(This,Parent,Id,Pos,Size,Choices, []) +-spec create(This, Parent, Id, Pos, Size, Choices) -> boolean() when + This::wxChoice(), Parent::wxWindow:wxWindow(), Id::integer(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]. + create(This,Parent,Id,Pos={PosX,PosY},Size={SizeW,SizeH},Choices) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices) -> create(This,Parent,Id,Pos,Size,Choices, []). -%% @spec (This::wxChoice(), Parent::wxWindow:wxWindow(), Id::integer(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], [Option]) -> bool() -%% Option = {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Pos, Size, Choices, [Option]) -> boolean() when + This::wxChoice(), Parent::wxWindow:wxWindow(), Id::integer(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], + Option :: {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,{PosX,PosY},{SizeW,SizeH},Choices, Options) when is_integer(Id),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices),is_list(Options) -> ?CLASS(ThisT,wxChoice), @@ -131,30 +144,35 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,{P wxe_util:call(?wxChoice_Create, <>|| UC_Str <- Choices_UCA>>)/binary, 0:(((8- ((0 + lists:sum([byte_size(S)+4||S<-Choices_UCA])) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxChoice(), N::integer()) -> ok %% @doc See external documentation. +-spec delete(This, N) -> ok when + This::wxChoice(), N::integer(). delete(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxChoice), wxe_util:cast(?wxChoice_Delete, <>). -%% @spec (This::wxChoice()) -> integer() %% @doc See external documentation. +-spec getColumns(This) -> integer() when + This::wxChoice(). getColumns(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxChoice), wxe_util:call(?wxChoice_GetColumns, <>). -%% @spec (This::wxChoice()) -> ok %% @equiv setColumns(This, []) +-spec setColumns(This) -> ok when + This::wxChoice(). + setColumns(This) when is_record(This, wx_ref) -> setColumns(This, []). -%% @spec (This::wxChoice(), [Option]) -> ok -%% Option = {n, integer()} %% @doc See external documentation. +-spec setColumns(This, [Option]) -> ok when + This::wxChoice(), + Option :: {n, integer()}. setColumns(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxChoice), @@ -164,8 +182,8 @@ setColumns(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxChoice_SetColumns, <>). -%% @spec (This::wxChoice()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxChoice) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxChoice), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxChoicebook.erl b/lib/wx/src/gen/wxChoicebook.erl index f37457f0ed..556170befa 100644 --- a/lib/wx/src/gen/wxChoicebook.erl +++ b/lib/wx/src/gen/wxChoicebook.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2011. All Rights Reserved. +%% Copyright Ericsson AB 2009-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([wxChoicebook/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxChoicebook() +-type wxChoicebook() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxChoicebook(). new() -> wxe_util:construct(?wxChoicebook_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxChoicebook() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxChoicebook() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxChoicebook() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxChoicebook() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -106,15 +113,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxChoicebook_new_3, <>). -%% @spec (This::wxChoicebook(), Page::wxWindow:wxWindow(), Text::string()) -> bool() %% @equiv addPage(This,Page,Text, []) +-spec addPage(This, Page, Text) -> boolean() when + This::wxChoicebook(), 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::wxChoicebook(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool() -%% Option = {bSelect, bool()} | {imageId, integer()} %% @doc See external documentation. +-spec addPage(This, Page, Text, [Option]) -> boolean() when + This::wxChoicebook(), 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,wxChoicebook), @@ -127,15 +138,18 @@ addPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageT,ref=PageRef},Text, Op wxe_util:call(?wxChoicebook_AddPage, <>). -%% @spec (This::wxChoicebook()) -> ok %% @equiv advanceSelection(This, []) +-spec advanceSelection(This) -> ok when + This::wxChoicebook(). + advanceSelection(This) when is_record(This, wx_ref) -> advanceSelection(This, []). -%% @spec (This::wxChoicebook(), [Option]) -> ok -%% Option = {forward, bool()} %% @doc See external documentation. +-spec advanceSelection(This, [Option]) -> ok when + This::wxChoicebook(), + Option :: {forward, boolean()}. advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxChoicebook), @@ -145,23 +159,29 @@ advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxChoicebook_AdvanceSelection, <>). -%% @spec (This::wxChoicebook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec assignImageList(This, ImageList) -> ok when + This::wxChoicebook(), ImageList::wxImageList:wxImageList(). assignImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxChoicebook), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxChoicebook_AssignImageList, <>). -%% @spec (This::wxChoicebook(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxChoicebook(), 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::wxChoicebook(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxChoicebook(), 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,wxChoicebook), @@ -174,98 +194,114 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxChoicebook_Create, <>). -%% @spec (This::wxChoicebook()) -> bool() %% @doc See external documentation. +-spec deleteAllPages(This) -> boolean() when + This::wxChoicebook(). deleteAllPages(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_DeleteAllPages, <>). -%% @spec (This::wxChoicebook(), N::integer()) -> bool() %% @doc See external documentation. +-spec deletePage(This, N) -> boolean() when + This::wxChoicebook(), N::integer(). deletePage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_DeletePage, <>). -%% @spec (This::wxChoicebook(), N::integer()) -> bool() %% @doc See external documentation. +-spec removePage(This, N) -> boolean() when + This::wxChoicebook(), N::integer(). removePage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_RemovePage, <>). -%% @spec (This::wxChoicebook()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getCurrentPage(This) -> wxWindow:wxWindow() when + This::wxChoicebook(). getCurrentPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_GetCurrentPage, <>). -%% @spec (This::wxChoicebook()) -> wxImageList:wxImageList() %% @doc See external documentation. +-spec getImageList(This) -> wxImageList:wxImageList() when + This::wxChoicebook(). getImageList(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_GetImageList, <>). -%% @spec (This::wxChoicebook(), N::integer()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getPage(This, N) -> wxWindow:wxWindow() when + This::wxChoicebook(), N::integer(). getPage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_GetPage, <>). -%% @spec (This::wxChoicebook()) -> integer() %% @doc See external documentation. +-spec getPageCount(This) -> integer() when + This::wxChoicebook(). getPageCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_GetPageCount, <>). -%% @spec (This::wxChoicebook(), N::integer()) -> integer() %% @doc See external documentation. +-spec getPageImage(This, N) -> integer() when + This::wxChoicebook(), N::integer(). getPageImage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_GetPageImage, <>). -%% @spec (This::wxChoicebook(), N::integer()) -> string() %% @doc See external documentation. +-spec getPageText(This, N) -> string() when + This::wxChoicebook(), N::integer(). getPageText(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_GetPageText, <>). -%% @spec (This::wxChoicebook()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxChoicebook(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_GetSelection, <>). -%% @spec (This::wxChoicebook(), Pt::{X::integer(), Y::integer()}) -> {integer(), Flags::integer()} %% @doc See external documentation. +-spec hitTest(This, Pt) -> Result when + Result ::{Res ::integer(), Flags::integer()}, + This::wxChoicebook(), Pt::{X::integer(), Y::integer()}. hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_HitTest, <>). -%% @spec (This::wxChoicebook(), N::integer(), Page::wxWindow:wxWindow(), Text::string()) -> bool() %% @equiv insertPage(This,N,Page,Text, []) +-spec insertPage(This, N, Page, Text) -> boolean() when + This::wxChoicebook(), N::integer(), Page::wxWindow:wxWindow(), Text::string(). + insertPage(This,N,Page,Text) when is_record(This, wx_ref),is_integer(N),is_record(Page, wx_ref),is_list(Text) -> insertPage(This,N,Page,Text, []). -%% @spec (This::wxChoicebook(), N::integer(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool() -%% Option = {bSelect, bool()} | {imageId, integer()} %% @doc See external documentation. +-spec insertPage(This, N, Page, Text, [Option]) -> boolean() when + This::wxChoicebook(), N::integer(), Page::wxWindow:wxWindow(), Text::string(), + Option :: {bSelect, boolean()} + | {imageId, integer()}. insertPage(#wx_ref{type=ThisT,ref=ThisRef},N,#wx_ref{type=PageT,ref=PageRef},Text, Options) when is_integer(N),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxChoicebook), @@ -278,32 +314,36 @@ insertPage(#wx_ref{type=ThisT,ref=ThisRef},N,#wx_ref{type=PageT,ref=PageRef},Tex wxe_util:call(?wxChoicebook_InsertPage, <>). -%% @spec (This::wxChoicebook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec setImageList(This, ImageList) -> ok when + This::wxChoicebook(), ImageList::wxImageList:wxImageList(). setImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxChoicebook), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxChoicebook_SetImageList, <>). -%% @spec (This::wxChoicebook(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setPageSize(This, Size) -> ok when + This::wxChoicebook(), Size::{W::integer(), H::integer()}. setPageSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxChoicebook), wxe_util:cast(?wxChoicebook_SetPageSize, <>). -%% @spec (This::wxChoicebook(), N::integer(), ImageId::integer()) -> bool() %% @doc See external documentation. +-spec setPageImage(This, N, ImageId) -> boolean() when + This::wxChoicebook(), N::integer(), ImageId::integer(). setPageImage(#wx_ref{type=ThisT,ref=ThisRef},N,ImageId) when is_integer(N),is_integer(ImageId) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_SetPageImage, <>). -%% @spec (This::wxChoicebook(), N::integer(), StrText::string()) -> bool() %% @doc See external documentation. +-spec setPageText(This, N, StrText) -> boolean() when + This::wxChoicebook(), N::integer(), StrText::string(). setPageText(#wx_ref{type=ThisT,ref=ThisRef},N,StrText) when is_integer(N),is_list(StrText) -> ?CLASS(ThisT,wxChoicebook), @@ -311,24 +351,26 @@ setPageText(#wx_ref{type=ThisT,ref=ThisRef},N,StrText) wxe_util:call(?wxChoicebook_SetPageText, <>). -%% @spec (This::wxChoicebook(), N::integer()) -> integer() %% @doc See external documentation. +-spec setSelection(This, N) -> integer() when + This::wxChoicebook(), N::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_SetSelection, <>). -%% @spec (This::wxChoicebook(), N::integer()) -> integer() %% @doc See external documentation. +-spec changeSelection(This, N) -> integer() when + This::wxChoicebook(), N::integer(). changeSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxChoicebook), wxe_util:call(?wxChoicebook_ChangeSelection, <>). -%% @spec (This::wxChoicebook()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxChoicebook) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxChoicebook), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxClientDC.erl b/lib/wx/src/gen/wxClientDC.erl index c966fb50cc..bdd344ca85 100644 --- a/lib/wx/src/gen/wxClientDC.erl +++ b/lib/wx/src/gen/wxClientDC.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 @@ -53,26 +53,29 @@ setPen/2,setTextBackground/2,setTextForeground/2,setUserScale/3,startDoc/2, startPage/1]). +-export_type([wxClientDC/0]). %% @hidden parent_class(wxWindowDC) -> true; parent_class(wxDC) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxClientDC() +-type wxClientDC() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxClientDC(). new() -> wxe_util:construct(?wxClientDC_new_0, <<>>). -%% @spec (Win::wxWindow:wxWindow()) -> wxClientDC() %% @doc See external documentation. +-spec new(Win) -> wxClientDC() when + Win::wxWindow:wxWindow(). new(#wx_ref{type=WinT,ref=WinRef}) -> ?CLASS(WinT,wxWindow), wxe_util:construct(?wxClientDC_new_1, <>). -%% @spec (This::wxClientDC()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxClientDC) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxClientDC), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxClipboard.erl b/lib/wx/src/gen/wxClipboard.erl index 7ae27b3133..73f57c681e 100644 --- a/lib/wx/src/gen/wxClipboard.erl +++ b/lib/wx/src/gen/wxClipboard.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 @@ -30,83 +30,96 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxClipboard/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxClipboard() +-type wxClipboard() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxClipboard(). new() -> wxe_util:construct(?wxClipboard_new, <<>>). -%% @spec (This::wxClipboard(), Data::wxDataObject:wxDataObject()) -> bool() %% @doc See external documentation. +-spec addData(This, Data) -> boolean() when + This::wxClipboard(), Data::wxDataObject:wxDataObject(). addData(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(ThisT,wxClipboard), ?CLASS(DataT,wxDataObject), wxe_util:call(?wxClipboard_AddData, <>). -%% @spec (This::wxClipboard()) -> ok %% @doc See external documentation. +-spec clear(This) -> ok when + This::wxClipboard(). clear(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxClipboard), wxe_util:cast(?wxClipboard_Clear, <>). -%% @spec (This::wxClipboard()) -> ok %% @doc See external documentation. +-spec close(This) -> ok when + This::wxClipboard(). close(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxClipboard), wxe_util:cast(?wxClipboard_Close, <>). -%% @spec (This::wxClipboard()) -> bool() %% @doc See external documentation. +-spec flush(This) -> boolean() when + This::wxClipboard(). flush(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxClipboard), wxe_util:call(?wxClipboard_Flush, <>). -%% @spec (This::wxClipboard(), Data::wxDataObject:wxDataObject()) -> bool() %% @doc See external documentation. +-spec getData(This, Data) -> boolean() when + This::wxClipboard(), Data::wxDataObject:wxDataObject(). getData(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(ThisT,wxClipboard), ?CLASS(DataT,wxDataObject), wxe_util:call(?wxClipboard_GetData, <>). -%% @spec (This::wxClipboard()) -> bool() %% @doc See external documentation. +-spec isOpened(This) -> boolean() when + This::wxClipboard(). isOpened(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxClipboard), wxe_util:call(?wxClipboard_IsOpened, <>). -%% @spec (This::wxClipboard()) -> bool() %% @doc See external documentation. +-spec open(This) -> boolean() when + This::wxClipboard(). open(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxClipboard), wxe_util:call(?wxClipboard_Open, <>). -%% @spec (This::wxClipboard(), Data::wxDataObject:wxDataObject()) -> bool() %% @doc See external documentation. +-spec setData(This, Data) -> boolean() when + This::wxClipboard(), Data::wxDataObject:wxDataObject(). setData(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(ThisT,wxClipboard), ?CLASS(DataT,wxDataObject), wxe_util:call(?wxClipboard_SetData, <>). -%% @spec (This::wxClipboard()) -> ok %% @equiv usePrimarySelection(This, []) +-spec usePrimarySelection(This) -> ok when + This::wxClipboard(). + usePrimarySelection(This) when is_record(This, wx_ref) -> usePrimarySelection(This, []). -%% @spec (This::wxClipboard(), [Option]) -> ok -%% Option = {primary, bool()} %% @doc See external documentation. +-spec usePrimarySelection(This, [Option]) -> ok when + This::wxClipboard(), + Option :: {primary, boolean()}. usePrimarySelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxClipboard), @@ -116,22 +129,23 @@ usePrimarySelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxClipboard_UsePrimarySelection, <>). -%% @spec (This::wxClipboard(), Format::integer()) -> bool() %% @doc See external documentation. +-spec isSupported(This, Format) -> boolean() when + This::wxClipboard(), Format::integer(). isSupported(#wx_ref{type=ThisT,ref=ThisRef},Format) when is_integer(Format) -> ?CLASS(ThisT,wxClipboard), wxe_util:call(?wxClipboard_IsSupported, <>). -%% @spec () -> wxClipboard() %% @doc See external documentation. +-spec get() -> wxClipboard(). get() -> wxe_util:call(?wxClipboard_Get, <<>>). -%% @spec (This::wxClipboard()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxClipboard) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxClipboard), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxCloseEvent.erl b/lib/wx/src/gen/wxCloseEvent.erl index 706d7701de..4a682c906e 100644 --- a/lib/wx/src/gen/wxCloseEvent.erl +++ b/lib/wx/src/gen/wxCloseEvent.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 @@ -37,49 +37,58 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxCloseEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxCloseEvent()) -> bool() +-type wxCloseEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec canVeto(This) -> boolean() when + This::wxCloseEvent(). canVeto(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCloseEvent), wxe_util:call(?wxCloseEvent_CanVeto, <>). -%% @spec (This::wxCloseEvent()) -> bool() %% @doc See external documentation. +-spec getLoggingOff(This) -> boolean() when + This::wxCloseEvent(). getLoggingOff(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCloseEvent), wxe_util:call(?wxCloseEvent_GetLoggingOff, <>). -%% @spec (This::wxCloseEvent(), CanVeto::bool()) -> ok %% @doc See external documentation. +-spec setCanVeto(This, CanVeto) -> ok when + This::wxCloseEvent(), CanVeto::boolean(). setCanVeto(#wx_ref{type=ThisT,ref=ThisRef},CanVeto) when is_boolean(CanVeto) -> ?CLASS(ThisT,wxCloseEvent), wxe_util:cast(?wxCloseEvent_SetCanVeto, <>). -%% @spec (This::wxCloseEvent(), LogOff::bool()) -> ok %% @doc See external documentation. +-spec setLoggingOff(This, LogOff) -> ok when + This::wxCloseEvent(), LogOff::boolean(). setLoggingOff(#wx_ref{type=ThisT,ref=ThisRef},LogOff) when is_boolean(LogOff) -> ?CLASS(ThisT,wxCloseEvent), wxe_util:cast(?wxCloseEvent_SetLoggingOff, <>). -%% @spec (This::wxCloseEvent()) -> ok %% @equiv veto(This, []) +-spec veto(This) -> ok when + This::wxCloseEvent(). + veto(This) when is_record(This, wx_ref) -> veto(This, []). -%% @spec (This::wxCloseEvent(), [Option]) -> ok -%% Option = {veto, bool()} %% @doc See external documentation. +-spec veto(This, [Option]) -> ok when + This::wxCloseEvent(), + Option :: {veto, boolean()}. veto(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxCloseEvent), diff --git a/lib/wx/src/gen/wxColourData.erl b/lib/wx/src/gen/wxColourData.erl index dc77ea043c..01b73a59f0 100644 --- a/lib/wx/src/gen/wxColourData.erl +++ b/lib/wx/src/gen/wxColourData.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 @@ -30,70 +30,79 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxColourData/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxColourData() +-type wxColourData() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxColourData(). new() -> wxe_util:construct(?wxColourData_new_0, <<>>). -%% @spec (Data::wxColourData()) -> wxColourData() %% @doc See external documentation. +-spec new(Data) -> wxColourData() when + Data::wxColourData(). new(#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(DataT,wxColourData), wxe_util:construct(?wxColourData_new_1, <>). -%% @spec (This::wxColourData()) -> bool() %% @doc See external documentation. +-spec getChooseFull(This) -> boolean() when + This::wxColourData(). getChooseFull(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxColourData), wxe_util:call(?wxColourData_GetChooseFull, <>). -%% @spec (This::wxColourData()) -> wx:colour() %% @doc See external documentation. +-spec getColour(This) -> wx:wx_colour() when + This::wxColourData(). getColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxColourData), wxe_util:call(?wxColourData_GetColour, <>). -%% @spec (This::wxColourData(), I::integer()) -> wx:colour() %% @doc See external documentation. +-spec getCustomColour(This, I) -> wx:wx_colour() when + This::wxColourData(), I::integer(). getCustomColour(#wx_ref{type=ThisT,ref=ThisRef},I) when is_integer(I) -> ?CLASS(ThisT,wxColourData), wxe_util:call(?wxColourData_GetCustomColour, <>). -%% @spec (This::wxColourData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec setChooseFull(This, Flag) -> ok when + This::wxColourData(), Flag::boolean(). setChooseFull(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxColourData), wxe_util:cast(?wxColourData_SetChooseFull, <>). -%% @spec (This::wxColourData(), Colour::wx:colour()) -> ok %% @doc See external documentation. +-spec setColour(This, Colour) -> ok when + This::wxColourData(), Colour::wx:wx_colour(). setColour(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxColourData), wxe_util:cast(?wxColourData_SetColour, <>). -%% @spec (This::wxColourData(), I::integer(), Colour::wx:colour()) -> ok %% @doc See external documentation. +-spec setCustomColour(This, I, Colour) -> ok when + This::wxColourData(), I::integer(), Colour::wx:wx_colour(). setCustomColour(#wx_ref{type=ThisT,ref=ThisRef},I,Colour) when is_integer(I),tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxColourData), wxe_util:cast(?wxColourData_SetCustomColour, <>). -%% @spec (This::wxColourData()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxColourData) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxColourData), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxColourDialog.erl b/lib/wx/src/gen/wxColourDialog.erl index f5677d00ff..7e9ec1975f 100644 --- a/lib/wx/src/gen/wxColourDialog.erl +++ b/lib/wx/src/gen/wxColourDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxColourDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,21 +85,25 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxColourDialog() +-type wxColourDialog() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxColourDialog(). new() -> wxe_util:construct(?wxColourDialog_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxColourDialog() %% @equiv new(Parent, []) +-spec new(Parent) -> wxColourDialog() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxColourDialog() -%% Option = {data, wxColourData:wxColourData()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxColourDialog() when + Parent::wxWindow:wxWindow(), + Option :: {data, wxColourData:wxColourData()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -108,15 +113,18 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxColourDialog_new_2, <>). -%% @spec (This::wxColourDialog(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxColourDialog(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxColourDialog(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {data, wxColourData:wxColourData()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxColourDialog(), Parent::wxWindow:wxWindow(), + Option :: {data, wxColourData:wxColourData()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxColourDialog), @@ -127,15 +135,16 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxColourDialog_Create, <>). -%% @spec (This::wxColourDialog()) -> wxColourData:wxColourData() %% @doc See external documentation. +-spec getColourData(This) -> wxColourData:wxColourData() when + This::wxColourDialog(). getColourData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxColourDialog), wxe_util:call(?wxColourDialog_GetColourData, <>). -%% @spec (This::wxColourDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxColourDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxColourDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxColourPickerCtrl.erl b/lib/wx/src/gen/wxColourPickerCtrl.erl index 60776925b9..91889006f9 100644 --- a/lib/wx/src/gen/wxColourPickerCtrl.erl +++ b/lib/wx/src/gen/wxColourPickerCtrl.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,6 +74,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxColourPickerCtrl/0]). %% @hidden parent_class(wxPickerBase) -> true; parent_class(wxControl) -> true; @@ -81,21 +82,29 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxColourPickerCtrl() +-type wxColourPickerCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxColourPickerCtrl(). new() -> wxe_util:construct(?wxColourPickerCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxColourPickerCtrl() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxColourPickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxColourPickerCtrl() -%% Option = {col, wx:colour()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxColourPickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {col, wx:wx_colour()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -109,15 +118,22 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxColourPickerCtrl_new_3, <>). -%% @spec (This::wxColourPickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxColourPickerCtrl(), 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::wxColourPickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {col, wx:colour()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxColourPickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {col, wx:wx_colour()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxColourPickerCtrl), @@ -132,22 +148,19 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxColourPickerCtrl_Create, <>). -%% @spec (This::wxColourPickerCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getColour(This) -> wx:wx_colour() when + This::wxColourPickerCtrl(). getColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxColourPickerCtrl), wxe_util:call(?wxColourPickerCtrl_GetColour, <>). -%% @spec (This::wxColourPickerCtrl(),X::string()|term()) -> bool()|ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setColour(This::wxColourPickerCtrl(), Text::string()) -> bool() -%%

-%%

-%% setColour(This::wxColourPickerCtrl(), Col::wx:colour()) -> ok -%%

+-spec setColour(This, Text) -> boolean() when + This::wxColourPickerCtrl(), Text::string(); + (This, Col) -> ok when + This::wxColourPickerCtrl(), Col::wx:wx_colour(). setColour(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxColourPickerCtrl), @@ -160,8 +173,8 @@ setColour(#wx_ref{type=ThisT,ref=ThisRef},Col) wxe_util:cast(?wxColourPickerCtrl_SetColour_1_1, <>). -%% @spec (This::wxColourPickerCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxColourPickerCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxColourPickerCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxColourPickerEvent.erl b/lib/wx/src/gen/wxColourPickerEvent.erl index 9ba431b841..fbd34cf9e7 100644 --- a/lib/wx/src/gen/wxColourPickerEvent.erl +++ b/lib/wx/src/gen/wxColourPickerEvent.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,13 +40,16 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxColourPickerEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxColourPickerEvent()) -> wx:colour() +-type wxColourPickerEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getColour(This) -> wx:wx_colour() when + This::wxColourPickerEvent(). getColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxColourPickerEvent), wxe_util:call(?wxColourPickerEvent_GetColour, diff --git a/lib/wx/src/gen/wxComboBox.erl b/lib/wx/src/gen/wxComboBox.erl index f743df4e93..88cee2e3a4 100644 --- a/lib/wx/src/gen/wxComboBox.erl +++ b/lib/wx/src/gen/wxComboBox.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 @@ -76,6 +76,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxComboBox/0]). %% @hidden parent_class(wxControlWithItems) -> true; parent_class(wxControl) -> true; @@ -83,21 +84,30 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxComboBox() +-type wxComboBox() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxComboBox(). new() -> wxe_util:construct(?wxComboBox_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxComboBox() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxComboBox() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxComboBox() -%% Option = {value, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {choices, [[string()]]} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxComboBox() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {value, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {choices, [[string()]]} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -112,15 +122,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxComboBox_new_3, <>). -%% @spec (This::wxComboBox(), Parent::wxWindow:wxWindow(), Id::integer(), Value::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]) -> bool() %% @equiv create(This,Parent,Id,Value,Pos,Size,Choices, []) +-spec create(This, Parent, Id, Value, Pos, Size, Choices) -> boolean() when + This::wxComboBox(), Parent::wxWindow:wxWindow(), Id::integer(), Value::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]. + create(This,Parent,Id,Value,Pos={PosX,PosY},Size={SizeW,SizeH},Choices) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Value),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices) -> create(This,Parent,Id,Value,Pos,Size,Choices, []). -%% @spec (This::wxComboBox(), Parent::wxWindow:wxWindow(), Id::integer(), Value::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], [Option]) -> bool() -%% Option = {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Value, Pos, Size, Choices, [Option]) -> boolean() when + This::wxComboBox(), Parent::wxWindow:wxWindow(), Id::integer(), Value::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], + Option :: {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Value,{PosX,PosY},{SizeW,SizeH},Choices, Options) when is_integer(Id),is_list(Value),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices),is_list(Options) -> ?CLASS(ThisT,wxComboBox), @@ -135,92 +149,105 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Va wxe_util:call(?wxComboBox_Create, <>|| UC_Str <- Choices_UCA>>)/binary, 0:(((8- ((4 + lists:sum([byte_size(S)+4||S<-Choices_UCA])) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxComboBox()) -> bool() %% @doc See external documentation. +-spec canCopy(This) -> boolean() when + This::wxComboBox(). canCopy(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:call(?wxComboBox_CanCopy, <>). -%% @spec (This::wxComboBox()) -> bool() %% @doc See external documentation. +-spec canCut(This) -> boolean() when + This::wxComboBox(). canCut(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:call(?wxComboBox_CanCut, <>). -%% @spec (This::wxComboBox()) -> bool() %% @doc See external documentation. +-spec canPaste(This) -> boolean() when + This::wxComboBox(). canPaste(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:call(?wxComboBox_CanPaste, <>). -%% @spec (This::wxComboBox()) -> bool() %% @doc See external documentation. +-spec canRedo(This) -> boolean() when + This::wxComboBox(). canRedo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:call(?wxComboBox_CanRedo, <>). -%% @spec (This::wxComboBox()) -> bool() %% @doc See external documentation. +-spec canUndo(This) -> boolean() when + This::wxComboBox(). canUndo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:call(?wxComboBox_CanUndo, <>). -%% @spec (This::wxComboBox()) -> ok %% @doc See external documentation. +-spec copy(This) -> ok when + This::wxComboBox(). copy(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_Copy, <>). -%% @spec (This::wxComboBox()) -> ok %% @doc See external documentation. +-spec cut(This) -> ok when + This::wxComboBox(). cut(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_Cut, <>). -%% @spec (This::wxComboBox()) -> integer() %% @doc See external documentation. +-spec getInsertionPoint(This) -> integer() when + This::wxComboBox(). getInsertionPoint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:call(?wxComboBox_GetInsertionPoint, <>). -%% @spec (This::wxComboBox()) -> integer() %% @doc See external documentation. +-spec getLastPosition(This) -> integer() when + This::wxComboBox(). getLastPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:call(?wxComboBox_GetLastPosition, <>). -%% @spec (This::wxComboBox()) -> string() %% @doc See external documentation. +-spec getValue(This) -> string() when + This::wxComboBox(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:call(?wxComboBox_GetValue, <>). -%% @spec (This::wxComboBox()) -> ok %% @doc See external documentation. +-spec paste(This) -> ok when + This::wxComboBox(). paste(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_Paste, <>). -%% @spec (This::wxComboBox()) -> ok %% @doc See external documentation. +-spec redo(This) -> ok when + This::wxComboBox(). redo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_Redo, <>). -%% @spec (This::wxComboBox(), From::integer(), To::integer(), Value::string()) -> ok %% @doc See external documentation. +-spec replace(This, From, To, Value) -> ok when + This::wxComboBox(), From::integer(), To::integer(), Value::string(). replace(#wx_ref{type=ThisT,ref=ThisRef},From,To,Value) when is_integer(From),is_integer(To),is_list(Value) -> ?CLASS(ThisT,wxComboBox), @@ -228,47 +255,53 @@ replace(#wx_ref{type=ThisT,ref=ThisRef},From,To,Value) wxe_util:cast(?wxComboBox_Replace, <>). -%% @spec (This::wxComboBox(), From::integer(), To::integer()) -> ok %% @doc See external documentation. +-spec remove(This, From, To) -> ok when + This::wxComboBox(), From::integer(), To::integer(). remove(#wx_ref{type=ThisT,ref=ThisRef},From,To) when is_integer(From),is_integer(To) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_Remove, <>). -%% @spec (This::wxComboBox(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setInsertionPoint(This, Pos) -> ok when + This::wxComboBox(), Pos::integer(). setInsertionPoint(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_SetInsertionPoint, <>). -%% @spec (This::wxComboBox()) -> ok %% @doc See external documentation. +-spec setInsertionPointEnd(This) -> ok when + This::wxComboBox(). setInsertionPointEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_SetInsertionPointEnd, <>). -%% @spec (This::wxComboBox(), N::integer()) -> ok %% @doc See external documentation. +-spec setSelection(This, N) -> ok when + This::wxComboBox(), N::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_SetSelection_1, <>). -%% @spec (This::wxComboBox(), From::integer(), To::integer()) -> ok %% @doc See external documentation. +-spec setSelection(This, From, To) -> ok when + This::wxComboBox(), From::integer(), To::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},From,To) when is_integer(From),is_integer(To) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_SetSelection_2, <>). -%% @spec (This::wxComboBox(), Value::string()) -> ok %% @doc See external documentation. +-spec setValue(This, Value) -> ok when + This::wxComboBox(), Value::string(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Value) when is_list(Value) -> ?CLASS(ThisT,wxComboBox), @@ -276,15 +309,16 @@ setValue(#wx_ref{type=ThisT,ref=ThisRef},Value) wxe_util:cast(?wxComboBox_SetValue, <>). -%% @spec (This::wxComboBox()) -> ok %% @doc See external documentation. +-spec undo(This) -> ok when + This::wxComboBox(). undo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxComboBox), wxe_util:cast(?wxComboBox_Undo, <>). -%% @spec (This::wxComboBox()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxComboBox) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxComboBox), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxCommandEvent.erl b/lib/wx/src/gen/wxCommandEvent.erl index 57fb9cecda..16414da4dd 100644 --- a/lib/wx/src/gen/wxCommandEvent.erl +++ b/lib/wx/src/gen/wxCommandEvent.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 @@ -38,69 +38,80 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxCommandEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxCommandEvent()) -> term() +-type wxCommandEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getClientData(This) -> term() when + This::wxCommandEvent(). getClientData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCommandEvent), wxe_util:call(?wxCommandEvent_getClientData, <>). -%% @spec (This::wxCommandEvent()) -> integer() %% @doc See external documentation. +-spec getExtraLong(This) -> integer() when + This::wxCommandEvent(). getExtraLong(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCommandEvent), wxe_util:call(?wxCommandEvent_GetExtraLong, <>). -%% @spec (This::wxCommandEvent()) -> integer() %% @doc See external documentation. +-spec getInt(This) -> integer() when + This::wxCommandEvent(). getInt(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCommandEvent), wxe_util:call(?wxCommandEvent_GetInt, <>). -%% @spec (This::wxCommandEvent()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxCommandEvent(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCommandEvent), wxe_util:call(?wxCommandEvent_GetSelection, <>). -%% @spec (This::wxCommandEvent()) -> string() %% @doc See external documentation. +-spec getString(This) -> string() when + This::wxCommandEvent(). getString(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCommandEvent), wxe_util:call(?wxCommandEvent_GetString, <>). -%% @spec (This::wxCommandEvent()) -> bool() %% @doc See external documentation. +-spec isChecked(This) -> boolean() when + This::wxCommandEvent(). isChecked(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCommandEvent), wxe_util:call(?wxCommandEvent_IsChecked, <>). -%% @spec (This::wxCommandEvent()) -> bool() %% @doc See external documentation. +-spec isSelection(This) -> boolean() when + This::wxCommandEvent(). isSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCommandEvent), wxe_util:call(?wxCommandEvent_IsSelection, <>). -%% @spec (This::wxCommandEvent(), I::integer()) -> ok %% @doc See external documentation. +-spec setInt(This, I) -> ok when + This::wxCommandEvent(), I::integer(). setInt(#wx_ref{type=ThisT,ref=ThisRef},I) when is_integer(I) -> ?CLASS(ThisT,wxCommandEvent), wxe_util:cast(?wxCommandEvent_SetInt, <>). -%% @spec (This::wxCommandEvent(), S::string()) -> ok %% @doc See external documentation. +-spec setString(This, S) -> ok when + This::wxCommandEvent(), S::string(). setString(#wx_ref{type=ThisT,ref=ThisRef},S) when is_list(S) -> ?CLASS(ThisT,wxCommandEvent), diff --git a/lib/wx/src/gen/wxContextMenuEvent.erl b/lib/wx/src/gen/wxContextMenuEvent.erl index 0050b97b89..9312803e33 100644 --- a/lib/wx/src/gen/wxContextMenuEvent.erl +++ b/lib/wx/src/gen/wxContextMenuEvent.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 @@ -40,20 +40,24 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxContextMenuEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxContextMenuEvent()) -> {X::integer(), Y::integer()} +-type wxContextMenuEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxContextMenuEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxContextMenuEvent), wxe_util:call(?wxContextMenuEvent_GetPosition, <>). -%% @spec (This::wxContextMenuEvent(), Pos::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec setPosition(This, Pos) -> ok when + This::wxContextMenuEvent(), Pos::{X::integer(), Y::integer()}. setPosition(#wx_ref{type=ThisT,ref=ThisRef},{PosX,PosY}) when is_integer(PosX),is_integer(PosY) -> ?CLASS(ThisT,wxContextMenuEvent), diff --git a/lib/wx/src/gen/wxControl.erl b/lib/wx/src/gen/wxControl.erl index e3f602e65a..743ec5151f 100644 --- a/lib/wx/src/gen/wxControl.erl +++ b/lib/wx/src/gen/wxControl.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 @@ -68,20 +68,24 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxControl/0]). %% @hidden parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxControl()) -> string() +-type wxControl() :: wx:wx_object(). %% @doc See external documentation. +-spec getLabel(This) -> string() when + This::wxControl(). getLabel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxControl), wxe_util:call(?wxControl_GetLabel, <>). -%% @spec (This::wxControl(), Label::string()) -> ok %% @doc See external documentation. +-spec setLabel(This, Label) -> ok when + This::wxControl(), Label::string(). setLabel(#wx_ref{type=ThisT,ref=ThisRef},Label) when is_list(Label) -> ?CLASS(ThisT,wxControl), diff --git a/lib/wx/src/gen/wxControlWithItems.erl b/lib/wx/src/gen/wxControlWithItems.erl index 0838b75bad..b57f472b04 100644 --- a/lib/wx/src/gen/wxControlWithItems.erl +++ b/lib/wx/src/gen/wxControlWithItems.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 @@ -72,14 +72,17 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxControlWithItems/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxControlWithItems(), Item::string()) -> integer() +-type wxControlWithItems() :: wx:wx_object(). %% @doc See external documentation. +-spec append(This, Item) -> integer() when + This::wxControlWithItems(), Item::string(). append(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_list(Item) -> ?CLASS(ThisT,wxControlWithItems), @@ -87,8 +90,9 @@ append(#wx_ref{type=ThisT,ref=ThisRef},Item) wxe_util:call(?wxControlWithItems_Append_1, <>). -%% @spec (This::wxControlWithItems(), Item::string(), ClientData::term()) -> integer() %% @doc See external documentation. +-spec append(This, Item, ClientData) -> integer() when + This::wxControlWithItems(), Item::string(), ClientData::term(). append(#wx_ref{type=ThisT,ref=ThisRef},Item,ClientData) when is_list(Item) -> ?CLASS(ThisT,wxControlWithItems), @@ -97,8 +101,9 @@ append(#wx_ref{type=ThisT,ref=ThisRef},Item,ClientData) wxe_util:call(?wxControlWithItems_Append_2, <>). -%% @spec (This::wxControlWithItems(), Strings::[[string()]]) -> ok %% @doc See external documentation. +-spec appendStrings(This, Strings) -> ok when + This::wxControlWithItems(), Strings::[[string()]]. appendStrings(#wx_ref{type=ThisT,ref=ThisRef},Strings) when is_list(Strings) -> ?CLASS(ThisT,wxControlWithItems), @@ -107,30 +112,35 @@ appendStrings(#wx_ref{type=ThisT,ref=ThisRef},Strings) wxe_util:cast(?wxControlWithItems_appendStrings_1, <>|| UC_Str <- Strings_UCA>>)/binary, 0:(((8- ((0 + lists:sum([byte_size(S)+4||S<-Strings_UCA])) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxControlWithItems()) -> ok %% @doc See external documentation. +-spec clear(This) -> ok when + This::wxControlWithItems(). clear(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:cast(?wxControlWithItems_Clear, <>). -%% @spec (This::wxControlWithItems(), N::integer()) -> ok %% @doc See external documentation. +-spec delete(This, N) -> ok when + This::wxControlWithItems(), N::integer(). delete(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:cast(?wxControlWithItems_Delete, <>). -%% @spec (This::wxControlWithItems(), S::string()) -> integer() %% @equiv findString(This,S, []) +-spec findString(This, S) -> integer() when + This::wxControlWithItems(), S::string(). + findString(This,S) when is_record(This, wx_ref),is_list(S) -> findString(This,S, []). -%% @spec (This::wxControlWithItems(), S::string(), [Option]) -> integer() -%% Option = {bCase, bool()} %% @doc See external documentation. +-spec findString(This, S, [Option]) -> integer() when + This::wxControlWithItems(), S::string(), + Option :: {bCase, boolean()}. findString(#wx_ref{type=ThisT,ref=ThisRef},S, Options) when is_list(S),is_list(Options) -> ?CLASS(ThisT,wxControlWithItems), @@ -141,16 +151,18 @@ findString(#wx_ref{type=ThisT,ref=ThisRef},S, Options) wxe_util:call(?wxControlWithItems_FindString, <>). -%% @spec (This::wxControlWithItems(), N::integer()) -> term() %% @doc See external documentation. +-spec getClientData(This, N) -> term() when + This::wxControlWithItems(), N::integer(). getClientData(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:call(?wxControlWithItems_getClientData, <>). -%% @spec (This::wxControlWithItems(), N::integer(), ClientData::term()) -> ok %% @doc See external documentation. +-spec setClientData(This, N, ClientData) -> ok when + This::wxControlWithItems(), N::integer(), ClientData::term(). setClientData(#wx_ref{type=ThisT,ref=ThisRef},N,ClientData) when is_integer(N) -> ?CLASS(ThisT,wxControlWithItems), @@ -158,37 +170,42 @@ setClientData(#wx_ref{type=ThisT,ref=ThisRef},N,ClientData) wxe_util:cast(?wxControlWithItems_setClientData, <>). -%% @spec (This::wxControlWithItems()) -> integer() %% @doc See external documentation. +-spec getCount(This) -> integer() when + This::wxControlWithItems(). getCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:call(?wxControlWithItems_GetCount, <>). -%% @spec (This::wxControlWithItems()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxControlWithItems(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:call(?wxControlWithItems_GetSelection, <>). -%% @spec (This::wxControlWithItems(), N::integer()) -> string() %% @doc See external documentation. +-spec getString(This, N) -> string() when + This::wxControlWithItems(), N::integer(). getString(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:call(?wxControlWithItems_GetString, <>). -%% @spec (This::wxControlWithItems()) -> string() %% @doc See external documentation. +-spec getStringSelection(This) -> string() when + This::wxControlWithItems(). getStringSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:call(?wxControlWithItems_GetStringSelection, <>). -%% @spec (This::wxControlWithItems(), Item::string(), Pos::integer()) -> integer() %% @doc See external documentation. +-spec insert(This, Item, Pos) -> integer() when + This::wxControlWithItems(), Item::string(), Pos::integer(). insert(#wx_ref{type=ThisT,ref=ThisRef},Item,Pos) when is_list(Item),is_integer(Pos) -> ?CLASS(ThisT,wxControlWithItems), @@ -196,8 +213,9 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Item,Pos) wxe_util:call(?wxControlWithItems_Insert_2, <>). -%% @spec (This::wxControlWithItems(), Item::string(), Pos::integer(), ClientData::term()) -> integer() %% @doc See external documentation. +-spec insert(This, Item, Pos, ClientData) -> integer() when + This::wxControlWithItems(), Item::string(), Pos::integer(), ClientData::term(). insert(#wx_ref{type=ThisT,ref=ThisRef},Item,Pos,ClientData) when is_list(Item),is_integer(Pos) -> ?CLASS(ThisT,wxControlWithItems), @@ -206,31 +224,35 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Item,Pos,ClientData) wxe_util:call(?wxControlWithItems_Insert_3, <>). -%% @spec (This::wxControlWithItems()) -> bool() %% @doc See external documentation. +-spec isEmpty(This) -> boolean() when + This::wxControlWithItems(). isEmpty(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:call(?wxControlWithItems_IsEmpty, <>). -%% @spec (This::wxControlWithItems(), N::integer()) -> ok %% @doc See external documentation. +-spec select(This, N) -> ok when + This::wxControlWithItems(), N::integer(). select(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:cast(?wxControlWithItems_Select, <>). -%% @spec (This::wxControlWithItems(), N::integer()) -> ok %% @doc See external documentation. +-spec setSelection(This, N) -> ok when + This::wxControlWithItems(), N::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxControlWithItems), wxe_util:cast(?wxControlWithItems_SetSelection, <>). -%% @spec (This::wxControlWithItems(), N::integer(), S::string()) -> ok %% @doc See external documentation. +-spec setString(This, N, S) -> ok when + This::wxControlWithItems(), N::integer(), S::string(). setString(#wx_ref{type=ThisT,ref=ThisRef},N,S) when is_integer(N),is_list(S) -> ?CLASS(ThisT,wxControlWithItems), @@ -238,8 +260,9 @@ setString(#wx_ref{type=ThisT,ref=ThisRef},N,S) wxe_util:cast(?wxControlWithItems_SetString, <>). -%% @spec (This::wxControlWithItems(), S::string()) -> bool() %% @doc See external documentation. +-spec setStringSelection(This, S) -> boolean() when + This::wxControlWithItems(), S::string(). setStringSelection(#wx_ref{type=ThisT,ref=ThisRef},S) when is_list(S) -> ?CLASS(ThisT,wxControlWithItems), diff --git a/lib/wx/src/gen/wxCursor.erl b/lib/wx/src/gen/wxCursor.erl index beb731fee3..3274e16454 100644 --- a/lib/wx/src/gen/wxCursor.erl +++ b/lib/wx/src/gen/wxCursor.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 @@ -34,25 +34,23 @@ getSubBitmap/2,getWidth/1,loadFile/2,loadFile/3,parent_class/1,saveFile/3, saveFile/4,setDepth/2,setHeight/2,setMask/2,setPalette/2,setWidth/2]). +-export_type([wxCursor/0]). %% @hidden parent_class(wxBitmap) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxCursor() +-type wxCursor() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxCursor(). new() -> wxe_util:construct(?wxCursor_new_0, <<>>). -%% @spec (X::integer()|term()) -> wxCursor() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(CursorId::integer()) -> wxCursor() -%%

-%%

-%% new(Image::wxImage:wxImage()) -> wxCursor() -%%

+-spec new(CursorId) -> wxCursor() when + CursorId::integer(); + (Image) -> wxCursor() when + Image::wxImage:wxImage(). new(CursorId) when is_integer(CursorId) -> wxe_util:construct(?wxCursor_new_1_0, @@ -62,15 +60,19 @@ new(#wx_ref{type=ImageT,ref=ImageRef}) -> wxe_util:construct(?wxCursor_new_1_1, <>). -%% @spec (Bits::binary(), Width::integer(), Height::integer()) -> wxCursor() %% @equiv new(Bits,Width,Height, []) +-spec new(Bits, Width, Height) -> wxCursor() when + Bits::binary(), Width::integer(), Height::integer(). + new(Bits,Width,Height) when is_binary(Bits),is_integer(Width),is_integer(Height) -> new(Bits,Width,Height, []). -%% @spec (Bits::binary(), Width::integer(), Height::integer(), [Option]) -> wxCursor() -%% Option = {hotSpotX, integer()} | {hotSpotY, integer()} %% @doc See external documentation. +-spec new(Bits, Width, Height, [Option]) -> wxCursor() when + Bits::binary(), Width::integer(), Height::integer(), + Option :: {hotSpotX, integer()} + | {hotSpotY, integer()}. new(Bits,Width,Height, Options) when is_binary(Bits),is_integer(Width),is_integer(Height),is_list(Options) -> wxe_util:send_bin(Bits), @@ -81,15 +83,16 @@ new(Bits,Width,Height, Options) wxe_util:construct(?wxCursor_new_4, <>). -%% @spec (This::wxCursor()) -> bool() %% @doc See external documentation. +-spec ok(This) -> boolean() when + This::wxCursor(). ok(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxCursor), wxe_util:call(?wxCursor_Ok, <>). -%% @spec (This::wxCursor()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxCursor) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxCursor), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxDC.erl b/lib/wx/src/gen/wxDC.erl index ba498c651a..25b452ed61 100644 --- a/lib/wx/src/gen/wxDC.erl +++ b/lib/wx/src/gen/wxDC.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 @@ -49,18 +49,25 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxDC/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxDC(), DestPt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Source::wxDC(), SrcPt::{X::integer(), Y::integer()}) -> bool() +-type wxDC() :: wx:wx_object(). %% @equiv blit(This,DestPt,Sz,Source,SrcPt, []) +-spec blit(This, DestPt, Sz, Source, SrcPt) -> boolean() when + This::wxDC(), DestPt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Source::wxDC(), SrcPt::{X::integer(), Y::integer()}. + blit(This,DestPt={DestPtX,DestPtY},Sz={SzW,SzH},Source,SrcPt={SrcPtX,SrcPtY}) when is_record(This, wx_ref),is_integer(DestPtX),is_integer(DestPtY),is_integer(SzW),is_integer(SzH),is_record(Source, wx_ref),is_integer(SrcPtX),is_integer(SrcPtY) -> blit(This,DestPt,Sz,Source,SrcPt, []). -%% @spec (This::wxDC(), DestPt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Source::wxDC(), SrcPt::{X::integer(), Y::integer()}, [Option]) -> bool() -%% Option = {rop, integer()} | {useMask, bool()} | {srcPtMask, {X::integer(), Y::integer()}} %% @doc See external documentation. +-spec blit(This, DestPt, Sz, Source, SrcPt, [Option]) -> boolean() when + This::wxDC(), DestPt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Source::wxDC(), SrcPt::{X::integer(), Y::integer()}, + Option :: {rop, integer()} + | {useMask, boolean()} + | {srcPtMask, {X::integer(), Y::integer()}}. blit(#wx_ref{type=ThisT,ref=ThisRef},{DestPtX,DestPtY},{SzW,SzH},#wx_ref{type=SourceT,ref=SourceRef},{SrcPtX,SrcPtY}, Options) when is_integer(DestPtX),is_integer(DestPtY),is_integer(SzW),is_integer(SzH),is_integer(SrcPtX),is_integer(SrcPtY),is_list(Options) -> ?CLASS(ThisT,wxDC), @@ -73,92 +80,105 @@ blit(#wx_ref{type=ThisT,ref=ThisRef},{DestPtX,DestPtY},{SzW,SzH},#wx_ref{type=So wxe_util:call(?wxDC_Blit, <>). -%% @spec (This::wxDC(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec calcBoundingBox(This, X, Y) -> ok when + This::wxDC(), X::integer(), Y::integer(). calcBoundingBox(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_CalcBoundingBox, <>). -%% @spec (This::wxDC()) -> ok %% @doc See external documentation. +-spec clear(This) -> ok when + This::wxDC(). clear(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_Clear, <>). -%% @spec (This::wxDC()) -> ok %% @doc See external documentation. +-spec computeScaleAndOrigin(This) -> ok when + This::wxDC(). computeScaleAndOrigin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_ComputeScaleAndOrigin, <>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec crossHair(This, Pt) -> ok when + This::wxDC(), Pt::{X::integer(), Y::integer()}. crossHair(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_CrossHair, <>). -%% @spec (This::wxDC()) -> ok %% @doc See external documentation. +-spec destroyClippingRegion(This) -> ok when + This::wxDC(). destroyClippingRegion(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DestroyClippingRegion, <>). -%% @spec (This::wxDC(), X::integer()) -> integer() %% @doc See external documentation. +-spec deviceToLogicalX(This, X) -> integer() when + This::wxDC(), X::integer(). deviceToLogicalX(#wx_ref{type=ThisT,ref=ThisRef},X) when is_integer(X) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_DeviceToLogicalX, <>). -%% @spec (This::wxDC(), X::integer()) -> integer() %% @doc See external documentation. +-spec deviceToLogicalXRel(This, X) -> integer() when + This::wxDC(), X::integer(). deviceToLogicalXRel(#wx_ref{type=ThisT,ref=ThisRef},X) when is_integer(X) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_DeviceToLogicalXRel, <>). -%% @spec (This::wxDC(), Y::integer()) -> integer() %% @doc See external documentation. +-spec deviceToLogicalY(This, Y) -> integer() when + This::wxDC(), Y::integer(). deviceToLogicalY(#wx_ref{type=ThisT,ref=ThisRef},Y) when is_integer(Y) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_DeviceToLogicalY, <>). -%% @spec (This::wxDC(), Y::integer()) -> integer() %% @doc See external documentation. +-spec deviceToLogicalYRel(This, Y) -> integer() when + This::wxDC(), Y::integer(). deviceToLogicalYRel(#wx_ref{type=ThisT,ref=ThisRef},Y) when is_integer(Y) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_DeviceToLogicalYRel, <>). -%% @spec (This::wxDC(), Pt1::{X::integer(), Y::integer()}, Pt2::{X::integer(), Y::integer()}, Centre::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec drawArc(This, Pt1, Pt2, Centre) -> ok when + This::wxDC(), Pt1::{X::integer(), Y::integer()}, Pt2::{X::integer(), Y::integer()}, Centre::{X::integer(), Y::integer()}. drawArc(#wx_ref{type=ThisT,ref=ThisRef},{Pt1X,Pt1Y},{Pt2X,Pt2Y},{CentreX,CentreY}) when is_integer(Pt1X),is_integer(Pt1Y),is_integer(Pt2X),is_integer(Pt2Y),is_integer(CentreX),is_integer(CentreY) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawArc, <>). -%% @spec (This::wxDC(), Bmp::wxBitmap:wxBitmap(), Pt::{X::integer(), Y::integer()}) -> ok %% @equiv drawBitmap(This,Bmp,Pt, []) +-spec drawBitmap(This, Bmp, Pt) -> ok when + This::wxDC(), Bmp::wxBitmap:wxBitmap(), Pt::{X::integer(), Y::integer()}. + drawBitmap(This,Bmp,Pt={PtX,PtY}) when is_record(This, wx_ref),is_record(Bmp, wx_ref),is_integer(PtX),is_integer(PtY) -> drawBitmap(This,Bmp,Pt, []). -%% @spec (This::wxDC(), Bmp::wxBitmap:wxBitmap(), Pt::{X::integer(), Y::integer()}, [Option]) -> ok -%% Option = {useMask, bool()} %% @doc See external documentation. +-spec drawBitmap(This, Bmp, Pt, [Option]) -> ok when + This::wxDC(), Bmp::wxBitmap:wxBitmap(), Pt::{X::integer(), Y::integer()}, + Option :: {useMask, boolean()}. drawBitmap(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef},{PtX,PtY}, Options) when is_integer(PtX),is_integer(PtY),is_list(Options) -> ?CLASS(ThisT,wxDC), @@ -169,48 +189,54 @@ drawBitmap(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef},{PtX,Pt wxe_util:cast(?wxDC_DrawBitmap, <>). -%% @spec (This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec drawCheckMark(This, Rect) -> ok when + This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. drawCheckMark(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawCheckMark, <>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}, Radius::integer()) -> ok %% @doc See external documentation. +-spec drawCircle(This, Pt, Radius) -> ok when + This::wxDC(), Pt::{X::integer(), Y::integer()}, Radius::integer(). drawCircle(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},Radius) when is_integer(PtX),is_integer(PtY),is_integer(Radius) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawCircle, <>). -%% @spec (This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec drawEllipse(This, Rect) -> ok when + This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. drawEllipse(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawEllipse_1, <>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec drawEllipse(This, Pt, Sz) -> ok when + This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}. drawEllipse(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH}) when is_integer(PtX),is_integer(PtY),is_integer(SzW),is_integer(SzH) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawEllipse_2, <>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Sa::float(), Ea::float()) -> ok %% @doc See external documentation. +-spec drawEllipticArc(This, Pt, Sz, Sa, Ea) -> ok when + This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Sa::float(), Ea::float(). drawEllipticArc(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH},Sa,Ea) when is_integer(PtX),is_integer(PtY),is_integer(SzW),is_integer(SzH),is_float(Sa),is_float(Ea) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawEllipticArc, <>). -%% @spec (This::wxDC(), Icon::wxIcon:wxIcon(), Pt::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec drawIcon(This, Icon, Pt) -> ok when + This::wxDC(), Icon::wxIcon:wxIcon(), Pt::{X::integer(), Y::integer()}. drawIcon(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconT,ref=IconRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxDC), @@ -218,15 +244,19 @@ drawIcon(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconT,ref=IconRef},{PtX,Pt wxe_util:cast(?wxDC_DrawIcon, <>). -%% @spec (This::wxDC(), Text::string(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok %% @equiv drawLabel(This,Text,Rect, []) +-spec drawLabel(This, Text, Rect) -> ok when + This::wxDC(), Text::string(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. + drawLabel(This,Text,Rect={RectX,RectY,RectW,RectH}) when is_record(This, wx_ref),is_list(Text),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> drawLabel(This,Text,Rect, []). -%% @spec (This::wxDC(), Text::string(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, [Option]) -> ok -%% Option = {alignment, integer()} | {indexAccel, integer()} %% @doc See external documentation. +-spec drawLabel(This, Text, Rect, [Option]) -> ok when + This::wxDC(), Text::string(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, + Option :: {alignment, integer()} + | {indexAccel, integer()}. drawLabel(#wx_ref{type=ThisT,ref=ThisRef},Text,{RectX,RectY,RectW,RectH}, Options) when is_list(Text),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),is_list(Options) -> ?CLASS(ThisT,wxDC), @@ -238,23 +268,28 @@ drawLabel(#wx_ref{type=ThisT,ref=ThisRef},Text,{RectX,RectY,RectW,RectH}, Option wxe_util:cast(?wxDC_DrawLabel, <>). -%% @spec (This::wxDC(), Pt1::{X::integer(), Y::integer()}, Pt2::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec drawLine(This, Pt1, Pt2) -> ok when + This::wxDC(), Pt1::{X::integer(), Y::integer()}, Pt2::{X::integer(), Y::integer()}. drawLine(#wx_ref{type=ThisT,ref=ThisRef},{Pt1X,Pt1Y},{Pt2X,Pt2Y}) when is_integer(Pt1X),is_integer(Pt1Y),is_integer(Pt2X),is_integer(Pt2Y) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawLine, <>). -%% @spec (This::wxDC(), Points::[{X::integer(), Y::integer()}]) -> ok %% @equiv drawLines(This,Points, []) +-spec drawLines(This, Points) -> ok when + This::wxDC(), Points::[{X::integer(), Y::integer()}]. + drawLines(This,Points) when is_record(This, wx_ref),is_list(Points) -> drawLines(This,Points, []). -%% @spec (This::wxDC(), Points::[{X::integer(), Y::integer()}], [Option]) -> ok -%% Option = {xoffset, integer()} | {yoffset, integer()} %% @doc See external documentation. +-spec drawLines(This, Points, [Option]) -> ok when + This::wxDC(), Points::[{X::integer(), Y::integer()}], + Option :: {xoffset, integer()} + | {yoffset, integer()}. drawLines(#wx_ref{type=ThisT,ref=ThisRef},Points, Options) when is_list(Points),is_list(Options) -> ?CLASS(ThisT,wxDC), @@ -266,15 +301,20 @@ drawLines(#wx_ref{type=ThisT,ref=ThisRef},Points, Options) <> || {X,Y} <- Points>>)/binary, BinOpt/binary>>). -%% @spec (This::wxDC(), Points::[{X::integer(), Y::integer()}]) -> ok %% @equiv drawPolygon(This,Points, []) +-spec drawPolygon(This, Points) -> ok when + This::wxDC(), Points::[{X::integer(), Y::integer()}]. + drawPolygon(This,Points) when is_record(This, wx_ref),is_list(Points) -> drawPolygon(This,Points, []). -%% @spec (This::wxDC(), Points::[{X::integer(), Y::integer()}], [Option]) -> ok -%% Option = {xoffset, integer()} | {yoffset, integer()} | {fillStyle, integer()} %% @doc See external documentation. +-spec drawPolygon(This, Points, [Option]) -> ok when + This::wxDC(), Points::[{X::integer(), Y::integer()}], + Option :: {xoffset, integer()} + | {yoffset, integer()} + | {fillStyle, integer()}. drawPolygon(#wx_ref{type=ThisT,ref=ThisRef},Points, Options) when is_list(Points),is_list(Options) -> ?CLASS(ThisT,wxDC), @@ -287,32 +327,36 @@ drawPolygon(#wx_ref{type=ThisT,ref=ThisRef},Points, Options) <> || {X,Y} <- Points>>)/binary, BinOpt/binary>>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec drawPoint(This, Pt) -> ok when + This::wxDC(), Pt::{X::integer(), Y::integer()}. drawPoint(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawPoint, <>). -%% @spec (This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec drawRectangle(This, Rect) -> ok when + This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. drawRectangle(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawRectangle_1, <>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec drawRectangle(This, Pt, Sz) -> ok when + This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}. drawRectangle(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH}) when is_integer(PtX),is_integer(PtY),is_integer(SzW),is_integer(SzH) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawRectangle_2, <>). -%% @spec (This::wxDC(), Text::string(), Pt::{X::integer(), Y::integer()}, Angle::float()) -> ok %% @doc See external documentation. +-spec drawRotatedText(This, Text, Pt, Angle) -> ok when + This::wxDC(), Text::string(), Pt::{X::integer(), Y::integer()}, Angle::float(). drawRotatedText(#wx_ref{type=ThisT,ref=ThisRef},Text,{PtX,PtY},Angle) when is_list(Text),is_integer(PtX),is_integer(PtY),is_float(Angle) -> ?CLASS(ThisT,wxDC), @@ -320,24 +364,27 @@ drawRotatedText(#wx_ref{type=ThisT,ref=ThisRef},Text,{PtX,PtY},Angle) wxe_util:cast(?wxDC_DrawRotatedText, <>). -%% @spec (This::wxDC(), R::{X::integer(), Y::integer(), W::integer(), H::integer()}, Radius::float()) -> ok %% @doc See external documentation. +-spec drawRoundedRectangle(This, R, Radius) -> ok when + This::wxDC(), R::{X::integer(), Y::integer(), W::integer(), H::integer()}, Radius::float(). drawRoundedRectangle(#wx_ref{type=ThisT,ref=ThisRef},{RX,RY,RW,RH},Radius) when is_integer(RX),is_integer(RY),is_integer(RW),is_integer(RH),is_float(Radius) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawRoundedRectangle_2, <>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Radius::float()) -> ok %% @doc See external documentation. +-spec drawRoundedRectangle(This, Pt, Sz, Radius) -> ok when + This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}, Radius::float(). drawRoundedRectangle(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH},Radius) when is_integer(PtX),is_integer(PtY),is_integer(SzW),is_integer(SzH),is_float(Radius) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_DrawRoundedRectangle_3, <>). -%% @spec (This::wxDC(), Text::string(), Pt::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec drawText(This, Text, Pt) -> ok when + This::wxDC(), Text::string(), Pt::{X::integer(), Y::integer()}. drawText(#wx_ref{type=ThisT,ref=ThisRef},Text,{PtX,PtY}) when is_list(Text),is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxDC), @@ -345,29 +392,34 @@ drawText(#wx_ref{type=ThisT,ref=ThisRef},Text,{PtX,PtY}) wxe_util:cast(?wxDC_DrawText, <>). -%% @spec (This::wxDC()) -> ok %% @doc See external documentation. +-spec endDoc(This) -> ok when + This::wxDC(). endDoc(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_EndDoc, <>). -%% @spec (This::wxDC()) -> ok %% @doc See external documentation. +-spec endPage(This) -> ok when + This::wxDC(). endPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_EndPage, <>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::wx:colour()) -> bool() %% @equiv floodFill(This,Pt,Col, []) +-spec floodFill(This, Pt, Col) -> boolean() when + This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::wx:wx_colour(). + floodFill(This,Pt={PtX,PtY},Col) when is_record(This, wx_ref),is_integer(PtX),is_integer(PtY),tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> floodFill(This,Pt,Col, []). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::wx:colour(), [Option]) -> bool() -%% Option = {style, integer()} %% @doc See external documentation. +-spec floodFill(This, Pt, Col, [Option]) -> boolean() when + This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::wx:wx_colour(), + Option :: {style, integer()}. floodFill(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},Col, Options) when is_integer(PtX),is_integer(PtY),tuple_size(Col) =:= 3; tuple_size(Col) =:= 4,is_list(Options) -> ?CLASS(ThisT,wxDC), @@ -377,81 +429,91 @@ floodFill(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},Col, Options) wxe_util:call(?wxDC_FloodFill, <>). -%% @spec (This::wxDC()) -> wxBrush:wxBrush() %% @doc See external documentation. +-spec getBackground(This) -> wxBrush:wxBrush() when + This::wxDC(). getBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetBackground, <>). -%% @spec (This::wxDC()) -> integer() %% @doc See external documentation. +-spec getBackgroundMode(This) -> integer() when + This::wxDC(). getBackgroundMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetBackgroundMode, <>). -%% @spec (This::wxDC()) -> wxBrush:wxBrush() %% @doc See external documentation. +-spec getBrush(This) -> wxBrush:wxBrush() when + This::wxDC(). getBrush(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetBrush, <>). -%% @spec (This::wxDC()) -> integer() %% @doc See external documentation. +-spec getCharHeight(This) -> integer() when + This::wxDC(). getCharHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetCharHeight, <>). -%% @spec (This::wxDC()) -> integer() %% @doc See external documentation. +-spec getCharWidth(This) -> integer() when + This::wxDC(). getCharWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetCharWidth, <>). -%% @spec (This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec getClippingBox(This, Rect) -> ok when + This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. getClippingBox(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_GetClippingBox, <>). -%% @spec (This::wxDC()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getFont(This) -> wxFont:wxFont() when + This::wxDC(). getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetFont, <>). -%% @spec (This::wxDC()) -> WxLayoutDirection -%% WxLayoutDirection = integer() %% @doc See external documentation. -%%
WxLayoutDirection is one of ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft +%%
Res = ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft +-spec getLayoutDirection(This) -> wx:wx_enum() when + This::wxDC(). getLayoutDirection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetLayoutDirection, <>). -%% @spec (This::wxDC()) -> integer() %% @doc See external documentation. +-spec getLogicalFunction(This) -> integer() when + This::wxDC(). getLogicalFunction(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetLogicalFunction, <>). -%% @spec (This::wxDC()) -> integer() %% @doc See external documentation. +-spec getMapMode(This) -> integer() when + This::wxDC(). getMapMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetMapMode, <>). -%% @spec (This::wxDC(), String::string()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getMultiLineTextExtent(This, String) -> {W::integer(), H::integer()} when + This::wxDC(), String::string(). getMultiLineTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String) when is_list(String) -> ?CLASS(ThisT,wxDC), @@ -459,9 +521,10 @@ getMultiLineTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String) wxe_util:call(?wxDC_GetMultiLineTextExtent_1, <>). -%% @spec (This::wxDC(), String::string(), [Option]) -> {Width::integer(), Height::integer(), HeightLine::integer()} -%% Option = {font, wxFont:wxFont()} %% @doc See external documentation. +-spec getMultiLineTextExtent(This, String, [Option]) -> {Width::integer(), Height::integer(), HeightLine::integer()} when + This::wxDC(), String::string(), + Option :: {font, wxFont:wxFont()}. getMultiLineTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String, Options) when is_list(String),is_list(Options) -> ?CLASS(ThisT,wxDC), @@ -472,8 +535,9 @@ getMultiLineTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String, Options) wxe_util:call(?wxDC_GetMultiLineTextExtent_4, <>). -%% @spec (This::wxDC(), Text::string(), Widths::[integer()]) -> bool() %% @doc See external documentation. +-spec getPartialTextExtents(This, Text, Widths) -> boolean() when + This::wxDC(), Text::string(), Widths::[integer()]. getPartialTextExtents(#wx_ref{type=ThisT,ref=ThisRef},Text,Widths) when is_list(Text),is_list(Widths) -> ?CLASS(ThisT,wxDC), @@ -482,51 +546,58 @@ getPartialTextExtents(#wx_ref{type=ThisT,ref=ThisRef},Text,Widths) <> || C <- Widths>>)/binary, 0:(((1+length(Widths)) rem 2)*32)>>). -%% @spec (This::wxDC()) -> wxPen:wxPen() %% @doc See external documentation. +-spec getPen(This) -> wxPen:wxPen() when + This::wxDC(). getPen(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetPen, <>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::wx:colour()) -> bool() %% @doc See external documentation. +-spec getPixel(This, Pt, Col) -> boolean() when + This::wxDC(), Pt::{X::integer(), Y::integer()}, Col::wx:wx_colour(). getPixel(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},Col) when is_integer(PtX),is_integer(PtY),tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetPixel, <>). -%% @spec (This::wxDC()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getPPI(This) -> {W::integer(), H::integer()} when + This::wxDC(). getPPI(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetPPI, <>). -%% @spec (This::wxDC()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getSize(This) -> {W::integer(), H::integer()} when + This::wxDC(). getSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetSize, <>). -%% @spec (This::wxDC()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getSizeMM(This) -> {W::integer(), H::integer()} when + This::wxDC(). getSizeMM(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetSizeMM, <>). -%% @spec (This::wxDC()) -> wx:colour() %% @doc See external documentation. +-spec getTextBackground(This) -> wx:wx_colour() when + This::wxDC(). getTextBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetTextBackground, <>). -%% @spec (This::wxDC(), String::string()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getTextExtent(This, String) -> {W::integer(), H::integer()} when + This::wxDC(), String::string(). getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String) when is_list(String) -> ?CLASS(ThisT,wxDC), @@ -534,9 +605,11 @@ getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String) wxe_util:call(?wxDC_GetTextExtent_1, <>). -%% @spec (This::wxDC(), String::string(), [Option]) -> {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()} -%% Option = {theFont, wxFont:wxFont()} %% @doc See external documentation. +-spec getTextExtent(This, String, [Option]) -> Result when + Result :: {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}, + This::wxDC(), String::string(), + Option :: {theFont, wxFont:wxFont()}. getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String, Options) when is_list(String),is_list(Options) -> ?CLASS(ThisT,wxDC), @@ -547,47 +620,53 @@ getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String, Options) wxe_util:call(?wxDC_GetTextExtent_4, <>). -%% @spec (This::wxDC()) -> wx:colour() %% @doc See external documentation. +-spec getTextForeground(This) -> wx:wx_colour() when + This::wxDC(). getTextForeground(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetTextForeground, <>). -%% @spec (This::wxDC()) -> {X::float(), Y::float()} %% @doc See external documentation. +-spec getUserScale(This) -> {X::float(), Y::float()} when + This::wxDC(). getUserScale(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_GetUserScale, <>). -%% @spec (This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:colour(), DestColour::wx:colour()) -> ok %% @doc See external documentation. +-spec gradientFillConcentric(This, Rect, InitialColour, DestColour) -> ok when + This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:wx_colour(), DestColour::wx:wx_colour(). gradientFillConcentric(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH},InitialColour,DestColour) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),tuple_size(InitialColour) =:= 3; tuple_size(InitialColour) =:= 4,tuple_size(DestColour) =:= 3; tuple_size(DestColour) =:= 4 -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_GradientFillConcentric_3, <>). -%% @spec (This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:colour(), DestColour::wx:colour(), CircleCenter::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec gradientFillConcentric(This, Rect, InitialColour, DestColour, CircleCenter) -> ok when + This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:wx_colour(), DestColour::wx:wx_colour(), CircleCenter::{X::integer(), Y::integer()}. gradientFillConcentric(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH},InitialColour,DestColour,{CircleCenterX,CircleCenterY}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),tuple_size(InitialColour) =:= 3; tuple_size(InitialColour) =:= 4,tuple_size(DestColour) =:= 3; tuple_size(DestColour) =:= 4,is_integer(CircleCenterX),is_integer(CircleCenterY) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_GradientFillConcentric_4, <>). -%% @spec (This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:colour(), DestColour::wx:colour()) -> ok %% @equiv gradientFillLinear(This,Rect,InitialColour,DestColour, []) +-spec gradientFillLinear(This, Rect, InitialColour, DestColour) -> ok when + This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:wx_colour(), DestColour::wx:wx_colour(). + gradientFillLinear(This,Rect={RectX,RectY,RectW,RectH},InitialColour,DestColour) when is_record(This, wx_ref),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),tuple_size(InitialColour) =:= 3; tuple_size(InitialColour) =:= 4,tuple_size(DestColour) =:= 3; tuple_size(DestColour) =:= 4 -> gradientFillLinear(This,Rect,InitialColour,DestColour, []). -%% @spec (This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:colour(), DestColour::wx:colour(), [Option]) -> ok -%% Option = {nDirection, WxDirection} -%% WxDirection = integer() %% @doc See external documentation. -%%
WxDirection is one of ?wxLEFT | ?wxRIGHT | ?wxUP | ?wxDOWN | ?wxTOP | ?wxBOTTOM | ?wxNORTH | ?wxSOUTH | ?wxWEST | ?wxEAST | ?wxALL +%%
NDirection = ?wxLEFT | ?wxRIGHT | ?wxUP | ?wxDOWN | ?wxTOP | ?wxBOTTOM | ?wxNORTH | ?wxSOUTH | ?wxWEST | ?wxEAST | ?wxALL +-spec gradientFillLinear(This, Rect, InitialColour, DestColour, [Option]) -> ok when + This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, InitialColour::wx:wx_colour(), DestColour::wx:wx_colour(), + Option :: {nDirection, wx:wx_enum()}. gradientFillLinear(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH},InitialColour,DestColour, Options) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),tuple_size(InitialColour) =:= 3; tuple_size(InitialColour) =:= 4,tuple_size(DestColour) =:= 3; tuple_size(DestColour) =:= 4,is_list(Options) -> ?CLASS(ThisT,wxDC), @@ -597,121 +676,131 @@ gradientFillLinear(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH},Ini wxe_util:cast(?wxDC_GradientFillLinear, <>). -%% @spec (This::wxDC(), X::integer()) -> integer() %% @doc See external documentation. +-spec logicalToDeviceX(This, X) -> integer() when + This::wxDC(), X::integer(). logicalToDeviceX(#wx_ref{type=ThisT,ref=ThisRef},X) when is_integer(X) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_LogicalToDeviceX, <>). -%% @spec (This::wxDC(), X::integer()) -> integer() %% @doc See external documentation. +-spec logicalToDeviceXRel(This, X) -> integer() when + This::wxDC(), X::integer(). logicalToDeviceXRel(#wx_ref{type=ThisT,ref=ThisRef},X) when is_integer(X) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_LogicalToDeviceXRel, <>). -%% @spec (This::wxDC(), Y::integer()) -> integer() %% @doc See external documentation. +-spec logicalToDeviceY(This, Y) -> integer() when + This::wxDC(), Y::integer(). logicalToDeviceY(#wx_ref{type=ThisT,ref=ThisRef},Y) when is_integer(Y) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_LogicalToDeviceY, <>). -%% @spec (This::wxDC(), Y::integer()) -> integer() %% @doc See external documentation. +-spec logicalToDeviceYRel(This, Y) -> integer() when + This::wxDC(), Y::integer(). logicalToDeviceYRel(#wx_ref{type=ThisT,ref=ThisRef},Y) when is_integer(Y) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_LogicalToDeviceYRel, <>). -%% @spec (This::wxDC()) -> integer() %% @doc See external documentation. +-spec maxX(This) -> integer() when + This::wxDC(). maxX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_MaxX, <>). -%% @spec (This::wxDC()) -> integer() %% @doc See external documentation. +-spec maxY(This) -> integer() when + This::wxDC(). maxY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_MaxY, <>). -%% @spec (This::wxDC()) -> integer() %% @doc See external documentation. +-spec minX(This) -> integer() when + This::wxDC(). minX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_MinX, <>). -%% @spec (This::wxDC()) -> integer() %% @doc See external documentation. +-spec minY(This) -> integer() when + This::wxDC(). minY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_MinY, <>). -%% @spec (This::wxDC()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxDC(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:call(?wxDC_IsOk, <>). -%% @spec (This::wxDC()) -> ok %% @doc See external documentation. +-spec resetBoundingBox(This) -> ok when + This::wxDC(). resetBoundingBox(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_ResetBoundingBox, <>). -%% @spec (This::wxDC(), XLeftRight::bool(), YBottomUp::bool()) -> ok %% @doc See external documentation. +-spec setAxisOrientation(This, XLeftRight, YBottomUp) -> ok when + This::wxDC(), XLeftRight::boolean(), YBottomUp::boolean(). setAxisOrientation(#wx_ref{type=ThisT,ref=ThisRef},XLeftRight,YBottomUp) when is_boolean(XLeftRight),is_boolean(YBottomUp) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetAxisOrientation, <>). -%% @spec (This::wxDC(), Brush::wxBrush:wxBrush()) -> ok %% @doc See external documentation. +-spec setBackground(This, Brush) -> ok when + This::wxDC(), Brush::wxBrush:wxBrush(). setBackground(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> ?CLASS(ThisT,wxDC), ?CLASS(BrushT,wxBrush), wxe_util:cast(?wxDC_SetBackground, <>). -%% @spec (This::wxDC(), Mode::integer()) -> ok %% @doc See external documentation. +-spec setBackgroundMode(This, Mode) -> ok when + This::wxDC(), Mode::integer(). setBackgroundMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) when is_integer(Mode) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetBackgroundMode, <>). -%% @spec (This::wxDC(), Brush::wxBrush:wxBrush()) -> ok %% @doc See external documentation. +-spec setBrush(This, Brush) -> ok when + This::wxDC(), Brush::wxBrush:wxBrush(). setBrush(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> ?CLASS(ThisT,wxDC), ?CLASS(BrushT,wxBrush), wxe_util:cast(?wxDC_SetBrush, <>). -%% @spec (This::wxDC(),X::term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setClippingRegion(This::wxDC(), Region::wxRegion:wxRegion()) -> ok -%%

-%%

-%% setClippingRegion(This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok -%%

+-spec setClippingRegion(This, Region) -> ok when + This::wxDC(), Region::wxRegion:wxRegion(); + (This, Rect) -> ok when + This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. setClippingRegion(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=RegionT,ref=RegionRef}) -> ?CLASS(ThisT,wxDC), ?CLASS(RegionT,wxRegion), @@ -723,98 +812,109 @@ setClippingRegion(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:cast(?wxDC_SetClippingRegion_1_1, <>). -%% @spec (This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setClippingRegion(This, Pt, Sz) -> ok when + This::wxDC(), Pt::{X::integer(), Y::integer()}, Sz::{W::integer(), H::integer()}. setClippingRegion(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY},{SzW,SzH}) when is_integer(PtX),is_integer(PtY),is_integer(SzW),is_integer(SzH) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetClippingRegion_2, <>). -%% @spec (This::wxDC(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec setDeviceOrigin(This, X, Y) -> ok when + This::wxDC(), X::integer(), Y::integer(). setDeviceOrigin(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetDeviceOrigin, <>). -%% @spec (This::wxDC(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setFont(This, Font) -> ok when + This::wxDC(), Font::wxFont:wxFont(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxDC), ?CLASS(FontT,wxFont), wxe_util:cast(?wxDC_SetFont, <>). -%% @spec (This::wxDC(), Dir::WxLayoutDirection) -> ok -%% WxLayoutDirection = integer() %% @doc See external documentation. -%%
WxLayoutDirection is one of ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft +%%
Dir = ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLayout_RightToLeft +-spec setLayoutDirection(This, Dir) -> ok when + This::wxDC(), Dir::wx:wx_enum(). setLayoutDirection(#wx_ref{type=ThisT,ref=ThisRef},Dir) when is_integer(Dir) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetLayoutDirection, <>). -%% @spec (This::wxDC(), Function::integer()) -> ok %% @doc See external documentation. +-spec setLogicalFunction(This, Function) -> ok when + This::wxDC(), Function::integer(). setLogicalFunction(#wx_ref{type=ThisT,ref=ThisRef},Function) when is_integer(Function) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetLogicalFunction, <>). -%% @spec (This::wxDC(), Mode::integer()) -> ok %% @doc See external documentation. +-spec setMapMode(This, Mode) -> ok when + This::wxDC(), Mode::integer(). setMapMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) when is_integer(Mode) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetMapMode, <>). -%% @spec (This::wxDC(), Palette::wxPalette:wxPalette()) -> ok %% @doc See external documentation. +-spec setPalette(This, Palette) -> ok when + This::wxDC(), Palette::wxPalette:wxPalette(). setPalette(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PaletteT,ref=PaletteRef}) -> ?CLASS(ThisT,wxDC), ?CLASS(PaletteT,wxPalette), wxe_util:cast(?wxDC_SetPalette, <>). -%% @spec (This::wxDC(), Pen::wxPen:wxPen()) -> ok %% @doc See external documentation. +-spec setPen(This, Pen) -> ok when + This::wxDC(), Pen::wxPen:wxPen(). setPen(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PenT,ref=PenRef}) -> ?CLASS(ThisT,wxDC), ?CLASS(PenT,wxPen), wxe_util:cast(?wxDC_SetPen, <>). -%% @spec (This::wxDC(), Colour::wx:colour()) -> ok %% @doc See external documentation. +-spec setTextBackground(This, Colour) -> ok when + This::wxDC(), Colour::wx:wx_colour(). setTextBackground(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetTextBackground, <>). -%% @spec (This::wxDC(), Colour::wx:colour()) -> ok %% @doc See external documentation. +-spec setTextForeground(This, Colour) -> ok when + This::wxDC(), Colour::wx:wx_colour(). setTextForeground(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetTextForeground, <>). -%% @spec (This::wxDC(), X::float(), Y::float()) -> ok %% @doc See external documentation. +-spec setUserScale(This, X, Y) -> ok when + This::wxDC(), X::float(), Y::float(). setUserScale(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_float(X),is_float(Y) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_SetUserScale, <>). -%% @spec (This::wxDC(), Message::string()) -> bool() %% @doc See external documentation. +-spec startDoc(This, Message) -> boolean() when + This::wxDC(), Message::string(). startDoc(#wx_ref{type=ThisT,ref=ThisRef},Message) when is_list(Message) -> ?CLASS(ThisT,wxDC), @@ -822,8 +922,9 @@ startDoc(#wx_ref{type=ThisT,ref=ThisRef},Message) wxe_util:call(?wxDC_StartDoc, <>). -%% @spec (This::wxDC()) -> ok %% @doc See external documentation. +-spec startPage(This) -> ok when + This::wxDC(). startPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDC), wxe_util:cast(?wxDC_StartPage, diff --git a/lib/wx/src/gen/wxDataObject.erl b/lib/wx/src/gen/wxDataObject.erl index bad6d96fb5..65b388aa48 100644 --- a/lib/wx/src/gen/wxDataObject.erl +++ b/lib/wx/src/gen/wxDataObject.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 @@ -29,6 +29,8 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxDataObject/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxDataObject() :: wx:wx_object(). diff --git a/lib/wx/src/gen/wxDateEvent.erl b/lib/wx/src/gen/wxDateEvent.erl index b4b010e122..417322097f 100644 --- a/lib/wx/src/gen/wxDateEvent.erl +++ b/lib/wx/src/gen/wxDateEvent.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,13 +40,16 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxDateEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxDateEvent()) -> wx:datetime() +-type wxDateEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getDate(This) -> wx:wx_datetime() when + This::wxDateEvent(). getDate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDateEvent), wxe_util:call(?wxDateEvent_GetDate, diff --git a/lib/wx/src/gen/wxDatePickerCtrl.erl b/lib/wx/src/gen/wxDatePickerCtrl.erl index 8a1700e9cd..e1c16d3612 100644 --- a/lib/wx/src/gen/wxDatePickerCtrl.erl +++ b/lib/wx/src/gen/wxDatePickerCtrl.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,6 +74,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxDatePickerCtrl/0]). %% @hidden parent_class(wxPickerBase) -> true; parent_class(wxControl) -> true; @@ -81,21 +82,29 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxDatePickerCtrl() +-type wxDatePickerCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxDatePickerCtrl(). new() -> wxe_util:construct(?wxDatePickerCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxDatePickerCtrl() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxDatePickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxDatePickerCtrl() -%% Option = {date, wx:datetime()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxDatePickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {date, wx:wx_datetime()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -109,39 +118,43 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxDatePickerCtrl_new_3, <>). -%% @spec (This::wxDatePickerCtrl(), Dt1::wx:datetime(), Dt2::wx:datetime()) -> bool() %% @doc See external documentation. +-spec getRange(This, Dt1, Dt2) -> boolean() when + This::wxDatePickerCtrl(), Dt1::wx:wx_datetime(), Dt2::wx:wx_datetime(). getRange(#wx_ref{type=ThisT,ref=ThisRef},Dt1,Dt2) when tuple_size(Dt1) =:= 2,tuple_size(Dt2) =:= 2 -> ?CLASS(ThisT,wxDatePickerCtrl), wxe_util:call(?wxDatePickerCtrl_GetRange, <>). -%% @spec (This::wxDatePickerCtrl()) -> wx:datetime() %% @doc See external documentation. +-spec getValue(This) -> wx:wx_datetime() when + This::wxDatePickerCtrl(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDatePickerCtrl), wxe_util:call(?wxDatePickerCtrl_GetValue, <>). -%% @spec (This::wxDatePickerCtrl(), Dt1::wx:datetime(), Dt2::wx:datetime()) -> ok %% @doc See external documentation. +-spec setRange(This, Dt1, Dt2) -> ok when + This::wxDatePickerCtrl(), Dt1::wx:wx_datetime(), Dt2::wx:wx_datetime(). setRange(#wx_ref{type=ThisT,ref=ThisRef},Dt1,Dt2) when tuple_size(Dt1) =:= 2,tuple_size(Dt2) =:= 2 -> ?CLASS(ThisT,wxDatePickerCtrl), wxe_util:cast(?wxDatePickerCtrl_SetRange, <>). -%% @spec (This::wxDatePickerCtrl(), Date::wx:datetime()) -> ok %% @doc See external documentation. +-spec setValue(This, Date) -> ok when + This::wxDatePickerCtrl(), Date::wx:wx_datetime(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Date) when tuple_size(Date) =:= 2 -> ?CLASS(ThisT,wxDatePickerCtrl), wxe_util:cast(?wxDatePickerCtrl_SetValue, <>). -%% @spec (This::wxDatePickerCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxDatePickerCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxDatePickerCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxDialog.erl b/lib/wx/src/gen/wxDialog.erl index 514a62813e..137ad27a45 100644 --- a/lib/wx/src/gen/wxDialog.erl +++ b/lib/wx/src/gen/wxDialog.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 @@ -76,27 +76,34 @@ thaw/1,transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxDialog/0]). %% @hidden parent_class(wxTopLevelWindow) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxDialog() +-type wxDialog() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxDialog(). new() -> wxe_util:construct(?wxDialog_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string()) -> wxDialog() %% @equiv new(Parent,Id,Title, []) +-spec new(Parent, Id, Title) -> wxDialog() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(). + new(Parent,Id,Title) when is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> new(Parent,Id,Title, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), [Option]) -> wxDialog() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, Title, [Option]) -> wxDialog() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -109,15 +116,20 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) wxe_util:construct(?wxDialog_new_4, <>). -%% @spec (This::wxDialog(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string()) -> bool() %% @equiv create(This,Parent,Id,Title, []) +-spec create(This, Parent, Id, Title) -> boolean() when + This::wxDialog(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(). + create(This,Parent,Id,Title) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> create(This,Parent,Id,Title, []). -%% @spec (This::wxDialog(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, Title, [Option]) -> boolean() when + This::wxDialog(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), + 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,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ThisT,wxDialog), @@ -131,76 +143,87 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Ti wxe_util:call(?wxDialog_Create, <>). -%% @spec (This::wxDialog(), Flags::integer()) -> wxSizer:wxSizer() %% @doc See external documentation. +-spec createButtonSizer(This, Flags) -> wxSizer:wxSizer() when + This::wxDialog(), Flags::integer(). createButtonSizer(#wx_ref{type=ThisT,ref=ThisRef},Flags) when is_integer(Flags) -> ?CLASS(ThisT,wxDialog), wxe_util:call(?wxDialog_CreateButtonSizer, <>). -%% @spec (This::wxDialog(), Flags::integer()) -> wxStdDialogButtonSizer:wxStdDialogButtonSizer() %% @doc See external documentation. +-spec createStdDialogButtonSizer(This, Flags) -> wxStdDialogButtonSizer:wxStdDialogButtonSizer() when + This::wxDialog(), Flags::integer(). createStdDialogButtonSizer(#wx_ref{type=ThisT,ref=ThisRef},Flags) when is_integer(Flags) -> ?CLASS(ThisT,wxDialog), wxe_util:call(?wxDialog_CreateStdDialogButtonSizer, <>). -%% @spec (This::wxDialog(), RetCode::integer()) -> ok %% @doc See external documentation. +-spec endModal(This, RetCode) -> ok when + This::wxDialog(), RetCode::integer(). endModal(#wx_ref{type=ThisT,ref=ThisRef},RetCode) when is_integer(RetCode) -> ?CLASS(ThisT,wxDialog), wxe_util:cast(?wxDialog_EndModal, <>). -%% @spec (This::wxDialog()) -> integer() %% @doc See external documentation. +-spec getAffirmativeId(This) -> integer() when + This::wxDialog(). getAffirmativeId(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDialog), wxe_util:call(?wxDialog_GetAffirmativeId, <>). -%% @spec (This::wxDialog()) -> integer() %% @doc See external documentation. +-spec getReturnCode(This) -> integer() when + This::wxDialog(). getReturnCode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDialog), wxe_util:call(?wxDialog_GetReturnCode, <>). -%% @spec (This::wxDialog()) -> bool() %% @doc See external documentation. +-spec isModal(This) -> boolean() when + This::wxDialog(). isModal(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDialog), wxe_util:call(?wxDialog_IsModal, <>). -%% @spec (This::wxDialog(), AffirmativeId::integer()) -> ok %% @doc See external documentation. +-spec setAffirmativeId(This, AffirmativeId) -> ok when + This::wxDialog(), AffirmativeId::integer(). setAffirmativeId(#wx_ref{type=ThisT,ref=ThisRef},AffirmativeId) when is_integer(AffirmativeId) -> ?CLASS(ThisT,wxDialog), wxe_util:cast(?wxDialog_SetAffirmativeId, <>). -%% @spec (This::wxDialog(), ReturnCode::integer()) -> ok %% @doc See external documentation. +-spec setReturnCode(This, ReturnCode) -> ok when + This::wxDialog(), ReturnCode::integer(). setReturnCode(#wx_ref{type=ThisT,ref=ThisRef},ReturnCode) when is_integer(ReturnCode) -> ?CLASS(ThisT,wxDialog), wxe_util:cast(?wxDialog_SetReturnCode, <>). -%% @spec (This::wxDialog()) -> bool() %% @equiv show(This, []) +-spec show(This) -> boolean() when + This::wxDialog(). + show(This) when is_record(This, wx_ref) -> show(This, []). -%% @spec (This::wxDialog(), [Option]) -> bool() -%% Option = {show, bool()} %% @doc See external documentation. +-spec show(This, [Option]) -> boolean() when + This::wxDialog(), + Option :: {show, boolean()}. show(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxDialog), @@ -210,15 +233,16 @@ show(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxDialog_Show, <>). -%% @spec (This::wxDialog()) -> integer() %% @doc See external documentation. +-spec showModal(This) -> integer() when + This::wxDialog(). showModal(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDialog), wxe_util:call(?wxDialog_ShowModal, <>). -%% @spec (This::wxDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxDirDialog.erl b/lib/wx/src/gen/wxDirDialog.erl index 28db3daf1d..6104803294 100644 --- a/lib/wx/src/gen/wxDirDialog.erl +++ b/lib/wx/src/gen/wxDirDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxDirDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,15 +85,23 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Parent::wxWindow:wxWindow()) -> wxDirDialog() +-type wxDirDialog() :: wx:wx_object(). %% @equiv new(Parent, []) +-spec new(Parent) -> wxDirDialog() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxDirDialog() -%% Option = {title, string()} | {defaultPath, string()} | {style, integer()} | {pos, {X::integer(), Y::integer()}} | {sz, {W::integer(), H::integer()}} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxDirDialog() when + Parent::wxWindow:wxWindow(), + Option :: {title, string()} + | {defaultPath, string()} + | {style, integer()} + | {pos, {X::integer(), Y::integer()}} + | {sz, {W::integer(), H::integer()}}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -106,22 +115,25 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxDirDialog_new, <>). -%% @spec (This::wxDirDialog()) -> string() %% @doc See external documentation. +-spec getPath(This) -> string() when + This::wxDirDialog(). getPath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDirDialog), wxe_util:call(?wxDirDialog_GetPath, <>). -%% @spec (This::wxDirDialog()) -> string() %% @doc See external documentation. +-spec getMessage(This) -> string() when + This::wxDirDialog(). getMessage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDirDialog), wxe_util:call(?wxDirDialog_GetMessage, <>). -%% @spec (This::wxDirDialog(), Message::string()) -> ok %% @doc See external documentation. +-spec setMessage(This, Message) -> ok when + This::wxDirDialog(), Message::string(). setMessage(#wx_ref{type=ThisT,ref=ThisRef},Message) when is_list(Message) -> ?CLASS(ThisT,wxDirDialog), @@ -129,8 +141,9 @@ setMessage(#wx_ref{type=ThisT,ref=ThisRef},Message) wxe_util:cast(?wxDirDialog_SetMessage, <>). -%% @spec (This::wxDirDialog(), Path::string()) -> ok %% @doc See external documentation. +-spec setPath(This, Path) -> ok when + This::wxDirDialog(), Path::string(). setPath(#wx_ref{type=ThisT,ref=ThisRef},Path) when is_list(Path) -> ?CLASS(ThisT,wxDirDialog), @@ -138,8 +151,8 @@ setPath(#wx_ref{type=ThisT,ref=ThisRef},Path) wxe_util:cast(?wxDirDialog_SetPath, <>). -%% @spec (This::wxDirDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxDirDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxDirDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxDirPickerCtrl.erl b/lib/wx/src/gen/wxDirPickerCtrl.erl index 2b24bc4bb0..667119c987 100644 --- a/lib/wx/src/gen/wxDirPickerCtrl.erl +++ b/lib/wx/src/gen/wxDirPickerCtrl.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,6 +74,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxDirPickerCtrl/0]). %% @hidden parent_class(wxPickerBase) -> true; parent_class(wxControl) -> true; @@ -81,21 +82,30 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxDirPickerCtrl() +-type wxDirPickerCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxDirPickerCtrl(). new() -> wxe_util:construct(?wxDirPickerCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxDirPickerCtrl() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxDirPickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxDirPickerCtrl() -%% Option = {path, string()} | {message, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxDirPickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {path, string()} + | {message, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -110,15 +120,23 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxDirPickerCtrl_new_3, <>). -%% @spec (This::wxDirPickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxDirPickerCtrl(), 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::wxDirPickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {path, string()} | {message, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxDirPickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {path, string()} + | {message, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxDirPickerCtrl), @@ -134,15 +152,17 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxDirPickerCtrl_Create, <>). -%% @spec (This::wxDirPickerCtrl()) -> string() %% @doc See external documentation. +-spec getPath(This) -> string() when + This::wxDirPickerCtrl(). getPath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxDirPickerCtrl), wxe_util:call(?wxDirPickerCtrl_GetPath, <>). -%% @spec (This::wxDirPickerCtrl(), Str::string()) -> ok %% @doc See external documentation. +-spec setPath(This, Str) -> ok when + This::wxDirPickerCtrl(), Str::string(). setPath(#wx_ref{type=ThisT,ref=ThisRef},Str) when is_list(Str) -> ?CLASS(ThisT,wxDirPickerCtrl), @@ -150,8 +170,8 @@ setPath(#wx_ref{type=ThisT,ref=ThisRef},Str) wxe_util:cast(?wxDirPickerCtrl_SetPath, <>). -%% @spec (This::wxDirPickerCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxDirPickerCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxDirPickerCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxDisplayChangedEvent.erl b/lib/wx/src/gen/wxDisplayChangedEvent.erl index c86ef62462..0c0612564b 100644 --- a/lib/wx/src/gen/wxDisplayChangedEvent.erl +++ b/lib/wx/src/gen/wxDisplayChangedEvent.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 @@ -37,10 +37,12 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxDisplayChangedEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxDisplayChangedEvent() :: wx:wx_object(). %% From wxEvent %% @hidden stopPropagation(This) -> wxEvent:stopPropagation(This). diff --git a/lib/wx/src/gen/wxEraseEvent.erl b/lib/wx/src/gen/wxEraseEvent.erl index 77139b6790..03ce8862dc 100644 --- a/lib/wx/src/gen/wxEraseEvent.erl +++ b/lib/wx/src/gen/wxEraseEvent.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 @@ -37,12 +37,15 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxEraseEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxEraseEvent()) -> wxDC:wxDC() +-type wxEraseEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getDC(This) -> wxDC:wxDC() when + This::wxEraseEvent(). getDC(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxEraseEvent), wxe_util:call(?wxEraseEvent_GetDC, diff --git a/lib/wx/src/gen/wxEvent.erl b/lib/wx/src/gen/wxEvent.erl index 403fd89f1f..1b2147a326 100644 --- a/lib/wx/src/gen/wxEvent.erl +++ b/lib/wx/src/gen/wxEvent.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 @@ -30,61 +30,72 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxEvent/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxEvent()) -> integer() +-type wxEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getId(This) -> integer() when + This::wxEvent(). getId(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxEvent), wxe_util:call(?wxEvent_GetId, <>). -%% @spec (This::wxEvent()) -> bool() %% @doc See external documentation. +-spec getSkipped(This) -> boolean() when + This::wxEvent(). getSkipped(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxEvent), wxe_util:call(?wxEvent_GetSkipped, <>). -%% @spec (This::wxEvent()) -> integer() %% @doc See external documentation. +-spec getTimestamp(This) -> integer() when + This::wxEvent(). getTimestamp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxEvent), wxe_util:call(?wxEvent_GetTimestamp, <>). -%% @spec (This::wxEvent()) -> bool() %% @doc See external documentation. +-spec isCommandEvent(This) -> boolean() when + This::wxEvent(). isCommandEvent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxEvent), wxe_util:call(?wxEvent_IsCommandEvent, <>). -%% @spec (This::wxEvent(), PropagationLevel::integer()) -> ok %% @doc See external documentation. +-spec resumePropagation(This, PropagationLevel) -> ok when + This::wxEvent(), PropagationLevel::integer(). resumePropagation(#wx_ref{type=ThisT,ref=ThisRef},PropagationLevel) when is_integer(PropagationLevel) -> ?CLASS(ThisT,wxEvent), wxe_util:cast(?wxEvent_ResumePropagation, <>). -%% @spec (This::wxEvent()) -> bool() %% @doc See external documentation. +-spec shouldPropagate(This) -> boolean() when + This::wxEvent(). shouldPropagate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxEvent), wxe_util:call(?wxEvent_ShouldPropagate, <>). -%% @spec (This::wxEvent()) -> ok %% @equiv skip(This, []) +-spec skip(This) -> ok when + This::wxEvent(). + skip(This) when is_record(This, wx_ref) -> skip(This, []). -%% @spec (This::wxEvent(), [Option]) -> ok -%% Option = {skip, bool()} %% @doc See external documentation. +-spec skip(This, [Option]) -> ok when + This::wxEvent(), + Option :: {skip, boolean()}. skip(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxEvent), @@ -94,8 +105,9 @@ skip(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxEvent_Skip, <>). -%% @spec (This::wxEvent()) -> integer() %% @doc See external documentation. +-spec stopPropagation(This) -> integer() when + This::wxEvent(). stopPropagation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxEvent), wxe_util:call(?wxEvent_StopPropagation, diff --git a/lib/wx/src/gen/wxEvtHandler.erl b/lib/wx/src/gen/wxEvtHandler.erl index 820c2b7a58..cf4a72da5a 100644 --- a/lib/wx/src/gen/wxEvtHandler.erl +++ b/lib/wx/src/gen/wxEvtHandler.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 @@ -37,10 +37,7 @@ %% %% The orginal documentation. %% -%% @headerfile "../../include/wx.hrl" %% -%%@type wxEvtHandler(). An object reference - -module(wxEvtHandler). -include("wxe.hrl"). -include("../include/wx.hrl"). @@ -53,17 +50,16 @@ new_evt_listener/0, destroy_evt_listener/1, get_callback/1, replace_fun_with_id/2]). --record(evh, {et=null,id=?wxID_ANY,lastId=?wxID_ANY,skip=undefined,userdata=[],cb=0}). - +-export_type([wxEvtHandler/0, wx/0, event/0]). +-type wxEvtHandler() :: wx:wx_object(). +-record(evh, {et=null,id=?wxID_ANY,lastId=?wxID_ANY,skip=undefined,userdata=[],cb=0}). -%% @spec (This::wxEvtHandler(), EventType::wxEventType()) -> ok %% @doc Equivalent to {@link connect/3. connect(This, EventType, [])} - +-spec connect(This::wxEvtHandler(), EventType::wxEventType()) -> ok. connect(This, EventType) -> connect(This, EventType, []). -%% @spec (This::wxEvtHandler(), EventType::wxEventType(), [Options]) -> ok %% @doc This function subscribes the to events of EventType, %% in the range id, lastId. The events will be received as messages %% if no callback is supplied. @@ -82,6 +78,9 @@ connect(This, EventType) -> %% to process the event. Default not specfied i.e. a message will %% be delivered to the process calling this function. %% {userData, term()} An erlang term that will be sent with the event. Default: []. +-spec connect(This::wxEvtHandler(), EventType::wxEventType(), [Option]) -> ok when + Option :: {id, integer()} | {lastId, integer()} | {skip, boolean()} | + {callback, function()} | {userData, term()}. connect(This=#wx_ref{type=ThisT}, EventType, Options) -> EvH = parse_opts(Options, #evh{et=EventType}), ?CLASS(ThisT,wxEvtHandler), @@ -118,26 +117,27 @@ parse_opts([], Opts = #evh{id=Id,lastId=Lid,skip=Skip, cb=CB}) -> Opts end. -%% @spec (This::wxEvtHandler()) -> true | false + %% @doc Equivalent to {@link disconnect/3. disconnect(This, null, [])} %% Can also have an optional callback Fun() as an additional last argument. - +-spec disconnect(This::wxEvtHandler()) -> boolean(). disconnect(This=#wx_ref{type=ThisT,ref=_ThisRef}) -> ?CLASS(ThisT,wxEvtHandler), disconnect(This, null, []). -%% @spec (This::wxEvtHandler(), EventType::wxEventType()) -> true | false %% @doc Equivalent to {@link disconnect/3. disconnect(This, EventType, [])} +-spec disconnect(This::wxEvtHandler(), EventType::wxEventType()) -> boolean(). disconnect(This=#wx_ref{type=ThisT,ref=_ThisRef}, EventType) when is_atom(EventType) -> ?CLASS(ThisT,wxEvtHandler), disconnect(This, EventType, []). -%% @spec (This::wxEvtHandler(), EventType::wxEventType(), Opts) -> true | false %% @doc See external documentation %% This function unsubscribes the process or callback fun from the event handler. %% EventType may be the atom 'null' to match any eventtype. %% Notice that the options skip and userdata is not used to match the eventhandler. -disconnect(This=#wx_ref{type=ThisT,ref=_ThisRef}, EventType, Opts) -> +-spec disconnect(This::wxEvtHandler(), EventType::wxEventType(), [Option]) -> boolean() when + Option :: {id, integer()} | {lastId, integer()} | {callback, function()}. +disconnect(This=#wx_ref{type=ThisT,ref=_ThisRef}, EventType, Opts) -> ?CLASS(ThisT,wxEvtHandler), EvH = parse_opts(Opts, #evh{et=EventType}), case wxe_util:disconnect_cb(This, EvH) of diff --git a/lib/wx/src/gen/wxFileDataObject.erl b/lib/wx/src/gen/wxFileDataObject.erl index 2fcfbd5374..3349005821 100644 --- a/lib/wx/src/gen/wxFileDataObject.erl +++ b/lib/wx/src/gen/wxFileDataObject.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 @@ -32,18 +32,21 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxFileDataObject/0]). %% @hidden parent_class(wxDataObject) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxFileDataObject() +-type wxFileDataObject() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxFileDataObject(). new() -> wxe_util:construct(?wxFileDataObject_new, <<>>). -%% @spec (This::wxFileDataObject(), Filename::string()) -> ok %% @doc See external documentation. +-spec addFile(This, Filename) -> ok when + This::wxFileDataObject(), Filename::string(). addFile(#wx_ref{type=ThisT,ref=ThisRef},Filename) when is_list(Filename) -> ?CLASS(ThisT,wxFileDataObject), @@ -51,15 +54,16 @@ addFile(#wx_ref{type=ThisT,ref=ThisRef},Filename) wxe_util:cast(?wxFileDataObject_AddFile, <>). -%% @spec (This::wxFileDataObject()) -> [[string()]] %% @doc See external documentation. +-spec getFilenames(This) -> [[string()]] when + This::wxFileDataObject(). getFilenames(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDataObject), wxe_util:call(?wxFileDataObject_GetFilenames, <>). -%% @spec (This::wxFileDataObject()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFileDataObject) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFileDataObject), wxe_util:destroy(?wxFileDataObject_destroy,Obj), diff --git a/lib/wx/src/gen/wxFileDialog.erl b/lib/wx/src/gen/wxFileDialog.erl index c6779927e9..b6bd7f164a 100644 --- a/lib/wx/src/gen/wxFileDialog.erl +++ b/lib/wx/src/gen/wxFileDialog.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 @@ -79,6 +79,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxFileDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -86,15 +87,25 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Parent::wxWindow:wxWindow()) -> wxFileDialog() +-type wxFileDialog() :: wx:wx_object(). %% @equiv new(Parent, []) +-spec new(Parent) -> wxFileDialog() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxFileDialog() -%% Option = {message, string()} | {defaultDir, string()} | {defaultFile, string()} | {wildCard, string()} | {style, integer()} | {pos, {X::integer(), Y::integer()}} | {sz, {W::integer(), H::integer()}} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxFileDialog() when + Parent::wxWindow:wxWindow(), + Option :: {message, string()} + | {defaultDir, string()} + | {defaultFile, string()} + | {wildCard, string()} + | {style, integer()} + | {pos, {X::integer(), Y::integer()}} + | {sz, {W::integer(), H::integer()}}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -110,64 +121,73 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxFileDialog_new, <>). -%% @spec (This::wxFileDialog()) -> string() %% @doc See external documentation. +-spec getDirectory(This) -> string() when + This::wxFileDialog(). getDirectory(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDialog), wxe_util:call(?wxFileDialog_GetDirectory, <>). -%% @spec (This::wxFileDialog()) -> string() %% @doc See external documentation. +-spec getFilename(This) -> string() when + This::wxFileDialog(). getFilename(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDialog), wxe_util:call(?wxFileDialog_GetFilename, <>). -%% @spec (This::wxFileDialog()) -> [[string()]] %% @doc See external documentation. +-spec getFilenames(This) -> [[string()]] when + This::wxFileDialog(). getFilenames(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDialog), wxe_util:call(?wxFileDialog_GetFilenames, <>). -%% @spec (This::wxFileDialog()) -> integer() %% @doc See external documentation. +-spec getFilterIndex(This) -> integer() when + This::wxFileDialog(). getFilterIndex(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDialog), wxe_util:call(?wxFileDialog_GetFilterIndex, <>). -%% @spec (This::wxFileDialog()) -> string() %% @doc See external documentation. +-spec getMessage(This) -> string() when + This::wxFileDialog(). getMessage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDialog), wxe_util:call(?wxFileDialog_GetMessage, <>). -%% @spec (This::wxFileDialog()) -> string() %% @doc See external documentation. +-spec getPath(This) -> string() when + This::wxFileDialog(). getPath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDialog), wxe_util:call(?wxFileDialog_GetPath, <>). -%% @spec (This::wxFileDialog()) -> [[string()]] %% @doc See external documentation. +-spec getPaths(This) -> [[string()]] when + This::wxFileDialog(). getPaths(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDialog), wxe_util:call(?wxFileDialog_GetPaths, <>). -%% @spec (This::wxFileDialog()) -> string() %% @doc See external documentation. +-spec getWildcard(This) -> string() when + This::wxFileDialog(). getWildcard(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDialog), wxe_util:call(?wxFileDialog_GetWildcard, <>). -%% @spec (This::wxFileDialog(), Dir::string()) -> ok %% @doc See external documentation. +-spec setDirectory(This, Dir) -> ok when + This::wxFileDialog(), Dir::string(). setDirectory(#wx_ref{type=ThisT,ref=ThisRef},Dir) when is_list(Dir) -> ?CLASS(ThisT,wxFileDialog), @@ -175,8 +195,9 @@ setDirectory(#wx_ref{type=ThisT,ref=ThisRef},Dir) wxe_util:cast(?wxFileDialog_SetDirectory, <>). -%% @spec (This::wxFileDialog(), Name::string()) -> ok %% @doc See external documentation. +-spec setFilename(This, Name) -> ok when + This::wxFileDialog(), Name::string(). setFilename(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxFileDialog), @@ -184,16 +205,18 @@ setFilename(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:cast(?wxFileDialog_SetFilename, <>). -%% @spec (This::wxFileDialog(), FilterIndex::integer()) -> ok %% @doc See external documentation. +-spec setFilterIndex(This, FilterIndex) -> ok when + This::wxFileDialog(), FilterIndex::integer(). setFilterIndex(#wx_ref{type=ThisT,ref=ThisRef},FilterIndex) when is_integer(FilterIndex) -> ?CLASS(ThisT,wxFileDialog), wxe_util:cast(?wxFileDialog_SetFilterIndex, <>). -%% @spec (This::wxFileDialog(), Message::string()) -> ok %% @doc See external documentation. +-spec setMessage(This, Message) -> ok when + This::wxFileDialog(), Message::string(). setMessage(#wx_ref{type=ThisT,ref=ThisRef},Message) when is_list(Message) -> ?CLASS(ThisT,wxFileDialog), @@ -201,8 +224,9 @@ setMessage(#wx_ref{type=ThisT,ref=ThisRef},Message) wxe_util:cast(?wxFileDialog_SetMessage, <>). -%% @spec (This::wxFileDialog(), Path::string()) -> ok %% @doc See external documentation. +-spec setPath(This, Path) -> ok when + This::wxFileDialog(), Path::string(). setPath(#wx_ref{type=ThisT,ref=ThisRef},Path) when is_list(Path) -> ?CLASS(ThisT,wxFileDialog), @@ -210,8 +234,9 @@ setPath(#wx_ref{type=ThisT,ref=ThisRef},Path) wxe_util:cast(?wxFileDialog_SetPath, <>). -%% @spec (This::wxFileDialog(), WildCard::string()) -> ok %% @doc See external documentation. +-spec setWildcard(This, WildCard) -> ok when + This::wxFileDialog(), WildCard::string(). setWildcard(#wx_ref{type=ThisT,ref=ThisRef},WildCard) when is_list(WildCard) -> ?CLASS(ThisT,wxFileDialog), @@ -219,8 +244,8 @@ setWildcard(#wx_ref{type=ThisT,ref=ThisRef},WildCard) wxe_util:cast(?wxFileDialog_SetWildcard, <>). -%% @spec (This::wxFileDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFileDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFileDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxFileDirPickerEvent.erl b/lib/wx/src/gen/wxFileDirPickerEvent.erl index cc4880b88c..1ed803ea74 100644 --- a/lib/wx/src/gen/wxFileDirPickerEvent.erl +++ b/lib/wx/src/gen/wxFileDirPickerEvent.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,13 +40,16 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxFileDirPickerEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxFileDirPickerEvent()) -> string() +-type wxFileDirPickerEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getPath(This) -> string() when + This::wxFileDirPickerEvent(). getPath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFileDirPickerEvent), wxe_util:call(?wxFileDirPickerEvent_GetPath, diff --git a/lib/wx/src/gen/wxFilePickerCtrl.erl b/lib/wx/src/gen/wxFilePickerCtrl.erl index 93bfa72380..456483ec55 100644 --- a/lib/wx/src/gen/wxFilePickerCtrl.erl +++ b/lib/wx/src/gen/wxFilePickerCtrl.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,6 +74,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxFilePickerCtrl/0]). %% @hidden parent_class(wxPickerBase) -> true; parent_class(wxControl) -> true; @@ -81,21 +82,31 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxFilePickerCtrl() +-type wxFilePickerCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxFilePickerCtrl(). new() -> wxe_util:construct(?wxFilePickerCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxFilePickerCtrl() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxFilePickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxFilePickerCtrl() -%% Option = {path, string()} | {message, string()} | {wildcard, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxFilePickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {path, string()} + | {message, string()} + | {wildcard, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -111,15 +122,24 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxFilePickerCtrl_new_3, <>). -%% @spec (This::wxFilePickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxFilePickerCtrl(), 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::wxFilePickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {path, string()} | {message, string()} | {wildcard, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxFilePickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {path, string()} + | {message, string()} + | {wildcard, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxFilePickerCtrl), @@ -136,15 +156,17 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxFilePickerCtrl_Create, <>). -%% @spec (This::wxFilePickerCtrl()) -> string() %% @doc See external documentation. +-spec getPath(This) -> string() when + This::wxFilePickerCtrl(). getPath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFilePickerCtrl), wxe_util:call(?wxFilePickerCtrl_GetPath, <>). -%% @spec (This::wxFilePickerCtrl(), Str::string()) -> ok %% @doc See external documentation. +-spec setPath(This, Str) -> ok when + This::wxFilePickerCtrl(), Str::string(). setPath(#wx_ref{type=ThisT,ref=ThisRef},Str) when is_list(Str) -> ?CLASS(ThisT,wxFilePickerCtrl), @@ -152,8 +174,8 @@ setPath(#wx_ref{type=ThisT,ref=ThisRef},Str) wxe_util:cast(?wxFilePickerCtrl_SetPath, <>). -%% @spec (This::wxFilePickerCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFilePickerCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFilePickerCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxFindReplaceData.erl b/lib/wx/src/gen/wxFindReplaceData.erl index 52eafa8398..fbc207b758 100644 --- a/lib/wx/src/gen/wxFindReplaceData.erl +++ b/lib/wx/src/gen/wxFindReplaceData.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 @@ -30,53 +30,61 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxFindReplaceData/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxFindReplaceData() +-type wxFindReplaceData() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxFindReplaceData(). new() -> wxe_util:construct(?wxFindReplaceData_new_0, <<>>). -%% @spec (Flags::integer()) -> wxFindReplaceData() %% @doc See external documentation. +-spec new(Flags) -> wxFindReplaceData() when + Flags::integer(). new(Flags) when is_integer(Flags) -> wxe_util:construct(?wxFindReplaceData_new_1, <>). -%% @spec (This::wxFindReplaceData()) -> string() %% @doc See external documentation. +-spec getFindString(This) -> string() when + This::wxFindReplaceData(). getFindString(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFindReplaceData), wxe_util:call(?wxFindReplaceData_GetFindString, <>). -%% @spec (This::wxFindReplaceData()) -> string() %% @doc See external documentation. +-spec getReplaceString(This) -> string() when + This::wxFindReplaceData(). getReplaceString(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFindReplaceData), wxe_util:call(?wxFindReplaceData_GetReplaceString, <>). -%% @spec (This::wxFindReplaceData()) -> integer() %% @doc See external documentation. +-spec getFlags(This) -> integer() when + This::wxFindReplaceData(). getFlags(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFindReplaceData), wxe_util:call(?wxFindReplaceData_GetFlags, <>). -%% @spec (This::wxFindReplaceData(), Flags::integer()) -> ok %% @doc See external documentation. +-spec setFlags(This, Flags) -> ok when + This::wxFindReplaceData(), Flags::integer(). setFlags(#wx_ref{type=ThisT,ref=ThisRef},Flags) when is_integer(Flags) -> ?CLASS(ThisT,wxFindReplaceData), wxe_util:cast(?wxFindReplaceData_SetFlags, <>). -%% @spec (This::wxFindReplaceData(), Str::string()) -> ok %% @doc See external documentation. +-spec setFindString(This, Str) -> ok when + This::wxFindReplaceData(), Str::string(). setFindString(#wx_ref{type=ThisT,ref=ThisRef},Str) when is_list(Str) -> ?CLASS(ThisT,wxFindReplaceData), @@ -84,8 +92,9 @@ setFindString(#wx_ref{type=ThisT,ref=ThisRef},Str) wxe_util:cast(?wxFindReplaceData_SetFindString, <>). -%% @spec (This::wxFindReplaceData(), Str::string()) -> ok %% @doc See external documentation. +-spec setReplaceString(This, Str) -> ok when + This::wxFindReplaceData(), Str::string(). setReplaceString(#wx_ref{type=ThisT,ref=ThisRef},Str) when is_list(Str) -> ?CLASS(ThisT,wxFindReplaceData), @@ -93,8 +102,8 @@ setReplaceString(#wx_ref{type=ThisT,ref=ThisRef},Str) wxe_util:cast(?wxFindReplaceData_SetReplaceString, <>). -%% @spec (This::wxFindReplaceData()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFindReplaceData) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFindReplaceData), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxFindReplaceDialog.erl b/lib/wx/src/gen/wxFindReplaceDialog.erl index b37fd41831..cef41e6d20 100644 --- a/lib/wx/src/gen/wxFindReplaceDialog.erl +++ b/lib/wx/src/gen/wxFindReplaceDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxFindReplaceDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,21 +85,25 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxFindReplaceDialog() +-type wxFindReplaceDialog() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxFindReplaceDialog(). new() -> wxe_util:construct(?wxFindReplaceDialog_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Data::wxFindReplaceData:wxFindReplaceData(), Title::string()) -> wxFindReplaceDialog() %% @equiv new(Parent,Data,Title, []) +-spec new(Parent, Data, Title) -> wxFindReplaceDialog() when + Parent::wxWindow:wxWindow(), Data::wxFindReplaceData:wxFindReplaceData(), Title::string(). + new(Parent,Data,Title) when is_record(Parent, wx_ref),is_record(Data, wx_ref),is_list(Title) -> new(Parent,Data,Title, []). -%% @spec (Parent::wxWindow:wxWindow(), Data::wxFindReplaceData:wxFindReplaceData(), Title::string(), [Option]) -> wxFindReplaceDialog() -%% Option = {style, integer()} %% @doc See external documentation. +-spec new(Parent, Data, Title, [Option]) -> wxFindReplaceDialog() when + Parent::wxWindow:wxWindow(), Data::wxFindReplaceData:wxFindReplaceData(), Title::string(), + Option :: {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=DataT,ref=DataRef},Title, Options) when is_list(Title),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -110,15 +115,18 @@ new(#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=DataT,ref=DataRef},Title, O wxe_util:construct(?wxFindReplaceDialog_new_4, <>). -%% @spec (This::wxFindReplaceDialog(), Parent::wxWindow:wxWindow(), Data::wxFindReplaceData:wxFindReplaceData(), Title::string()) -> bool() %% @equiv create(This,Parent,Data,Title, []) +-spec create(This, Parent, Data, Title) -> boolean() when + This::wxFindReplaceDialog(), Parent::wxWindow:wxWindow(), Data::wxFindReplaceData:wxFindReplaceData(), Title::string(). + create(This,Parent,Data,Title) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_record(Data, wx_ref),is_list(Title) -> create(This,Parent,Data,Title, []). -%% @spec (This::wxFindReplaceDialog(), Parent::wxWindow:wxWindow(), Data::wxFindReplaceData:wxFindReplaceData(), Title::string(), [Option]) -> bool() -%% Option = {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Data, Title, [Option]) -> boolean() when + This::wxFindReplaceDialog(), Parent::wxWindow:wxWindow(), Data::wxFindReplaceData:wxFindReplaceData(), Title::string(), + Option :: {style, integer()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=DataT,ref=DataRef},Title, Options) when is_list(Title),is_list(Options) -> ?CLASS(ThisT,wxFindReplaceDialog), @@ -131,15 +139,16 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},#wx_r wxe_util:call(?wxFindReplaceDialog_Create, <>). -%% @spec (This::wxFindReplaceDialog()) -> wxFindReplaceData:wxFindReplaceData() %% @doc See external documentation. +-spec getData(This) -> wxFindReplaceData:wxFindReplaceData() when + This::wxFindReplaceDialog(). getData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFindReplaceDialog), wxe_util:call(?wxFindReplaceDialog_GetData, <>). -%% @spec (This::wxFindReplaceDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFindReplaceDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFindReplaceDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxFlexGridSizer.erl b/lib/wx/src/gen/wxFlexGridSizer.erl index 910cc78894..d22ae74015 100644 --- a/lib/wx/src/gen/wxFlexGridSizer.erl +++ b/lib/wx/src/gen/wxFlexGridSizer.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 @@ -45,20 +45,26 @@ setMinSize/2,setMinSize/3,setRows/2,setSizeHints/2,setVGap/2,setVirtualSizeHints/2, show/2,show/3]). +-export_type([wxFlexGridSizer/0]). %% @hidden parent_class(wxGridSizer) -> true; parent_class(wxSizer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Cols::integer()) -> wxFlexGridSizer() +-type wxFlexGridSizer() :: wx:wx_object(). %% @equiv new(Cols, []) +-spec new(Cols) -> wxFlexGridSizer() when + Cols::integer(). + new(Cols) when is_integer(Cols) -> new(Cols, []). -%% @spec (Cols::integer(), [Option]) -> wxFlexGridSizer() -%% Option = {vgap, integer()} | {hgap, integer()} %% @doc See external documentation. +-spec new(Cols, [Option]) -> wxFlexGridSizer() when + Cols::integer(), + Option :: {vgap, integer()} + | {hgap, integer()}. new(Cols, Options) when is_integer(Cols),is_list(Options) -> MOpts = fun({vgap, Vgap}, Acc) -> [<<1:32/?UI,Vgap:32/?UI>>|Acc]; @@ -68,22 +74,26 @@ new(Cols, Options) wxe_util:construct(?wxFlexGridSizer_new_2, <>). -%% @spec (Rows::integer(), Cols::integer(), Vgap::integer(), Hgap::integer()) -> wxFlexGridSizer() %% @doc See external documentation. +-spec new(Rows, Cols, Vgap, Hgap) -> wxFlexGridSizer() when + Rows::integer(), Cols::integer(), Vgap::integer(), Hgap::integer(). new(Rows,Cols,Vgap,Hgap) when is_integer(Rows),is_integer(Cols),is_integer(Vgap),is_integer(Hgap) -> wxe_util:construct(?wxFlexGridSizer_new_4, <>). -%% @spec (This::wxFlexGridSizer(), Idx::integer()) -> ok %% @equiv addGrowableCol(This,Idx, []) +-spec addGrowableCol(This, Idx) -> ok when + This::wxFlexGridSizer(), Idx::integer(). + addGrowableCol(This,Idx) when is_record(This, wx_ref),is_integer(Idx) -> addGrowableCol(This,Idx, []). -%% @spec (This::wxFlexGridSizer(), Idx::integer(), [Option]) -> ok -%% Option = {proportion, integer()} %% @doc See external documentation. +-spec addGrowableCol(This, Idx, [Option]) -> ok when + This::wxFlexGridSizer(), Idx::integer(), + Option :: {proportion, integer()}. addGrowableCol(#wx_ref{type=ThisT,ref=ThisRef},Idx, Options) when is_integer(Idx),is_list(Options) -> ?CLASS(ThisT,wxFlexGridSizer), @@ -93,15 +103,18 @@ addGrowableCol(#wx_ref{type=ThisT,ref=ThisRef},Idx, Options) wxe_util:cast(?wxFlexGridSizer_AddGrowableCol, <>). -%% @spec (This::wxFlexGridSizer(), Idx::integer()) -> ok %% @equiv addGrowableRow(This,Idx, []) +-spec addGrowableRow(This, Idx) -> ok when + This::wxFlexGridSizer(), Idx::integer(). + addGrowableRow(This,Idx) when is_record(This, wx_ref),is_integer(Idx) -> addGrowableRow(This,Idx, []). -%% @spec (This::wxFlexGridSizer(), Idx::integer(), [Option]) -> ok -%% Option = {proportion, integer()} %% @doc See external documentation. +-spec addGrowableRow(This, Idx, [Option]) -> ok when + This::wxFlexGridSizer(), Idx::integer(), + Option :: {proportion, integer()}. addGrowableRow(#wx_ref{type=ThisT,ref=ThisRef},Idx, Options) when is_integer(Idx),is_list(Options) -> ?CLASS(ThisT,wxFlexGridSizer), @@ -111,58 +124,62 @@ addGrowableRow(#wx_ref{type=ThisT,ref=ThisRef},Idx, Options) wxe_util:cast(?wxFlexGridSizer_AddGrowableRow, <>). -%% @spec (This::wxFlexGridSizer()) -> integer() %% @doc See external documentation. +-spec getFlexibleDirection(This) -> integer() when + This::wxFlexGridSizer(). getFlexibleDirection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFlexGridSizer), wxe_util:call(?wxFlexGridSizer_GetFlexibleDirection, <>). -%% @spec (This::wxFlexGridSizer()) -> WxFlexSizerGrowMode -%% WxFlexSizerGrowMode = integer() %% @doc See external documentation. -%%
WxFlexSizerGrowMode is one of ?wxFLEX_GROWMODE_NONE | ?wxFLEX_GROWMODE_SPECIFIED | ?wxFLEX_GROWMODE_ALL +%%
Res = ?wxFLEX_GROWMODE_NONE | ?wxFLEX_GROWMODE_SPECIFIED | ?wxFLEX_GROWMODE_ALL +-spec getNonFlexibleGrowMode(This) -> wx:wx_enum() when + This::wxFlexGridSizer(). getNonFlexibleGrowMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFlexGridSizer), wxe_util:call(?wxFlexGridSizer_GetNonFlexibleGrowMode, <>). -%% @spec (This::wxFlexGridSizer(), Idx::integer()) -> ok %% @doc See external documentation. +-spec removeGrowableCol(This, Idx) -> ok when + This::wxFlexGridSizer(), Idx::integer(). removeGrowableCol(#wx_ref{type=ThisT,ref=ThisRef},Idx) when is_integer(Idx) -> ?CLASS(ThisT,wxFlexGridSizer), wxe_util:cast(?wxFlexGridSizer_RemoveGrowableCol, <>). -%% @spec (This::wxFlexGridSizer(), Idx::integer()) -> ok %% @doc See external documentation. +-spec removeGrowableRow(This, Idx) -> ok when + This::wxFlexGridSizer(), Idx::integer(). removeGrowableRow(#wx_ref{type=ThisT,ref=ThisRef},Idx) when is_integer(Idx) -> ?CLASS(ThisT,wxFlexGridSizer), wxe_util:cast(?wxFlexGridSizer_RemoveGrowableRow, <>). -%% @spec (This::wxFlexGridSizer(), Direction::integer()) -> ok %% @doc See external documentation. +-spec setFlexibleDirection(This, Direction) -> ok when + This::wxFlexGridSizer(), Direction::integer(). setFlexibleDirection(#wx_ref{type=ThisT,ref=ThisRef},Direction) when is_integer(Direction) -> ?CLASS(ThisT,wxFlexGridSizer), wxe_util:cast(?wxFlexGridSizer_SetFlexibleDirection, <>). -%% @spec (This::wxFlexGridSizer(), Mode::WxFlexSizerGrowMode) -> ok -%% WxFlexSizerGrowMode = integer() %% @doc See external documentation. -%%
WxFlexSizerGrowMode is one of ?wxFLEX_GROWMODE_NONE | ?wxFLEX_GROWMODE_SPECIFIED | ?wxFLEX_GROWMODE_ALL +%%
Mode = ?wxFLEX_GROWMODE_NONE | ?wxFLEX_GROWMODE_SPECIFIED | ?wxFLEX_GROWMODE_ALL +-spec setNonFlexibleGrowMode(This, Mode) -> ok when + This::wxFlexGridSizer(), Mode::wx:wx_enum(). setNonFlexibleGrowMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) when is_integer(Mode) -> ?CLASS(ThisT,wxFlexGridSizer), wxe_util:cast(?wxFlexGridSizer_SetNonFlexibleGrowMode, <>). -%% @spec (This::wxFlexGridSizer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFlexGridSizer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFlexGridSizer), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxFocusEvent.erl b/lib/wx/src/gen/wxFocusEvent.erl index 46f2e2a3df..d6478c1142 100644 --- a/lib/wx/src/gen/wxFocusEvent.erl +++ b/lib/wx/src/gen/wxFocusEvent.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 @@ -37,12 +37,15 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxFocusEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxFocusEvent()) -> wxWindow:wxWindow() +-type wxFocusEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getWindow(This) -> wxWindow:wxWindow() when + This::wxFocusEvent(). getWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFocusEvent), wxe_util:call(?wxFocusEvent_GetWindow, diff --git a/lib/wx/src/gen/wxFont.erl b/lib/wx/src/gen/wxFont.erl index 4afc53cfa8..dc8c738b49 100644 --- a/lib/wx/src/gen/wxFont.erl +++ b/lib/wx/src/gen/wxFont.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 @@ -33,38 +33,43 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxFont/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxFont() +-type wxFont() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxFont(). new() -> wxe_util:construct(?wxFont_new_0, <<>>). -%% @spec (Fontname::string()) -> wxFont() %% @doc See external documentation. +-spec new(Fontname) -> wxFont() when + Fontname::string(). new(Fontname) when is_list(Fontname) -> Fontname_UC = unicode:characters_to_binary([Fontname,0]), wxe_util:construct(?wxFont_new_1, <<(byte_size(Fontname_UC)):32/?UI,(Fontname_UC)/binary, 0:(((8- ((4+byte_size(Fontname_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (Size::integer(), Family::WxFontFamily, Style::WxFontStyle, Weight::integer()) -> wxFont() %% @equiv new(Size,Family,Style,Weight, []) +-spec new(Size, Family, Style, Weight) -> wxFont() when + Size::integer(), Family::wx:wx_enum(), Style::wx:wx_enum(), Weight::integer(). + new(Size,Family,Style,Weight) when is_integer(Size),is_integer(Family),is_integer(Style),is_integer(Weight) -> new(Size,Family,Style,Weight, []). -%% @spec (Size::integer(), Family::WxFontFamily, Style::WxFontStyle, Weight::integer(), [Option]) -> wxFont() -%% Option = {underlined, bool()} | {face, string()} | {encoding, WxFontEncoding} -%% WxFontFamily = integer() -%% WxFontStyle = integer() -%% WxFontEncoding = integer() %% @doc See external documentation. -%%
WxFontFamily is one of ?wxFONTFAMILY_DEFAULT | ?wxFONTFAMILY_DECORATIVE | ?wxFONTFAMILY_ROMAN | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS | ?wxFONTFAMILY_MODERN | ?wxFONTFAMILY_TELETYPE | ?wxFONTFAMILY_MAX | ?wxFONTFAMILY_UNKNOWN -%%
WxFontStyle is one of ?wxFONTSTYLE_NORMAL | ?wxFONTSTYLE_ITALIC | ?wxFONTSTYLE_SLANT | ?wxFONTSTYLE_MAX -%%
WxFontEncoding is one of ?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()} + | {face, string()} + | {encoding, wx:wx_enum()}. new(Size,Family,Style,Weight, Options) when is_integer(Size),is_integer(Family),is_integer(Style),is_integer(Weight),is_list(Options) -> MOpts = fun({underlined, Underlined}, Acc) -> [<<1:32/?UI,(wxe_util:from_bool(Underlined)):32/?UI>>|Acc]; @@ -75,99 +80,107 @@ new(Size,Family,Style,Weight, Options) wxe_util:construct(?wxFont_new_5, <>). -%% @spec (This::wxFont()) -> bool() %% @doc See external documentation. +-spec isFixedWidth(This) -> boolean() when + This::wxFont(). isFixedWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_IsFixedWidth, <>). -%% @spec () -> WxFontEncoding -%% WxFontEncoding = integer() %% @doc See external documentation. -%%
WxFontEncoding is one of ?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 +%%
Res = ?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 getDefaultEncoding() -> wx:wx_enum(). getDefaultEncoding() -> wxe_util:call(?wxFont_GetDefaultEncoding, <<>>). -%% @spec (This::wxFont()) -> string() %% @doc See external documentation. +-spec getFaceName(This) -> string() when + This::wxFont(). getFaceName(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_GetFaceName, <>). -%% @spec (This::wxFont()) -> WxFontFamily -%% WxFontFamily = integer() %% @doc See external documentation. -%%
WxFontFamily is one of ?wxFONTFAMILY_DEFAULT | ?wxFONTFAMILY_DECORATIVE | ?wxFONTFAMILY_ROMAN | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS | ?wxFONTFAMILY_MODERN | ?wxFONTFAMILY_TELETYPE | ?wxFONTFAMILY_MAX | ?wxFONTFAMILY_UNKNOWN +%%
Res = ?wxFONTFAMILY_DEFAULT | ?wxFONTFAMILY_DECORATIVE | ?wxFONTFAMILY_ROMAN | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS | ?wxFONTFAMILY_MODERN | ?wxFONTFAMILY_TELETYPE | ?wxFONTFAMILY_MAX | ?wxFONTFAMILY_UNKNOWN +-spec getFamily(This) -> wx:wx_enum() when + This::wxFont(). getFamily(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_GetFamily, <>). -%% @spec (This::wxFont()) -> string() %% @doc See external documentation. +-spec getNativeFontInfoDesc(This) -> string() when + This::wxFont(). getNativeFontInfoDesc(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_GetNativeFontInfoDesc, <>). -%% @spec (This::wxFont()) -> string() %% @doc See external documentation. +-spec getNativeFontInfoUserDesc(This) -> string() when + This::wxFont(). getNativeFontInfoUserDesc(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_GetNativeFontInfoUserDesc, <>). -%% @spec (This::wxFont()) -> integer() %% @doc See external documentation. +-spec getPointSize(This) -> integer() when + This::wxFont(). getPointSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_GetPointSize, <>). -%% @spec (This::wxFont()) -> WxFontStyle -%% WxFontStyle = integer() %% @doc See external documentation. -%%
WxFontStyle is one of ?wxFONTSTYLE_NORMAL | ?wxFONTSTYLE_ITALIC | ?wxFONTSTYLE_SLANT | ?wxFONTSTYLE_MAX +%%
Res = ?wxFONTSTYLE_NORMAL | ?wxFONTSTYLE_ITALIC | ?wxFONTSTYLE_SLANT | ?wxFONTSTYLE_MAX +-spec getStyle(This) -> wx:wx_enum() when + This::wxFont(). getStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_GetStyle, <>). -%% @spec (This::wxFont()) -> bool() %% @doc See external documentation. +-spec getUnderlined(This) -> boolean() when + This::wxFont(). getUnderlined(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_GetUnderlined, <>). -%% @spec (This::wxFont()) -> integer() %% @doc See external documentation. +-spec getWeight(This) -> integer() when + This::wxFont(). getWeight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_GetWeight, <>). -%% @spec (This::wxFont()) -> bool() %% @doc See external documentation. +-spec ok(This) -> boolean() when + This::wxFont(). ok(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFont), wxe_util:call(?wxFont_Ok, <>). -%% @spec (Encoding::WxFontEncoding) -> ok -%% WxFontEncoding = integer() %% @doc See external documentation. -%%
WxFontEncoding is one of ?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 +%%
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 setDefaultEncoding(Encoding) -> ok when + Encoding::wx:wx_enum(). setDefaultEncoding(Encoding) when is_integer(Encoding) -> wxe_util:cast(?wxFont_SetDefaultEncoding, <>). -%% @spec (This::wxFont(), FaceName::string()) -> bool() %% @doc See external documentation. +-spec setFaceName(This, FaceName) -> boolean() when + This::wxFont(), FaceName::string(). setFaceName(#wx_ref{type=ThisT,ref=ThisRef},FaceName) when is_list(FaceName) -> ?CLASS(ThisT,wxFont), @@ -175,52 +188,55 @@ setFaceName(#wx_ref{type=ThisT,ref=ThisRef},FaceName) wxe_util:call(?wxFont_SetFaceName, <>). -%% @spec (This::wxFont(), Family::WxFontFamily) -> ok -%% WxFontFamily = integer() %% @doc See external documentation. -%%
WxFontFamily is one of ?wxFONTFAMILY_DEFAULT | ?wxFONTFAMILY_DECORATIVE | ?wxFONTFAMILY_ROMAN | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS | ?wxFONTFAMILY_MODERN | ?wxFONTFAMILY_TELETYPE | ?wxFONTFAMILY_MAX | ?wxFONTFAMILY_UNKNOWN +%%
Family = ?wxFONTFAMILY_DEFAULT | ?wxFONTFAMILY_DECORATIVE | ?wxFONTFAMILY_ROMAN | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS | ?wxFONTFAMILY_MODERN | ?wxFONTFAMILY_TELETYPE | ?wxFONTFAMILY_MAX | ?wxFONTFAMILY_UNKNOWN +-spec setFamily(This, Family) -> ok when + This::wxFont(), Family::wx:wx_enum(). setFamily(#wx_ref{type=ThisT,ref=ThisRef},Family) when is_integer(Family) -> ?CLASS(ThisT,wxFont), wxe_util:cast(?wxFont_SetFamily, <>). -%% @spec (This::wxFont(), PointSize::integer()) -> ok %% @doc See external documentation. +-spec setPointSize(This, PointSize) -> ok when + This::wxFont(), PointSize::integer(). setPointSize(#wx_ref{type=ThisT,ref=ThisRef},PointSize) when is_integer(PointSize) -> ?CLASS(ThisT,wxFont), wxe_util:cast(?wxFont_SetPointSize, <>). -%% @spec (This::wxFont(), Style::WxFontStyle) -> ok -%% WxFontStyle = integer() %% @doc See external documentation. -%%
WxFontStyle is one of ?wxFONTSTYLE_NORMAL | ?wxFONTSTYLE_ITALIC | ?wxFONTSTYLE_SLANT | ?wxFONTSTYLE_MAX +%%
Style = ?wxFONTSTYLE_NORMAL | ?wxFONTSTYLE_ITALIC | ?wxFONTSTYLE_SLANT | ?wxFONTSTYLE_MAX +-spec setStyle(This, Style) -> ok when + This::wxFont(), Style::wx:wx_enum(). setStyle(#wx_ref{type=ThisT,ref=ThisRef},Style) when is_integer(Style) -> ?CLASS(ThisT,wxFont), wxe_util:cast(?wxFont_SetStyle, <>). -%% @spec (This::wxFont(), Underlined::bool()) -> ok %% @doc See external documentation. +-spec setUnderlined(This, Underlined) -> ok when + This::wxFont(), Underlined::boolean(). setUnderlined(#wx_ref{type=ThisT,ref=ThisRef},Underlined) when is_boolean(Underlined) -> ?CLASS(ThisT,wxFont), wxe_util:cast(?wxFont_SetUnderlined, <>). -%% @spec (This::wxFont(), Weight::integer()) -> ok %% @doc See external documentation. +-spec setWeight(This, Weight) -> ok when + This::wxFont(), Weight::integer(). setWeight(#wx_ref{type=ThisT,ref=ThisRef},Weight) when is_integer(Weight) -> ?CLASS(ThisT,wxFont), wxe_util:cast(?wxFont_SetWeight, <>). -%% @spec (This::wxFont()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFont) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFont), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxFontData.erl b/lib/wx/src/gen/wxFontData.erl index 33015b7ca9..df8e734000 100644 --- a/lib/wx/src/gen/wxFontData.erl +++ b/lib/wx/src/gen/wxFontData.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 @@ -31,122 +31,138 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxFontData/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxFontData() +-type wxFontData() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxFontData(). new() -> wxe_util:construct(?wxFontData_new_0, <<>>). -%% @spec (Data::wxFontData()) -> wxFontData() %% @doc See external documentation. +-spec new(Data) -> wxFontData() when + Data::wxFontData(). new(#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(DataT,wxFontData), wxe_util:construct(?wxFontData_new_1, <>). -%% @spec (This::wxFontData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enableEffects(This, Flag) -> ok when + This::wxFontData(), Flag::boolean(). enableEffects(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxFontData), wxe_util:cast(?wxFontData_EnableEffects, <>). -%% @spec (This::wxFontData()) -> bool() %% @doc See external documentation. +-spec getAllowSymbols(This) -> boolean() when + This::wxFontData(). getAllowSymbols(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontData), wxe_util:call(?wxFontData_GetAllowSymbols, <>). -%% @spec (This::wxFontData()) -> wx:colour() %% @doc See external documentation. +-spec getColour(This) -> wx:wx_colour() when + This::wxFontData(). getColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontData), wxe_util:call(?wxFontData_GetColour, <>). -%% @spec (This::wxFontData()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getChosenFont(This) -> wxFont:wxFont() when + This::wxFontData(). getChosenFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontData), wxe_util:call(?wxFontData_GetChosenFont, <>). -%% @spec (This::wxFontData()) -> bool() %% @doc See external documentation. +-spec getEnableEffects(This) -> boolean() when + This::wxFontData(). getEnableEffects(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontData), wxe_util:call(?wxFontData_GetEnableEffects, <>). -%% @spec (This::wxFontData()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getInitialFont(This) -> wxFont:wxFont() when + This::wxFontData(). getInitialFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontData), wxe_util:call(?wxFontData_GetInitialFont, <>). -%% @spec (This::wxFontData()) -> bool() %% @doc See external documentation. +-spec getShowHelp(This) -> boolean() when + This::wxFontData(). getShowHelp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontData), wxe_util:call(?wxFontData_GetShowHelp, <>). -%% @spec (This::wxFontData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec setAllowSymbols(This, Flag) -> ok when + This::wxFontData(), Flag::boolean(). setAllowSymbols(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxFontData), wxe_util:cast(?wxFontData_SetAllowSymbols, <>). -%% @spec (This::wxFontData(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setChosenFont(This, Font) -> ok when + This::wxFontData(), Font::wxFont:wxFont(). setChosenFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxFontData), ?CLASS(FontT,wxFont), wxe_util:cast(?wxFontData_SetChosenFont, <>). -%% @spec (This::wxFontData(), Colour::wx:colour()) -> ok %% @doc See external documentation. +-spec setColour(This, Colour) -> ok when + This::wxFontData(), Colour::wx:wx_colour(). setColour(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxFontData), wxe_util:cast(?wxFontData_SetColour, <>). -%% @spec (This::wxFontData(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setInitialFont(This, Font) -> ok when + This::wxFontData(), Font::wxFont:wxFont(). setInitialFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxFontData), ?CLASS(FontT,wxFont), wxe_util:cast(?wxFontData_SetInitialFont, <>). -%% @spec (This::wxFontData(), MinRange::integer(), MaxRange::integer()) -> ok %% @doc See external documentation. +-spec setRange(This, MinRange, MaxRange) -> ok when + This::wxFontData(), MinRange::integer(), MaxRange::integer(). setRange(#wx_ref{type=ThisT,ref=ThisRef},MinRange,MaxRange) when is_integer(MinRange),is_integer(MaxRange) -> ?CLASS(ThisT,wxFontData), wxe_util:cast(?wxFontData_SetRange, <>). -%% @spec (This::wxFontData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec setShowHelp(This, Flag) -> ok when + This::wxFontData(), Flag::boolean(). setShowHelp(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxFontData), wxe_util:cast(?wxFontData_SetShowHelp, <>). -%% @spec (This::wxFontData()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFontData) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFontData), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxFontDialog.erl b/lib/wx/src/gen/wxFontDialog.erl index 357bfe532d..ad061055da 100644 --- a/lib/wx/src/gen/wxFontDialog.erl +++ b/lib/wx/src/gen/wxFontDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxFontDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,22 +85,25 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxFontDialog() +-type wxFontDialog() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxFontDialog(). new() -> wxe_util:construct(?wxFontDialog_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Data::wxFontData:wxFontData()) -> wxFontDialog() %% @doc See external documentation. +-spec new(Parent, Data) -> wxFontDialog() when + Parent::wxWindow:wxWindow(), Data::wxFontData:wxFontData(). new(#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(ParentT,wxWindow), ?CLASS(DataT,wxFontData), wxe_util:construct(?wxFontDialog_new_2, <>). -%% @spec (This::wxFontDialog(), Parent::wxWindow:wxWindow(), Data::wxFontData:wxFontData()) -> bool() %% @doc See external documentation. +-spec create(This, Parent, Data) -> boolean() when + This::wxFontDialog(), Parent::wxWindow:wxWindow(), Data::wxFontData:wxFontData(). create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(ThisT,wxFontDialog), ?CLASS(ParentT,wxWindow), @@ -107,15 +111,16 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},#wx_r wxe_util:call(?wxFontDialog_Create, <>). -%% @spec (This::wxFontDialog()) -> wxFontData:wxFontData() %% @doc See external documentation. +-spec getFontData(This) -> wxFontData:wxFontData() when + This::wxFontDialog(). getFontData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontDialog), wxe_util:call(?wxFontDialog_GetFontData, <>). -%% @spec (This::wxFontDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFontDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFontDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxFontPickerCtrl.erl b/lib/wx/src/gen/wxFontPickerCtrl.erl index 3050011b60..01be91239c 100644 --- a/lib/wx/src/gen/wxFontPickerCtrl.erl +++ b/lib/wx/src/gen/wxFontPickerCtrl.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 @@ -75,6 +75,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxFontPickerCtrl/0]). %% @hidden parent_class(wxPickerBase) -> true; parent_class(wxControl) -> true; @@ -82,21 +83,29 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxFontPickerCtrl() +-type wxFontPickerCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxFontPickerCtrl(). new() -> wxe_util:construct(?wxFontPickerCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxFontPickerCtrl() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxFontPickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxFontPickerCtrl() -%% Option = {initial, wxFont:wxFont()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxFontPickerCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {initial, wxFont:wxFont()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -110,15 +119,22 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxFontPickerCtrl_new_3, <>). -%% @spec (This::wxFontPickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxFontPickerCtrl(), 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::wxFontPickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {initial, wxFont:wxFont()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxFontPickerCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {initial, wxFont:wxFont()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxFontPickerCtrl), @@ -133,38 +149,42 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxFontPickerCtrl_Create, <>). -%% @spec (This::wxFontPickerCtrl()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getSelectedFont(This) -> wxFont:wxFont() when + This::wxFontPickerCtrl(). getSelectedFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontPickerCtrl), wxe_util:call(?wxFontPickerCtrl_GetSelectedFont, <>). -%% @spec (This::wxFontPickerCtrl(), F::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setSelectedFont(This, F) -> ok when + This::wxFontPickerCtrl(), F::wxFont:wxFont(). setSelectedFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FT,ref=FRef}) -> ?CLASS(ThisT,wxFontPickerCtrl), ?CLASS(FT,wxFont), wxe_util:cast(?wxFontPickerCtrl_SetSelectedFont, <>). -%% @spec (This::wxFontPickerCtrl()) -> integer() %% @doc See external documentation. +-spec getMaxPointSize(This) -> integer() when + This::wxFontPickerCtrl(). getMaxPointSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontPickerCtrl), wxe_util:call(?wxFontPickerCtrl_GetMaxPointSize, <>). -%% @spec (This::wxFontPickerCtrl(), Max::integer()) -> ok %% @doc See external documentation. +-spec setMaxPointSize(This, Max) -> ok when + This::wxFontPickerCtrl(), Max::integer(). setMaxPointSize(#wx_ref{type=ThisT,ref=ThisRef},Max) when is_integer(Max) -> ?CLASS(ThisT,wxFontPickerCtrl), wxe_util:cast(?wxFontPickerCtrl_SetMaxPointSize, <>). -%% @spec (This::wxFontPickerCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFontPickerCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFontPickerCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxFontPickerEvent.erl b/lib/wx/src/gen/wxFontPickerEvent.erl index 6eb456767f..2dc3606409 100644 --- a/lib/wx/src/gen/wxFontPickerEvent.erl +++ b/lib/wx/src/gen/wxFontPickerEvent.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,13 +40,16 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxFontPickerEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxFontPickerEvent()) -> wxFont:wxFont() +-type wxFontPickerEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getFont(This) -> wxFont:wxFont() when + This::wxFontPickerEvent(). getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFontPickerEvent), wxe_util:call(?wxFontPickerEvent_GetFont, diff --git a/lib/wx/src/gen/wxFrame.erl b/lib/wx/src/gen/wxFrame.erl index 7e25bc8762..1618af137c 100644 --- a/lib/wx/src/gen/wxFrame.erl +++ b/lib/wx/src/gen/wxFrame.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 @@ -78,27 +78,34 @@ showFullScreen/3,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxFrame/0]). %% @hidden parent_class(wxTopLevelWindow) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxFrame() +-type wxFrame() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxFrame(). new() -> wxe_util:construct(?wxFrame_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string()) -> wxFrame() %% @equiv new(Parent,Id,Title, []) +-spec new(Parent, Id, Title) -> wxFrame() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(). + new(Parent,Id,Title) when is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> new(Parent,Id,Title, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), [Option]) -> wxFrame() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, Title, [Option]) -> wxFrame() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -111,15 +118,20 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) wxe_util:construct(?wxFrame_new_4, <>). -%% @spec (This::wxFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string()) -> bool() %% @equiv create(This,Parent,Id,Title, []) +-spec create(This, Parent, Id, Title) -> boolean() when + This::wxFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(). + create(This,Parent,Id,Title) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> create(This,Parent,Id,Title, []). -%% @spec (This::wxFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, Title, [Option]) -> boolean() when + This::wxFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), + 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,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ThisT,wxFrame), @@ -133,15 +145,20 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Ti wxe_util:call(?wxFrame_Create, <>). -%% @spec (This::wxFrame()) -> wxStatusBar:wxStatusBar() %% @equiv createStatusBar(This, []) +-spec createStatusBar(This) -> wxStatusBar:wxStatusBar() when + This::wxFrame(). + createStatusBar(This) when is_record(This, wx_ref) -> createStatusBar(This, []). -%% @spec (This::wxFrame(), [Option]) -> wxStatusBar:wxStatusBar() -%% Option = {number, integer()} | {style, integer()} | {id, integer()} %% @doc See external documentation. +-spec createStatusBar(This, [Option]) -> wxStatusBar:wxStatusBar() when + This::wxFrame(), + Option :: {number, integer()} + | {style, integer()} + | {id, integer()}. createStatusBar(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxFrame), @@ -153,15 +170,19 @@ createStatusBar(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxFrame_CreateStatusBar, <>). -%% @spec (This::wxFrame()) -> wxToolBar:wxToolBar() %% @equiv createToolBar(This, []) +-spec createToolBar(This) -> wxToolBar:wxToolBar() when + This::wxFrame(). + createToolBar(This) when is_record(This, wx_ref) -> createToolBar(This, []). -%% @spec (This::wxFrame(), [Option]) -> wxToolBar:wxToolBar() -%% Option = {style, integer()} | {id, integer()} %% @doc See external documentation. +-spec createToolBar(This, [Option]) -> wxToolBar:wxToolBar() when + This::wxFrame(), + Option :: {style, integer()} + | {id, integer()}. createToolBar(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxFrame), @@ -172,89 +193,102 @@ createToolBar(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxFrame_CreateToolBar, <>). -%% @spec (This::wxFrame()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getClientAreaOrigin(This) -> {X::integer(), Y::integer()} when + This::wxFrame(). getClientAreaOrigin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFrame), wxe_util:call(?wxFrame_GetClientAreaOrigin, <>). -%% @spec (This::wxFrame()) -> wxMenuBar:wxMenuBar() %% @doc See external documentation. +-spec getMenuBar(This) -> wxMenuBar:wxMenuBar() when + This::wxFrame(). getMenuBar(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFrame), wxe_util:call(?wxFrame_GetMenuBar, <>). -%% @spec (This::wxFrame()) -> wxStatusBar:wxStatusBar() %% @doc See external documentation. +-spec getStatusBar(This) -> wxStatusBar:wxStatusBar() when + This::wxFrame(). getStatusBar(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFrame), wxe_util:call(?wxFrame_GetStatusBar, <>). -%% @spec (This::wxFrame()) -> integer() %% @doc See external documentation. +-spec getStatusBarPane(This) -> integer() when + This::wxFrame(). getStatusBarPane(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFrame), wxe_util:call(?wxFrame_GetStatusBarPane, <>). -%% @spec (This::wxFrame()) -> wxToolBar:wxToolBar() %% @doc See external documentation. +-spec getToolBar(This) -> wxToolBar:wxToolBar() when + This::wxFrame(). getToolBar(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFrame), wxe_util:call(?wxFrame_GetToolBar, <>). -%% @spec (This::wxFrame(), Winid::integer()) -> bool() %% @doc See external documentation. +-spec processCommand(This, Winid) -> boolean() when + This::wxFrame(), Winid::integer(). processCommand(#wx_ref{type=ThisT,ref=ThisRef},Winid) when is_integer(Winid) -> ?CLASS(ThisT,wxFrame), wxe_util:call(?wxFrame_ProcessCommand, <>). -%% @spec (This::wxFrame()) -> ok %% @doc See external documentation. +-spec sendSizeEvent(This) -> ok when + This::wxFrame(). sendSizeEvent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxFrame), wxe_util:cast(?wxFrame_SendSizeEvent, <>). -%% @spec (This::wxFrame(), Menubar::wxMenuBar:wxMenuBar()) -> ok %% @doc See external documentation. +-spec setMenuBar(This, Menubar) -> ok when + This::wxFrame(), Menubar::wxMenuBar:wxMenuBar(). setMenuBar(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MenubarT,ref=MenubarRef}) -> ?CLASS(ThisT,wxFrame), ?CLASS(MenubarT,wxMenuBar), wxe_util:cast(?wxFrame_SetMenuBar, <>). -%% @spec (This::wxFrame(), Statbar::wxStatusBar:wxStatusBar()) -> ok %% @doc See external documentation. +-spec setStatusBar(This, Statbar) -> ok when + This::wxFrame(), Statbar::wxStatusBar:wxStatusBar(). setStatusBar(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=StatbarT,ref=StatbarRef}) -> ?CLASS(ThisT,wxFrame), ?CLASS(StatbarT,wxStatusBar), wxe_util:cast(?wxFrame_SetStatusBar, <>). -%% @spec (This::wxFrame(), N::integer()) -> ok %% @doc See external documentation. +-spec setStatusBarPane(This, N) -> ok when + This::wxFrame(), N::integer(). setStatusBarPane(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxFrame), wxe_util:cast(?wxFrame_SetStatusBarPane, <>). -%% @spec (This::wxFrame(), Text::string()) -> ok %% @equiv setStatusText(This,Text, []) +-spec setStatusText(This, Text) -> ok when + This::wxFrame(), Text::string(). + setStatusText(This,Text) when is_record(This, wx_ref),is_list(Text) -> setStatusText(This,Text, []). -%% @spec (This::wxFrame(), Text::string(), [Option]) -> ok -%% Option = {number, integer()} %% @doc See external documentation. +-spec setStatusText(This, Text, [Option]) -> ok when + This::wxFrame(), Text::string(), + Option :: {number, integer()}. setStatusText(#wx_ref{type=ThisT,ref=ThisRef},Text, Options) when is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxFrame), @@ -265,8 +299,9 @@ setStatusText(#wx_ref{type=ThisT,ref=ThisRef},Text, Options) wxe_util:cast(?wxFrame_SetStatusText, <>). -%% @spec (This::wxFrame(), Widths_field::[integer()]) -> ok %% @doc See external documentation. +-spec setStatusWidths(This, Widths_field) -> ok when + This::wxFrame(), Widths_field::[integer()]. setStatusWidths(#wx_ref{type=ThisT,ref=ThisRef},Widths_field) when is_list(Widths_field) -> ?CLASS(ThisT,wxFrame), @@ -274,16 +309,17 @@ setStatusWidths(#wx_ref{type=ThisT,ref=ThisRef},Widths_field) <> || C <- Widths_field>>)/binary, 0:(((0+length(Widths_field)) rem 2)*32)>>). -%% @spec (This::wxFrame(), Toolbar::wxToolBar:wxToolBar()) -> ok %% @doc See external documentation. +-spec setToolBar(This, Toolbar) -> ok when + This::wxFrame(), Toolbar::wxToolBar:wxToolBar(). setToolBar(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ToolbarT,ref=ToolbarRef}) -> ?CLASS(ThisT,wxFrame), ?CLASS(ToolbarT,wxToolBar), wxe_util:cast(?wxFrame_SetToolBar, <>). -%% @spec (This::wxFrame()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxFrame) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxFrame), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxGBSizerItem.erl b/lib/wx/src/gen/wxGBSizerItem.erl index 90dd98fdf2..1860e5f808 100644 --- a/lib/wx/src/gen/wxGBSizerItem.erl +++ b/lib/wx/src/gen/wxGBSizerItem.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 @@ -37,10 +37,12 @@ setMinSize/2,setMinSize/3,setProportion/2,setRatio/2,setRatio/3,setSizer/2, setSpacer/2,setSpacer/3,setWindow/2,show/2]). +-export_type([wxGBSizerItem/0]). %% @hidden parent_class(wxSizerItem) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxGBSizerItem() :: wx:wx_object(). %% From wxSizerItem %% @hidden show(This,Show) -> wxSizerItem:show(This,Show). diff --git a/lib/wx/src/gen/wxGLCanvas.erl b/lib/wx/src/gen/wxGLCanvas.erl index a30d8cefd9..515ccab2ff 100644 --- a/lib/wx/src/gen/wxGLCanvas.erl +++ b/lib/wx/src/gen/wxGLCanvas.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 @@ -68,26 +68,33 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxGLCanvas/0]). %% @hidden parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Parent::wxWindow:wxWindow()) -> wxGLCanvas() +-type wxGLCanvas() :: wx:wx_object(). %% @equiv new(Parent, []) +-spec new(Parent) -> wxGLCanvas() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(),X::term()) -> wxGLCanvas() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Parent::wxWindow:wxWindow(), Shared::wxGLContext:wxGLContext() | wxGLCanvas()) -> new(Parent,Shared, [])

-%%

-%% new(Parent::wxWindow:wxWindow(), [Option]) -> wxGLCanvas() -%%
Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {name, string()} | {attribList, [integer()]} | {palette, wxPalette:wxPalette()} -%%

+-spec new(Parent, Shared) -> wxGLCanvas() when + Parent::wxWindow:wxWindow(), Shared::wxGLContext:wxGLContext() | wxGLCanvas(); + (Parent, [Option]) -> wxGLCanvas() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {name, string()} + | {attribList, [integer()]} + | {palette, wxPalette:wxPalette()}. new(Parent,Shared) when is_record(Parent, wx_ref),is_record(Shared, wx_ref) -> @@ -108,9 +115,16 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxGLCanvas_new_2, <>). -%% @spec (Parent::wxWindow:wxWindow(), Shared::wxGLContext:wxGLContext() | wxGLCanvas(), [Option]) -> wxGLCanvas() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {name, string()} | {attribList, [integer()]} | {palette, wxPalette:wxPalette()} %% @doc See external documentation. +-spec new(Parent, Shared, [Option]) -> wxGLCanvas() when + Parent::wxWindow:wxWindow(), Shared::wxGLContext:wxGLContext() | wxGLCanvas(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {name, string()} + | {attribList, [integer()]} + | {palette, wxPalette:wxPalette()}. new(#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=SharedT,ref=SharedRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -133,15 +147,17 @@ new(#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=SharedT,ref=SharedRef}, Opt wxe_util:construct(SharedOP, <>). -%% @spec (This::wxGLCanvas()) -> wxGLContext:wxGLContext() %% @doc See external documentation. +-spec getContext(This) -> wxGLContext:wxGLContext() when + This::wxGLCanvas(). getContext(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGLCanvas), wxe_util:call(?wxGLCanvas_GetContext, <>). -%% @spec (This::wxGLCanvas()) -> ok %% @doc See external documentation. +-spec setCurrent(This) -> ok when + This::wxGLCanvas(). setCurrent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGLCanvas), _Result = wxe_util:cast(?wxGLCanvas_SetCurrent, @@ -149,15 +165,16 @@ setCurrent(#wx_ref{type=ThisT,ref=ThisRef}) -> {ok, _} = wxe_master:init_opengl(), _Result. -%% @spec (This::wxGLCanvas()) -> ok %% @doc See external documentation. +-spec swapBuffers(This) -> ok when + This::wxGLCanvas(). swapBuffers(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGLCanvas), wxe_util:cast(?wxGLCanvas_SwapBuffers, <>). -%% @spec (This::wxGLCanvas()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGLCanvas) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGLCanvas), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxGauge.erl b/lib/wx/src/gen/wxGauge.erl index 484fd36936..bb453b4a8b 100644 --- a/lib/wx/src/gen/wxGauge.erl +++ b/lib/wx/src/gen/wxGauge.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 @@ -71,27 +71,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxGauge/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGauge() +-type wxGauge() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxGauge(). new() -> wxe_util:construct(?wxGauge_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Range::integer()) -> wxGauge() %% @equiv new(Parent,Id,Range, []) +-spec new(Parent, Id, Range) -> wxGauge() when + Parent::wxWindow:wxWindow(), Id::integer(), Range::integer(). + new(Parent,Id,Range) when is_record(Parent, wx_ref),is_integer(Id),is_integer(Range) -> new(Parent,Id,Range, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Range::integer(), [Option]) -> wxGauge() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, Range, [Option]) -> wxGauge() when + Parent::wxWindow:wxWindow(), Id::integer(), Range::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Range, Options) when is_integer(Id),is_integer(Range),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -104,15 +112,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Range, Options) wxe_util:construct(?wxGauge_new_4, <>). -%% @spec (This::wxGauge(), Parent::wxWindow:wxWindow(), Id::integer(), Range::integer()) -> bool() %% @equiv create(This,Parent,Id,Range, []) +-spec create(This, Parent, Id, Range) -> boolean() when + This::wxGauge(), Parent::wxWindow:wxWindow(), Id::integer(), Range::integer(). + create(This,Parent,Id,Range) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_integer(Range) -> create(This,Parent,Id,Range, []). -%% @spec (This::wxGauge(), Parent::wxWindow:wxWindow(), Id::integer(), Range::integer(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Range, [Option]) -> boolean() when + This::wxGauge(), Parent::wxWindow:wxWindow(), Id::integer(), Range::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Range, Options) when is_integer(Id),is_integer(Range),is_list(Options) -> ?CLASS(ThisT,wxGauge), @@ -126,82 +140,92 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Ra wxe_util:call(?wxGauge_Create, <>). -%% @spec (This::wxGauge()) -> integer() %% @doc See external documentation. +-spec getBezelFace(This) -> integer() when + This::wxGauge(). getBezelFace(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGauge), wxe_util:call(?wxGauge_GetBezelFace, <>). -%% @spec (This::wxGauge()) -> integer() %% @doc See external documentation. +-spec getRange(This) -> integer() when + This::wxGauge(). getRange(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGauge), wxe_util:call(?wxGauge_GetRange, <>). -%% @spec (This::wxGauge()) -> integer() %% @doc See external documentation. +-spec getShadowWidth(This) -> integer() when + This::wxGauge(). getShadowWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGauge), wxe_util:call(?wxGauge_GetShadowWidth, <>). -%% @spec (This::wxGauge()) -> integer() %% @doc See external documentation. +-spec getValue(This) -> integer() when + This::wxGauge(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGauge), wxe_util:call(?wxGauge_GetValue, <>). -%% @spec (This::wxGauge()) -> bool() %% @doc See external documentation. +-spec isVertical(This) -> boolean() when + This::wxGauge(). isVertical(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGauge), wxe_util:call(?wxGauge_IsVertical, <>). -%% @spec (This::wxGauge(), W::integer()) -> ok %% @doc See external documentation. +-spec setBezelFace(This, W) -> ok when + This::wxGauge(), W::integer(). setBezelFace(#wx_ref{type=ThisT,ref=ThisRef},W) when is_integer(W) -> ?CLASS(ThisT,wxGauge), wxe_util:cast(?wxGauge_SetBezelFace, <>). -%% @spec (This::wxGauge(), R::integer()) -> ok %% @doc See external documentation. +-spec setRange(This, R) -> ok when + This::wxGauge(), R::integer(). setRange(#wx_ref{type=ThisT,ref=ThisRef},R) when is_integer(R) -> ?CLASS(ThisT,wxGauge), wxe_util:cast(?wxGauge_SetRange, <>). -%% @spec (This::wxGauge(), W::integer()) -> ok %% @doc See external documentation. +-spec setShadowWidth(This, W) -> ok when + This::wxGauge(), W::integer(). setShadowWidth(#wx_ref{type=ThisT,ref=ThisRef},W) when is_integer(W) -> ?CLASS(ThisT,wxGauge), wxe_util:cast(?wxGauge_SetShadowWidth, <>). -%% @spec (This::wxGauge(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setValue(This, Pos) -> ok when + This::wxGauge(), Pos::integer(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxGauge), wxe_util:cast(?wxGauge_SetValue, <>). -%% @spec (This::wxGauge()) -> ok %% @doc See external documentation. +-spec pulse(This) -> ok when + This::wxGauge(). pulse(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGauge), wxe_util:cast(?wxGauge_Pulse, <>). -%% @spec (This::wxGauge()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGauge) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGauge), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxGenericDirCtrl.erl b/lib/wx/src/gen/wxGenericDirCtrl.erl index 626a454d2a..6ea26e0426 100644 --- a/lib/wx/src/gen/wxGenericDirCtrl.erl +++ b/lib/wx/src/gen/wxGenericDirCtrl.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 @@ -72,27 +72,38 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxGenericDirCtrl/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGenericDirCtrl() +-type wxGenericDirCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxGenericDirCtrl(). new() -> wxe_util:construct(?wxGenericDirCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxGenericDirCtrl() %% @equiv new(Parent, []) +-spec new(Parent) -> wxGenericDirCtrl() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxGenericDirCtrl() -%% Option = {id, integer()} | {dir, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {filter, string()} | {defaultFilter, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxGenericDirCtrl() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {dir, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {filter, string()} + | {defaultFilter, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -108,15 +119,24 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxGenericDirCtrl_new_2, <>). -%% @spec (This::wxGenericDirCtrl(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxGenericDirCtrl(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxGenericDirCtrl(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {id, integer()} | {dir, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {filter, string()} | {defaultFilter, integer()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxGenericDirCtrl(), Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {dir, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {filter, string()} + | {defaultFilter, integer()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGenericDirCtrl), @@ -133,22 +153,25 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxGenericDirCtrl_Create, <>). -%% @spec (This::wxGenericDirCtrl()) -> ok %% @doc See external documentation. +-spec init(This) -> ok when + This::wxGenericDirCtrl(). init(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:cast(?wxGenericDirCtrl_Init, <>). -%% @spec (This::wxGenericDirCtrl()) -> ok %% @doc See external documentation. +-spec collapseTree(This) -> ok when + This::wxGenericDirCtrl(). collapseTree(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:cast(?wxGenericDirCtrl_CollapseTree, <>). -%% @spec (This::wxGenericDirCtrl(), Path::string()) -> bool() %% @doc See external documentation. +-spec expandPath(This, Path) -> boolean() when + This::wxGenericDirCtrl(), Path::string(). expandPath(#wx_ref{type=ThisT,ref=ThisRef},Path) when is_list(Path) -> ?CLASS(ThisT,wxGenericDirCtrl), @@ -156,64 +179,73 @@ expandPath(#wx_ref{type=ThisT,ref=ThisRef},Path) wxe_util:call(?wxGenericDirCtrl_ExpandPath, <>). -%% @spec (This::wxGenericDirCtrl()) -> string() %% @doc See external documentation. +-spec getDefaultPath(This) -> string() when + This::wxGenericDirCtrl(). getDefaultPath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:call(?wxGenericDirCtrl_GetDefaultPath, <>). -%% @spec (This::wxGenericDirCtrl()) -> string() %% @doc See external documentation. +-spec getPath(This) -> string() when + This::wxGenericDirCtrl(). getPath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:call(?wxGenericDirCtrl_GetPath, <>). -%% @spec (This::wxGenericDirCtrl()) -> string() %% @doc See external documentation. +-spec getFilePath(This) -> string() when + This::wxGenericDirCtrl(). getFilePath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:call(?wxGenericDirCtrl_GetFilePath, <>). -%% @spec (This::wxGenericDirCtrl()) -> string() %% @doc See external documentation. +-spec getFilter(This) -> string() when + This::wxGenericDirCtrl(). getFilter(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:call(?wxGenericDirCtrl_GetFilter, <>). -%% @spec (This::wxGenericDirCtrl()) -> integer() %% @doc See external documentation. +-spec getFilterIndex(This) -> integer() when + This::wxGenericDirCtrl(). getFilterIndex(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:call(?wxGenericDirCtrl_GetFilterIndex, <>). -%% @spec (This::wxGenericDirCtrl()) -> integer() %% @doc See external documentation. +-spec getRootId(This) -> integer() when + This::wxGenericDirCtrl(). getRootId(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:call(?wxGenericDirCtrl_GetRootId, <>). -%% @spec (This::wxGenericDirCtrl()) -> wxTreeCtrl:wxTreeCtrl() %% @doc See external documentation. +-spec getTreeCtrl(This) -> wxTreeCtrl:wxTreeCtrl() when + This::wxGenericDirCtrl(). getTreeCtrl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:call(?wxGenericDirCtrl_GetTreeCtrl, <>). -%% @spec (This::wxGenericDirCtrl()) -> ok %% @doc See external documentation. +-spec reCreateTree(This) -> ok when + This::wxGenericDirCtrl(). reCreateTree(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:cast(?wxGenericDirCtrl_ReCreateTree, <>). -%% @spec (This::wxGenericDirCtrl(), Path::string()) -> ok %% @doc See external documentation. +-spec setDefaultPath(This, Path) -> ok when + This::wxGenericDirCtrl(), Path::string(). setDefaultPath(#wx_ref{type=ThisT,ref=ThisRef},Path) when is_list(Path) -> ?CLASS(ThisT,wxGenericDirCtrl), @@ -221,8 +253,9 @@ setDefaultPath(#wx_ref{type=ThisT,ref=ThisRef},Path) wxe_util:cast(?wxGenericDirCtrl_SetDefaultPath, <>). -%% @spec (This::wxGenericDirCtrl(), Filter::string()) -> ok %% @doc See external documentation. +-spec setFilter(This, Filter) -> ok when + This::wxGenericDirCtrl(), Filter::string(). setFilter(#wx_ref{type=ThisT,ref=ThisRef},Filter) when is_list(Filter) -> ?CLASS(ThisT,wxGenericDirCtrl), @@ -230,16 +263,18 @@ setFilter(#wx_ref{type=ThisT,ref=ThisRef},Filter) wxe_util:cast(?wxGenericDirCtrl_SetFilter, <>). -%% @spec (This::wxGenericDirCtrl(), N::integer()) -> ok %% @doc See external documentation. +-spec setFilterIndex(This, N) -> ok when + This::wxGenericDirCtrl(), N::integer(). setFilterIndex(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxGenericDirCtrl), wxe_util:cast(?wxGenericDirCtrl_SetFilterIndex, <>). -%% @spec (This::wxGenericDirCtrl(), Path::string()) -> ok %% @doc See external documentation. +-spec setPath(This, Path) -> ok when + This::wxGenericDirCtrl(), Path::string(). setPath(#wx_ref{type=ThisT,ref=ThisRef},Path) when is_list(Path) -> ?CLASS(ThisT,wxGenericDirCtrl), @@ -247,8 +282,8 @@ setPath(#wx_ref{type=ThisT,ref=ThisRef},Path) wxe_util:cast(?wxGenericDirCtrl_SetPath, <>). -%% @spec (This::wxGenericDirCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGenericDirCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGenericDirCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxGraphicsBrush.erl b/lib/wx/src/gen/wxGraphicsBrush.erl index e1ad01567d..bbc0c4b1a0 100644 --- a/lib/wx/src/gen/wxGraphicsBrush.erl +++ b/lib/wx/src/gen/wxGraphicsBrush.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 @@ -32,10 +32,12 @@ %% inherited exports -export([getRenderer/1,isNull/1,parent_class/1]). +-export_type([wxGraphicsBrush/0]). %% @hidden parent_class(wxGraphicsObject) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxGraphicsBrush() :: wx:wx_object(). %% From wxGraphicsObject %% @hidden isNull(This) -> wxGraphicsObject:isNull(This). diff --git a/lib/wx/src/gen/wxGraphicsContext.erl b/lib/wx/src/gen/wxGraphicsContext.erl index 05c56dd4b2..ddbfc92157 100644 --- a/lib/wx/src/gen/wxGraphicsContext.erl +++ b/lib/wx/src/gen/wxGraphicsContext.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 @@ -40,18 +40,21 @@ %% inherited exports -export([getRenderer/1,isNull/1,parent_class/1]). +-export_type([wxGraphicsContext/0]). %% @hidden parent_class(wxGraphicsObject) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGraphicsContext() +-type wxGraphicsContext() :: wx:wx_object(). %% @doc See external documentation. +-spec create() -> wxGraphicsContext(). create() -> wxe_util:call(?wxGraphicsContext_Create_0, <<>>). -%% @spec (Dc::wxWindowDC:wxWindowDC() | wxWindow:wxWindow()) -> wxGraphicsContext() %% @doc See external documentation. +-spec create(Dc) -> wxGraphicsContext() when + Dc::wxWindowDC:wxWindowDC() | wxWindow:wxWindow(). create(#wx_ref{type=DcT,ref=DcRef}) -> DcOP = case ?CLASS_T(DcT,wxWindowDC) of true -> @@ -62,47 +65,54 @@ create(#wx_ref{type=DcT,ref=DcRef}) -> wxe_util:call(DcOP, <>). -%% @spec (This::wxGraphicsContext(), Pen::wxPen:wxPen()) -> wxGraphicsPen:wxGraphicsPen() %% @doc See external documentation. +-spec createPen(This, Pen) -> wxGraphicsPen:wxGraphicsPen() when + This::wxGraphicsContext(), Pen::wxPen:wxPen(). createPen(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PenT,ref=PenRef}) -> ?CLASS(ThisT,wxGraphicsContext), ?CLASS(PenT,wxPen), wxe_util:call(?wxGraphicsContext_CreatePen, <>). -%% @spec (This::wxGraphicsContext(), Brush::wxBrush:wxBrush()) -> wxGraphicsBrush:wxGraphicsBrush() %% @doc See external documentation. +-spec createBrush(This, Brush) -> wxGraphicsBrush:wxGraphicsBrush() when + This::wxGraphicsContext(), Brush::wxBrush:wxBrush(). createBrush(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> ?CLASS(ThisT,wxGraphicsContext), ?CLASS(BrushT,wxBrush), wxe_util:call(?wxGraphicsContext_CreateBrush, <>). -%% @spec (This::wxGraphicsContext(), Xo::float(), Yo::float(), Xc::float(), Yc::float(), Radius::float(), OColor::wx:colour(), CColor::wx:colour()) -> wxGraphicsBrush:wxGraphicsBrush() %% @doc See external documentation. +-spec createRadialGradientBrush(This, Xo, Yo, Xc, Yc, Radius, OColor, CColor) -> wxGraphicsBrush:wxGraphicsBrush() when + This::wxGraphicsContext(), Xo::float(), Yo::float(), Xc::float(), Yc::float(), Radius::float(), OColor::wx:wx_colour(), CColor::wx:wx_colour(). createRadialGradientBrush(#wx_ref{type=ThisT,ref=ThisRef},Xo,Yo,Xc,Yc,Radius,OColor,CColor) when is_float(Xo),is_float(Yo),is_float(Xc),is_float(Yc),is_float(Radius),tuple_size(OColor) =:= 3; tuple_size(OColor) =:= 4,tuple_size(CColor) =:= 3; tuple_size(CColor) =:= 4 -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:call(?wxGraphicsContext_CreateRadialGradientBrush, <>). -%% @spec (This::wxGraphicsContext(), X1::float(), Y1::float(), X2::float(), Y2::float(), C1::wx:colour(), C2::wx:colour()) -> wxGraphicsBrush:wxGraphicsBrush() %% @doc See external documentation. +-spec createLinearGradientBrush(This, X1, Y1, X2, Y2, C1, C2) -> wxGraphicsBrush:wxGraphicsBrush() when + This::wxGraphicsContext(), X1::float(), Y1::float(), X2::float(), Y2::float(), C1::wx:wx_colour(), C2::wx:wx_colour(). createLinearGradientBrush(#wx_ref{type=ThisT,ref=ThisRef},X1,Y1,X2,Y2,C1,C2) when is_float(X1),is_float(Y1),is_float(X2),is_float(Y2),tuple_size(C1) =:= 3; tuple_size(C1) =:= 4,tuple_size(C2) =:= 3; tuple_size(C2) =:= 4 -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:call(?wxGraphicsContext_CreateLinearGradientBrush, <>). -%% @spec (This::wxGraphicsContext(), Font::wxFont:wxFont()) -> wxGraphicsFont:wxGraphicsFont() %% @equiv createFont(This,Font, []) +-spec createFont(This, Font) -> wxGraphicsFont:wxGraphicsFont() when + This::wxGraphicsContext(), Font::wxFont:wxFont(). + createFont(This,Font) when is_record(This, wx_ref),is_record(Font, wx_ref) -> createFont(This,Font, []). -%% @spec (This::wxGraphicsContext(), Font::wxFont:wxFont(), [Option]) -> wxGraphicsFont:wxGraphicsFont() -%% Option = {col, wx:colour()} %% @doc See external documentation. +-spec createFont(This, Font, [Option]) -> wxGraphicsFont:wxGraphicsFont() when + This::wxGraphicsContext(), Font::wxFont:wxFont(), + Option :: {col, wx:wx_colour()}. createFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGraphicsContext), @@ -113,15 +123,23 @@ createFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}, Opti wxe_util:call(?wxGraphicsContext_CreateFont, <>). -%% @spec (This::wxGraphicsContext()) -> wxGraphicsMatrix:wxGraphicsMatrix() %% @equiv createMatrix(This, []) +-spec createMatrix(This) -> wxGraphicsMatrix:wxGraphicsMatrix() when + This::wxGraphicsContext(). + createMatrix(This) when is_record(This, wx_ref) -> createMatrix(This, []). -%% @spec (This::wxGraphicsContext(), [Option]) -> wxGraphicsMatrix:wxGraphicsMatrix() -%% Option = {a, float()} | {b, float()} | {c, float()} | {d, float()} | {tx, float()} | {ty, float()} %% @doc See external documentation. +-spec createMatrix(This, [Option]) -> wxGraphicsMatrix:wxGraphicsMatrix() when + This::wxGraphicsContext(), + Option :: {a, float()} + | {b, float()} + | {c, float()} + | {d, float()} + | {tx, float()} + | {ty, float()}. createMatrix(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGraphicsContext), @@ -136,38 +154,43 @@ createMatrix(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxGraphicsContext_CreateMatrix, <>). -%% @spec (This::wxGraphicsContext()) -> wxGraphicsPath:wxGraphicsPath() %% @doc See external documentation. +-spec createPath(This) -> wxGraphicsPath:wxGraphicsPath() when + This::wxGraphicsContext(). createPath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:call(?wxGraphicsContext_CreatePath, <>). -%% @spec (This::wxGraphicsContext(), Region::wxRegion:wxRegion()) -> ok %% @doc See external documentation. +-spec clip(This, Region) -> ok when + This::wxGraphicsContext(), Region::wxRegion:wxRegion(). clip(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=RegionT,ref=RegionRef}) -> ?CLASS(ThisT,wxGraphicsContext), ?CLASS(RegionT,wxRegion), wxe_util:cast(?wxGraphicsContext_Clip_1, <>). -%% @spec (This::wxGraphicsContext(), X::float(), Y::float(), W::float(), H::float()) -> ok %% @doc See external documentation. +-spec clip(This, X, Y, W, H) -> ok when + This::wxGraphicsContext(), X::float(), Y::float(), W::float(), H::float(). clip(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_float(X),is_float(Y),is_float(W),is_float(H) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_Clip_4, <>). -%% @spec (This::wxGraphicsContext()) -> ok %% @doc See external documentation. +-spec resetClip(This) -> ok when + This::wxGraphicsContext(). resetClip(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_ResetClip, <>). -%% @spec (This::wxGraphicsContext(), Bmp::wxBitmap:wxBitmap(), X::float(), Y::float(), W::float(), H::float()) -> ok %% @doc See external documentation. +-spec drawBitmap(This, Bmp, X, Y, W, H) -> ok when + This::wxGraphicsContext(), Bmp::wxBitmap:wxBitmap(), X::float(), Y::float(), W::float(), H::float(). drawBitmap(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef},X,Y,W,H) when is_float(X),is_float(Y),is_float(W),is_float(H) -> ?CLASS(ThisT,wxGraphicsContext), @@ -175,16 +198,18 @@ drawBitmap(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef},X,Y,W,H wxe_util:cast(?wxGraphicsContext_DrawBitmap, <>). -%% @spec (This::wxGraphicsContext(), X::float(), Y::float(), W::float(), H::float()) -> ok %% @doc See external documentation. +-spec drawEllipse(This, X, Y, W, H) -> ok when + This::wxGraphicsContext(), X::float(), Y::float(), W::float(), H::float(). drawEllipse(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_float(X),is_float(Y),is_float(W),is_float(H) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_DrawEllipse, <>). -%% @spec (This::wxGraphicsContext(), Icon::wxIcon:wxIcon(), X::float(), Y::float(), W::float(), H::float()) -> ok %% @doc See external documentation. +-spec drawIcon(This, Icon, X, Y, W, H) -> ok when + This::wxGraphicsContext(), Icon::wxIcon:wxIcon(), X::float(), Y::float(), W::float(), H::float(). drawIcon(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconT,ref=IconRef},X,Y,W,H) when is_float(X),is_float(Y),is_float(W),is_float(H) -> ?CLASS(ThisT,wxGraphicsContext), @@ -192,15 +217,18 @@ drawIcon(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconT,ref=IconRef},X,Y,W,H wxe_util:cast(?wxGraphicsContext_DrawIcon, <>). -%% @spec (This::wxGraphicsContext(), N::integer(), Points::{X::float(), Y::float()}) -> ok %% @equiv drawLines(This,N,Points, []) +-spec drawLines(This, N, Points) -> ok when + This::wxGraphicsContext(), N::integer(), Points::{X::float(), Y::float()}. + drawLines(This,N,Points={PointsX,PointsY}) when is_record(This, wx_ref),is_integer(N),is_number(PointsX),is_number(PointsY) -> drawLines(This,N,Points, []). -%% @spec (This::wxGraphicsContext(), N::integer(), Points::{X::float(), Y::float()}, [Option]) -> ok -%% Option = {fillStyle, integer()} %% @doc See external documentation. +-spec drawLines(This, N, Points, [Option]) -> ok when + This::wxGraphicsContext(), N::integer(), Points::{X::float(), Y::float()}, + Option :: {fillStyle, integer()}. drawLines(#wx_ref{type=ThisT,ref=ThisRef},N,{PointsX,PointsY}, Options) when is_integer(N),is_number(PointsX),is_number(PointsY),is_list(Options) -> ?CLASS(ThisT,wxGraphicsContext), @@ -210,15 +238,18 @@ drawLines(#wx_ref{type=ThisT,ref=ThisRef},N,{PointsX,PointsY}, Options) wxe_util:cast(?wxGraphicsContext_DrawLines, <>). -%% @spec (This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath()) -> ok %% @equiv drawPath(This,Path, []) +-spec drawPath(This, Path) -> ok when + This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath(). + drawPath(This,Path) when is_record(This, wx_ref),is_record(Path, wx_ref) -> drawPath(This,Path, []). -%% @spec (This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath(), [Option]) -> ok -%% Option = {fillStyle, integer()} %% @doc See external documentation. +-spec drawPath(This, Path, [Option]) -> ok when + This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath(), + Option :: {fillStyle, integer()}. drawPath(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PathT,ref=PathRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGraphicsContext), @@ -229,24 +260,27 @@ drawPath(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PathT,ref=PathRef}, Option wxe_util:cast(?wxGraphicsContext_DrawPath, <>). -%% @spec (This::wxGraphicsContext(), X::float(), Y::float(), W::float(), H::float()) -> ok %% @doc See external documentation. +-spec drawRectangle(This, X, Y, W, H) -> ok when + This::wxGraphicsContext(), X::float(), Y::float(), W::float(), H::float(). drawRectangle(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_float(X),is_float(Y),is_float(W),is_float(H) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_DrawRectangle, <>). -%% @spec (This::wxGraphicsContext(), X::float(), Y::float(), W::float(), H::float(), Radius::float()) -> ok %% @doc See external documentation. +-spec drawRoundedRectangle(This, X, Y, W, H, Radius) -> ok when + This::wxGraphicsContext(), X::float(), Y::float(), W::float(), H::float(), Radius::float(). drawRoundedRectangle(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H,Radius) when is_float(X),is_float(Y),is_float(W),is_float(H),is_float(Radius) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_DrawRoundedRectangle, <>). -%% @spec (This::wxGraphicsContext(), Str::string(), X::float(), Y::float()) -> ok %% @doc See external documentation. +-spec drawText(This, Str, X, Y) -> ok when + This::wxGraphicsContext(), Str::string(), X::float(), Y::float(). drawText(#wx_ref{type=ThisT,ref=ThisRef},Str,X,Y) when is_list(Str),is_float(X),is_float(Y) -> ?CLASS(ThisT,wxGraphicsContext), @@ -254,15 +288,11 @@ drawText(#wx_ref{type=ThisT,ref=ThisRef},Str,X,Y) wxe_util:cast(?wxGraphicsContext_DrawText_3, <>). -%% @spec (This::wxGraphicsContext(),Str::string(),X::float(),Y::float(),X::float()|term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% drawText(This::wxGraphicsContext(), Str::string(), X::float(), Y::float(), Angle::float()) -> ok -%%

-%%

-%% drawText(This::wxGraphicsContext(), Str::string(), X::float(), Y::float(), BackgroundBrush::wxGraphicsBrush:wxGraphicsBrush()) -> ok -%%

+-spec drawText(This, Str, X, Y, Angle) -> ok when + This::wxGraphicsContext(), Str::string(), X::float(), Y::float(), Angle::float(); + (This, Str, X, Y, BackgroundBrush) -> ok when + This::wxGraphicsContext(), Str::string(), X::float(), Y::float(), BackgroundBrush::wxGraphicsBrush:wxGraphicsBrush(). drawText(#wx_ref{type=ThisT,ref=ThisRef},Str,X,Y,Angle) when is_list(Str),is_float(X),is_float(Y),is_float(Angle) -> ?CLASS(ThisT,wxGraphicsContext), @@ -277,8 +307,9 @@ drawText(#wx_ref{type=ThisT,ref=ThisRef},Str,X,Y,#wx_ref{type=BackgroundBrushT,r wxe_util:cast(?wxGraphicsContext_DrawText_4_1, <>). -%% @spec (This::wxGraphicsContext(), Str::string(), X::float(), Y::float(), Angle::float(), BackgroundBrush::wxGraphicsBrush:wxGraphicsBrush()) -> ok %% @doc See external documentation. +-spec drawText(This, Str, X, Y, Angle, BackgroundBrush) -> ok when + This::wxGraphicsContext(), Str::string(), X::float(), Y::float(), Angle::float(), BackgroundBrush::wxGraphicsBrush:wxGraphicsBrush(). drawText(#wx_ref{type=ThisT,ref=ThisRef},Str,X,Y,Angle,#wx_ref{type=BackgroundBrushT,ref=BackgroundBrushRef}) when is_list(Str),is_float(X),is_float(Y),is_float(Angle) -> ?CLASS(ThisT,wxGraphicsContext), @@ -287,15 +318,18 @@ drawText(#wx_ref{type=ThisT,ref=ThisRef},Str,X,Y,Angle,#wx_ref{type=BackgroundBr wxe_util:cast(?wxGraphicsContext_DrawText_5, <>). -%% @spec (This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath()) -> ok %% @equiv fillPath(This,Path, []) +-spec fillPath(This, Path) -> ok when + This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath(). + fillPath(This,Path) when is_record(This, wx_ref),is_record(Path, wx_ref) -> fillPath(This,Path, []). -%% @spec (This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath(), [Option]) -> ok -%% Option = {fillStyle, integer()} %% @doc See external documentation. +-spec fillPath(This, Path, [Option]) -> ok when + This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath(), + Option :: {fillStyle, integer()}. fillPath(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PathT,ref=PathRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGraphicsContext), @@ -306,23 +340,26 @@ fillPath(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PathT,ref=PathRef}, Option wxe_util:cast(?wxGraphicsContext_FillPath, <>). -%% @spec (This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath()) -> ok %% @doc See external documentation. +-spec strokePath(This, Path) -> ok when + This::wxGraphicsContext(), Path::wxGraphicsPath:wxGraphicsPath(). strokePath(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PathT,ref=PathRef}) -> ?CLASS(ThisT,wxGraphicsContext), ?CLASS(PathT,wxGraphicsPath), wxe_util:cast(?wxGraphicsContext_StrokePath, <>). -%% @spec (This::wxGraphicsContext()) -> ok %% @doc See external documentation. +-spec getNativeContext(This) -> ok when + This::wxGraphicsContext(). getNativeContext(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_GetNativeContext, <>). -%% @spec (This::wxGraphicsContext(), Text::string(), Widths::[float()]) -> ok %% @doc See external documentation. +-spec getPartialTextExtents(This, Text, Widths) -> ok when + This::wxGraphicsContext(), Text::string(), Widths::[float()]. getPartialTextExtents(#wx_ref{type=ThisT,ref=ThisRef},Text,Widths) when is_list(Text),is_list(Widths) -> ?CLASS(ThisT,wxGraphicsContext), @@ -331,8 +368,10 @@ getPartialTextExtents(#wx_ref{type=ThisT,ref=ThisRef},Text,Widths) <> || C <- Widths>>)/binary>>). -%% @spec (This::wxGraphicsContext(), Text::string()) -> {Width::float(), Height::float(), Descent::float(), ExternalLeading::float()} %% @doc See external documentation. +-spec getTextExtent(This, Text) -> Result when + Result ::{Width::float(), Height::float(), Descent::float(), ExternalLeading::float()}, + This::wxGraphicsContext(), Text::string(). getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxGraphicsContext), @@ -340,55 +379,62 @@ getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:call(?wxGraphicsContext_GetTextExtent, <>). -%% @spec (This::wxGraphicsContext(), Angle::float()) -> ok %% @doc See external documentation. +-spec rotate(This, Angle) -> ok when + This::wxGraphicsContext(), Angle::float(). rotate(#wx_ref{type=ThisT,ref=ThisRef},Angle) when is_float(Angle) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_Rotate, <>). -%% @spec (This::wxGraphicsContext(), XScale::float(), YScale::float()) -> ok %% @doc See external documentation. +-spec scale(This, XScale, YScale) -> ok when + This::wxGraphicsContext(), XScale::float(), YScale::float(). scale(#wx_ref{type=ThisT,ref=ThisRef},XScale,YScale) when is_float(XScale),is_float(YScale) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_Scale, <>). -%% @spec (This::wxGraphicsContext(), Dx::float(), Dy::float()) -> ok %% @doc See external documentation. +-spec translate(This, Dx, Dy) -> ok when + This::wxGraphicsContext(), Dx::float(), Dy::float(). translate(#wx_ref{type=ThisT,ref=ThisRef},Dx,Dy) when is_float(Dx),is_float(Dy) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_Translate, <>). -%% @spec (This::wxGraphicsContext()) -> wxGraphicsMatrix:wxGraphicsMatrix() %% @doc See external documentation. +-spec getTransform(This) -> wxGraphicsMatrix:wxGraphicsMatrix() when + This::wxGraphicsContext(). getTransform(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:call(?wxGraphicsContext_GetTransform, <>). -%% @spec (This::wxGraphicsContext(), Matrix::wxGraphicsMatrix:wxGraphicsMatrix()) -> ok %% @doc See external documentation. +-spec setTransform(This, Matrix) -> ok when + This::wxGraphicsContext(), Matrix::wxGraphicsMatrix:wxGraphicsMatrix(). setTransform(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MatrixT,ref=MatrixRef}) -> ?CLASS(ThisT,wxGraphicsContext), ?CLASS(MatrixT,wxGraphicsMatrix), wxe_util:cast(?wxGraphicsContext_SetTransform, <>). -%% @spec (This::wxGraphicsContext(), Matrix::wxGraphicsMatrix:wxGraphicsMatrix()) -> ok %% @doc See external documentation. +-spec concatTransform(This, Matrix) -> ok when + This::wxGraphicsContext(), Matrix::wxGraphicsMatrix:wxGraphicsMatrix(). concatTransform(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MatrixT,ref=MatrixRef}) -> ?CLASS(ThisT,wxGraphicsContext), ?CLASS(MatrixT,wxGraphicsMatrix), wxe_util:cast(?wxGraphicsContext_ConcatTransform, <>). -%% @spec (This::wxGraphicsContext(), Brush::wxGraphicsBrush:wxGraphicsBrush() | wxBrush:wxBrush()) -> ok %% @doc See external documentation. +-spec setBrush(This, Brush) -> ok when + This::wxGraphicsContext(), Brush::wxGraphicsBrush:wxGraphicsBrush() | wxBrush:wxBrush(). setBrush(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> ?CLASS(ThisT,wxGraphicsContext), BrushOP = case ?CLASS_T(BrushT,wxGraphicsBrush) of @@ -400,16 +446,18 @@ setBrush(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> wxe_util:cast(BrushOP, <>). -%% @spec (This::wxGraphicsContext(), Font::wxGraphicsFont:wxGraphicsFont()) -> ok %% @doc See external documentation. +-spec setFont(This, Font) -> ok when + This::wxGraphicsContext(), Font::wxGraphicsFont:wxGraphicsFont(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxGraphicsContext), ?CLASS(FontT,wxGraphicsFont), wxe_util:cast(?wxGraphicsContext_SetFont_1, <>). -%% @spec (This::wxGraphicsContext(), Font::wxFont:wxFont(), Colour::wx:colour()) -> ok %% @doc See external documentation. +-spec setFont(This, Font, Colour) -> ok when + This::wxGraphicsContext(), Font::wxFont:wxFont(), Colour::wx:wx_colour(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxGraphicsContext), @@ -417,8 +465,9 @@ setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef},Colour) wxe_util:cast(?wxGraphicsContext_SetFont_2, <>). -%% @spec (This::wxGraphicsContext(), Pen::wxPen:wxPen() | wxGraphicsPen:wxGraphicsPen()) -> ok %% @doc See external documentation. +-spec setPen(This, Pen) -> ok when + This::wxGraphicsContext(), Pen::wxPen:wxPen() | wxGraphicsPen:wxGraphicsPen(). setPen(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PenT,ref=PenRef}) -> ?CLASS(ThisT,wxGraphicsContext), PenOP = case ?CLASS_T(PenT,wxPen) of @@ -430,24 +479,27 @@ setPen(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PenT,ref=PenRef}) -> wxe_util:cast(PenOP, <>). -%% @spec (This::wxGraphicsContext(), X1::float(), Y1::float(), X2::float(), Y2::float()) -> ok %% @doc See external documentation. +-spec strokeLine(This, X1, Y1, X2, Y2) -> ok when + This::wxGraphicsContext(), X1::float(), Y1::float(), X2::float(), Y2::float(). strokeLine(#wx_ref{type=ThisT,ref=ThisRef},X1,Y1,X2,Y2) when is_float(X1),is_float(Y1),is_float(X2),is_float(Y2) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_StrokeLine, <>). -%% @spec (This::wxGraphicsContext(), N::integer(), Points::{X::float(), Y::float()}) -> ok %% @doc See external documentation. +-spec strokeLines(This, N, Points) -> ok when + This::wxGraphicsContext(), N::integer(), Points::{X::float(), Y::float()}. strokeLines(#wx_ref{type=ThisT,ref=ThisRef},N,{PointsX,PointsY}) when is_integer(N),is_number(PointsX),is_number(PointsY) -> ?CLASS(ThisT,wxGraphicsContext), wxe_util:cast(?wxGraphicsContext_StrokeLines_2, <>). -%% @spec (This::wxGraphicsContext(), N::integer(), BeginPoints::{X::float(), Y::float()}, EndPoints::{X::float(), Y::float()}) -> ok %% @doc See external documentation. +-spec strokeLines(This, N, BeginPoints, EndPoints) -> ok when + This::wxGraphicsContext(), N::integer(), BeginPoints::{X::float(), Y::float()}, EndPoints::{X::float(), Y::float()}. strokeLines(#wx_ref{type=ThisT,ref=ThisRef},N,{BeginPointsX,BeginPointsY},{EndPointsX,EndPointsY}) when is_integer(N),is_number(BeginPointsX),is_number(BeginPointsY),is_number(EndPointsX),is_number(EndPointsY) -> ?CLASS(ThisT,wxGraphicsContext), diff --git a/lib/wx/src/gen/wxGraphicsFont.erl b/lib/wx/src/gen/wxGraphicsFont.erl index 19b2172176..03220599fb 100644 --- a/lib/wx/src/gen/wxGraphicsFont.erl +++ b/lib/wx/src/gen/wxGraphicsFont.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 @@ -32,10 +32,12 @@ %% inherited exports -export([getRenderer/1,isNull/1,parent_class/1]). +-export_type([wxGraphicsFont/0]). %% @hidden parent_class(wxGraphicsObject) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxGraphicsFont() :: wx:wx_object(). %% From wxGraphicsObject %% @hidden isNull(This) -> wxGraphicsObject:isNull(This). diff --git a/lib/wx/src/gen/wxGraphicsMatrix.erl b/lib/wx/src/gen/wxGraphicsMatrix.erl index 635a2027b3..6cf4257530 100644 --- a/lib/wx/src/gen/wxGraphicsMatrix.erl +++ b/lib/wx/src/gen/wxGraphicsMatrix.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 @@ -33,87 +33,107 @@ %% inherited exports -export([getRenderer/1,isNull/1,parent_class/1]). +-export_type([wxGraphicsMatrix/0]). %% @hidden parent_class(wxGraphicsObject) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxGraphicsMatrix(), T::wxGraphicsMatrix()) -> ok +-type wxGraphicsMatrix() :: wx:wx_object(). %% @doc See external documentation. +-spec concat(This, T) -> ok when + This::wxGraphicsMatrix(), T::wxGraphicsMatrix(). concat(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=TT,ref=TRef}) -> ?CLASS(ThisT,wxGraphicsMatrix), ?CLASS(TT,wxGraphicsMatrix), wxe_util:cast(?wxGraphicsMatrix_Concat, <>). -%% @spec (This::wxGraphicsMatrix()) -> {A::float(), B::float(), C::float(), D::float(), Tx::float(), Ty::float()} %% @doc See external documentation. +-spec get(This) -> Result when + Result ::{A::float(), B::float(), C::float(), D::float(), Tx::float(), Ty::float()}, + This::wxGraphicsMatrix(). get(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsMatrix), wxe_util:call(?wxGraphicsMatrix_Get, <>). -%% @spec (This::wxGraphicsMatrix()) -> ok %% @doc See external documentation. +-spec getNativeMatrix(This) -> ok when + This::wxGraphicsMatrix(). getNativeMatrix(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsMatrix), wxe_util:cast(?wxGraphicsMatrix_GetNativeMatrix, <>). -%% @spec (This::wxGraphicsMatrix()) -> ok %% @doc See external documentation. +-spec invert(This) -> ok when + This::wxGraphicsMatrix(). invert(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsMatrix), wxe_util:cast(?wxGraphicsMatrix_Invert, <>). -%% @spec (This::wxGraphicsMatrix(), T::wxGraphicsMatrix()) -> bool() %% @doc See external documentation. +-spec isEqual(This, T) -> boolean() when + This::wxGraphicsMatrix(), T::wxGraphicsMatrix(). isEqual(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=TT,ref=TRef}) -> ?CLASS(ThisT,wxGraphicsMatrix), ?CLASS(TT,wxGraphicsMatrix), wxe_util:call(?wxGraphicsMatrix_IsEqual, <>). -%% @spec (This::wxGraphicsMatrix()) -> bool() %% @doc See external documentation. +-spec isIdentity(This) -> boolean() when + This::wxGraphicsMatrix(). isIdentity(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsMatrix), wxe_util:call(?wxGraphicsMatrix_IsIdentity, <>). -%% @spec (This::wxGraphicsMatrix(), Angle::float()) -> ok %% @doc See external documentation. +-spec rotate(This, Angle) -> ok when + This::wxGraphicsMatrix(), Angle::float(). rotate(#wx_ref{type=ThisT,ref=ThisRef},Angle) when is_float(Angle) -> ?CLASS(ThisT,wxGraphicsMatrix), wxe_util:cast(?wxGraphicsMatrix_Rotate, <>). -%% @spec (This::wxGraphicsMatrix(), XScale::float(), YScale::float()) -> ok %% @doc See external documentation. +-spec scale(This, XScale, YScale) -> ok when + This::wxGraphicsMatrix(), XScale::float(), YScale::float(). scale(#wx_ref{type=ThisT,ref=ThisRef},XScale,YScale) when is_float(XScale),is_float(YScale) -> ?CLASS(ThisT,wxGraphicsMatrix), wxe_util:cast(?wxGraphicsMatrix_Scale, <>). -%% @spec (This::wxGraphicsMatrix(), Dx::float(), Dy::float()) -> ok %% @doc See external documentation. +-spec translate(This, Dx, Dy) -> ok when + This::wxGraphicsMatrix(), Dx::float(), Dy::float(). translate(#wx_ref{type=ThisT,ref=ThisRef},Dx,Dy) when is_float(Dx),is_float(Dy) -> ?CLASS(ThisT,wxGraphicsMatrix), wxe_util:cast(?wxGraphicsMatrix_Translate, <>). -%% @spec (This::wxGraphicsMatrix()) -> ok %% @equiv set(This, []) +-spec set(This) -> ok when + This::wxGraphicsMatrix(). + set(This) when is_record(This, wx_ref) -> set(This, []). -%% @spec (This::wxGraphicsMatrix(), [Option]) -> ok -%% Option = {a, float()} | {b, float()} | {c, float()} | {d, float()} | {tx, float()} | {ty, float()} %% @doc See external documentation. +-spec set(This, [Option]) -> ok when + This::wxGraphicsMatrix(), + Option :: {a, float()} + | {b, float()} + | {c, float()} + | {d, float()} + | {tx, float()} + | {ty, float()}. set(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGraphicsMatrix), @@ -128,15 +148,17 @@ set(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxGraphicsMatrix_Set, <>). -%% @spec (This::wxGraphicsMatrix()) -> {X::float(), Y::float()} %% @doc See external documentation. +-spec transformPoint(This) -> {X::float(), Y::float()} when + This::wxGraphicsMatrix(). transformPoint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsMatrix), wxe_util:call(?wxGraphicsMatrix_TransformPoint, <>). -%% @spec (This::wxGraphicsMatrix()) -> {Dx::float(), Dy::float()} %% @doc See external documentation. +-spec transformDistance(This) -> {Dx::float(), Dy::float()} when + This::wxGraphicsMatrix(). transformDistance(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsMatrix), wxe_util:call(?wxGraphicsMatrix_TransformDistance, diff --git a/lib/wx/src/gen/wxGraphicsObject.erl b/lib/wx/src/gen/wxGraphicsObject.erl index 7e63285b7a..e2e082ff91 100644 --- a/lib/wx/src/gen/wxGraphicsObject.erl +++ b/lib/wx/src/gen/wxGraphicsObject.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 @@ -29,18 +29,22 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxGraphicsObject/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxGraphicsObject()) -> wxGraphicsRenderer:wxGraphicsRenderer() +-type wxGraphicsObject() :: wx:wx_object(). %% @doc See external documentation. +-spec getRenderer(This) -> wxGraphicsRenderer:wxGraphicsRenderer() when + This::wxGraphicsObject(). getRenderer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsObject), wxe_util:call(?wxGraphicsObject_GetRenderer, <>). -%% @spec (This::wxGraphicsObject()) -> bool() %% @doc See external documentation. +-spec isNull(This) -> boolean() when + This::wxGraphicsObject(). isNull(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsObject), wxe_util:call(?wxGraphicsObject_IsNull, diff --git a/lib/wx/src/gen/wxGraphicsPath.erl b/lib/wx/src/gen/wxGraphicsPath.erl index e41496c641..6e9af755b9 100644 --- a/lib/wx/src/gen/wxGraphicsPath.erl +++ b/lib/wx/src/gen/wxGraphicsPath.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 @@ -36,152 +36,169 @@ %% inherited exports -export([getRenderer/1,isNull/1,parent_class/1]). +-export_type([wxGraphicsPath/0]). %% @hidden parent_class(wxGraphicsObject) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxGraphicsPath(), P::{X::float(), Y::float()}) -> ok +-type wxGraphicsPath() :: wx:wx_object(). %% @doc See external documentation. +-spec moveToPoint(This, P) -> ok when + This::wxGraphicsPath(), P::{X::float(), Y::float()}. moveToPoint(#wx_ref{type=ThisT,ref=ThisRef},{PX,PY}) when is_number(PX),is_number(PY) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_MoveToPoint_1, <>). -%% @spec (This::wxGraphicsPath(), X::float(), Y::float()) -> ok %% @doc See external documentation. +-spec moveToPoint(This, X, Y) -> ok when + This::wxGraphicsPath(), X::float(), Y::float(). moveToPoint(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_float(X),is_float(Y) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_MoveToPoint_2, <>). -%% @spec (This::wxGraphicsPath(), C::{X::float(), Y::float()}, R::float(), StartAngle::float(), EndAngle::float(), Clockwise::bool()) -> ok %% @doc See external documentation. +-spec addArc(This, C, R, StartAngle, EndAngle, Clockwise) -> ok when + This::wxGraphicsPath(), C::{X::float(), Y::float()}, R::float(), StartAngle::float(), EndAngle::float(), Clockwise::boolean(). addArc(#wx_ref{type=ThisT,ref=ThisRef},{CX,CY},R,StartAngle,EndAngle,Clockwise) when is_number(CX),is_number(CY),is_float(R),is_float(StartAngle),is_float(EndAngle),is_boolean(Clockwise) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddArc_5, <>). -%% @spec (This::wxGraphicsPath(), X::float(), Y::float(), R::float(), StartAngle::float(), EndAngle::float(), Clockwise::bool()) -> ok %% @doc See external documentation. +-spec addArc(This, X, Y, R, StartAngle, EndAngle, Clockwise) -> ok when + This::wxGraphicsPath(), X::float(), Y::float(), R::float(), StartAngle::float(), EndAngle::float(), Clockwise::boolean(). addArc(#wx_ref{type=ThisT,ref=ThisRef},X,Y,R,StartAngle,EndAngle,Clockwise) when is_float(X),is_float(Y),is_float(R),is_float(StartAngle),is_float(EndAngle),is_boolean(Clockwise) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddArc_6, <>). -%% @spec (This::wxGraphicsPath(), X1::float(), Y1::float(), X2::float(), Y2::float(), R::float()) -> ok %% @doc See external documentation. +-spec addArcToPoint(This, X1, Y1, X2, Y2, R) -> ok when + This::wxGraphicsPath(), X1::float(), Y1::float(), X2::float(), Y2::float(), R::float(). addArcToPoint(#wx_ref{type=ThisT,ref=ThisRef},X1,Y1,X2,Y2,R) when is_float(X1),is_float(Y1),is_float(X2),is_float(Y2),is_float(R) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddArcToPoint, <>). -%% @spec (This::wxGraphicsPath(), X::float(), Y::float(), R::float()) -> ok %% @doc See external documentation. +-spec addCircle(This, X, Y, R) -> ok when + This::wxGraphicsPath(), X::float(), Y::float(), R::float(). addCircle(#wx_ref{type=ThisT,ref=ThisRef},X,Y,R) when is_float(X),is_float(Y),is_float(R) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddCircle, <>). -%% @spec (This::wxGraphicsPath(), C1::{X::float(), Y::float()}, C2::{X::float(), Y::float()}, E::{X::float(), Y::float()}) -> ok %% @doc See external documentation. +-spec addCurveToPoint(This, C1, C2, E) -> ok when + This::wxGraphicsPath(), C1::{X::float(), Y::float()}, C2::{X::float(), Y::float()}, E::{X::float(), Y::float()}. addCurveToPoint(#wx_ref{type=ThisT,ref=ThisRef},{C1X,C1Y},{C2X,C2Y},{EX,EY}) when is_number(C1X),is_number(C1Y),is_number(C2X),is_number(C2Y),is_number(EX),is_number(EY) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddCurveToPoint_3, <>). -%% @spec (This::wxGraphicsPath(), Cx1::float(), Cy1::float(), Cx2::float(), Cy2::float(), X::float(), Y::float()) -> ok %% @doc See external documentation. +-spec addCurveToPoint(This, Cx1, Cy1, Cx2, Cy2, X, Y) -> ok when + This::wxGraphicsPath(), Cx1::float(), Cy1::float(), Cx2::float(), Cy2::float(), X::float(), Y::float(). addCurveToPoint(#wx_ref{type=ThisT,ref=ThisRef},Cx1,Cy1,Cx2,Cy2,X,Y) when is_float(Cx1),is_float(Cy1),is_float(Cx2),is_float(Cy2),is_float(X),is_float(Y) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddCurveToPoint_6, <>). -%% @spec (This::wxGraphicsPath(), X::float(), Y::float(), W::float(), H::float()) -> ok %% @doc See external documentation. +-spec addEllipse(This, X, Y, W, H) -> ok when + This::wxGraphicsPath(), X::float(), Y::float(), W::float(), H::float(). addEllipse(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_float(X),is_float(Y),is_float(W),is_float(H) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddEllipse, <>). -%% @spec (This::wxGraphicsPath(), P::{X::float(), Y::float()}) -> ok %% @doc See external documentation. +-spec addLineToPoint(This, P) -> ok when + This::wxGraphicsPath(), P::{X::float(), Y::float()}. addLineToPoint(#wx_ref{type=ThisT,ref=ThisRef},{PX,PY}) when is_number(PX),is_number(PY) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddLineToPoint_1, <>). -%% @spec (This::wxGraphicsPath(), X::float(), Y::float()) -> ok %% @doc See external documentation. +-spec addLineToPoint(This, X, Y) -> ok when + This::wxGraphicsPath(), X::float(), Y::float(). addLineToPoint(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_float(X),is_float(Y) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddLineToPoint_2, <>). -%% @spec (This::wxGraphicsPath(), Path::wxGraphicsPath()) -> ok %% @doc See external documentation. +-spec addPath(This, Path) -> ok when + This::wxGraphicsPath(), Path::wxGraphicsPath(). addPath(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PathT,ref=PathRef}) -> ?CLASS(ThisT,wxGraphicsPath), ?CLASS(PathT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddPath, <>). -%% @spec (This::wxGraphicsPath(), Cx::float(), Cy::float(), X::float(), Y::float()) -> ok %% @doc See external documentation. +-spec addQuadCurveToPoint(This, Cx, Cy, X, Y) -> ok when + This::wxGraphicsPath(), Cx::float(), Cy::float(), X::float(), Y::float(). addQuadCurveToPoint(#wx_ref{type=ThisT,ref=ThisRef},Cx,Cy,X,Y) when is_float(Cx),is_float(Cy),is_float(X),is_float(Y) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddQuadCurveToPoint, <>). -%% @spec (This::wxGraphicsPath(), X::float(), Y::float(), W::float(), H::float()) -> ok %% @doc See external documentation. +-spec addRectangle(This, X, Y, W, H) -> ok when + This::wxGraphicsPath(), X::float(), Y::float(), W::float(), H::float(). addRectangle(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_float(X),is_float(Y),is_float(W),is_float(H) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddRectangle, <>). -%% @spec (This::wxGraphicsPath(), X::float(), Y::float(), W::float(), H::float(), Radius::float()) -> ok %% @doc See external documentation. +-spec addRoundedRectangle(This, X, Y, W, H, Radius) -> ok when + This::wxGraphicsPath(), X::float(), Y::float(), W::float(), H::float(), Radius::float(). addRoundedRectangle(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H,Radius) when is_float(X),is_float(Y),is_float(W),is_float(H),is_float(Radius) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_AddRoundedRectangle, <>). -%% @spec (This::wxGraphicsPath()) -> ok %% @doc See external documentation. +-spec closeSubpath(This) -> ok when + This::wxGraphicsPath(). closeSubpath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:cast(?wxGraphicsPath_CloseSubpath, <>). -%% @spec (This::wxGraphicsPath(), C::{X::float(), Y::float()}) -> bool() %% @equiv contains(This,C, []) +-spec contains(This, C) -> boolean() when + This::wxGraphicsPath(), C::{X::float(), Y::float()}. + contains(This,C={CX,CY}) when is_record(This, wx_ref),is_number(CX),is_number(CY) -> contains(This,C, []). -%% @spec (This::wxGraphicsPath(),X::float()|term(),X::float()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% contains(This::wxGraphicsPath(), X::float(), Y::float()) -> contains(This,X,Y, [])

-%%

-%% contains(This::wxGraphicsPath(), C::{X::float(), Y::float()}, [Option]) -> bool() -%%
Option = {fillStyle, integer()} -%%

+-spec contains(This, X, Y) -> boolean() when + This::wxGraphicsPath(), X::float(), Y::float(); + (This, C, [Option]) -> boolean() when + This::wxGraphicsPath(), C::{X::float(), Y::float()}, + Option :: {fillStyle, integer()}. contains(This,X,Y) when is_record(This, wx_ref),is_float(X),is_float(Y) -> @@ -195,9 +212,10 @@ contains(#wx_ref{type=ThisT,ref=ThisRef},{CX,CY}, Options) wxe_util:call(?wxGraphicsPath_Contains_2, <>). -%% @spec (This::wxGraphicsPath(), X::float(), Y::float(), [Option]) -> bool() -%% Option = {fillStyle, integer()} %% @doc See external documentation. +-spec contains(This, X, Y, [Option]) -> boolean() when + This::wxGraphicsPath(), X::float(), Y::float(), + Option :: {fillStyle, integer()}. contains(#wx_ref{type=ThisT,ref=ThisRef},X,Y, Options) when is_float(X),is_float(Y),is_list(Options) -> ?CLASS(ThisT,wxGraphicsPath), @@ -207,22 +225,25 @@ contains(#wx_ref{type=ThisT,ref=ThisRef},X,Y, Options) wxe_util:call(?wxGraphicsPath_Contains_3, <>). -%% @spec (This::wxGraphicsPath()) -> {X::float(), Y::float(), W::float(), H::float()} %% @doc See external documentation. +-spec getBox(This) -> {X::float(), Y::float(), W::float(), H::float()} when + This::wxGraphicsPath(). getBox(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:call(?wxGraphicsPath_GetBox, <>). -%% @spec (This::wxGraphicsPath()) -> {X::float(), Y::float()} %% @doc See external documentation. +-spec getCurrentPoint(This) -> {X::float(), Y::float()} when + This::wxGraphicsPath(). getCurrentPoint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsPath), wxe_util:call(?wxGraphicsPath_GetCurrentPoint, <>). -%% @spec (This::wxGraphicsPath(), Matrix::wxGraphicsMatrix:wxGraphicsMatrix()) -> ok %% @doc See external documentation. +-spec transform(This, Matrix) -> ok when + This::wxGraphicsPath(), Matrix::wxGraphicsMatrix:wxGraphicsMatrix(). transform(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MatrixT,ref=MatrixRef}) -> ?CLASS(ThisT,wxGraphicsPath), ?CLASS(MatrixT,wxGraphicsMatrix), diff --git a/lib/wx/src/gen/wxGraphicsPen.erl b/lib/wx/src/gen/wxGraphicsPen.erl index 395b05f8af..76a59e6e2c 100644 --- a/lib/wx/src/gen/wxGraphicsPen.erl +++ b/lib/wx/src/gen/wxGraphicsPen.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 @@ -32,10 +32,12 @@ %% inherited exports -export([getRenderer/1,isNull/1,parent_class/1]). +-export_type([wxGraphicsPen/0]). %% @hidden parent_class(wxGraphicsObject) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxGraphicsPen() :: wx:wx_object(). %% From wxGraphicsObject %% @hidden isNull(This) -> wxGraphicsObject:isNull(This). diff --git a/lib/wx/src/gen/wxGraphicsRenderer.erl b/lib/wx/src/gen/wxGraphicsRenderer.erl index ed53ebf468..b4b3e506e7 100644 --- a/lib/wx/src/gen/wxGraphicsRenderer.erl +++ b/lib/wx/src/gen/wxGraphicsRenderer.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 @@ -31,17 +31,20 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxGraphicsRenderer/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGraphicsRenderer() +-type wxGraphicsRenderer() :: wx:wx_object(). %% @doc See external documentation. +-spec getDefaultRenderer() -> wxGraphicsRenderer(). getDefaultRenderer() -> wxe_util:call(?wxGraphicsRenderer_GetDefaultRenderer, <<>>). -%% @spec (This::wxGraphicsRenderer(), Dc::wxWindowDC:wxWindowDC() | wxWindow:wxWindow()) -> wxGraphicsContext:wxGraphicsContext() %% @doc See external documentation. +-spec createContext(This, Dc) -> wxGraphicsContext:wxGraphicsContext() when + This::wxGraphicsRenderer(), Dc::wxWindowDC:wxWindowDC() | wxWindow:wxWindow(). createContext(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DcT,ref=DcRef}) -> ?CLASS(ThisT,wxGraphicsRenderer), DcOP = case ?CLASS_T(DcT,wxWindowDC) of @@ -53,47 +56,54 @@ createContext(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DcT,ref=DcRef}) -> wxe_util:call(DcOP, <>). -%% @spec (This::wxGraphicsRenderer(), Pen::wxPen:wxPen()) -> wxGraphicsPen:wxGraphicsPen() %% @doc See external documentation. +-spec createPen(This, Pen) -> wxGraphicsPen:wxGraphicsPen() when + This::wxGraphicsRenderer(), Pen::wxPen:wxPen(). createPen(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PenT,ref=PenRef}) -> ?CLASS(ThisT,wxGraphicsRenderer), ?CLASS(PenT,wxPen), wxe_util:call(?wxGraphicsRenderer_CreatePen, <>). -%% @spec (This::wxGraphicsRenderer(), Brush::wxBrush:wxBrush()) -> wxGraphicsBrush:wxGraphicsBrush() %% @doc See external documentation. +-spec createBrush(This, Brush) -> wxGraphicsBrush:wxGraphicsBrush() when + This::wxGraphicsRenderer(), Brush::wxBrush:wxBrush(). createBrush(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BrushT,ref=BrushRef}) -> ?CLASS(ThisT,wxGraphicsRenderer), ?CLASS(BrushT,wxBrush), wxe_util:call(?wxGraphicsRenderer_CreateBrush, <>). -%% @spec (This::wxGraphicsRenderer(), X1::float(), Y1::float(), X2::float(), Y2::float(), C1::wx:colour(), C2::wx:colour()) -> wxGraphicsBrush:wxGraphicsBrush() %% @doc See external documentation. +-spec createLinearGradientBrush(This, X1, Y1, X2, Y2, C1, C2) -> wxGraphicsBrush:wxGraphicsBrush() when + This::wxGraphicsRenderer(), X1::float(), Y1::float(), X2::float(), Y2::float(), C1::wx:wx_colour(), C2::wx:wx_colour(). createLinearGradientBrush(#wx_ref{type=ThisT,ref=ThisRef},X1,Y1,X2,Y2,C1,C2) when is_float(X1),is_float(Y1),is_float(X2),is_float(Y2),tuple_size(C1) =:= 3; tuple_size(C1) =:= 4,tuple_size(C2) =:= 3; tuple_size(C2) =:= 4 -> ?CLASS(ThisT,wxGraphicsRenderer), wxe_util:call(?wxGraphicsRenderer_CreateLinearGradientBrush, <>). -%% @spec (This::wxGraphicsRenderer(), Xo::float(), Yo::float(), Xc::float(), Yc::float(), Radius::float(), OColor::wx:colour(), CColor::wx:colour()) -> wxGraphicsBrush:wxGraphicsBrush() %% @doc See external documentation. +-spec createRadialGradientBrush(This, Xo, Yo, Xc, Yc, Radius, OColor, CColor) -> wxGraphicsBrush:wxGraphicsBrush() when + This::wxGraphicsRenderer(), Xo::float(), Yo::float(), Xc::float(), Yc::float(), Radius::float(), OColor::wx:wx_colour(), CColor::wx:wx_colour(). createRadialGradientBrush(#wx_ref{type=ThisT,ref=ThisRef},Xo,Yo,Xc,Yc,Radius,OColor,CColor) when is_float(Xo),is_float(Yo),is_float(Xc),is_float(Yc),is_float(Radius),tuple_size(OColor) =:= 3; tuple_size(OColor) =:= 4,tuple_size(CColor) =:= 3; tuple_size(CColor) =:= 4 -> ?CLASS(ThisT,wxGraphicsRenderer), wxe_util:call(?wxGraphicsRenderer_CreateRadialGradientBrush, <>). -%% @spec (This::wxGraphicsRenderer(), Font::wxFont:wxFont()) -> wxGraphicsFont:wxGraphicsFont() %% @equiv createFont(This,Font, []) +-spec createFont(This, Font) -> wxGraphicsFont:wxGraphicsFont() when + This::wxGraphicsRenderer(), Font::wxFont:wxFont(). + createFont(This,Font) when is_record(This, wx_ref),is_record(Font, wx_ref) -> createFont(This,Font, []). -%% @spec (This::wxGraphicsRenderer(), Font::wxFont:wxFont(), [Option]) -> wxGraphicsFont:wxGraphicsFont() -%% Option = {col, wx:colour()} %% @doc See external documentation. +-spec createFont(This, Font, [Option]) -> wxGraphicsFont:wxGraphicsFont() when + This::wxGraphicsRenderer(), Font::wxFont:wxFont(), + Option :: {col, wx:wx_colour()}. createFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGraphicsRenderer), @@ -104,15 +114,23 @@ createFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}, Opti wxe_util:call(?wxGraphicsRenderer_CreateFont, <>). -%% @spec (This::wxGraphicsRenderer()) -> wxGraphicsMatrix:wxGraphicsMatrix() %% @equiv createMatrix(This, []) +-spec createMatrix(This) -> wxGraphicsMatrix:wxGraphicsMatrix() when + This::wxGraphicsRenderer(). + createMatrix(This) when is_record(This, wx_ref) -> createMatrix(This, []). -%% @spec (This::wxGraphicsRenderer(), [Option]) -> wxGraphicsMatrix:wxGraphicsMatrix() -%% Option = {a, float()} | {b, float()} | {c, float()} | {d, float()} | {tx, float()} | {ty, float()} %% @doc See external documentation. +-spec createMatrix(This, [Option]) -> wxGraphicsMatrix:wxGraphicsMatrix() when + This::wxGraphicsRenderer(), + Option :: {a, float()} + | {b, float()} + | {c, float()} + | {d, float()} + | {tx, float()} + | {ty, float()}. createMatrix(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGraphicsRenderer), @@ -127,8 +145,9 @@ createMatrix(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxGraphicsRenderer_CreateMatrix, <>). -%% @spec (This::wxGraphicsRenderer()) -> wxGraphicsPath:wxGraphicsPath() %% @doc See external documentation. +-spec createPath(This) -> wxGraphicsPath:wxGraphicsPath() when + This::wxGraphicsRenderer(). createPath(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGraphicsRenderer), wxe_util:call(?wxGraphicsRenderer_CreatePath, diff --git a/lib/wx/src/gen/wxGrid.erl b/lib/wx/src/gen/wxGrid.erl index 531fed05c1..ab4ec3a44a 100644 --- a/lib/wx/src/gen/wxGrid.erl +++ b/lib/wx/src/gen/wxGrid.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 @@ -125,6 +125,7 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxGrid/0]). %% @hidden parent_class(wxScrolledWindow) -> true; parent_class(wxPanel) -> true; @@ -132,27 +133,29 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGrid() +-type wxGrid() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxGrid(). new() -> wxe_util:construct(?wxGrid_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxGrid() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxGrid() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(),X::integer(),X::integer()|term()) -> wxGrid() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Parent::wxWindow:wxWindow(), X::integer(), Y::integer()) -> new(Parent,X,Y, [])

-%%

-%% new(Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxGrid() -%%
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 + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(Parent,X,Y) when is_record(Parent, wx_ref),is_integer(X),is_integer(Y) -> @@ -168,9 +171,12 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxGrid_new_3, <>). -%% @spec (Parent::wxWindow:wxWindow(), X::integer(), Y::integer(), [Option]) -> wxGrid() -%% Option = {w, integer()} | {h, integer()} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, X, Y, [Option]) -> wxGrid() when + Parent::wxWindow:wxWindow(), X::integer(), Y::integer(), + Option :: {w, integer()} + | {h, integer()} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},X,Y, Options) when is_integer(X),is_integer(Y),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -182,15 +188,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef},X,Y, Options) wxe_util:construct(?wxGrid_new_4, <>). -%% @spec (This::wxGrid()) -> bool() %% @equiv appendCols(This, []) +-spec appendCols(This) -> boolean() when + This::wxGrid(). + appendCols(This) when is_record(This, wx_ref) -> appendCols(This, []). -%% @spec (This::wxGrid(), [Option]) -> bool() -%% Option = {numCols, integer()} | {updateLabels, bool()} %% @doc See external documentation. +-spec appendCols(This, [Option]) -> boolean() when + This::wxGrid(), + Option :: {numCols, integer()} + | {updateLabels, boolean()}. appendCols(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -201,15 +211,19 @@ appendCols(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxGrid_AppendCols, <>). -%% @spec (This::wxGrid()) -> bool() %% @equiv appendRows(This, []) +-spec appendRows(This) -> boolean() when + This::wxGrid(). + appendRows(This) when is_record(This, wx_ref) -> appendRows(This, []). -%% @spec (This::wxGrid(), [Option]) -> bool() -%% Option = {numRows, integer()} | {updateLabels, bool()} %% @doc See external documentation. +-spec appendRows(This, [Option]) -> boolean() when + This::wxGrid(), + Option :: {numRows, integer()} + | {updateLabels, boolean()}. appendRows(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -220,22 +234,26 @@ appendRows(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxGrid_AppendRows, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec autoSize(This) -> ok when + This::wxGrid(). autoSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_AutoSize, <>). -%% @spec (This::wxGrid(), Col::integer()) -> ok %% @equiv autoSizeColumn(This,Col, []) +-spec autoSizeColumn(This, Col) -> ok when + This::wxGrid(), Col::integer(). + autoSizeColumn(This,Col) when is_record(This, wx_ref),is_integer(Col) -> autoSizeColumn(This,Col, []). -%% @spec (This::wxGrid(), Col::integer(), [Option]) -> ok -%% Option = {setAsMin, bool()} %% @doc See external documentation. +-spec autoSizeColumn(This, Col, [Option]) -> ok when + This::wxGrid(), Col::integer(), + Option :: {setAsMin, boolean()}. autoSizeColumn(#wx_ref{type=ThisT,ref=ThisRef},Col, Options) when is_integer(Col),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -245,15 +263,18 @@ autoSizeColumn(#wx_ref{type=ThisT,ref=ThisRef},Col, Options) wxe_util:cast(?wxGrid_AutoSizeColumn, <>). -%% @spec (This::wxGrid()) -> ok %% @equiv autoSizeColumns(This, []) +-spec autoSizeColumns(This) -> ok when + This::wxGrid(). + autoSizeColumns(This) when is_record(This, wx_ref) -> autoSizeColumns(This, []). -%% @spec (This::wxGrid(), [Option]) -> ok -%% Option = {setAsMin, bool()} %% @doc See external documentation. +-spec autoSizeColumns(This, [Option]) -> ok when + This::wxGrid(), + Option :: {setAsMin, boolean()}. autoSizeColumns(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -263,15 +284,18 @@ autoSizeColumns(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxGrid_AutoSizeColumns, <>). -%% @spec (This::wxGrid(), Row::integer()) -> ok %% @equiv autoSizeRow(This,Row, []) +-spec autoSizeRow(This, Row) -> ok when + This::wxGrid(), Row::integer(). + autoSizeRow(This,Row) when is_record(This, wx_ref),is_integer(Row) -> autoSizeRow(This,Row, []). -%% @spec (This::wxGrid(), Row::integer(), [Option]) -> ok -%% Option = {setAsMin, bool()} %% @doc See external documentation. +-spec autoSizeRow(This, Row, [Option]) -> ok when + This::wxGrid(), Row::integer(), + Option :: {setAsMin, boolean()}. autoSizeRow(#wx_ref{type=ThisT,ref=ThisRef},Row, Options) when is_integer(Row),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -281,15 +305,18 @@ autoSizeRow(#wx_ref{type=ThisT,ref=ThisRef},Row, Options) wxe_util:cast(?wxGrid_AutoSizeRow, <>). -%% @spec (This::wxGrid()) -> ok %% @equiv autoSizeRows(This, []) +-spec autoSizeRows(This) -> ok when + This::wxGrid(). + autoSizeRows(This) when is_record(This, wx_ref) -> autoSizeRows(This, []). -%% @spec (This::wxGrid(), [Option]) -> ok -%% Option = {setAsMin, bool()} %% @doc See external documentation. +-spec autoSizeRows(This, [Option]) -> ok when + This::wxGrid(), + Option :: {setAsMin, boolean()}. autoSizeRows(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -299,90 +326,102 @@ autoSizeRows(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxGrid_AutoSizeRows, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec beginBatch(This) -> ok when + This::wxGrid(). beginBatch(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_BeginBatch, <>). -%% @spec (This::wxGrid(), TopLeft::{R::integer(), C::integer()}, BottomRight::{R::integer(), C::integer()}) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec blockToDeviceRect(This, TopLeft, BottomRight) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxGrid(), TopLeft::{R::integer(), C::integer()}, BottomRight::{R::integer(), C::integer()}. blockToDeviceRect(#wx_ref{type=ThisT,ref=ThisRef},{TopLeftR,TopLeftC},{BottomRightR,BottomRightC}) when is_integer(TopLeftR),is_integer(TopLeftC),is_integer(BottomRightR),is_integer(BottomRightC) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_BlockToDeviceRect, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec canDragColSize(This) -> boolean() when + This::wxGrid(). canDragColSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_CanDragColSize, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec canDragRowSize(This) -> boolean() when + This::wxGrid(). canDragRowSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_CanDragRowSize, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec canDragGridSize(This) -> boolean() when + This::wxGrid(). canDragGridSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_CanDragGridSize, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec canEnableCellControl(This) -> boolean() when + This::wxGrid(). canEnableCellControl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_CanEnableCellControl, <>). -%% @spec (This::wxGrid(), Coords::{R::integer(), C::integer()}) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec cellToRect(This, Coords) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxGrid(), Coords::{R::integer(), C::integer()}. cellToRect(#wx_ref{type=ThisT,ref=ThisRef},{CoordsR,CoordsC}) when is_integer(CoordsR),is_integer(CoordsC) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_CellToRect_1, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec cellToRect(This, Row, Col) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxGrid(), Row::integer(), Col::integer(). cellToRect(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_CellToRect_2, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec clearGrid(This) -> ok when + This::wxGrid(). clearGrid(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_ClearGrid, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec clearSelection(This) -> ok when + This::wxGrid(). clearSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_ClearSelection, <>). -%% @spec (This::wxGrid(), NumRows::integer(), NumCols::integer()) -> bool() %% @equiv createGrid(This,NumRows,NumCols, []) +-spec createGrid(This, NumRows, NumCols) -> boolean() when + This::wxGrid(), NumRows::integer(), NumCols::integer(). + createGrid(This,NumRows,NumCols) when is_record(This, wx_ref),is_integer(NumRows),is_integer(NumCols) -> createGrid(This,NumRows,NumCols, []). -%% @spec (This::wxGrid(), NumRows::integer(), NumCols::integer(), [Option]) -> bool() -%% Option = {selmode, WxGridSelectionModes} -%% WxGridSelectionModes = integer() %% @doc See external documentation. -%%
WxGridSelectionModes is one of ?wxGrid_wxGridSelectCells | ?wxGrid_wxGridSelectRows | ?wxGrid_wxGridSelectColumns +%%
Selmode = ?wxGrid_wxGridSelectCells | ?wxGrid_wxGridSelectRows | ?wxGrid_wxGridSelectColumns +-spec createGrid(This, NumRows, NumCols, [Option]) -> boolean() when + This::wxGrid(), NumRows::integer(), NumCols::integer(), + Option :: {selmode, wx:wx_enum()}. createGrid(#wx_ref{type=ThisT,ref=ThisRef},NumRows,NumCols, Options) when is_integer(NumRows),is_integer(NumCols),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -392,15 +431,20 @@ createGrid(#wx_ref{type=ThisT,ref=ThisRef},NumRows,NumCols, Options) wxe_util:call(?wxGrid_CreateGrid, <>). -%% @spec (This::wxGrid()) -> bool() %% @equiv deleteCols(This, []) +-spec deleteCols(This) -> boolean() when + This::wxGrid(). + deleteCols(This) when is_record(This, wx_ref) -> deleteCols(This, []). -%% @spec (This::wxGrid(), [Option]) -> bool() -%% Option = {pos, integer()} | {numCols, integer()} | {updateLabels, bool()} %% @doc See external documentation. +-spec deleteCols(This, [Option]) -> boolean() when + This::wxGrid(), + Option :: {pos, integer()} + | {numCols, integer()} + | {updateLabels, boolean()}. deleteCols(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -412,15 +456,20 @@ deleteCols(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxGrid_DeleteCols, <>). -%% @spec (This::wxGrid()) -> bool() %% @equiv deleteRows(This, []) +-spec deleteRows(This) -> boolean() when + This::wxGrid(). + deleteRows(This) when is_record(This, wx_ref) -> deleteRows(This, []). -%% @spec (This::wxGrid(), [Option]) -> bool() -%% Option = {pos, integer()} | {numRows, integer()} | {updateLabels, bool()} %% @doc See external documentation. +-spec deleteRows(This, [Option]) -> boolean() when + This::wxGrid(), + Option :: {pos, integer()} + | {numRows, integer()} + | {updateLabels, boolean()}. deleteRows(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -432,43 +481,50 @@ deleteRows(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxGrid_DeleteRows, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec disableCellEditControl(This) -> ok when + This::wxGrid(). disableCellEditControl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_DisableCellEditControl, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec disableDragColSize(This) -> ok when + This::wxGrid(). disableDragColSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_DisableDragColSize, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec disableDragGridSize(This) -> ok when + This::wxGrid(). disableDragGridSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_DisableDragGridSize, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec disableDragRowSize(This) -> ok when + This::wxGrid(). disableDragRowSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_DisableDragRowSize, <>). -%% @spec (This::wxGrid()) -> ok %% @equiv enableCellEditControl(This, []) +-spec enableCellEditControl(This) -> ok when + This::wxGrid(). + enableCellEditControl(This) when is_record(This, wx_ref) -> enableCellEditControl(This, []). -%% @spec (This::wxGrid(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enableCellEditControl(This, [Option]) -> ok when + This::wxGrid(), + Option :: {enable, boolean()}. enableCellEditControl(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -478,15 +534,18 @@ enableCellEditControl(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxGrid_EnableCellEditControl, <>). -%% @spec (This::wxGrid()) -> ok %% @equiv enableDragColSize(This, []) +-spec enableDragColSize(This) -> ok when + This::wxGrid(). + enableDragColSize(This) when is_record(This, wx_ref) -> enableDragColSize(This, []). -%% @spec (This::wxGrid(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enableDragColSize(This, [Option]) -> ok when + This::wxGrid(), + Option :: {enable, boolean()}. enableDragColSize(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -496,15 +555,18 @@ enableDragColSize(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxGrid_EnableDragColSize, <>). -%% @spec (This::wxGrid()) -> ok %% @equiv enableDragGridSize(This, []) +-spec enableDragGridSize(This) -> ok when + This::wxGrid(). + enableDragGridSize(This) when is_record(This, wx_ref) -> enableDragGridSize(This, []). -%% @spec (This::wxGrid(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enableDragGridSize(This, [Option]) -> ok when + This::wxGrid(), + Option :: {enable, boolean()}. enableDragGridSize(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -514,15 +576,18 @@ enableDragGridSize(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxGrid_EnableDragGridSize, <>). -%% @spec (This::wxGrid()) -> ok %% @equiv enableDragRowSize(This, []) +-spec enableDragRowSize(This) -> ok when + This::wxGrid(). + enableDragRowSize(This) when is_record(This, wx_ref) -> enableDragRowSize(This, []). -%% @spec (This::wxGrid(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enableDragRowSize(This, [Option]) -> ok when + This::wxGrid(), + Option :: {enable, boolean()}. enableDragRowSize(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -532,23 +597,27 @@ enableDragRowSize(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxGrid_EnableDragRowSize, <>). -%% @spec (This::wxGrid(), Edit::bool()) -> ok %% @doc See external documentation. +-spec enableEditing(This, Edit) -> ok when + This::wxGrid(), Edit::boolean(). enableEditing(#wx_ref{type=ThisT,ref=ThisRef},Edit) when is_boolean(Edit) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_EnableEditing, <>). -%% @spec (This::wxGrid()) -> ok %% @equiv enableGridLines(This, []) +-spec enableGridLines(This) -> ok when + This::wxGrid(). + enableGridLines(This) when is_record(This, wx_ref) -> enableGridLines(This, []). -%% @spec (This::wxGrid(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enableGridLines(This, [Option]) -> ok when + This::wxGrid(), + Option :: {enable, boolean()}. enableGridLines(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -558,194 +627,220 @@ enableGridLines(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxGrid_EnableGridLines, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec endBatch(This) -> ok when + This::wxGrid(). endBatch(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_EndBatch, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec fit(This) -> ok when + This::wxGrid(). fit(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_Fit, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec forceRefresh(This) -> ok when + This::wxGrid(). forceRefresh(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_ForceRefresh, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getBatchCount(This) -> integer() when + This::wxGrid(). getBatchCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetBatchCount, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> {Horiz::integer(), Vert::integer()} %% @doc See external documentation. +-spec getCellAlignment(This, Row, Col) -> {Horiz::integer(), Vert::integer()} when + This::wxGrid(), Row::integer(), Col::integer(). getCellAlignment(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetCellAlignment, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> wx:colour() %% @doc See external documentation. +-spec getCellBackgroundColour(This, Row, Col) -> wx:wx_colour() when + This::wxGrid(), Row::integer(), Col::integer(). getCellBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetCellBackgroundColour, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellEditor:wxGridCellEditor() %% @doc See external documentation. +-spec getCellEditor(This, Row, Col) -> wxGridCellEditor:wxGridCellEditor() when + This::wxGrid(), Row::integer(), Col::integer(). getCellEditor(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetCellEditor, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getCellFont(This, Row, Col) -> wxFont:wxFont() when + This::wxGrid(), Row::integer(), Col::integer(). getCellFont(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetCellFont, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellRenderer:wxGridCellRenderer() %% @doc See external documentation. +-spec getCellRenderer(This, Row, Col) -> wxGridCellRenderer:wxGridCellRenderer() when + This::wxGrid(), Row::integer(), Col::integer(). getCellRenderer(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetCellRenderer, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> wx:colour() %% @doc See external documentation. +-spec getCellTextColour(This, Row, Col) -> wx:wx_colour() when + This::wxGrid(), Row::integer(), Col::integer(). getCellTextColour(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetCellTextColour, <>). -%% @spec (This::wxGrid(), Coords::{R::integer(), C::integer()}) -> string() %% @doc See external documentation. +-spec getCellValue(This, Coords) -> string() when + This::wxGrid(), Coords::{R::integer(), C::integer()}. getCellValue(#wx_ref{type=ThisT,ref=ThisRef},{CoordsR,CoordsC}) when is_integer(CoordsR),is_integer(CoordsC) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetCellValue_1, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> string() %% @doc See external documentation. +-spec getCellValue(This, Row, Col) -> string() when + This::wxGrid(), Row::integer(), Col::integer(). getCellValue(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetCellValue_2, <>). -%% @spec (This::wxGrid()) -> {Horiz::integer(), Vert::integer()} %% @doc See external documentation. +-spec getColLabelAlignment(This) -> {Horiz::integer(), Vert::integer()} when + This::wxGrid(). getColLabelAlignment(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetColLabelAlignment, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getColLabelSize(This) -> integer() when + This::wxGrid(). getColLabelSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetColLabelSize, <>). -%% @spec (This::wxGrid(), Col::integer()) -> string() %% @doc See external documentation. +-spec getColLabelValue(This, Col) -> string() when + This::wxGrid(), Col::integer(). getColLabelValue(#wx_ref{type=ThisT,ref=ThisRef},Col) when is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetColLabelValue, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getColMinimalAcceptableWidth(This) -> integer() when + This::wxGrid(). getColMinimalAcceptableWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetColMinimalAcceptableWidth, <>). -%% @spec (This::wxGrid()) -> {Horiz::integer(), Vert::integer()} %% @doc See external documentation. +-spec getDefaultCellAlignment(This) -> {Horiz::integer(), Vert::integer()} when + This::wxGrid(). getDefaultCellAlignment(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultCellAlignment, <>). -%% @spec (This::wxGrid()) -> wx:colour() %% @doc See external documentation. +-spec getDefaultCellBackgroundColour(This) -> wx:wx_colour() when + This::wxGrid(). getDefaultCellBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultCellBackgroundColour, <>). -%% @spec (This::wxGrid()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getDefaultCellFont(This) -> wxFont:wxFont() when + This::wxGrid(). getDefaultCellFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultCellFont, <>). -%% @spec (This::wxGrid()) -> wx:colour() %% @doc See external documentation. +-spec getDefaultCellTextColour(This) -> wx:wx_colour() when + This::wxGrid(). getDefaultCellTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultCellTextColour, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getDefaultColLabelSize(This) -> integer() when + This::wxGrid(). getDefaultColLabelSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultColLabelSize, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getDefaultColSize(This) -> integer() when + This::wxGrid(). getDefaultColSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultColSize, <>). -%% @spec (This::wxGrid()) -> wxGridCellEditor:wxGridCellEditor() %% @doc See external documentation. +-spec getDefaultEditor(This) -> wxGridCellEditor:wxGridCellEditor() when + This::wxGrid(). getDefaultEditor(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultEditor, <>). -%% @spec (This::wxGrid(), C::{R::integer(), C::integer()}) -> wxGridCellEditor:wxGridCellEditor() %% @doc See external documentation. +-spec getDefaultEditorForCell(This, C) -> wxGridCellEditor:wxGridCellEditor() when + This::wxGrid(), C::{R::integer(), C::integer()}. getDefaultEditorForCell(#wx_ref{type=ThisT,ref=ThisRef},{CR,CC}) when is_integer(CR),is_integer(CC) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultEditorForCell_1, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellEditor:wxGridCellEditor() %% @doc See external documentation. +-spec getDefaultEditorForCell(This, Row, Col) -> wxGridCellEditor:wxGridCellEditor() when + This::wxGrid(), Row::integer(), Col::integer(). getDefaultEditorForCell(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultEditorForCell_2, <>). -%% @spec (This::wxGrid(), TypeName::string()) -> wxGridCellEditor:wxGridCellEditor() %% @doc See external documentation. +-spec getDefaultEditorForType(This, TypeName) -> wxGridCellEditor:wxGridCellEditor() when + This::wxGrid(), TypeName::string(). getDefaultEditorForType(#wx_ref{type=ThisT,ref=ThisRef},TypeName) when is_list(TypeName) -> ?CLASS(ThisT,wxGrid), @@ -753,23 +848,26 @@ getDefaultEditorForType(#wx_ref{type=ThisT,ref=ThisRef},TypeName) wxe_util:call(?wxGrid_GetDefaultEditorForType, <>). -%% @spec (This::wxGrid()) -> wxGridCellRenderer:wxGridCellRenderer() %% @doc See external documentation. +-spec getDefaultRenderer(This) -> wxGridCellRenderer:wxGridCellRenderer() when + This::wxGrid(). getDefaultRenderer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultRenderer, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellRenderer:wxGridCellRenderer() %% @doc See external documentation. +-spec getDefaultRendererForCell(This, Row, Col) -> wxGridCellRenderer:wxGridCellRenderer() when + This::wxGrid(), Row::integer(), Col::integer(). getDefaultRendererForCell(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultRendererForCell, <>). -%% @spec (This::wxGrid(), TypeName::string()) -> wxGridCellRenderer:wxGridCellRenderer() %% @doc See external documentation. +-spec getDefaultRendererForType(This, TypeName) -> wxGridCellRenderer:wxGridCellRenderer() when + This::wxGrid(), TypeName::string(). getDefaultRendererForType(#wx_ref{type=ThisT,ref=ThisRef},TypeName) when is_list(TypeName) -> ?CLASS(ThisT,wxGrid), @@ -777,242 +875,279 @@ getDefaultRendererForType(#wx_ref{type=ThisT,ref=ThisRef},TypeName) wxe_util:call(?wxGrid_GetDefaultRendererForType, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getDefaultRowLabelSize(This) -> integer() when + This::wxGrid(). getDefaultRowLabelSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultRowLabelSize, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getDefaultRowSize(This) -> integer() when + This::wxGrid(). getDefaultRowSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetDefaultRowSize, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getGridCursorCol(This) -> integer() when + This::wxGrid(). getGridCursorCol(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetGridCursorCol, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getGridCursorRow(This) -> integer() when + This::wxGrid(). getGridCursorRow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetGridCursorRow, <>). -%% @spec (This::wxGrid()) -> wx:colour() %% @doc See external documentation. +-spec getGridLineColour(This) -> wx:wx_colour() when + This::wxGrid(). getGridLineColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetGridLineColour, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec gridLinesEnabled(This) -> boolean() when + This::wxGrid(). gridLinesEnabled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GridLinesEnabled, <>). -%% @spec (This::wxGrid()) -> wx:colour() %% @doc See external documentation. +-spec getLabelBackgroundColour(This) -> wx:wx_colour() when + This::wxGrid(). getLabelBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetLabelBackgroundColour, <>). -%% @spec (This::wxGrid()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getLabelFont(This) -> wxFont:wxFont() when + This::wxGrid(). getLabelFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetLabelFont, <>). -%% @spec (This::wxGrid()) -> wx:colour() %% @doc See external documentation. +-spec getLabelTextColour(This) -> wx:wx_colour() when + This::wxGrid(). getLabelTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetLabelTextColour, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getNumberCols(This) -> integer() when + This::wxGrid(). getNumberCols(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetNumberCols, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getNumberRows(This) -> integer() when + This::wxGrid(). getNumberRows(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetNumberRows, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellAttr:wxGridCellAttr() %% @doc See external documentation. +-spec getOrCreateCellAttr(This, Row, Col) -> wxGridCellAttr:wxGridCellAttr() when + This::wxGrid(), Row::integer(), Col::integer(). getOrCreateCellAttr(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetOrCreateCellAttr, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getRowMinimalAcceptableHeight(This) -> integer() when + This::wxGrid(). getRowMinimalAcceptableHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetRowMinimalAcceptableHeight, <>). -%% @spec (This::wxGrid()) -> {Horiz::integer(), Vert::integer()} %% @doc See external documentation. +-spec getRowLabelAlignment(This) -> {Horiz::integer(), Vert::integer()} when + This::wxGrid(). getRowLabelAlignment(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetRowLabelAlignment, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getRowLabelSize(This) -> integer() when + This::wxGrid(). getRowLabelSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetRowLabelSize, <>). -%% @spec (This::wxGrid(), Row::integer()) -> string() %% @doc See external documentation. +-spec getRowLabelValue(This, Row) -> string() when + This::wxGrid(), Row::integer(). getRowLabelValue(#wx_ref{type=ThisT,ref=ThisRef},Row) when is_integer(Row) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetRowLabelValue, <>). -%% @spec (This::wxGrid(), Row::integer()) -> integer() %% @doc See external documentation. +-spec getRowSize(This, Row) -> integer() when + This::wxGrid(), Row::integer(). getRowSize(#wx_ref{type=ThisT,ref=ThisRef},Row) when is_integer(Row) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetRowSize, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getScrollLineX(This) -> integer() when + This::wxGrid(). getScrollLineX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetScrollLineX, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getScrollLineY(This) -> integer() when + This::wxGrid(). getScrollLineY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetScrollLineY, <>). -%% @spec (This::wxGrid()) -> [{R::integer(), C::integer()}] %% @doc See external documentation. +-spec getSelectedCells(This) -> [{R::integer(), C::integer()}] when + This::wxGrid(). getSelectedCells(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetSelectedCells, <>). -%% @spec (This::wxGrid()) -> [integer()] %% @doc See external documentation. +-spec getSelectedCols(This) -> [integer()] when + This::wxGrid(). getSelectedCols(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetSelectedCols, <>). -%% @spec (This::wxGrid()) -> [integer()] %% @doc See external documentation. +-spec getSelectedRows(This) -> [integer()] when + This::wxGrid(). getSelectedRows(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetSelectedRows, <>). -%% @spec (This::wxGrid()) -> wx:colour() %% @doc See external documentation. +-spec getSelectionBackground(This) -> wx:wx_colour() when + This::wxGrid(). getSelectionBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetSelectionBackground, <>). -%% @spec (This::wxGrid()) -> [{R::integer(), C::integer()}] %% @doc See external documentation. +-spec getSelectionBlockTopLeft(This) -> [{R::integer(), C::integer()}] when + This::wxGrid(). getSelectionBlockTopLeft(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetSelectionBlockTopLeft, <>). -%% @spec (This::wxGrid()) -> [{R::integer(), C::integer()}] %% @doc See external documentation. +-spec getSelectionBlockBottomRight(This) -> [{R::integer(), C::integer()}] when + This::wxGrid(). getSelectionBlockBottomRight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetSelectionBlockBottomRight, <>). -%% @spec (This::wxGrid()) -> wx:colour() %% @doc See external documentation. +-spec getSelectionForeground(This) -> wx:wx_colour() when + This::wxGrid(). getSelectionForeground(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetSelectionForeground, <>). -%% @spec (This::wxGrid()) -> integer() %% @doc See external documentation. +-spec getViewWidth(This) -> integer() when + This::wxGrid(). getViewWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetViewWidth, <>). -%% @spec (This::wxGrid()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getGridWindow(This) -> wxWindow:wxWindow() when + This::wxGrid(). getGridWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetGridWindow, <>). -%% @spec (This::wxGrid()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getGridRowLabelWindow(This) -> wxWindow:wxWindow() when + This::wxGrid(). getGridRowLabelWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetGridRowLabelWindow, <>). -%% @spec (This::wxGrid()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getGridColLabelWindow(This) -> wxWindow:wxWindow() when + This::wxGrid(). getGridColLabelWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetGridColLabelWindow, <>). -%% @spec (This::wxGrid()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getGridCornerLabelWindow(This) -> wxWindow:wxWindow() when + This::wxGrid(). getGridCornerLabelWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_GetGridCornerLabelWindow, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec hideCellEditControl(This) -> ok when + This::wxGrid(). hideCellEditControl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_HideCellEditControl, <>). -%% @spec (This::wxGrid()) -> bool() %% @equiv insertCols(This, []) +-spec insertCols(This) -> boolean() when + This::wxGrid(). + insertCols(This) when is_record(This, wx_ref) -> insertCols(This, []). -%% @spec (This::wxGrid(), [Option]) -> bool() -%% Option = {pos, integer()} | {numCols, integer()} | {updateLabels, bool()} %% @doc See external documentation. +-spec insertCols(This, [Option]) -> boolean() when + This::wxGrid(), + Option :: {pos, integer()} + | {numCols, integer()} + | {updateLabels, boolean()}. insertCols(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1024,15 +1159,20 @@ insertCols(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxGrid_InsertCols, <>). -%% @spec (This::wxGrid()) -> bool() %% @equiv insertRows(This, []) +-spec insertRows(This) -> boolean() when + This::wxGrid(). + insertRows(This) when is_record(This, wx_ref) -> insertRows(This, []). -%% @spec (This::wxGrid(), [Option]) -> bool() -%% Option = {pos, integer()} | {numRows, integer()} | {updateLabels, bool()} %% @doc See external documentation. +-spec insertRows(This, [Option]) -> boolean() when + This::wxGrid(), + Option :: {pos, integer()} + | {numRows, integer()} + | {updateLabels, boolean()}. insertRows(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1044,73 +1184,79 @@ insertRows(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxGrid_InsertRows, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec isCellEditControlEnabled(This) -> boolean() when + This::wxGrid(). isCellEditControlEnabled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_IsCellEditControlEnabled, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec isCurrentCellReadOnly(This) -> boolean() when + This::wxGrid(). isCurrentCellReadOnly(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_IsCurrentCellReadOnly, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec isEditable(This) -> boolean() when + This::wxGrid(). isEditable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_IsEditable, <>). -%% @spec (This::wxGrid(), Coords::{R::integer(), C::integer()}) -> bool() %% @doc See external documentation. +-spec isInSelection(This, Coords) -> boolean() when + This::wxGrid(), Coords::{R::integer(), C::integer()}. isInSelection(#wx_ref{type=ThisT,ref=ThisRef},{CoordsR,CoordsC}) when is_integer(CoordsR),is_integer(CoordsC) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_IsInSelection_1, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> bool() %% @doc See external documentation. +-spec isInSelection(This, Row, Col) -> boolean() when + This::wxGrid(), Row::integer(), Col::integer(). isInSelection(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_IsInSelection_2, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> bool() %% @doc See external documentation. +-spec isReadOnly(This, Row, Col) -> boolean() when + This::wxGrid(), Row::integer(), Col::integer(). isReadOnly(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_IsReadOnly, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec isSelection(This) -> boolean() when + This::wxGrid(). isSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_IsSelection, <>). -%% @spec (This::wxGrid(), Coords::{R::integer(), C::integer()}) -> bool() %% @equiv isVisible(This,Coords, []) +-spec isVisible(This, Coords) -> boolean() when + This::wxGrid(), Coords::{R::integer(), C::integer()}. + isVisible(This,Coords={CoordsR,CoordsC}) when is_record(This, wx_ref),is_integer(CoordsR),is_integer(CoordsC) -> isVisible(This,Coords, []). -%% @spec (This::wxGrid(),X::integer()|term(),X::integer()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% isVisible(This::wxGrid(), Row::integer(), Col::integer()) -> isVisible(This,Row,Col, [])

-%%

-%% isVisible(This::wxGrid(), Coords::{R::integer(), C::integer()}, [Option]) -> bool() -%%
Option = {wholeCellVisible, bool()} -%%

+-spec isVisible(This, Row, Col) -> boolean() when + This::wxGrid(), Row::integer(), Col::integer(); + (This, Coords, [Option]) -> boolean() when + This::wxGrid(), Coords::{R::integer(), C::integer()}, + Option :: {wholeCellVisible, boolean()}. isVisible(This,Row,Col) when is_record(This, wx_ref),is_integer(Row),is_integer(Col) -> @@ -1124,9 +1270,10 @@ isVisible(#wx_ref{type=ThisT,ref=ThisRef},{CoordsR,CoordsC}, Options) wxe_util:call(?wxGrid_IsVisible_2, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer(), [Option]) -> bool() -%% Option = {wholeCellVisible, bool()} %% @doc See external documentation. +-spec isVisible(This, Row, Col, [Option]) -> boolean() when + This::wxGrid(), Row::integer(), Col::integer(), + Option :: {wholeCellVisible, boolean()}. isVisible(#wx_ref{type=ThisT,ref=ThisRef},Row,Col, Options) when is_integer(Row),is_integer(Col),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1136,102 +1283,115 @@ isVisible(#wx_ref{type=ThisT,ref=ThisRef},Row,Col, Options) wxe_util:call(?wxGrid_IsVisible_3, <>). -%% @spec (This::wxGrid(), Coords::{R::integer(), C::integer()}) -> ok %% @doc See external documentation. +-spec makeCellVisible(This, Coords) -> ok when + This::wxGrid(), Coords::{R::integer(), C::integer()}. makeCellVisible(#wx_ref{type=ThisT,ref=ThisRef},{CoordsR,CoordsC}) when is_integer(CoordsR),is_integer(CoordsC) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_MakeCellVisible_1, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> ok %% @doc See external documentation. +-spec makeCellVisible(This, Row, Col) -> ok when + This::wxGrid(), Row::integer(), Col::integer(). makeCellVisible(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_MakeCellVisible_2, <>). -%% @spec (This::wxGrid(), ExpandSelection::bool()) -> bool() %% @doc See external documentation. +-spec moveCursorDown(This, ExpandSelection) -> boolean() when + This::wxGrid(), ExpandSelection::boolean(). moveCursorDown(#wx_ref{type=ThisT,ref=ThisRef},ExpandSelection) when is_boolean(ExpandSelection) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MoveCursorDown, <>). -%% @spec (This::wxGrid(), ExpandSelection::bool()) -> bool() %% @doc See external documentation. +-spec moveCursorLeft(This, ExpandSelection) -> boolean() when + This::wxGrid(), ExpandSelection::boolean(). moveCursorLeft(#wx_ref{type=ThisT,ref=ThisRef},ExpandSelection) when is_boolean(ExpandSelection) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MoveCursorLeft, <>). -%% @spec (This::wxGrid(), ExpandSelection::bool()) -> bool() %% @doc See external documentation. +-spec moveCursorRight(This, ExpandSelection) -> boolean() when + This::wxGrid(), ExpandSelection::boolean(). moveCursorRight(#wx_ref{type=ThisT,ref=ThisRef},ExpandSelection) when is_boolean(ExpandSelection) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MoveCursorRight, <>). -%% @spec (This::wxGrid(), ExpandSelection::bool()) -> bool() %% @doc See external documentation. +-spec moveCursorUp(This, ExpandSelection) -> boolean() when + This::wxGrid(), ExpandSelection::boolean(). moveCursorUp(#wx_ref{type=ThisT,ref=ThisRef},ExpandSelection) when is_boolean(ExpandSelection) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MoveCursorUp, <>). -%% @spec (This::wxGrid(), ExpandSelection::bool()) -> bool() %% @doc See external documentation. +-spec moveCursorDownBlock(This, ExpandSelection) -> boolean() when + This::wxGrid(), ExpandSelection::boolean(). moveCursorDownBlock(#wx_ref{type=ThisT,ref=ThisRef},ExpandSelection) when is_boolean(ExpandSelection) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MoveCursorDownBlock, <>). -%% @spec (This::wxGrid(), ExpandSelection::bool()) -> bool() %% @doc See external documentation. +-spec moveCursorLeftBlock(This, ExpandSelection) -> boolean() when + This::wxGrid(), ExpandSelection::boolean(). moveCursorLeftBlock(#wx_ref{type=ThisT,ref=ThisRef},ExpandSelection) when is_boolean(ExpandSelection) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MoveCursorLeftBlock, <>). -%% @spec (This::wxGrid(), ExpandSelection::bool()) -> bool() %% @doc See external documentation. +-spec moveCursorRightBlock(This, ExpandSelection) -> boolean() when + This::wxGrid(), ExpandSelection::boolean(). moveCursorRightBlock(#wx_ref{type=ThisT,ref=ThisRef},ExpandSelection) when is_boolean(ExpandSelection) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MoveCursorRightBlock, <>). -%% @spec (This::wxGrid(), ExpandSelection::bool()) -> bool() %% @doc See external documentation. +-spec moveCursorUpBlock(This, ExpandSelection) -> boolean() when + This::wxGrid(), ExpandSelection::boolean(). moveCursorUpBlock(#wx_ref{type=ThisT,ref=ThisRef},ExpandSelection) when is_boolean(ExpandSelection) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MoveCursorUpBlock, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec movePageDown(This) -> boolean() when + This::wxGrid(). movePageDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MovePageDown, <>). -%% @spec (This::wxGrid()) -> bool() %% @doc See external documentation. +-spec movePageUp(This) -> boolean() when + This::wxGrid(). movePageUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_MovePageUp, <>). -%% @spec (This::wxGrid(), TypeName::string(), Renderer::wxGridCellRenderer:wxGridCellRenderer(), Editor::wxGridCellEditor:wxGridCellEditor()) -> ok %% @doc See external documentation. +-spec registerDataType(This, TypeName, Renderer, Editor) -> ok when + This::wxGrid(), TypeName::string(), Renderer::wxGridCellRenderer:wxGridCellRenderer(), Editor::wxGridCellEditor:wxGridCellEditor(). registerDataType(#wx_ref{type=ThisT,ref=ThisRef},TypeName,#wx_ref{type=RendererT,ref=RendererRef},#wx_ref{type=EditorT,ref=EditorRef}) when is_list(TypeName) -> ?CLASS(ThisT,wxGrid), @@ -1241,29 +1401,34 @@ registerDataType(#wx_ref{type=ThisT,ref=ThisRef},TypeName,#wx_ref{type=RendererT wxe_util:cast(?wxGrid_RegisterDataType, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec saveEditControlValue(This) -> ok when + This::wxGrid(). saveEditControlValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SaveEditControlValue, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec selectAll(This) -> ok when + This::wxGrid(). selectAll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SelectAll, <>). -%% @spec (This::wxGrid(), TopLeft::{R::integer(), C::integer()}, BottomRight::{R::integer(), C::integer()}) -> ok %% @equiv selectBlock(This,TopLeft,BottomRight, []) +-spec selectBlock(This, TopLeft, BottomRight) -> ok when + This::wxGrid(), TopLeft::{R::integer(), C::integer()}, BottomRight::{R::integer(), C::integer()}. + selectBlock(This,TopLeft={TopLeftR,TopLeftC},BottomRight={BottomRightR,BottomRightC}) when is_record(This, wx_ref),is_integer(TopLeftR),is_integer(TopLeftC),is_integer(BottomRightR),is_integer(BottomRightC) -> selectBlock(This,TopLeft,BottomRight, []). -%% @spec (This::wxGrid(), TopLeft::{R::integer(), C::integer()}, BottomRight::{R::integer(), C::integer()}, [Option]) -> ok -%% Option = {addToSelected, bool()} %% @doc See external documentation. +-spec selectBlock(This, TopLeft, BottomRight, [Option]) -> ok when + This::wxGrid(), TopLeft::{R::integer(), C::integer()}, BottomRight::{R::integer(), C::integer()}, + Option :: {addToSelected, boolean()}. selectBlock(#wx_ref{type=ThisT,ref=ThisRef},{TopLeftR,TopLeftC},{BottomRightR,BottomRightC}, Options) when is_integer(TopLeftR),is_integer(TopLeftC),is_integer(BottomRightR),is_integer(BottomRightC),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1273,15 +1438,18 @@ selectBlock(#wx_ref{type=ThisT,ref=ThisRef},{TopLeftR,TopLeftC},{BottomRightR,Bo wxe_util:cast(?wxGrid_SelectBlock_3, <>). -%% @spec (This::wxGrid(), TopRow::integer(), LeftCol::integer(), BottomRow::integer(), RightCol::integer()) -> ok %% @equiv selectBlock(This,TopRow,LeftCol,BottomRow,RightCol, []) +-spec selectBlock(This, TopRow, LeftCol, BottomRow, RightCol) -> ok when + This::wxGrid(), TopRow::integer(), LeftCol::integer(), BottomRow::integer(), RightCol::integer(). + selectBlock(This,TopRow,LeftCol,BottomRow,RightCol) when is_record(This, wx_ref),is_integer(TopRow),is_integer(LeftCol),is_integer(BottomRow),is_integer(RightCol) -> selectBlock(This,TopRow,LeftCol,BottomRow,RightCol, []). -%% @spec (This::wxGrid(), TopRow::integer(), LeftCol::integer(), BottomRow::integer(), RightCol::integer(), [Option]) -> ok -%% Option = {addToSelected, bool()} %% @doc See external documentation. +-spec selectBlock(This, TopRow, LeftCol, BottomRow, RightCol, [Option]) -> ok when + This::wxGrid(), TopRow::integer(), LeftCol::integer(), BottomRow::integer(), RightCol::integer(), + Option :: {addToSelected, boolean()}. selectBlock(#wx_ref{type=ThisT,ref=ThisRef},TopRow,LeftCol,BottomRow,RightCol, Options) when is_integer(TopRow),is_integer(LeftCol),is_integer(BottomRow),is_integer(RightCol),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1291,15 +1459,18 @@ selectBlock(#wx_ref{type=ThisT,ref=ThisRef},TopRow,LeftCol,BottomRow,RightCol, O wxe_util:cast(?wxGrid_SelectBlock_5, <>). -%% @spec (This::wxGrid(), Col::integer()) -> ok %% @equiv selectCol(This,Col, []) +-spec selectCol(This, Col) -> ok when + This::wxGrid(), Col::integer(). + selectCol(This,Col) when is_record(This, wx_ref),is_integer(Col) -> selectCol(This,Col, []). -%% @spec (This::wxGrid(), Col::integer(), [Option]) -> ok -%% Option = {addToSelected, bool()} %% @doc See external documentation. +-spec selectCol(This, Col, [Option]) -> ok when + This::wxGrid(), Col::integer(), + Option :: {addToSelected, boolean()}. selectCol(#wx_ref{type=ThisT,ref=ThisRef},Col, Options) when is_integer(Col),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1309,15 +1480,18 @@ selectCol(#wx_ref{type=ThisT,ref=ThisRef},Col, Options) wxe_util:cast(?wxGrid_SelectCol, <>). -%% @spec (This::wxGrid(), Row::integer()) -> ok %% @equiv selectRow(This,Row, []) +-spec selectRow(This, Row) -> ok when + This::wxGrid(), Row::integer(). + selectRow(This,Row) when is_record(This, wx_ref),is_integer(Row) -> selectRow(This,Row, []). -%% @spec (This::wxGrid(), Row::integer(), [Option]) -> ok -%% Option = {addToSelected, bool()} %% @doc See external documentation. +-spec selectRow(This, Row, [Option]) -> ok when + This::wxGrid(), Row::integer(), + Option :: {addToSelected, boolean()}. selectRow(#wx_ref{type=ThisT,ref=ThisRef},Row, Options) when is_integer(Row),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1327,47 +1501,47 @@ selectRow(#wx_ref{type=ThisT,ref=ThisRef},Row, Options) wxe_util:cast(?wxGrid_SelectRow, <>). -%% @spec (This::wxGrid(), Align::integer()) -> ok %% @doc See external documentation. +-spec setCellAlignment(This, Align) -> ok when + This::wxGrid(), Align::integer(). setCellAlignment(#wx_ref{type=ThisT,ref=ThisRef},Align) when is_integer(Align) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetCellAlignment_1, <>). -%% @spec (This::wxGrid(), Align::integer(), Row::integer(), Col::integer()) -> ok %% @doc See external documentation. +-spec setCellAlignment(This, Align, Row, Col) -> ok when + This::wxGrid(), Align::integer(), Row::integer(), Col::integer(). setCellAlignment(#wx_ref{type=ThisT,ref=ThisRef},Align,Row,Col) when is_integer(Align),is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetCellAlignment_3, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer(), Horiz::integer(), Vert::integer()) -> ok %% @doc See external documentation. +-spec setCellAlignment(This, Row, Col, Horiz, Vert) -> ok when + This::wxGrid(), Row::integer(), Col::integer(), Horiz::integer(), Vert::integer(). setCellAlignment(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,Horiz,Vert) when is_integer(Row),is_integer(Col),is_integer(Horiz),is_integer(Vert) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetCellAlignment_4, <>). -%% @spec (This::wxGrid(), Col::wx:colour()) -> ok %% @doc See external documentation. +-spec setCellBackgroundColour(This, Col) -> ok when + This::wxGrid(), Col::wx:wx_colour(). setCellBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Col) when tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetCellBackgroundColour_1, <>). -%% @spec (This::wxGrid(),X::integer()|term(),X::integer(),X::term()|integer()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setCellBackgroundColour(This::wxGrid(), Row::integer(), Col::integer(), Val::wx:colour()) -> ok -%%

-%%

-%% setCellBackgroundColour(This::wxGrid(), Colour::wx:colour(), Row::integer(), Col::integer()) -> ok -%%

+-spec setCellBackgroundColour(This, Row, Col, Val) -> ok when + This::wxGrid(), Row::integer(), Col::integer(), Val::wx:wx_colour(); + (This, Colour, Row, Col) -> ok when + This::wxGrid(), Colour::wx:wx_colour(), Row::integer(), Col::integer(). setCellBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,Val) when is_integer(Row),is_integer(Col),tuple_size(Val) =:= 3; tuple_size(Val) =:= 4 -> ?CLASS(ThisT,wxGrid), @@ -1379,8 +1553,9 @@ setCellBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Colour,Row,Col) wxe_util:cast(?wxGrid_SetCellBackgroundColour_3_1, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer(), Editor::wxGridCellEditor:wxGridCellEditor()) -> ok %% @doc See external documentation. +-spec setCellEditor(This, Row, Col, Editor) -> ok when + This::wxGrid(), Row::integer(), Col::integer(), Editor::wxGridCellEditor:wxGridCellEditor(). setCellEditor(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=EditorT,ref=EditorRef}) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), @@ -1388,8 +1563,9 @@ setCellEditor(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=EditorT,ref=E wxe_util:cast(?wxGrid_SetCellEditor, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer(), Val::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setCellFont(This, Row, Col, Val) -> ok when + This::wxGrid(), Row::integer(), Col::integer(), Val::wxFont:wxFont(). setCellFont(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=ValT,ref=ValRef}) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), @@ -1397,8 +1573,9 @@ setCellFont(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=ValT,ref=ValRef wxe_util:cast(?wxGrid_SetCellFont, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer(), Renderer::wxGridCellRenderer:wxGridCellRenderer()) -> ok %% @doc See external documentation. +-spec setCellRenderer(This, Row, Col, Renderer) -> ok when + This::wxGrid(), Row::integer(), Col::integer(), Renderer::wxGridCellRenderer:wxGridCellRenderer(). setCellRenderer(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=RendererT,ref=RendererRef}) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), @@ -1406,23 +1583,20 @@ setCellRenderer(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=RendererT,r wxe_util:cast(?wxGrid_SetCellRenderer, <>). -%% @spec (This::wxGrid(), Col::wx:colour()) -> ok %% @doc See external documentation. +-spec setCellTextColour(This, Col) -> ok when + This::wxGrid(), Col::wx:wx_colour(). setCellTextColour(#wx_ref{type=ThisT,ref=ThisRef},Col) when tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetCellTextColour_1, <>). -%% @spec (This::wxGrid(),X::integer()|term(),X::integer(),X::term()|integer()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setCellTextColour(This::wxGrid(), Row::integer(), Col::integer(), Val::wx:colour()) -> ok -%%

-%%

-%% setCellTextColour(This::wxGrid(), Val::wx:colour(), Row::integer(), Col::integer()) -> ok -%%

+-spec setCellTextColour(This, Row, Col, Val) -> ok when + This::wxGrid(), Row::integer(), Col::integer(), Val::wx:wx_colour(); + (This, Val, Row, Col) -> ok when + This::wxGrid(), Val::wx:wx_colour(), Row::integer(), Col::integer(). setCellTextColour(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,Val) when is_integer(Row),is_integer(Col),tuple_size(Val) =:= 3; tuple_size(Val) =:= 4 -> ?CLASS(ThisT,wxGrid), @@ -1434,8 +1608,9 @@ setCellTextColour(#wx_ref{type=ThisT,ref=ThisRef},Val,Row,Col) wxe_util:cast(?wxGrid_SetCellTextColour_3_1, <>). -%% @spec (This::wxGrid(), Coords::{R::integer(), C::integer()}, S::string()) -> ok %% @doc See external documentation. +-spec setCellValue(This, Coords, S) -> ok when + This::wxGrid(), Coords::{R::integer(), C::integer()}, S::string(). setCellValue(#wx_ref{type=ThisT,ref=ThisRef},{CoordsR,CoordsC},S) when is_integer(CoordsR),is_integer(CoordsC),is_list(S) -> ?CLASS(ThisT,wxGrid), @@ -1443,15 +1618,11 @@ setCellValue(#wx_ref{type=ThisT,ref=ThisRef},{CoordsR,CoordsC},S) wxe_util:cast(?wxGrid_SetCellValue_2, <>). -%% @spec (This::wxGrid(),X::integer()|string(),X::integer(),X::string()|integer()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setCellValue(This::wxGrid(), Row::integer(), Col::integer(), S::string()) -> ok -%%

-%%

-%% setCellValue(This::wxGrid(), Val::string(), Row::integer(), Col::integer()) -> ok -%%

+-spec setCellValue(This, Row, Col, S) -> ok when + This::wxGrid(), Row::integer(), Col::integer(), S::string(); + (This, Val, Row, Col) -> ok when + This::wxGrid(), Val::string(), Row::integer(), Col::integer(). setCellValue(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,S) when is_integer(Row),is_integer(Col),is_list(S) -> ?CLASS(ThisT,wxGrid), @@ -1465,8 +1636,9 @@ setCellValue(#wx_ref{type=ThisT,ref=ThisRef},Val,Row,Col) wxe_util:cast(?wxGrid_SetCellValue_3_1, <>). -%% @spec (This::wxGrid(), Col::integer(), Attr::wxGridCellAttr:wxGridCellAttr()) -> ok %% @doc See external documentation. +-spec setColAttr(This, Col, Attr) -> ok when + This::wxGrid(), Col::integer(), Attr::wxGridCellAttr:wxGridCellAttr(). setColAttr(#wx_ref{type=ThisT,ref=ThisRef},Col,#wx_ref{type=AttrT,ref=AttrRef}) when is_integer(Col) -> ?CLASS(ThisT,wxGrid), @@ -1474,31 +1646,37 @@ setColAttr(#wx_ref{type=ThisT,ref=ThisRef},Col,#wx_ref{type=AttrT,ref=AttrRef}) wxe_util:cast(?wxGrid_SetColAttr, <>). -%% @spec (This::wxGrid(), Col::integer()) -> ok %% @doc See external documentation. +-spec setColFormatBool(This, Col) -> ok when + This::wxGrid(), Col::integer(). setColFormatBool(#wx_ref{type=ThisT,ref=ThisRef},Col) when is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetColFormatBool, <>). -%% @spec (This::wxGrid(), Col::integer()) -> ok %% @doc See external documentation. +-spec setColFormatNumber(This, Col) -> ok when + This::wxGrid(), Col::integer(). setColFormatNumber(#wx_ref{type=ThisT,ref=ThisRef},Col) when is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetColFormatNumber, <>). -%% @spec (This::wxGrid(), Col::integer()) -> ok %% @equiv setColFormatFloat(This,Col, []) +-spec setColFormatFloat(This, Col) -> ok when + This::wxGrid(), Col::integer(). + setColFormatFloat(This,Col) when is_record(This, wx_ref),is_integer(Col) -> setColFormatFloat(This,Col, []). -%% @spec (This::wxGrid(), Col::integer(), [Option]) -> ok -%% Option = {width, integer()} | {precision, integer()} %% @doc See external documentation. +-spec setColFormatFloat(This, Col, [Option]) -> ok when + This::wxGrid(), Col::integer(), + Option :: {width, integer()} + | {precision, integer()}. setColFormatFloat(#wx_ref{type=ThisT,ref=ThisRef},Col, Options) when is_integer(Col),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1509,8 +1687,9 @@ setColFormatFloat(#wx_ref{type=ThisT,ref=ThisRef},Col, Options) wxe_util:cast(?wxGrid_SetColFormatFloat, <>). -%% @spec (This::wxGrid(), Col::integer(), TypeName::string()) -> ok %% @doc See external documentation. +-spec setColFormatCustom(This, Col, TypeName) -> ok when + This::wxGrid(), Col::integer(), TypeName::string(). setColFormatCustom(#wx_ref{type=ThisT,ref=ThisRef},Col,TypeName) when is_integer(Col),is_list(TypeName) -> ?CLASS(ThisT,wxGrid), @@ -1518,24 +1697,27 @@ setColFormatCustom(#wx_ref{type=ThisT,ref=ThisRef},Col,TypeName) wxe_util:cast(?wxGrid_SetColFormatCustom, <>). -%% @spec (This::wxGrid(), Horiz::integer(), Vert::integer()) -> ok %% @doc See external documentation. +-spec setColLabelAlignment(This, Horiz, Vert) -> ok when + This::wxGrid(), Horiz::integer(), Vert::integer(). setColLabelAlignment(#wx_ref{type=ThisT,ref=ThisRef},Horiz,Vert) when is_integer(Horiz),is_integer(Vert) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetColLabelAlignment, <>). -%% @spec (This::wxGrid(), Height::integer()) -> ok %% @doc See external documentation. +-spec setColLabelSize(This, Height) -> ok when + This::wxGrid(), Height::integer(). setColLabelSize(#wx_ref{type=ThisT,ref=ThisRef},Height) when is_integer(Height) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetColLabelSize, <>). -%% @spec (This::wxGrid(), Col::integer(), Val::string()) -> ok %% @doc See external documentation. +-spec setColLabelValue(This, Col, Val) -> ok when + This::wxGrid(), Col::integer(), Val::string(). setColLabelValue(#wx_ref{type=ThisT,ref=ThisRef},Col,Val) when is_integer(Col),is_list(Val) -> ?CLASS(ThisT,wxGrid), @@ -1543,87 +1725,99 @@ setColLabelValue(#wx_ref{type=ThisT,ref=ThisRef},Col,Val) wxe_util:cast(?wxGrid_SetColLabelValue, <>). -%% @spec (This::wxGrid(), Col::integer(), Width::integer()) -> ok %% @doc See external documentation. +-spec setColMinimalWidth(This, Col, Width) -> ok when + This::wxGrid(), Col::integer(), Width::integer(). setColMinimalWidth(#wx_ref{type=ThisT,ref=ThisRef},Col,Width) when is_integer(Col),is_integer(Width) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetColMinimalWidth, <>). -%% @spec (This::wxGrid(), Width::integer()) -> ok %% @doc See external documentation. +-spec setColMinimalAcceptableWidth(This, Width) -> ok when + This::wxGrid(), Width::integer(). setColMinimalAcceptableWidth(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetColMinimalAcceptableWidth, <>). -%% @spec (This::wxGrid(), Col::integer(), Width::integer()) -> ok %% @doc See external documentation. +-spec setColSize(This, Col, Width) -> ok when + This::wxGrid(), Col::integer(), Width::integer(). setColSize(#wx_ref{type=ThisT,ref=ThisRef},Col,Width) when is_integer(Col),is_integer(Width) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetColSize, <>). -%% @spec (This::wxGrid(), Horiz::integer(), Vert::integer()) -> ok %% @doc See external documentation. +-spec setDefaultCellAlignment(This, Horiz, Vert) -> ok when + This::wxGrid(), Horiz::integer(), Vert::integer(). setDefaultCellAlignment(#wx_ref{type=ThisT,ref=ThisRef},Horiz,Vert) when is_integer(Horiz),is_integer(Vert) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetDefaultCellAlignment, <>). -%% @spec (This::wxGrid(), Val::wx:colour()) -> ok %% @doc See external documentation. +-spec setDefaultCellBackgroundColour(This, Val) -> ok when + This::wxGrid(), Val::wx:wx_colour(). setDefaultCellBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Val) when tuple_size(Val) =:= 3; tuple_size(Val) =:= 4 -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetDefaultCellBackgroundColour, <>). -%% @spec (This::wxGrid(), Val::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setDefaultCellFont(This, Val) -> ok when + This::wxGrid(), Val::wxFont:wxFont(). setDefaultCellFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ValT,ref=ValRef}) -> ?CLASS(ThisT,wxGrid), ?CLASS(ValT,wxFont), wxe_util:cast(?wxGrid_SetDefaultCellFont, <>). -%% @spec (This::wxGrid(), Val::wx:colour()) -> ok %% @doc See external documentation. +-spec setDefaultCellTextColour(This, Val) -> ok when + This::wxGrid(), Val::wx:wx_colour(). setDefaultCellTextColour(#wx_ref{type=ThisT,ref=ThisRef},Val) when tuple_size(Val) =:= 3; tuple_size(Val) =:= 4 -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetDefaultCellTextColour, <>). -%% @spec (This::wxGrid(), Editor::wxGridCellEditor:wxGridCellEditor()) -> ok %% @doc See external documentation. +-spec setDefaultEditor(This, Editor) -> ok when + This::wxGrid(), Editor::wxGridCellEditor:wxGridCellEditor(). setDefaultEditor(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=EditorT,ref=EditorRef}) -> ?CLASS(ThisT,wxGrid), ?CLASS(EditorT,wxGridCellEditor), wxe_util:cast(?wxGrid_SetDefaultEditor, <>). -%% @spec (This::wxGrid(), Renderer::wxGridCellRenderer:wxGridCellRenderer()) -> ok %% @doc See external documentation. +-spec setDefaultRenderer(This, Renderer) -> ok when + This::wxGrid(), Renderer::wxGridCellRenderer:wxGridCellRenderer(). setDefaultRenderer(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=RendererT,ref=RendererRef}) -> ?CLASS(ThisT,wxGrid), ?CLASS(RendererT,wxGridCellRenderer), wxe_util:cast(?wxGrid_SetDefaultRenderer, <>). -%% @spec (This::wxGrid(), Width::integer()) -> ok %% @equiv setDefaultColSize(This,Width, []) +-spec setDefaultColSize(This, Width) -> ok when + This::wxGrid(), Width::integer(). + setDefaultColSize(This,Width) when is_record(This, wx_ref),is_integer(Width) -> setDefaultColSize(This,Width, []). -%% @spec (This::wxGrid(), Width::integer(), [Option]) -> ok -%% Option = {resizeExistingCols, bool()} %% @doc See external documentation. +-spec setDefaultColSize(This, Width, [Option]) -> ok when + This::wxGrid(), Width::integer(), + Option :: {resizeExistingCols, boolean()}. setDefaultColSize(#wx_ref{type=ThisT,ref=ThisRef},Width, Options) when is_integer(Width),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1633,15 +1827,18 @@ setDefaultColSize(#wx_ref{type=ThisT,ref=ThisRef},Width, Options) wxe_util:cast(?wxGrid_SetDefaultColSize, <>). -%% @spec (This::wxGrid(), Height::integer()) -> ok %% @equiv setDefaultRowSize(This,Height, []) +-spec setDefaultRowSize(This, Height) -> ok when + This::wxGrid(), Height::integer(). + setDefaultRowSize(This,Height) when is_record(This, wx_ref),is_integer(Height) -> setDefaultRowSize(This,Height, []). -%% @spec (This::wxGrid(), Height::integer(), [Option]) -> ok -%% Option = {resizeExistingRows, bool()} %% @doc See external documentation. +-spec setDefaultRowSize(This, Height, [Option]) -> ok when + This::wxGrid(), Height::integer(), + Option :: {resizeExistingRows, boolean()}. setDefaultRowSize(#wx_ref{type=ThisT,ref=ThisRef},Height, Options) when is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1651,63 +1848,72 @@ setDefaultRowSize(#wx_ref{type=ThisT,ref=ThisRef},Height, Options) wxe_util:cast(?wxGrid_SetDefaultRowSize, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> ok %% @doc See external documentation. +-spec setGridCursor(This, Row, Col) -> ok when + This::wxGrid(), Row::integer(), Col::integer(). setGridCursor(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetGridCursor, <>). -%% @spec (This::wxGrid(), Val::wx:colour()) -> ok %% @doc See external documentation. +-spec setGridLineColour(This, Val) -> ok when + This::wxGrid(), Val::wx:wx_colour(). setGridLineColour(#wx_ref{type=ThisT,ref=ThisRef},Val) when tuple_size(Val) =:= 3; tuple_size(Val) =:= 4 -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetGridLineColour, <>). -%% @spec (This::wxGrid(), Val::wx:colour()) -> ok %% @doc See external documentation. +-spec setLabelBackgroundColour(This, Val) -> ok when + This::wxGrid(), Val::wx:wx_colour(). setLabelBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Val) when tuple_size(Val) =:= 3; tuple_size(Val) =:= 4 -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetLabelBackgroundColour, <>). -%% @spec (This::wxGrid(), Val::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setLabelFont(This, Val) -> ok when + This::wxGrid(), Val::wxFont:wxFont(). setLabelFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ValT,ref=ValRef}) -> ?CLASS(ThisT,wxGrid), ?CLASS(ValT,wxFont), wxe_util:cast(?wxGrid_SetLabelFont, <>). -%% @spec (This::wxGrid(), Val::wx:colour()) -> ok %% @doc See external documentation. +-spec setLabelTextColour(This, Val) -> ok when + This::wxGrid(), Val::wx:wx_colour(). setLabelTextColour(#wx_ref{type=ThisT,ref=ThisRef},Val) when tuple_size(Val) =:= 3; tuple_size(Val) =:= 4 -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetLabelTextColour, <>). -%% @spec (This::wxGrid(), ExtraWidth::integer(), ExtraHeight::integer()) -> ok %% @doc See external documentation. +-spec setMargins(This, ExtraWidth, ExtraHeight) -> ok when + This::wxGrid(), ExtraWidth::integer(), ExtraHeight::integer(). setMargins(#wx_ref{type=ThisT,ref=ThisRef},ExtraWidth,ExtraHeight) when is_integer(ExtraWidth),is_integer(ExtraHeight) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetMargins, <>). -%% @spec (This::wxGrid(), Row::integer(), Col::integer()) -> ok %% @equiv setReadOnly(This,Row,Col, []) +-spec setReadOnly(This, Row, Col) -> ok when + This::wxGrid(), Row::integer(), Col::integer(). + setReadOnly(This,Row,Col) when is_record(This, wx_ref),is_integer(Row),is_integer(Col) -> setReadOnly(This,Row,Col, []). -%% @spec (This::wxGrid(), Row::integer(), Col::integer(), [Option]) -> ok -%% Option = {isReadOnly, bool()} %% @doc See external documentation. +-spec setReadOnly(This, Row, Col, [Option]) -> ok when + This::wxGrid(), Row::integer(), Col::integer(), + Option :: {isReadOnly, boolean()}. setReadOnly(#wx_ref{type=ThisT,ref=ThisRef},Row,Col, Options) when is_integer(Row),is_integer(Col),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1717,8 +1923,9 @@ setReadOnly(#wx_ref{type=ThisT,ref=ThisRef},Row,Col, Options) wxe_util:cast(?wxGrid_SetReadOnly, <>). -%% @spec (This::wxGrid(), Row::integer(), Attr::wxGridCellAttr:wxGridCellAttr()) -> ok %% @doc See external documentation. +-spec setRowAttr(This, Row, Attr) -> ok when + This::wxGrid(), Row::integer(), Attr::wxGridCellAttr:wxGridCellAttr(). setRowAttr(#wx_ref{type=ThisT,ref=ThisRef},Row,#wx_ref{type=AttrT,ref=AttrRef}) when is_integer(Row) -> ?CLASS(ThisT,wxGrid), @@ -1726,24 +1933,27 @@ setRowAttr(#wx_ref{type=ThisT,ref=ThisRef},Row,#wx_ref{type=AttrT,ref=AttrRef}) wxe_util:cast(?wxGrid_SetRowAttr, <>). -%% @spec (This::wxGrid(), Horiz::integer(), Vert::integer()) -> ok %% @doc See external documentation. +-spec setRowLabelAlignment(This, Horiz, Vert) -> ok when + This::wxGrid(), Horiz::integer(), Vert::integer(). setRowLabelAlignment(#wx_ref{type=ThisT,ref=ThisRef},Horiz,Vert) when is_integer(Horiz),is_integer(Vert) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetRowLabelAlignment, <>). -%% @spec (This::wxGrid(), Width::integer()) -> ok %% @doc See external documentation. +-spec setRowLabelSize(This, Width) -> ok when + This::wxGrid(), Width::integer(). setRowLabelSize(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetRowLabelSize, <>). -%% @spec (This::wxGrid(), Row::integer(), Val::string()) -> ok %% @doc See external documentation. +-spec setRowLabelValue(This, Row, Val) -> ok when + This::wxGrid(), Row::integer(), Val::string(). setRowLabelValue(#wx_ref{type=ThisT,ref=ThisRef},Row,Val) when is_integer(Row),is_list(Val) -> ?CLASS(ThisT,wxGrid), @@ -1751,88 +1961,99 @@ setRowLabelValue(#wx_ref{type=ThisT,ref=ThisRef},Row,Val) wxe_util:cast(?wxGrid_SetRowLabelValue, <>). -%% @spec (This::wxGrid(), Row::integer(), Width::integer()) -> ok %% @doc See external documentation. +-spec setRowMinimalHeight(This, Row, Width) -> ok when + This::wxGrid(), Row::integer(), Width::integer(). setRowMinimalHeight(#wx_ref{type=ThisT,ref=ThisRef},Row,Width) when is_integer(Row),is_integer(Width) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetRowMinimalHeight, <>). -%% @spec (This::wxGrid(), Width::integer()) -> ok %% @doc See external documentation. +-spec setRowMinimalAcceptableHeight(This, Width) -> ok when + This::wxGrid(), Width::integer(). setRowMinimalAcceptableHeight(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetRowMinimalAcceptableHeight, <>). -%% @spec (This::wxGrid(), Row::integer(), Height::integer()) -> ok %% @doc See external documentation. +-spec setRowSize(This, Row, Height) -> ok when + This::wxGrid(), Row::integer(), Height::integer(). setRowSize(#wx_ref{type=ThisT,ref=ThisRef},Row,Height) when is_integer(Row),is_integer(Height) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetRowSize, <>). -%% @spec (This::wxGrid(), X::integer()) -> ok %% @doc See external documentation. +-spec setScrollLineX(This, X) -> ok when + This::wxGrid(), X::integer(). setScrollLineX(#wx_ref{type=ThisT,ref=ThisRef},X) when is_integer(X) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetScrollLineX, <>). -%% @spec (This::wxGrid(), Y::integer()) -> ok %% @doc See external documentation. +-spec setScrollLineY(This, Y) -> ok when + This::wxGrid(), Y::integer(). setScrollLineY(#wx_ref{type=ThisT,ref=ThisRef},Y) when is_integer(Y) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetScrollLineY, <>). -%% @spec (This::wxGrid(), C::wx:colour()) -> ok %% @doc See external documentation. +-spec setSelectionBackground(This, C) -> ok when + This::wxGrid(), C::wx:wx_colour(). setSelectionBackground(#wx_ref{type=ThisT,ref=ThisRef},C) when tuple_size(C) =:= 3; tuple_size(C) =:= 4 -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetSelectionBackground, <>). -%% @spec (This::wxGrid(), C::wx:colour()) -> ok %% @doc See external documentation. +-spec setSelectionForeground(This, C) -> ok when + This::wxGrid(), C::wx:wx_colour(). setSelectionForeground(#wx_ref{type=ThisT,ref=ThisRef},C) when tuple_size(C) =:= 3; tuple_size(C) =:= 4 -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetSelectionForeground, <>). -%% @spec (This::wxGrid(), Selmode::WxGridSelectionModes) -> ok -%% WxGridSelectionModes = integer() %% @doc See external documentation. -%%
WxGridSelectionModes is one of ?wxGrid_wxGridSelectCells | ?wxGrid_wxGridSelectRows | ?wxGrid_wxGridSelectColumns +%%
Selmode = ?wxGrid_wxGridSelectCells | ?wxGrid_wxGridSelectRows | ?wxGrid_wxGridSelectColumns +-spec setSelectionMode(This, Selmode) -> ok when + This::wxGrid(), Selmode::wx:wx_enum(). setSelectionMode(#wx_ref{type=ThisT,ref=ThisRef},Selmode) when is_integer(Selmode) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_SetSelectionMode, <>). -%% @spec (This::wxGrid()) -> ok %% @doc See external documentation. +-spec showCellEditControl(This) -> ok when + This::wxGrid(). showCellEditControl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGrid), wxe_util:cast(?wxGrid_ShowCellEditControl, <>). -%% @spec (This::wxGrid(), X::integer()) -> integer() %% @equiv xToCol(This,X, []) +-spec xToCol(This, X) -> integer() when + This::wxGrid(), X::integer(). + xToCol(This,X) when is_record(This, wx_ref),is_integer(X) -> xToCol(This,X, []). -%% @spec (This::wxGrid(), X::integer(), [Option]) -> integer() -%% Option = {clipToMinMax, bool()} %% @doc See external documentation. +-spec xToCol(This, X, [Option]) -> integer() when + This::wxGrid(), X::integer(), + Option :: {clipToMinMax, boolean()}. xToCol(#wx_ref{type=ThisT,ref=ThisRef},X, Options) when is_integer(X),is_list(Options) -> ?CLASS(ThisT,wxGrid), @@ -1842,32 +2063,35 @@ xToCol(#wx_ref{type=ThisT,ref=ThisRef},X, Options) wxe_util:call(?wxGrid_XToCol, <>). -%% @spec (This::wxGrid(), X::integer()) -> integer() %% @doc See external documentation. +-spec xToEdgeOfCol(This, X) -> integer() when + This::wxGrid(), X::integer(). xToEdgeOfCol(#wx_ref{type=ThisT,ref=ThisRef},X) when is_integer(X) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_XToEdgeOfCol, <>). -%% @spec (This::wxGrid(), Y::integer()) -> integer() %% @doc See external documentation. +-spec yToEdgeOfRow(This, Y) -> integer() when + This::wxGrid(), Y::integer(). yToEdgeOfRow(#wx_ref{type=ThisT,ref=ThisRef},Y) when is_integer(Y) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_YToEdgeOfRow, <>). -%% @spec (This::wxGrid(), Y::integer()) -> integer() %% @doc See external documentation. +-spec yToRow(This, Y) -> integer() when + This::wxGrid(), Y::integer(). yToRow(#wx_ref{type=ThisT,ref=ThisRef},Y) when is_integer(Y) -> ?CLASS(ThisT,wxGrid), wxe_util:call(?wxGrid_YToRow, <>). -%% @spec (This::wxGrid()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGrid) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGrid), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxGridBagSizer.erl b/lib/wx/src/gen/wxGridBagSizer.erl index d2b8a2b045..10d87d0a4e 100644 --- a/lib/wx/src/gen/wxGridBagSizer.erl +++ b/lib/wx/src/gen/wxGridBagSizer.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 @@ -48,20 +48,24 @@ setItemMinSize/4,setMinSize/2,setMinSize/3,setNonFlexibleGrowMode/2, setRows/2,setSizeHints/2,setVGap/2,setVirtualSizeHints/2,show/2,show/3]). +-export_type([wxGridBagSizer/0]). %% @hidden parent_class(wxFlexGridSizer) -> true; parent_class(wxGridSizer) -> true; parent_class(wxSizer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGridBagSizer() +-type wxGridBagSizer() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxGridBagSizer(). + new() -> new([]). -%% @spec ([Option]) -> wxGridBagSizer() -%% Option = {vgap, integer()} | {hgap, integer()} %% @doc See external documentation. +-spec new([Option]) -> wxGridBagSizer() when + Option :: {vgap, integer()} + | {hgap, integer()}. new(Options) when is_list(Options) -> MOpts = fun({vgap, Vgap}, Acc) -> [<<1:32/?UI,Vgap:32/?UI>>|Acc]; @@ -71,8 +75,9 @@ new(Options) wxe_util:construct(?wxGridBagSizer_new, <>). -%% @spec (This::wxGridBagSizer(), Item::wxSizerItem:wxSizerItem() | wxGBSizerItem:wxGBSizerItem()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. +-spec add(This, Item) -> wxSizerItem:wxSizerItem() when + This::wxGridBagSizer(), Item::wxSizerItem:wxSizerItem() | wxGBSizerItem:wxGBSizerItem(). add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> ?CLASS(ThisT,wxGridBagSizer), ItemOP = case ?CLASS_T(ItemT,wxSizerItem) of @@ -84,17 +89,17 @@ add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> wxe_util:call(ItemOP, <>). -%% @spec (This::wxGridBagSizer(),X::integer()|term(),X::integer()|term()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% add(This::wxGridBagSizer(), Width::integer(), Height::integer()) -> add(This,Width,Height, [])

-%%

-%% add(This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Pos::{R::integer(), C::integer()}) -> add(This,Window,Pos, [])

-%%

-%% add(This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), [Option]) -> wxSizerItem:wxSizerItem() -%%
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 + 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()}. add(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> @@ -121,19 +126,21 @@ add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}, Options wxe_util:call(WindowOP, <>). -%% @spec (This::wxGridBagSizer(),X::integer()|term(),X::integer()|term(),X::term()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% add(This::wxGridBagSizer(), Width::integer(), Height::integer(), Pos::{R::integer(), C::integer()}) -> add(This,Width,Height,Pos, [])

-%%

-%% add(This::wxGridBagSizer(), Width::integer(), Height::integer(), [Option]) -> wxSizerItem:wxSizerItem() -%%
Option = {proportion, integer()} | {flag, integer()} | {border, integer()} | {userData, wx:wx()} -%%

-%%

-%% add(This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Pos::{R::integer(), C::integer()}, [Option]) -> wxSizerItem:wxSizerItem() -%%
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 + 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()}. add(This,Width,Height,Pos={PosR,PosC}) when is_record(This, wx_ref),is_integer(Width),is_integer(Height),is_integer(PosR),is_integer(PosC) -> @@ -167,9 +174,13 @@ add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},{PosR,Po wxe_util:call(WindowOP, <>). -%% @spec (This::wxGridBagSizer(), Width::integer(), Height::integer(), Pos::{R::integer(), C::integer()}, [Option]) -> wxSizerItem:wxSizerItem() -%% Option = {span, {RS::integer(), CS::integer()}} | {flag, integer()} | {border, integer()} | {userData, wx:wx()} %% @doc See external documentation. +-spec add(This, Width, Height, Pos, [Option]) -> wxSizerItem:wxSizerItem() when + This::wxGridBagSizer(), Width::integer(), Height::integer(), Pos::{R::integer(), C::integer()}, + Option :: {span, {RS::integer(), CS::integer()}} + | {flag, integer()} + | {border, integer()} + | {userData, wx:wx()}. add(#wx_ref{type=ThisT,ref=ThisRef},Width,Height,{PosR,PosC}, Options) when is_integer(Width),is_integer(Height),is_integer(PosR),is_integer(PosC),is_list(Options) -> ?CLASS(ThisT,wxGridBagSizer), @@ -182,28 +193,28 @@ add(#wx_ref{type=ThisT,ref=ThisRef},Width,Height,{PosR,PosC}, Options) wxe_util:call(?wxGridBagSizer_Add_4, <>). -%% @spec (This::wxGridBagSizer()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec calcMin(This) -> {W::integer(), H::integer()} when + This::wxGridBagSizer(). calcMin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridBagSizer), wxe_util:call(?wxGridBagSizer_CalcMin, <>). -%% @spec (This::wxGridBagSizer(), Item::wxGBSizerItem:wxGBSizerItem()) -> bool() %% @equiv checkForIntersection(This,Item, []) +-spec checkForIntersection(This, Item) -> boolean() when + This::wxGridBagSizer(), Item::wxGBSizerItem:wxGBSizerItem(). + checkForIntersection(This,Item) when is_record(This, wx_ref),is_record(Item, wx_ref) -> checkForIntersection(This,Item, []). -%% @spec (This::wxGridBagSizer(),X::term(),X::term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% checkForIntersection(This::wxGridBagSizer(), Pos::{R::integer(), C::integer()}, Span::{RS::integer(), CS::integer()}) -> checkForIntersection(This,Pos,Span, [])

-%%

-%% checkForIntersection(This::wxGridBagSizer(), Item::wxGBSizerItem:wxGBSizerItem(), [Option]) -> bool() -%%
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 + This::wxGridBagSizer(), Item::wxGBSizerItem:wxGBSizerItem(), + Option :: {excludeItem, wxGBSizerItem:wxGBSizerItem()}. checkForIntersection(This,Pos={PosR,PosC},Span={SpanRS,SpanCS}) when is_record(This, wx_ref),is_integer(PosR),is_integer(PosC),is_integer(SpanRS),is_integer(SpanCS) -> @@ -218,9 +229,10 @@ checkForIntersection(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=Item wxe_util:call(?wxGridBagSizer_CheckForIntersection_2, <>). -%% @spec (This::wxGridBagSizer(), Pos::{R::integer(), C::integer()}, Span::{RS::integer(), CS::integer()}, [Option]) -> bool() -%% Option = {excludeItem, wxGBSizerItem:wxGBSizerItem()} %% @doc See external documentation. +-spec checkForIntersection(This, Pos, Span, [Option]) -> boolean() when + This::wxGridBagSizer(), Pos::{R::integer(), C::integer()}, Span::{RS::integer(), CS::integer()}, + Option :: {excludeItem, wxGBSizerItem:wxGBSizerItem()}. checkForIntersection(#wx_ref{type=ThisT,ref=ThisRef},{PosR,PosC},{SpanRS,SpanCS}, Options) when is_integer(PosR),is_integer(PosC),is_integer(SpanRS),is_integer(SpanCS),is_list(Options) -> ?CLASS(ThisT,wxGridBagSizer), @@ -230,8 +242,9 @@ checkForIntersection(#wx_ref{type=ThisT,ref=ThisRef},{PosR,PosC},{SpanRS,SpanCS} wxe_util:call(?wxGridBagSizer_CheckForIntersection_3, <>). -%% @spec (This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer()) -> wxGBSizerItem:wxGBSizerItem() %% @doc See external documentation. +-spec findItem(This, Window) -> wxGBSizerItem:wxGBSizerItem() when + This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(). findItem(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(ThisT,wxGridBagSizer), WindowOP = case ?CLASS_T(WindowT,wxWindow) of @@ -243,54 +256,55 @@ findItem(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> wxe_util:call(WindowOP, <>). -%% @spec (This::wxGridBagSizer(), Pt::{X::integer(), Y::integer()}) -> wxGBSizerItem:wxGBSizerItem() %% @doc See external documentation. +-spec findItemAtPoint(This, Pt) -> wxGBSizerItem:wxGBSizerItem() when + This::wxGridBagSizer(), Pt::{X::integer(), Y::integer()}. findItemAtPoint(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxGridBagSizer), wxe_util:call(?wxGridBagSizer_FindItemAtPoint, <>). -%% @spec (This::wxGridBagSizer(), Pos::{R::integer(), C::integer()}) -> wxGBSizerItem:wxGBSizerItem() %% @doc See external documentation. +-spec findItemAtPosition(This, Pos) -> wxGBSizerItem:wxGBSizerItem() when + This::wxGridBagSizer(), Pos::{R::integer(), C::integer()}. findItemAtPosition(#wx_ref{type=ThisT,ref=ThisRef},{PosR,PosC}) when is_integer(PosR),is_integer(PosC) -> ?CLASS(ThisT,wxGridBagSizer), wxe_util:call(?wxGridBagSizer_FindItemAtPosition, <>). -%% @spec (This::wxGridBagSizer(), UserData::wx:wx()) -> wxGBSizerItem:wxGBSizerItem() %% @doc See external documentation. +-spec findItemWithData(This, UserData) -> wxGBSizerItem:wxGBSizerItem() when + This::wxGridBagSizer(), UserData::wx:wx(). findItemWithData(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=UserDataT,ref=UserDataRef}) -> ?CLASS(ThisT,wxGridBagSizer), ?CLASS(UserDataT,wx), wxe_util:call(?wxGridBagSizer_FindItemWithData, <>). -%% @spec (This::wxGridBagSizer(), Row::integer(), Col::integer()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getCellSize(This, Row, Col) -> {W::integer(), H::integer()} when + This::wxGridBagSizer(), Row::integer(), Col::integer(). getCellSize(#wx_ref{type=ThisT,ref=ThisRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGridBagSizer), wxe_util:call(?wxGridBagSizer_GetCellSize, <>). -%% @spec (This::wxGridBagSizer()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getEmptyCellSize(This) -> {W::integer(), H::integer()} when + This::wxGridBagSizer(). getEmptyCellSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridBagSizer), wxe_util:call(?wxGridBagSizer_GetEmptyCellSize, <>). -%% @spec (This::wxGridBagSizer(),X::integer()|term()) -> {R::integer(), C::integer()} %% @doc See external documentation. -%%
Alternatives: -%%

-%% getItemPosition(This::wxGridBagSizer(), Index::integer()) -> {R::integer(), C::integer()} -%%

-%%

-%% getItemPosition(This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer()) -> {R::integer(), C::integer()} -%%

+-spec getItemPosition(This, Index) -> {R::integer(), C::integer()} when + This::wxGridBagSizer(), Index::integer(); + (This, Window) -> {R::integer(), C::integer()} when + This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(). getItemPosition(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxGridBagSizer), @@ -307,15 +321,11 @@ getItemPosition(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowR wxe_util:call(WindowOP, <>). -%% @spec (This::wxGridBagSizer(),X::integer()|term()) -> {RS::integer(), CS::integer()} %% @doc See external documentation. -%%
Alternatives: -%%

-%% getItemSpan(This::wxGridBagSizer(), Index::integer()) -> {RS::integer(), CS::integer()} -%%

-%%

-%% getItemSpan(This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer()) -> {RS::integer(), CS::integer()} -%%

+-spec getItemSpan(This, Index) -> {RS::integer(), CS::integer()} when + This::wxGridBagSizer(), Index::integer(); + (This, Window) -> {RS::integer(), CS::integer()} when + This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(). getItemSpan(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxGridBagSizer), @@ -332,23 +342,20 @@ getItemSpan(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) wxe_util:call(WindowOP, <>). -%% @spec (This::wxGridBagSizer(), Sz::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setEmptyCellSize(This, Sz) -> ok when + This::wxGridBagSizer(), Sz::{W::integer(), H::integer()}. setEmptyCellSize(#wx_ref{type=ThisT,ref=ThisRef},{SzW,SzH}) when is_integer(SzW),is_integer(SzH) -> ?CLASS(ThisT,wxGridBagSizer), wxe_util:cast(?wxGridBagSizer_SetEmptyCellSize, <>). -%% @spec (This::wxGridBagSizer(),X::integer()|term(),Pos::{R::integer(), C::integer()}) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% setItemPosition(This::wxGridBagSizer(), Index::integer(), Pos::{R::integer(), C::integer()}) -> bool() -%%

-%%

-%% setItemPosition(This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Pos::{R::integer(), C::integer()}) -> bool() -%%

+-spec setItemPosition(This, Index, Pos) -> boolean() when + This::wxGridBagSizer(), Index::integer(), Pos::{R::integer(), C::integer()}; + (This, Window, Pos) -> boolean() when + This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Pos::{R::integer(), C::integer()}. setItemPosition(#wx_ref{type=ThisT,ref=ThisRef},Index,{PosR,PosC}) when is_integer(Index),is_integer(PosR),is_integer(PosC) -> ?CLASS(ThisT,wxGridBagSizer), @@ -366,15 +373,11 @@ setItemPosition(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowR wxe_util:call(WindowOP, <>). -%% @spec (This::wxGridBagSizer(),X::integer()|term(),Span::{RS::integer(), CS::integer()}) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% setItemSpan(This::wxGridBagSizer(), Index::integer(), Span::{RS::integer(), CS::integer()}) -> bool() -%%

-%%

-%% setItemSpan(This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Span::{RS::integer(), CS::integer()}) -> bool() -%%

+-spec setItemSpan(This, Index, Span) -> boolean() when + This::wxGridBagSizer(), Index::integer(), Span::{RS::integer(), CS::integer()}; + (This, Window, Span) -> boolean() when + This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Span::{RS::integer(), CS::integer()}. setItemSpan(#wx_ref{type=ThisT,ref=ThisRef},Index,{SpanRS,SpanCS}) when is_integer(Index),is_integer(SpanRS),is_integer(SpanCS) -> ?CLASS(ThisT,wxGridBagSizer), @@ -392,8 +395,8 @@ setItemSpan(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}, wxe_util:call(WindowOP, <>). -%% @spec (This::wxGridBagSizer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridBagSizer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridBagSizer), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxGridCellAttr.erl b/lib/wx/src/gen/wxGridCellAttr.erl index a9a0c1fb79..896bf97489 100644 --- a/lib/wx/src/gen/wxGridCellAttr.erl +++ b/lib/wx/src/gen/wxGridCellAttr.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 @@ -33,50 +33,59 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxGridCellAttr/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxGridCellAttr(), ColText::wx:colour()) -> ok +-type wxGridCellAttr() :: wx:wx_object(). %% @doc See external documentation. +-spec setTextColour(This, ColText) -> ok when + This::wxGridCellAttr(), ColText::wx:wx_colour(). setTextColour(#wx_ref{type=ThisT,ref=ThisRef},ColText) when tuple_size(ColText) =:= 3; tuple_size(ColText) =:= 4 -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:cast(?wxGridCellAttr_SetTextColour, <>). -%% @spec (This::wxGridCellAttr(), ColBack::wx:colour()) -> ok %% @doc See external documentation. +-spec setBackgroundColour(This, ColBack) -> ok when + This::wxGridCellAttr(), ColBack::wx:wx_colour(). setBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},ColBack) when tuple_size(ColBack) =:= 3; tuple_size(ColBack) =:= 4 -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:cast(?wxGridCellAttr_SetBackgroundColour, <>). -%% @spec (This::wxGridCellAttr(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setFont(This, Font) -> ok when + This::wxGridCellAttr(), Font::wxFont:wxFont(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxGridCellAttr), ?CLASS(FontT,wxFont), wxe_util:cast(?wxGridCellAttr_SetFont, <>). -%% @spec (This::wxGridCellAttr(), HAlign::integer(), VAlign::integer()) -> ok %% @doc See external documentation. +-spec setAlignment(This, HAlign, VAlign) -> ok when + This::wxGridCellAttr(), HAlign::integer(), VAlign::integer(). setAlignment(#wx_ref{type=ThisT,ref=ThisRef},HAlign,VAlign) when is_integer(HAlign),is_integer(VAlign) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:cast(?wxGridCellAttr_SetAlignment, <>). -%% @spec (This::wxGridCellAttr()) -> ok %% @equiv setReadOnly(This, []) +-spec setReadOnly(This) -> ok when + This::wxGridCellAttr(). + setReadOnly(This) when is_record(This, wx_ref) -> setReadOnly(This, []). -%% @spec (This::wxGridCellAttr(), [Option]) -> ok -%% Option = {isReadOnly, bool()} %% @doc See external documentation. +-spec setReadOnly(This, [Option]) -> ok when + This::wxGridCellAttr(), + Option :: {isReadOnly, boolean()}. setReadOnly(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxGridCellAttr), @@ -86,94 +95,107 @@ setReadOnly(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxGridCellAttr_SetReadOnly, <>). -%% @spec (This::wxGridCellAttr(), Renderer::wxGridCellRenderer:wxGridCellRenderer()) -> ok %% @doc See external documentation. +-spec setRenderer(This, Renderer) -> ok when + This::wxGridCellAttr(), Renderer::wxGridCellRenderer:wxGridCellRenderer(). setRenderer(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=RendererT,ref=RendererRef}) -> ?CLASS(ThisT,wxGridCellAttr), ?CLASS(RendererT,wxGridCellRenderer), wxe_util:cast(?wxGridCellAttr_SetRenderer, <>). -%% @spec (This::wxGridCellAttr(), Editor::wxGridCellEditor:wxGridCellEditor()) -> ok %% @doc See external documentation. +-spec setEditor(This, Editor) -> ok when + This::wxGridCellAttr(), Editor::wxGridCellEditor:wxGridCellEditor(). setEditor(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=EditorT,ref=EditorRef}) -> ?CLASS(ThisT,wxGridCellAttr), ?CLASS(EditorT,wxGridCellEditor), wxe_util:cast(?wxGridCellAttr_SetEditor, <>). -%% @spec (This::wxGridCellAttr()) -> bool() %% @doc See external documentation. +-spec hasTextColour(This) -> boolean() when + This::wxGridCellAttr(). hasTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_HasTextColour, <>). -%% @spec (This::wxGridCellAttr()) -> bool() %% @doc See external documentation. +-spec hasBackgroundColour(This) -> boolean() when + This::wxGridCellAttr(). hasBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_HasBackgroundColour, <>). -%% @spec (This::wxGridCellAttr()) -> bool() %% @doc See external documentation. +-spec hasFont(This) -> boolean() when + This::wxGridCellAttr(). hasFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_HasFont, <>). -%% @spec (This::wxGridCellAttr()) -> bool() %% @doc See external documentation. +-spec hasAlignment(This) -> boolean() when + This::wxGridCellAttr(). hasAlignment(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_HasAlignment, <>). -%% @spec (This::wxGridCellAttr()) -> bool() %% @doc See external documentation. +-spec hasRenderer(This) -> boolean() when + This::wxGridCellAttr(). hasRenderer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_HasRenderer, <>). -%% @spec (This::wxGridCellAttr()) -> bool() %% @doc See external documentation. +-spec hasEditor(This) -> boolean() when + This::wxGridCellAttr(). hasEditor(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_HasEditor, <>). -%% @spec (This::wxGridCellAttr()) -> wx:colour() %% @doc See external documentation. +-spec getTextColour(This) -> wx:wx_colour() when + This::wxGridCellAttr(). getTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_GetTextColour, <>). -%% @spec (This::wxGridCellAttr()) -> wx:colour() %% @doc See external documentation. +-spec getBackgroundColour(This) -> wx:wx_colour() when + This::wxGridCellAttr(). getBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_GetBackgroundColour, <>). -%% @spec (This::wxGridCellAttr()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getFont(This) -> wxFont:wxFont() when + This::wxGridCellAttr(). getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_GetFont, <>). -%% @spec (This::wxGridCellAttr()) -> {HAlign::integer(), VAlign::integer()} %% @doc See external documentation. +-spec getAlignment(This) -> {HAlign::integer(), VAlign::integer()} when + This::wxGridCellAttr(). getAlignment(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_GetAlignment, <>). -%% @spec (This::wxGridCellAttr(), Grid::wxGrid:wxGrid(), Row::integer(), Col::integer()) -> wxGridCellRenderer:wxGridCellRenderer() %% @doc See external documentation. +-spec getRenderer(This, Grid, Row, Col) -> wxGridCellRenderer:wxGridCellRenderer() when + This::wxGridCellAttr(), Grid::wxGrid:wxGrid(), Row::integer(), Col::integer(). getRenderer(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=GridT,ref=GridRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGridCellAttr), @@ -181,8 +203,9 @@ getRenderer(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=GridT,ref=GridRef},Row, wxe_util:call(?wxGridCellAttr_GetRenderer, <>). -%% @spec (This::wxGridCellAttr(), Grid::wxGrid:wxGrid(), Row::integer(), Col::integer()) -> wxGridCellEditor:wxGridCellEditor() %% @doc See external documentation. +-spec getEditor(This, Grid, Row, Col) -> wxGridCellEditor:wxGridCellEditor() when + This::wxGridCellAttr(), Grid::wxGrid:wxGrid(), Row::integer(), Col::integer(). getEditor(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=GridT,ref=GridRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGridCellAttr), @@ -190,15 +213,17 @@ getEditor(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=GridT,ref=GridRef},Row,Co wxe_util:call(?wxGridCellAttr_GetEditor, <>). -%% @spec (This::wxGridCellAttr()) -> bool() %% @doc See external documentation. +-spec isReadOnly(This) -> boolean() when + This::wxGridCellAttr(). isReadOnly(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellAttr), wxe_util:call(?wxGridCellAttr_IsReadOnly, <>). -%% @spec (This::wxGridCellAttr(), DefAttr::wxGridCellAttr()) -> ok %% @doc See external documentation. +-spec setDefAttr(This, DefAttr) -> ok when + This::wxGridCellAttr(), DefAttr::wxGridCellAttr(). setDefAttr(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DefAttrT,ref=DefAttrRef}) -> ?CLASS(ThisT,wxGridCellAttr), ?CLASS(DefAttrT,wxGridCellAttr), diff --git a/lib/wx/src/gen/wxGridCellBoolEditor.erl b/lib/wx/src/gen/wxGridCellBoolEditor.erl index a54cfe5eab..c4a68ac597 100644 --- a/lib/wx/src/gen/wxGridCellBoolEditor.erl +++ b/lib/wx/src/gen/wxGridCellBoolEditor.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -33,32 +33,37 @@ -export([beginEdit/4,endEdit/4,handleReturn/2,isCreated/1,paintBackground/3, parent_class/1,reset/1,setSize/2,show/2,show/3,startingClick/1,startingKey/2]). +-export_type([wxGridCellBoolEditor/0]). %% @hidden parent_class(wxGridCellEditor) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGridCellBoolEditor() +-type wxGridCellBoolEditor() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxGridCellBoolEditor(). new() -> wxe_util:construct(?wxGridCellBoolEditor_new, <<>>). -%% @spec (Value::string()) -> bool() %% @doc See external documentation. +-spec isTrueValue(Value) -> boolean() when + Value::string(). isTrueValue(Value) when is_list(Value) -> Value_UC = unicode:characters_to_binary([Value,0]), wxe_util:call(?wxGridCellBoolEditor_IsTrueValue, <<(byte_size(Value_UC)):32/?UI,(Value_UC)/binary, 0:(((8- ((4+byte_size(Value_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec () -> ok %% @equiv useStringValues([]) +-spec useStringValues() -> ok. + useStringValues() -> useStringValues([]). -%% @spec ([Option]) -> ok -%% Option = {valueTrue, string()} | {valueFalse, string()} %% @doc See external documentation. +-spec useStringValues([Option]) -> ok when + Option :: {valueTrue, string()} + | {valueFalse, string()}. useStringValues(Options) when is_list(Options) -> MOpts = fun({valueTrue, ValueTrue}, Acc) -> ValueTrue_UC = unicode:characters_to_binary([ValueTrue,0]),[<<1:32/?UI,(byte_size(ValueTrue_UC)):32/?UI,(ValueTrue_UC)/binary, 0:(((8- ((0+byte_size(ValueTrue_UC)) band 16#7)) band 16#7))/unit:8>>|Acc]; @@ -68,8 +73,8 @@ useStringValues(Options) wxe_util:cast(?wxGridCellBoolEditor_UseStringValues, <>). -%% @spec (This::wxGridCellBoolEditor()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridCellBoolEditor) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridCellBoolEditor), wxe_util:destroy(?wxGridCellBoolEditor_destroy,Obj), diff --git a/lib/wx/src/gen/wxGridCellBoolRenderer.erl b/lib/wx/src/gen/wxGridCellBoolRenderer.erl index a98091f62c..ae9d4baf47 100644 --- a/lib/wx/src/gen/wxGridCellBoolRenderer.erl +++ b/lib/wx/src/gen/wxGridCellBoolRenderer.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-2012. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -32,18 +32,20 @@ %% inherited exports -export([draw/8,getBestSize/6,parent_class/1]). +-export_type([wxGridCellBoolRenderer/0]). %% @hidden parent_class(wxGridCellRenderer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGridCellBoolRenderer() +-type wxGridCellBoolRenderer() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxGridCellBoolRenderer(). new() -> wxe_util:construct(?wxGridCellBoolRenderer_new, <<>>). -%% @spec (This::wxGridCellBoolRenderer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridCellBoolRenderer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridCellBoolRenderer), wxe_util:destroy(?wxGridCellBoolRenderer_destroy,Obj), diff --git a/lib/wx/src/gen/wxGridCellChoiceEditor.erl b/lib/wx/src/gen/wxGridCellChoiceEditor.erl index 1adee550f8..d8ed206f07 100644 --- a/lib/wx/src/gen/wxGridCellChoiceEditor.erl +++ b/lib/wx/src/gen/wxGridCellChoiceEditor.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -33,19 +33,24 @@ -export([beginEdit/4,endEdit/4,handleReturn/2,isCreated/1,paintBackground/3, parent_class/1,reset/1,setSize/2,show/2,show/3,startingClick/1,startingKey/2]). +-export_type([wxGridCellChoiceEditor/0]). %% @hidden parent_class(wxGridCellEditor) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Choices::[[string()]]) -> wxGridCellChoiceEditor() +-type wxGridCellChoiceEditor() :: wx:wx_object(). %% @equiv new(Choices, []) +-spec new(Choices) -> wxGridCellChoiceEditor() when + Choices::[[string()]]. + new(Choices) when is_list(Choices) -> new(Choices, []). -%% @spec (Choices::[[string()]], [Option]) -> wxGridCellChoiceEditor() -%% Option = {allowOthers, bool()} %% @doc See external documentation. +-spec new(Choices, [Option]) -> wxGridCellChoiceEditor() when + Choices::[[string()]], + Option :: {allowOthers, boolean()}. new(Choices, Options) when is_list(Choices),is_list(Options) -> Choices_UCA = [unicode:characters_to_binary([ChoicesTemp,0]) || @@ -56,8 +61,9 @@ new(Choices, Options) wxe_util:construct(?wxGridCellChoiceEditor_new, <<(length(Choices_UCA)):32/?UI, (<< <<(byte_size(UC_Str)):32/?UI, UC_Str/binary>>|| UC_Str <- Choices_UCA>>)/binary, 0:(((8- ((4 + lists:sum([byte_size(S)+4||S<-Choices_UCA])) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxGridCellChoiceEditor(), Params::string()) -> ok %% @doc See external documentation. +-spec setParameters(This, Params) -> ok when + This::wxGridCellChoiceEditor(), Params::string(). setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) when is_list(Params) -> ?CLASS(ThisT,wxGridCellChoiceEditor), @@ -65,8 +71,8 @@ setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) wxe_util:cast(?wxGridCellChoiceEditor_SetParameters, <>). -%% @spec (This::wxGridCellChoiceEditor()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridCellChoiceEditor) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridCellChoiceEditor), wxe_util:destroy(?wxGridCellChoiceEditor_destroy,Obj), diff --git a/lib/wx/src/gen/wxGridCellEditor.erl b/lib/wx/src/gen/wxGridCellEditor.erl index de1ebc5a4c..e84cdeb49a 100644 --- a/lib/wx/src/gen/wxGridCellEditor.erl +++ b/lib/wx/src/gen/wxGridCellEditor.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 @@ -30,11 +30,14 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxGridCellEditor/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxGridCellEditor(), Parent::wxWindow:wxWindow(), Id::integer(), EvtHandler::wxEvtHandler:wxEvtHandler()) -> ok +-type wxGridCellEditor() :: wx:wx_object(). %% @doc See external documentation. +-spec create(This, Parent, Id, EvtHandler) -> ok when + This::wxGridCellEditor(), Parent::wxWindow:wxWindow(), Id::integer(), EvtHandler::wxEvtHandler:wxEvtHandler(). create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,#wx_ref{type=EvtHandlerT,ref=EvtHandlerRef}) when is_integer(Id) -> ?CLASS(ThisT,wxGridCellEditor), @@ -43,30 +46,35 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,#w wxe_util:cast(?wxGridCellEditor_Create, <>). -%% @spec (This::wxGridCellEditor()) -> bool() %% @doc See external documentation. +-spec isCreated(This) -> boolean() when + This::wxGridCellEditor(). isCreated(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellEditor), wxe_util:call(?wxGridCellEditor_IsCreated, <>). -%% @spec (This::wxGridCellEditor(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setSize(This, Rect) -> ok when + This::wxGridCellEditor(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. setSize(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxGridCellEditor), wxe_util:cast(?wxGridCellEditor_SetSize, <>). -%% @spec (This::wxGridCellEditor(), Show::bool()) -> ok %% @equiv show(This,Show, []) +-spec show(This, Show) -> ok when + This::wxGridCellEditor(), Show::boolean(). + show(This,Show) when is_record(This, wx_ref),is_boolean(Show) -> show(This,Show, []). -%% @spec (This::wxGridCellEditor(), Show::bool(), [Option]) -> ok -%% Option = {attr, wxGridCellAttr:wxGridCellAttr()} %% @doc See external documentation. +-spec show(This, Show, [Option]) -> ok when + This::wxGridCellEditor(), Show::boolean(), + Option :: {attr, wxGridCellAttr:wxGridCellAttr()}. show(#wx_ref{type=ThisT,ref=ThisRef},Show, Options) when is_boolean(Show),is_list(Options) -> ?CLASS(ThisT,wxGridCellEditor), @@ -76,8 +84,9 @@ show(#wx_ref{type=ThisT,ref=ThisRef},Show, Options) wxe_util:cast(?wxGridCellEditor_Show, <>). -%% @spec (This::wxGridCellEditor(), RectCell::{X::integer(), Y::integer(), W::integer(), H::integer()}, Attr::wxGridCellAttr:wxGridCellAttr()) -> ok %% @doc See external documentation. +-spec paintBackground(This, RectCell, Attr) -> ok when + This::wxGridCellEditor(), RectCell::{X::integer(), Y::integer(), W::integer(), H::integer()}, Attr::wxGridCellAttr:wxGridCellAttr(). paintBackground(#wx_ref{type=ThisT,ref=ThisRef},{RectCellX,RectCellY,RectCellW,RectCellH},#wx_ref{type=AttrT,ref=AttrRef}) when is_integer(RectCellX),is_integer(RectCellY),is_integer(RectCellW),is_integer(RectCellH) -> ?CLASS(ThisT,wxGridCellEditor), @@ -85,8 +94,9 @@ paintBackground(#wx_ref{type=ThisT,ref=ThisRef},{RectCellX,RectCellY,RectCellW,R wxe_util:cast(?wxGridCellEditor_PaintBackground, <>). -%% @spec (This::wxGridCellEditor(), Row::integer(), Col::integer(), Grid::wxGrid:wxGrid()) -> ok %% @doc See external documentation. +-spec beginEdit(This, Row, Col, Grid) -> ok when + This::wxGridCellEditor(), Row::integer(), Col::integer(), Grid::wxGrid:wxGrid(). beginEdit(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=GridT,ref=GridRef}) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGridCellEditor), @@ -94,8 +104,9 @@ beginEdit(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=GridT,ref=GridRef wxe_util:cast(?wxGridCellEditor_BeginEdit, <>). -%% @spec (This::wxGridCellEditor(), Row::integer(), Col::integer(), Grid::wxGrid:wxGrid()) -> bool() %% @doc See external documentation. +-spec endEdit(This, Row, Col, Grid) -> boolean() when + This::wxGridCellEditor(), Row::integer(), Col::integer(), Grid::wxGrid:wxGrid(). endEdit(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=GridT,ref=GridRef}) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGridCellEditor), @@ -103,30 +114,34 @@ endEdit(#wx_ref{type=ThisT,ref=ThisRef},Row,Col,#wx_ref{type=GridT,ref=GridRef}) wxe_util:call(?wxGridCellEditor_EndEdit, <>). -%% @spec (This::wxGridCellEditor()) -> ok %% @doc See external documentation. +-spec reset(This) -> ok when + This::wxGridCellEditor(). reset(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellEditor), wxe_util:cast(?wxGridCellEditor_Reset, <>). -%% @spec (This::wxGridCellEditor(), Event::wxKeyEvent:wxKeyEvent()) -> ok %% @doc See external documentation. +-spec startingKey(This, Event) -> ok when + This::wxGridCellEditor(), Event::wxKeyEvent:wxKeyEvent(). startingKey(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=EventT,ref=EventRef}) -> ?CLASS(ThisT,wxGridCellEditor), ?CLASS(EventT,wxKeyEvent), wxe_util:cast(?wxGridCellEditor_StartingKey, <>). -%% @spec (This::wxGridCellEditor()) -> ok %% @doc See external documentation. +-spec startingClick(This) -> ok when + This::wxGridCellEditor(). startingClick(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellEditor), wxe_util:cast(?wxGridCellEditor_StartingClick, <>). -%% @spec (This::wxGridCellEditor(), Event::wxKeyEvent:wxKeyEvent()) -> ok %% @doc See external documentation. +-spec handleReturn(This, Event) -> ok when + This::wxGridCellEditor(), Event::wxKeyEvent:wxKeyEvent(). handleReturn(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=EventT,ref=EventRef}) -> ?CLASS(ThisT,wxGridCellEditor), ?CLASS(EventT,wxKeyEvent), diff --git a/lib/wx/src/gen/wxGridCellFloatEditor.erl b/lib/wx/src/gen/wxGridCellFloatEditor.erl index 3caad74f0e..ebb5aa04d4 100644 --- a/lib/wx/src/gen/wxGridCellFloatEditor.erl +++ b/lib/wx/src/gen/wxGridCellFloatEditor.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -33,18 +33,22 @@ -export([beginEdit/4,endEdit/4,handleReturn/2,isCreated/1,paintBackground/3, parent_class/1,reset/1,setSize/2,show/2,show/3,startingClick/1,startingKey/2]). +-export_type([wxGridCellFloatEditor/0]). %% @hidden parent_class(wxGridCellEditor) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGridCellFloatEditor() +-type wxGridCellFloatEditor() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxGridCellFloatEditor(). + new() -> new([]). -%% @spec ([Option]) -> wxGridCellFloatEditor() -%% Option = {width, integer()} | {precision, integer()} %% @doc See external documentation. +-spec new([Option]) -> wxGridCellFloatEditor() when + Option :: {width, integer()} + | {precision, integer()}. new(Options) when is_list(Options) -> MOpts = fun({width, Width}, Acc) -> [<<1:32/?UI,Width:32/?UI>>|Acc]; @@ -54,8 +58,9 @@ new(Options) wxe_util:construct(?wxGridCellFloatEditor_new, <>). -%% @spec (This::wxGridCellFloatEditor(), Params::string()) -> ok %% @doc See external documentation. +-spec setParameters(This, Params) -> ok when + This::wxGridCellFloatEditor(), Params::string(). setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) when is_list(Params) -> ?CLASS(ThisT,wxGridCellFloatEditor), @@ -63,8 +68,8 @@ setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) wxe_util:cast(?wxGridCellFloatEditor_SetParameters, <>). -%% @spec (This::wxGridCellFloatEditor()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridCellFloatEditor) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridCellFloatEditor), wxe_util:destroy(?wxGridCellFloatEditor_destroy,Obj), diff --git a/lib/wx/src/gen/wxGridCellFloatRenderer.erl b/lib/wx/src/gen/wxGridCellFloatRenderer.erl index 84ffd21b37..4e3450c90b 100644 --- a/lib/wx/src/gen/wxGridCellFloatRenderer.erl +++ b/lib/wx/src/gen/wxGridCellFloatRenderer.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -34,19 +34,23 @@ %% inherited exports -export([draw/8,getBestSize/6,parent_class/1]). +-export_type([wxGridCellFloatRenderer/0]). %% @hidden parent_class(wxGridCellStringRenderer) -> true; parent_class(wxGridCellRenderer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGridCellFloatRenderer() +-type wxGridCellFloatRenderer() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxGridCellFloatRenderer(). + new() -> new([]). -%% @spec ([Option]) -> wxGridCellFloatRenderer() -%% Option = {width, integer()} | {precision, integer()} %% @doc See external documentation. +-spec new([Option]) -> wxGridCellFloatRenderer() when + Option :: {width, integer()} + | {precision, integer()}. new(Options) when is_list(Options) -> MOpts = fun({width, Width}, Acc) -> [<<1:32/?UI,Width:32/?UI>>|Acc]; @@ -56,22 +60,25 @@ new(Options) wxe_util:construct(?wxGridCellFloatRenderer_new, <>). -%% @spec (This::wxGridCellFloatRenderer()) -> integer() %% @doc See external documentation. +-spec getPrecision(This) -> integer() when + This::wxGridCellFloatRenderer(). getPrecision(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellFloatRenderer), wxe_util:call(?wxGridCellFloatRenderer_GetPrecision, <>). -%% @spec (This::wxGridCellFloatRenderer()) -> integer() %% @doc See external documentation. +-spec getWidth(This) -> integer() when + This::wxGridCellFloatRenderer(). getWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellFloatRenderer), wxe_util:call(?wxGridCellFloatRenderer_GetWidth, <>). -%% @spec (This::wxGridCellFloatRenderer(), Params::string()) -> ok %% @doc See external documentation. +-spec setParameters(This, Params) -> ok when + This::wxGridCellFloatRenderer(), Params::string(). setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) when is_list(Params) -> ?CLASS(ThisT,wxGridCellFloatRenderer), @@ -79,24 +86,26 @@ setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) wxe_util:cast(?wxGridCellFloatRenderer_SetParameters, <>). -%% @spec (This::wxGridCellFloatRenderer(), Precision::integer()) -> ok %% @doc See external documentation. +-spec setPrecision(This, Precision) -> ok when + This::wxGridCellFloatRenderer(), Precision::integer(). setPrecision(#wx_ref{type=ThisT,ref=ThisRef},Precision) when is_integer(Precision) -> ?CLASS(ThisT,wxGridCellFloatRenderer), wxe_util:cast(?wxGridCellFloatRenderer_SetPrecision, <>). -%% @spec (This::wxGridCellFloatRenderer(), Width::integer()) -> ok %% @doc See external documentation. +-spec setWidth(This, Width) -> ok when + This::wxGridCellFloatRenderer(), Width::integer(). setWidth(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxGridCellFloatRenderer), wxe_util:cast(?wxGridCellFloatRenderer_SetWidth, <>). -%% @spec (This::wxGridCellFloatRenderer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridCellFloatRenderer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridCellFloatRenderer), wxe_util:destroy(?wxGridCellFloatRenderer_destroy,Obj), diff --git a/lib/wx/src/gen/wxGridCellNumberEditor.erl b/lib/wx/src/gen/wxGridCellNumberEditor.erl index 4ebdbb14e9..c3ac0c41d5 100644 --- a/lib/wx/src/gen/wxGridCellNumberEditor.erl +++ b/lib/wx/src/gen/wxGridCellNumberEditor.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -34,19 +34,23 @@ -export([beginEdit/4,endEdit/4,handleReturn/2,isCreated/1,paintBackground/3, parent_class/1,reset/1,setSize/2,show/2,show/3,startingClick/1,startingKey/2]). +-export_type([wxGridCellNumberEditor/0]). %% @hidden parent_class(wxGridCellTextEditor) -> true; parent_class(wxGridCellEditor) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGridCellNumberEditor() +-type wxGridCellNumberEditor() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxGridCellNumberEditor(). + new() -> new([]). -%% @spec ([Option]) -> wxGridCellNumberEditor() -%% Option = {min, integer()} | {max, integer()} %% @doc See external documentation. +-spec new([Option]) -> wxGridCellNumberEditor() when + Option :: {min, integer()} + | {max, integer()}. new(Options) when is_list(Options) -> MOpts = fun({min, Min}, Acc) -> [<<1:32/?UI,Min:32/?UI>>|Acc]; @@ -56,15 +60,17 @@ new(Options) wxe_util:construct(?wxGridCellNumberEditor_new, <>). -%% @spec (This::wxGridCellNumberEditor()) -> string() %% @doc See external documentation. +-spec getValue(This) -> string() when + This::wxGridCellNumberEditor(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridCellNumberEditor), wxe_util:call(?wxGridCellNumberEditor_GetValue, <>). -%% @spec (This::wxGridCellNumberEditor(), Params::string()) -> ok %% @doc See external documentation. +-spec setParameters(This, Params) -> ok when + This::wxGridCellNumberEditor(), Params::string(). setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) when is_list(Params) -> ?CLASS(ThisT,wxGridCellNumberEditor), @@ -72,8 +78,8 @@ setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) wxe_util:cast(?wxGridCellNumberEditor_SetParameters, <>). -%% @spec (This::wxGridCellNumberEditor()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridCellNumberEditor) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridCellNumberEditor), wxe_util:destroy(?wxGridCellNumberEditor_destroy,Obj), diff --git a/lib/wx/src/gen/wxGridCellNumberRenderer.erl b/lib/wx/src/gen/wxGridCellNumberRenderer.erl index 651057bb4b..5d5bd89960 100644 --- a/lib/wx/src/gen/wxGridCellNumberRenderer.erl +++ b/lib/wx/src/gen/wxGridCellNumberRenderer.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -33,19 +33,21 @@ %% inherited exports -export([draw/8,getBestSize/6,parent_class/1]). +-export_type([wxGridCellNumberRenderer/0]). %% @hidden parent_class(wxGridCellStringRenderer) -> true; parent_class(wxGridCellRenderer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGridCellNumberRenderer() +-type wxGridCellNumberRenderer() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxGridCellNumberRenderer(). new() -> wxe_util:construct(?wxGridCellNumberRenderer_new, <<>>). -%% @spec (This::wxGridCellNumberRenderer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridCellNumberRenderer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridCellNumberRenderer), wxe_util:destroy(?wxGridCellNumberRenderer_destroy,Obj), diff --git a/lib/wx/src/gen/wxGridCellRenderer.erl b/lib/wx/src/gen/wxGridCellRenderer.erl index 765c116a48..42d376a347 100644 --- a/lib/wx/src/gen/wxGridCellRenderer.erl +++ b/lib/wx/src/gen/wxGridCellRenderer.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 @@ -29,11 +29,14 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxGridCellRenderer/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxGridCellRenderer(), Grid::wxGrid:wxGrid(), Attr::wxGridCellAttr:wxGridCellAttr(), Dc::wxDC:wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, Row::integer(), Col::integer(), IsSelected::bool()) -> ok +-type wxGridCellRenderer() :: wx:wx_object(). %% @doc See external documentation. +-spec draw(This, Grid, Attr, Dc, Rect, Row, Col, IsSelected) -> ok when + This::wxGridCellRenderer(), Grid::wxGrid:wxGrid(), Attr::wxGridCellAttr:wxGridCellAttr(), Dc::wxDC:wxDC(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, Row::integer(), Col::integer(), IsSelected::boolean(). draw(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=GridT,ref=GridRef},#wx_ref{type=AttrT,ref=AttrRef},#wx_ref{type=DcT,ref=DcRef},{RectX,RectY,RectW,RectH},Row,Col,IsSelected) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),is_integer(Row),is_integer(Col),is_boolean(IsSelected) -> ?CLASS(ThisT,wxGridCellRenderer), @@ -43,8 +46,9 @@ draw(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=GridT,ref=GridRef},#wx_ref{typ wxe_util:cast(?wxGridCellRenderer_Draw, <>). -%% @spec (This::wxGridCellRenderer(), Grid::wxGrid:wxGrid(), Attr::wxGridCellAttr:wxGridCellAttr(), Dc::wxDC:wxDC(), Row::integer(), Col::integer()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getBestSize(This, Grid, Attr, Dc, Row, Col) -> {W::integer(), H::integer()} when + This::wxGridCellRenderer(), Grid::wxGrid:wxGrid(), Attr::wxGridCellAttr:wxGridCellAttr(), Dc::wxDC:wxDC(), Row::integer(), Col::integer(). getBestSize(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=GridT,ref=GridRef},#wx_ref{type=AttrT,ref=AttrRef},#wx_ref{type=DcT,ref=DcRef},Row,Col) when is_integer(Row),is_integer(Col) -> ?CLASS(ThisT,wxGridCellRenderer), diff --git a/lib/wx/src/gen/wxGridCellStringRenderer.erl b/lib/wx/src/gen/wxGridCellStringRenderer.erl index 28a79e0453..36887a3d52 100644 --- a/lib/wx/src/gen/wxGridCellStringRenderer.erl +++ b/lib/wx/src/gen/wxGridCellStringRenderer.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-2012. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -32,18 +32,20 @@ %% inherited exports -export([draw/8,getBestSize/6,parent_class/1]). +-export_type([wxGridCellStringRenderer/0]). %% @hidden parent_class(wxGridCellRenderer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGridCellStringRenderer() +-type wxGridCellStringRenderer() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxGridCellStringRenderer(). new() -> wxe_util:construct(?wxGridCellStringRenderer_new, <<>>). -%% @spec (This::wxGridCellStringRenderer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridCellStringRenderer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridCellStringRenderer), wxe_util:destroy(?wxGridCellStringRenderer_destroy,Obj), diff --git a/lib/wx/src/gen/wxGridCellTextEditor.erl b/lib/wx/src/gen/wxGridCellTextEditor.erl index d9ab1dc107..e849de7afd 100644 --- a/lib/wx/src/gen/wxGridCellTextEditor.erl +++ b/lib/wx/src/gen/wxGridCellTextEditor.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -33,18 +33,21 @@ -export([beginEdit/4,endEdit/4,handleReturn/2,isCreated/1,paintBackground/3, parent_class/1,reset/1,setSize/2,show/2,show/3,startingClick/1,startingKey/2]). +-export_type([wxGridCellTextEditor/0]). %% @hidden parent_class(wxGridCellEditor) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxGridCellTextEditor() +-type wxGridCellTextEditor() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxGridCellTextEditor(). new() -> wxe_util:construct(?wxGridCellTextEditor_new, <<>>). -%% @spec (This::wxGridCellTextEditor(), Params::string()) -> ok %% @doc See external documentation. +-spec setParameters(This, Params) -> ok when + This::wxGridCellTextEditor(), Params::string(). setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) when is_list(Params) -> ?CLASS(ThisT,wxGridCellTextEditor), @@ -52,8 +55,8 @@ setParameters(#wx_ref{type=ThisT,ref=ThisRef},Params) wxe_util:cast(?wxGridCellTextEditor_SetParameters, <>). -%% @spec (This::wxGridCellTextEditor()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridCellTextEditor) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridCellTextEditor), wxe_util:destroy(?wxGridCellTextEditor_destroy,Obj), diff --git a/lib/wx/src/gen/wxGridEvent.erl b/lib/wx/src/gen/wxGridEvent.erl index 123088afb5..59c2ad53b5 100644 --- a/lib/wx/src/gen/wxGridEvent.erl +++ b/lib/wx/src/gen/wxGridEvent.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 @@ -42,63 +42,73 @@ isSelection/1,parent_class/1,resumePropagation/2,setInt/2,setString/2, shouldPropagate/1,skip/1,skip/2,stopPropagation/1,veto/1]). +-export_type([wxGridEvent/0]). %% @hidden parent_class(wxNotifyEvent) -> true; parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxGridEvent()) -> bool() +-type wxGridEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec altDown(This) -> boolean() when + This::wxGridEvent(). altDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridEvent), wxe_util:call(?wxGridEvent_AltDown, <>). -%% @spec (This::wxGridEvent()) -> bool() %% @doc See external documentation. +-spec controlDown(This) -> boolean() when + This::wxGridEvent(). controlDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridEvent), wxe_util:call(?wxGridEvent_ControlDown, <>). -%% @spec (This::wxGridEvent()) -> integer() %% @doc See external documentation. +-spec getCol(This) -> integer() when + This::wxGridEvent(). getCol(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridEvent), wxe_util:call(?wxGridEvent_GetCol, <>). -%% @spec (This::wxGridEvent()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxGridEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridEvent), wxe_util:call(?wxGridEvent_GetPosition, <>). -%% @spec (This::wxGridEvent()) -> integer() %% @doc See external documentation. +-spec getRow(This) -> integer() when + This::wxGridEvent(). getRow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridEvent), wxe_util:call(?wxGridEvent_GetRow, <>). -%% @spec (This::wxGridEvent()) -> bool() %% @doc See external documentation. +-spec metaDown(This) -> boolean() when + This::wxGridEvent(). metaDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridEvent), wxe_util:call(?wxGridEvent_MetaDown, <>). -%% @spec (This::wxGridEvent()) -> bool() %% @doc See external documentation. +-spec selecting(This) -> boolean() when + This::wxGridEvent(). selecting(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridEvent), wxe_util:call(?wxGridEvent_Selecting, <>). -%% @spec (This::wxGridEvent()) -> bool() %% @doc See external documentation. +-spec shiftDown(This) -> boolean() when + This::wxGridEvent(). shiftDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridEvent), wxe_util:call(?wxGridEvent_ShiftDown, diff --git a/lib/wx/src/gen/wxGridSizer.erl b/lib/wx/src/gen/wxGridSizer.erl index fd8580c70d..0893105352 100644 --- a/lib/wx/src/gen/wxGridSizer.erl +++ b/lib/wx/src/gen/wxGridSizer.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 @@ -41,19 +41,25 @@ setMinSize/2,setMinSize/3,setSizeHints/2,setVirtualSizeHints/2,show/2, show/3]). +-export_type([wxGridSizer/0]). %% @hidden parent_class(wxSizer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Cols::integer()) -> wxGridSizer() +-type wxGridSizer() :: wx:wx_object(). %% @equiv new(Cols, []) +-spec new(Cols) -> wxGridSizer() when + Cols::integer(). + new(Cols) when is_integer(Cols) -> new(Cols, []). -%% @spec (Cols::integer(), [Option]) -> wxGridSizer() -%% Option = {vgap, integer()} | {hgap, integer()} %% @doc See external documentation. +-spec new(Cols, [Option]) -> wxGridSizer() when + Cols::integer(), + Option :: {vgap, integer()} + | {hgap, integer()}. new(Cols, Options) when is_integer(Cols),is_list(Options) -> MOpts = fun({vgap, Vgap}, Acc) -> [<<1:32/?UI,Vgap:32/?UI>>|Acc]; @@ -63,75 +69,84 @@ new(Cols, Options) wxe_util:construct(?wxGridSizer_new_2, <>). -%% @spec (Rows::integer(), Cols::integer(), Vgap::integer(), Hgap::integer()) -> wxGridSizer() %% @doc See external documentation. +-spec new(Rows, Cols, Vgap, Hgap) -> wxGridSizer() when + Rows::integer(), Cols::integer(), Vgap::integer(), Hgap::integer(). new(Rows,Cols,Vgap,Hgap) when is_integer(Rows),is_integer(Cols),is_integer(Vgap),is_integer(Hgap) -> wxe_util:construct(?wxGridSizer_new_4, <>). -%% @spec (This::wxGridSizer()) -> integer() %% @doc See external documentation. +-spec getCols(This) -> integer() when + This::wxGridSizer(). getCols(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridSizer), wxe_util:call(?wxGridSizer_GetCols, <>). -%% @spec (This::wxGridSizer()) -> integer() %% @doc See external documentation. +-spec getHGap(This) -> integer() when + This::wxGridSizer(). getHGap(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridSizer), wxe_util:call(?wxGridSizer_GetHGap, <>). -%% @spec (This::wxGridSizer()) -> integer() %% @doc See external documentation. +-spec getRows(This) -> integer() when + This::wxGridSizer(). getRows(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridSizer), wxe_util:call(?wxGridSizer_GetRows, <>). -%% @spec (This::wxGridSizer()) -> integer() %% @doc See external documentation. +-spec getVGap(This) -> integer() when + This::wxGridSizer(). getVGap(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxGridSizer), wxe_util:call(?wxGridSizer_GetVGap, <>). -%% @spec (This::wxGridSizer(), Cols::integer()) -> ok %% @doc See external documentation. +-spec setCols(This, Cols) -> ok when + This::wxGridSizer(), Cols::integer(). setCols(#wx_ref{type=ThisT,ref=ThisRef},Cols) when is_integer(Cols) -> ?CLASS(ThisT,wxGridSizer), wxe_util:cast(?wxGridSizer_SetCols, <>). -%% @spec (This::wxGridSizer(), Gap::integer()) -> ok %% @doc See external documentation. +-spec setHGap(This, Gap) -> ok when + This::wxGridSizer(), Gap::integer(). setHGap(#wx_ref{type=ThisT,ref=ThisRef},Gap) when is_integer(Gap) -> ?CLASS(ThisT,wxGridSizer), wxe_util:cast(?wxGridSizer_SetHGap, <>). -%% @spec (This::wxGridSizer(), Rows::integer()) -> ok %% @doc See external documentation. +-spec setRows(This, Rows) -> ok when + This::wxGridSizer(), Rows::integer(). setRows(#wx_ref{type=ThisT,ref=ThisRef},Rows) when is_integer(Rows) -> ?CLASS(ThisT,wxGridSizer), wxe_util:cast(?wxGridSizer_SetRows, <>). -%% @spec (This::wxGridSizer(), Gap::integer()) -> ok %% @doc See external documentation. +-spec setVGap(This, Gap) -> ok when + This::wxGridSizer(), Gap::integer(). setVGap(#wx_ref{type=ThisT,ref=ThisRef},Gap) when is_integer(Gap) -> ?CLASS(ThisT,wxGridSizer), wxe_util:cast(?wxGridSizer_SetVGap, <>). -%% @spec (This::wxGridSizer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxGridSizer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxGridSizer), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxHelpEvent.erl b/lib/wx/src/gen/wxHelpEvent.erl index b80903c314..70da136be8 100644 --- a/lib/wx/src/gen/wxHelpEvent.erl +++ b/lib/wx/src/gen/wxHelpEvent.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 @@ -37,38 +37,42 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxHelpEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxHelpEvent()) -> Origin -%% Origin = integer() +-type wxHelpEvent() :: wx:wx_object(). %% @doc See external documentation. -%%
Origin is one of ?wxHelpEvent_Origin_Unknown | ?wxHelpEvent_Origin_Keyboard | ?wxHelpEvent_Origin_HelpButton +%%
Res = ?wxHelpEvent_Origin_Unknown | ?wxHelpEvent_Origin_Keyboard | ?wxHelpEvent_Origin_HelpButton +-spec getOrigin(This) -> wx:wx_enum() when + This::wxHelpEvent(). getOrigin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHelpEvent), wxe_util:call(?wxHelpEvent_GetOrigin, <>). -%% @spec (This::wxHelpEvent()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxHelpEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHelpEvent), wxe_util:call(?wxHelpEvent_GetPosition, <>). -%% @spec (This::wxHelpEvent(), Origin::Origin) -> ok -%% Origin = integer() %% @doc See external documentation. -%%
Origin is one of ?wxHelpEvent_Origin_Unknown | ?wxHelpEvent_Origin_Keyboard | ?wxHelpEvent_Origin_HelpButton +%%
Origin = ?wxHelpEvent_Origin_Unknown | ?wxHelpEvent_Origin_Keyboard | ?wxHelpEvent_Origin_HelpButton +-spec setOrigin(This, Origin) -> ok when + This::wxHelpEvent(), Origin::wx:wx_enum(). setOrigin(#wx_ref{type=ThisT,ref=ThisRef},Origin) when is_integer(Origin) -> ?CLASS(ThisT,wxHelpEvent), wxe_util:cast(?wxHelpEvent_SetOrigin, <>). -%% @spec (This::wxHelpEvent(), Pos::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec setPosition(This, Pos) -> ok when + This::wxHelpEvent(), Pos::{X::integer(), Y::integer()}. setPosition(#wx_ref{type=ThisT,ref=ThisRef},{PosX,PosY}) when is_integer(PosX),is_integer(PosY) -> ?CLASS(ThisT,wxHelpEvent), diff --git a/lib/wx/src/gen/wxHtmlEasyPrinting.erl b/lib/wx/src/gen/wxHtmlEasyPrinting.erl index 15d673169a..5f1f55af64 100644 --- a/lib/wx/src/gen/wxHtmlEasyPrinting.erl +++ b/lib/wx/src/gen/wxHtmlEasyPrinting.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 @@ -32,17 +32,21 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxHtmlEasyPrinting/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxHtmlEasyPrinting() +-type wxHtmlEasyPrinting() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxHtmlEasyPrinting(). + new() -> new([]). -%% @spec ([Option]) -> wxHtmlEasyPrinting() -%% Option = {name, string()} | {parentWindow, wxWindow:wxWindow()} %% @doc See external documentation. +-spec new([Option]) -> wxHtmlEasyPrinting() when + Option :: {name, string()} + | {parentWindow, wxWindow:wxWindow()}. new(Options) when is_list(Options) -> MOpts = fun({name, Name}, Acc) -> Name_UC = unicode:characters_to_binary([Name,0]),[<<1:32/?UI,(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((0+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>|Acc]; @@ -52,22 +56,25 @@ new(Options) wxe_util:construct(?wxHtmlEasyPrinting_new, <>). -%% @spec (This::wxHtmlEasyPrinting()) -> wxPrintData:wxPrintData() %% @doc See external documentation. +-spec getPrintData(This) -> wxPrintData:wxPrintData() when + This::wxHtmlEasyPrinting(). getPrintData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlEasyPrinting), wxe_util:call(?wxHtmlEasyPrinting_GetPrintData, <>). -%% @spec (This::wxHtmlEasyPrinting()) -> wxPageSetupDialogData:wxPageSetupDialogData() %% @doc See external documentation. +-spec getPageSetupData(This) -> wxPageSetupDialogData:wxPageSetupDialogData() when + This::wxHtmlEasyPrinting(). getPageSetupData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlEasyPrinting), wxe_util:call(?wxHtmlEasyPrinting_GetPageSetupData, <>). -%% @spec (This::wxHtmlEasyPrinting(), Htmlfile::string()) -> bool() %% @doc See external documentation. +-spec previewFile(This, Htmlfile) -> boolean() when + This::wxHtmlEasyPrinting(), Htmlfile::string(). previewFile(#wx_ref{type=ThisT,ref=ThisRef},Htmlfile) when is_list(Htmlfile) -> ?CLASS(ThisT,wxHtmlEasyPrinting), @@ -75,15 +82,18 @@ previewFile(#wx_ref{type=ThisT,ref=ThisRef},Htmlfile) wxe_util:call(?wxHtmlEasyPrinting_PreviewFile, <>). -%% @spec (This::wxHtmlEasyPrinting(), Htmltext::string()) -> bool() %% @equiv previewText(This,Htmltext, []) +-spec previewText(This, Htmltext) -> boolean() when + This::wxHtmlEasyPrinting(), Htmltext::string(). + previewText(This,Htmltext) when is_record(This, wx_ref),is_list(Htmltext) -> previewText(This,Htmltext, []). -%% @spec (This::wxHtmlEasyPrinting(), Htmltext::string(), [Option]) -> bool() -%% Option = {basepath, string()} %% @doc See external documentation. +-spec previewText(This, Htmltext, [Option]) -> boolean() when + This::wxHtmlEasyPrinting(), Htmltext::string(), + Option :: {basepath, string()}. previewText(#wx_ref{type=ThisT,ref=ThisRef},Htmltext, Options) when is_list(Htmltext),is_list(Options) -> ?CLASS(ThisT,wxHtmlEasyPrinting), @@ -94,8 +104,9 @@ previewText(#wx_ref{type=ThisT,ref=ThisRef},Htmltext, Options) wxe_util:call(?wxHtmlEasyPrinting_PreviewText, <>). -%% @spec (This::wxHtmlEasyPrinting(), Htmlfile::string()) -> bool() %% @doc See external documentation. +-spec printFile(This, Htmlfile) -> boolean() when + This::wxHtmlEasyPrinting(), Htmlfile::string(). printFile(#wx_ref{type=ThisT,ref=ThisRef},Htmlfile) when is_list(Htmlfile) -> ?CLASS(ThisT,wxHtmlEasyPrinting), @@ -103,15 +114,18 @@ printFile(#wx_ref{type=ThisT,ref=ThisRef},Htmlfile) wxe_util:call(?wxHtmlEasyPrinting_PrintFile, <>). -%% @spec (This::wxHtmlEasyPrinting(), Htmltext::string()) -> bool() %% @equiv printText(This,Htmltext, []) +-spec printText(This, Htmltext) -> boolean() when + This::wxHtmlEasyPrinting(), Htmltext::string(). + printText(This,Htmltext) when is_record(This, wx_ref),is_list(Htmltext) -> printText(This,Htmltext, []). -%% @spec (This::wxHtmlEasyPrinting(), Htmltext::string(), [Option]) -> bool() -%% Option = {basepath, string()} %% @doc See external documentation. +-spec printText(This, Htmltext, [Option]) -> boolean() when + This::wxHtmlEasyPrinting(), Htmltext::string(), + Option :: {basepath, string()}. printText(#wx_ref{type=ThisT,ref=ThisRef},Htmltext, Options) when is_list(Htmltext),is_list(Options) -> ?CLASS(ThisT,wxHtmlEasyPrinting), @@ -122,22 +136,26 @@ printText(#wx_ref{type=ThisT,ref=ThisRef},Htmltext, Options) wxe_util:call(?wxHtmlEasyPrinting_PrintText, <>). -%% @spec (This::wxHtmlEasyPrinting()) -> ok %% @doc See external documentation. +-spec pageSetup(This) -> ok when + This::wxHtmlEasyPrinting(). pageSetup(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlEasyPrinting), wxe_util:cast(?wxHtmlEasyPrinting_PageSetup, <>). -%% @spec (This::wxHtmlEasyPrinting(), Normal_face::string(), Fixed_face::string()) -> ok %% @equiv setFonts(This,Normal_face,Fixed_face, []) +-spec setFonts(This, Normal_face, Fixed_face) -> ok when + This::wxHtmlEasyPrinting(), Normal_face::string(), Fixed_face::string(). + setFonts(This,Normal_face,Fixed_face) when is_record(This, wx_ref),is_list(Normal_face),is_list(Fixed_face) -> setFonts(This,Normal_face,Fixed_face, []). -%% @spec (This::wxHtmlEasyPrinting(), Normal_face::string(), Fixed_face::string(), [Option]) -> ok -%% Option = {sizes, [integer()]} %% @doc See external documentation. +-spec setFonts(This, Normal_face, Fixed_face, [Option]) -> ok when + This::wxHtmlEasyPrinting(), Normal_face::string(), Fixed_face::string(), + Option :: {sizes, [integer()]}. setFonts(#wx_ref{type=ThisT,ref=ThisRef},Normal_face,Fixed_face, Options) when is_list(Normal_face),is_list(Fixed_face),is_list(Options) -> ?CLASS(ThisT,wxHtmlEasyPrinting), @@ -150,15 +168,18 @@ setFonts(#wx_ref{type=ThisT,ref=ThisRef},Normal_face,Fixed_face, Options) wxe_util:cast(?wxHtmlEasyPrinting_SetFonts, <>). -%% @spec (This::wxHtmlEasyPrinting(), Header::string()) -> ok %% @equiv setHeader(This,Header, []) +-spec setHeader(This, Header) -> ok when + This::wxHtmlEasyPrinting(), Header::string(). + setHeader(This,Header) when is_record(This, wx_ref),is_list(Header) -> setHeader(This,Header, []). -%% @spec (This::wxHtmlEasyPrinting(), Header::string(), [Option]) -> ok -%% Option = {pg, integer()} %% @doc See external documentation. +-spec setHeader(This, Header, [Option]) -> ok when + This::wxHtmlEasyPrinting(), Header::string(), + Option :: {pg, integer()}. setHeader(#wx_ref{type=ThisT,ref=ThisRef},Header, Options) when is_list(Header),is_list(Options) -> ?CLASS(ThisT,wxHtmlEasyPrinting), @@ -169,15 +190,18 @@ setHeader(#wx_ref{type=ThisT,ref=ThisRef},Header, Options) wxe_util:cast(?wxHtmlEasyPrinting_SetHeader, <>). -%% @spec (This::wxHtmlEasyPrinting(), Footer::string()) -> ok %% @equiv setFooter(This,Footer, []) +-spec setFooter(This, Footer) -> ok when + This::wxHtmlEasyPrinting(), Footer::string(). + setFooter(This,Footer) when is_record(This, wx_ref),is_list(Footer) -> setFooter(This,Footer, []). -%% @spec (This::wxHtmlEasyPrinting(), Footer::string(), [Option]) -> ok -%% Option = {pg, integer()} %% @doc See external documentation. +-spec setFooter(This, Footer, [Option]) -> ok when + This::wxHtmlEasyPrinting(), Footer::string(), + Option :: {pg, integer()}. setFooter(#wx_ref{type=ThisT,ref=ThisRef},Footer, Options) when is_list(Footer),is_list(Options) -> ?CLASS(ThisT,wxHtmlEasyPrinting), @@ -188,8 +212,8 @@ setFooter(#wx_ref{type=ThisT,ref=ThisRef},Footer, Options) wxe_util:cast(?wxHtmlEasyPrinting_SetFooter, <>). -%% @spec (This::wxHtmlEasyPrinting()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxHtmlEasyPrinting) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxHtmlEasyPrinting), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxHtmlLinkEvent.erl b/lib/wx/src/gen/wxHtmlLinkEvent.erl index 166493ccbc..94fe670f35 100644 --- a/lib/wx/src/gen/wxHtmlLinkEvent.erl +++ b/lib/wx/src/gen/wxHtmlLinkEvent.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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,13 +40,16 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxHtmlLinkEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxHtmlLinkEvent()) -> wx:wxHtmlLinkInfo() +-type wxHtmlLinkEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getLinkInfo(This) -> wx:wx_wxHtmlLinkInfo() when + This::wxHtmlLinkEvent(). getLinkInfo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlLinkEvent), wxe_util:call(?wxHtmlLinkEvent_GetLinkInfo, diff --git a/lib/wx/src/gen/wxHtmlWindow.erl b/lib/wx/src/gen/wxHtmlWindow.erl index 891e5481fb..c8237ec31d 100644 --- a/lib/wx/src/gen/wxHtmlWindow.erl +++ b/lib/wx/src/gen/wxHtmlWindow.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2011. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -79,6 +79,7 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxHtmlWindow/0]). %% @hidden parent_class(wxScrolledWindow) -> true; parent_class(wxPanel) -> true; @@ -86,21 +87,28 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxHtmlWindow() +-type wxHtmlWindow() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxHtmlWindow(). new() -> wxe_util:construct(?wxHtmlWindow_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxHtmlWindow() %% @equiv new(Parent, []) +-spec new(Parent) -> wxHtmlWindow() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxHtmlWindow() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxHtmlWindow() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -113,8 +121,9 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxHtmlWindow_new_2, <>). -%% @spec (This::wxHtmlWindow(), Source::string()) -> bool() %% @doc See external documentation. +-spec appendToPage(This, Source) -> boolean() when + This::wxHtmlWindow(), Source::string(). appendToPage(#wx_ref{type=ThisT,ref=ThisRef},Source) when is_list(Source) -> ?CLASS(ThisT,wxHtmlWindow), @@ -122,71 +131,81 @@ appendToPage(#wx_ref{type=ThisT,ref=ThisRef},Source) wxe_util:call(?wxHtmlWindow_AppendToPage, <>). -%% @spec (This::wxHtmlWindow()) -> string() %% @doc See external documentation. +-spec getOpenedAnchor(This) -> string() when + This::wxHtmlWindow(). getOpenedAnchor(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_GetOpenedAnchor, <>). -%% @spec (This::wxHtmlWindow()) -> string() %% @doc See external documentation. +-spec getOpenedPage(This) -> string() when + This::wxHtmlWindow(). getOpenedPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_GetOpenedPage, <>). -%% @spec (This::wxHtmlWindow()) -> string() %% @doc See external documentation. +-spec getOpenedPageTitle(This) -> string() when + This::wxHtmlWindow(). getOpenedPageTitle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_GetOpenedPageTitle, <>). -%% @spec (This::wxHtmlWindow()) -> wxFrame:wxFrame() %% @doc See external documentation. +-spec getRelatedFrame(This) -> wxFrame:wxFrame() when + This::wxHtmlWindow(). getRelatedFrame(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_GetRelatedFrame, <>). -%% @spec (This::wxHtmlWindow()) -> bool() %% @doc See external documentation. +-spec historyBack(This) -> boolean() when + This::wxHtmlWindow(). historyBack(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_HistoryBack, <>). -%% @spec (This::wxHtmlWindow()) -> bool() %% @doc See external documentation. +-spec historyCanBack(This) -> boolean() when + This::wxHtmlWindow(). historyCanBack(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_HistoryCanBack, <>). -%% @spec (This::wxHtmlWindow()) -> bool() %% @doc See external documentation. +-spec historyCanForward(This) -> boolean() when + This::wxHtmlWindow(). historyCanForward(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_HistoryCanForward, <>). -%% @spec (This::wxHtmlWindow()) -> ok %% @doc See external documentation. +-spec historyClear(This) -> ok when + This::wxHtmlWindow(). historyClear(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:cast(?wxHtmlWindow_HistoryClear, <>). -%% @spec (This::wxHtmlWindow()) -> bool() %% @doc See external documentation. +-spec historyForward(This) -> boolean() when + This::wxHtmlWindow(). historyForward(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_HistoryForward, <>). -%% @spec (This::wxHtmlWindow(), Filename::string()) -> bool() %% @doc See external documentation. +-spec loadFile(This, Filename) -> boolean() when + This::wxHtmlWindow(), Filename::string(). loadFile(#wx_ref{type=ThisT,ref=ThisRef},Filename) when is_list(Filename) -> ?CLASS(ThisT,wxHtmlWindow), @@ -194,8 +213,9 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},Filename) wxe_util:call(?wxHtmlWindow_LoadFile, <>). -%% @spec (This::wxHtmlWindow(), Location::string()) -> bool() %% @doc See external documentation. +-spec loadPage(This, Location) -> boolean() when + This::wxHtmlWindow(), Location::string(). loadPage(#wx_ref{type=ThisT,ref=ThisRef},Location) when is_list(Location) -> ?CLASS(ThisT,wxHtmlWindow), @@ -203,53 +223,61 @@ loadPage(#wx_ref{type=ThisT,ref=ThisRef},Location) wxe_util:call(?wxHtmlWindow_LoadPage, <>). -%% @spec (This::wxHtmlWindow()) -> ok %% @doc See external documentation. +-spec selectAll(This) -> ok when + This::wxHtmlWindow(). selectAll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:cast(?wxHtmlWindow_SelectAll, <>). -%% @spec (This::wxHtmlWindow()) -> string() %% @doc See external documentation. +-spec selectionToText(This) -> string() when + This::wxHtmlWindow(). selectionToText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_SelectionToText, <>). -%% @spec (This::wxHtmlWindow(), Pos::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec selectLine(This, Pos) -> ok when + This::wxHtmlWindow(), Pos::{X::integer(), Y::integer()}. selectLine(#wx_ref{type=ThisT,ref=ThisRef},{PosX,PosY}) when is_integer(PosX),is_integer(PosY) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:cast(?wxHtmlWindow_SelectLine, <>). -%% @spec (This::wxHtmlWindow(), Pos::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec selectWord(This, Pos) -> ok when + This::wxHtmlWindow(), Pos::{X::integer(), Y::integer()}. selectWord(#wx_ref{type=ThisT,ref=ThisRef},{PosX,PosY}) when is_integer(PosX),is_integer(PosY) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:cast(?wxHtmlWindow_SelectWord, <>). -%% @spec (This::wxHtmlWindow(), B::integer()) -> ok %% @doc See external documentation. +-spec setBorders(This, B) -> ok when + This::wxHtmlWindow(), B::integer(). setBorders(#wx_ref{type=ThisT,ref=ThisRef},B) when is_integer(B) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:cast(?wxHtmlWindow_SetBorders, <>). -%% @spec (This::wxHtmlWindow(), Normal_face::string(), Fixed_face::string()) -> ok %% @equiv setFonts(This,Normal_face,Fixed_face, []) +-spec setFonts(This, Normal_face, Fixed_face) -> ok when + This::wxHtmlWindow(), Normal_face::string(), Fixed_face::string(). + setFonts(This,Normal_face,Fixed_face) when is_record(This, wx_ref),is_list(Normal_face),is_list(Fixed_face) -> setFonts(This,Normal_face,Fixed_face, []). -%% @spec (This::wxHtmlWindow(), Normal_face::string(), Fixed_face::string(), [Option]) -> ok -%% Option = {sizes, integer()} %% @doc See external documentation. +-spec setFonts(This, Normal_face, Fixed_face, [Option]) -> ok when + This::wxHtmlWindow(), Normal_face::string(), Fixed_face::string(), + Option :: {sizes, integer()}. setFonts(#wx_ref{type=ThisT,ref=ThisRef},Normal_face,Fixed_face, Options) when is_list(Normal_face),is_list(Fixed_face),is_list(Options) -> ?CLASS(ThisT,wxHtmlWindow), @@ -261,8 +289,9 @@ setFonts(#wx_ref{type=ThisT,ref=ThisRef},Normal_face,Fixed_face, Options) wxe_util:cast(?wxHtmlWindow_SetFonts, <>). -%% @spec (This::wxHtmlWindow(), Source::string()) -> bool() %% @doc See external documentation. +-spec setPage(This, Source) -> boolean() when + This::wxHtmlWindow(), Source::string(). setPage(#wx_ref{type=ThisT,ref=ThisRef},Source) when is_list(Source) -> ?CLASS(ThisT,wxHtmlWindow), @@ -270,8 +299,9 @@ setPage(#wx_ref{type=ThisT,ref=ThisRef},Source) wxe_util:call(?wxHtmlWindow_SetPage, <>). -%% @spec (This::wxHtmlWindow(), Frame::wxFrame:wxFrame(), Format::string()) -> ok %% @doc See external documentation. +-spec setRelatedFrame(This, Frame, Format) -> ok when + This::wxHtmlWindow(), Frame::wxFrame:wxFrame(), Format::string(). setRelatedFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef},Format) when is_list(Format) -> ?CLASS(ThisT,wxHtmlWindow), @@ -280,23 +310,25 @@ setRelatedFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef wxe_util:cast(?wxHtmlWindow_SetRelatedFrame, <>). -%% @spec (This::wxHtmlWindow(), Bar::integer()) -> ok %% @doc See external documentation. +-spec setRelatedStatusBar(This, Bar) -> ok when + This::wxHtmlWindow(), Bar::integer(). setRelatedStatusBar(#wx_ref{type=ThisT,ref=ThisRef},Bar) when is_integer(Bar) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:cast(?wxHtmlWindow_SetRelatedStatusBar, <>). -%% @spec (This::wxHtmlWindow()) -> string() %% @doc See external documentation. +-spec toText(This) -> string() when + This::wxHtmlWindow(). toText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxHtmlWindow), wxe_util:call(?wxHtmlWindow_ToText, <>). -%% @spec (This::wxHtmlWindow()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxHtmlWindow) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxHtmlWindow), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxIcon.erl b/lib/wx/src/gen/wxIcon.erl index 5b224c00b6..0e218f9917 100644 --- a/lib/wx/src/gen/wxIcon.erl +++ b/lib/wx/src/gen/wxIcon.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 @@ -35,24 +35,23 @@ saveFile/3,saveFile/4,setDepth/2,setHeight/2,setMask/2,setPalette/2, setWidth/2]). +-export_type([wxIcon/0]). %% @hidden parent_class(wxBitmap) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxIcon() +-type wxIcon() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxIcon(). new() -> wxe_util:construct(?wxIcon_new_0, <<>>). -%% @spec (X::string()|term()) -> wxIcon() %% @doc See external documentation. -%%
Alternatives: -%%

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

-%%

-%% new(Loc::wx:wx()) -> wxIcon() -%%

+-spec new(Filename) -> wxIcon() when + Filename::string(); + (Loc) -> wxIcon() when + Loc::wx:wx(). new(Filename) when is_list(Filename) -> @@ -62,11 +61,13 @@ new(#wx_ref{type=LocT,ref=LocRef}) -> wxe_util:construct(?wxIcon_new_1, <>). -%% @spec (Filename::string(), [Option]) -> wxIcon() -%% Option = {type, WxBitmapType} | {desiredWidth, integer()} | {desiredHeight, integer()} -%% WxBitmapType = integer() %% @doc See external documentation. -%%
WxBitmapType is one of ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY +%%
Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY +-spec new(Filename, [Option]) -> wxIcon() when + Filename::string(), + Option :: {type, wx:wx_enum()} + | {desiredWidth, integer()} + | {desiredHeight, integer()}. new(Filename, Options) when is_list(Filename),is_list(Options) -> Filename_UC = unicode:characters_to_binary([Filename,0]), @@ -78,16 +79,17 @@ new(Filename, Options) wxe_util:construct(?wxIcon_new_2, <<(byte_size(Filename_UC)):32/?UI,(Filename_UC)/binary, 0:(((8- ((4+byte_size(Filename_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxIcon(), Bmp::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec copyFromBitmap(This, Bmp) -> ok when + This::wxIcon(), Bmp::wxBitmap:wxBitmap(). copyFromBitmap(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef}) -> ?CLASS(ThisT,wxIcon), ?CLASS(BmpT,wxBitmap), wxe_util:cast(?wxIcon_CopyFromBitmap, <>). -%% @spec (This::wxIcon()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxIcon) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxIcon), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxIconBundle.erl b/lib/wx/src/gen/wxIconBundle.erl index 011b2dd1ac..4d4614f171 100644 --- a/lib/wx/src/gen/wxIconBundle.erl +++ b/lib/wx/src/gen/wxIconBundle.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 @@ -29,17 +29,20 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxIconBundle/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxIconBundle() +-type wxIconBundle() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxIconBundle(). new() -> wxe_util:construct(?wxIconBundle_new_0, <<>>). -%% @spec (Ic::wxIconBundle() | wxIcon:wxIcon()) -> wxIconBundle() %% @doc See external documentation. +-spec new(Ic) -> wxIconBundle() when + Ic::wxIconBundle() | wxIcon:wxIcon(). new(#wx_ref{type=IcT,ref=IcRef}) -> IcOP = case ?CLASS_T(IcT,wxIconBundle) of true -> @@ -50,24 +53,27 @@ new(#wx_ref{type=IcT,ref=IcRef}) -> wxe_util:construct(IcOP, <>). -%% @spec (File::string(), Type::integer()) -> wxIconBundle() %% @doc See external documentation. +-spec new(File, Type) -> wxIconBundle() when + File::string(), Type::integer(). new(File,Type) when is_list(File),is_integer(Type) -> File_UC = unicode:characters_to_binary([File,0]), wxe_util:construct(?wxIconBundle_new_2, <<(byte_size(File_UC)):32/?UI,(File_UC)/binary, 0:(((8- ((4+byte_size(File_UC)) band 16#7)) band 16#7))/unit:8,Type:32/?UI>>). -%% @spec (This::wxIconBundle(), Icon::wxIcon:wxIcon()) -> ok %% @doc See external documentation. +-spec addIcon(This, Icon) -> ok when + This::wxIconBundle(), Icon::wxIcon:wxIcon(). addIcon(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconT,ref=IconRef}) -> ?CLASS(ThisT,wxIconBundle), ?CLASS(IconT,wxIcon), wxe_util:cast(?wxIconBundle_AddIcon_1, <>). -%% @spec (This::wxIconBundle(), File::string(), Type::integer()) -> ok %% @doc See external documentation. +-spec addIcon(This, File, Type) -> ok when + This::wxIconBundle(), File::string(), Type::integer(). addIcon(#wx_ref{type=ThisT,ref=ThisRef},File,Type) when is_list(File),is_integer(Type) -> ?CLASS(ThisT,wxIconBundle), @@ -75,22 +81,20 @@ addIcon(#wx_ref{type=ThisT,ref=ThisRef},File,Type) wxe_util:cast(?wxIconBundle_AddIcon_2, <>). -%% @spec (This::wxIconBundle()) -> wxIcon:wxIcon() %% @equiv getIcon(This, []) +-spec getIcon(This) -> wxIcon:wxIcon() when + This::wxIconBundle(). + getIcon(This) when is_record(This, wx_ref) -> getIcon(This, []). -%% @spec (This::wxIconBundle(),X::term()) -> wxIcon:wxIcon() %% @doc See external documentation. -%%
Alternatives: -%%

-%% getIcon(This::wxIconBundle(), [Option]) -> wxIcon:wxIcon() -%%
Option = {size, integer()} -%%

-%%

-%% getIcon(This::wxIconBundle(), Size::{W::integer(), H::integer()}) -> wxIcon:wxIcon() -%%

+-spec getIcon(This, [Option]) -> wxIcon:wxIcon() when + This::wxIconBundle(), + Option :: {size, integer()}; + (This, Size) -> wxIcon:wxIcon() when + This::wxIconBundle(), Size::{W::integer(), H::integer()}. getIcon(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxIconBundle), @@ -105,8 +109,8 @@ getIcon(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) wxe_util:call(?wxIconBundle_GetIcon_1_1, <>). -%% @spec (This::wxIconBundle()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxIconBundle) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxIconBundle), wxe_util:destroy(?wxIconBundle_destruct,Obj), diff --git a/lib/wx/src/gen/wxIconizeEvent.erl b/lib/wx/src/gen/wxIconizeEvent.erl index 647d8019a1..f428ebf70f 100644 --- a/lib/wx/src/gen/wxIconizeEvent.erl +++ b/lib/wx/src/gen/wxIconizeEvent.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 @@ -37,12 +37,15 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxIconizeEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxIconizeEvent()) -> bool() +-type wxIconizeEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec iconized(This) -> boolean() when + This::wxIconizeEvent(). iconized(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxIconizeEvent), wxe_util:call(?wxIconizeEvent_Iconized, diff --git a/lib/wx/src/gen/wxIdleEvent.erl b/lib/wx/src/gen/wxIdleEvent.erl index 87ed7e0cd2..4749026446 100644 --- a/lib/wx/src/gen/wxIdleEvent.erl +++ b/lib/wx/src/gen/wxIdleEvent.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 @@ -37,34 +37,39 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxIdleEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Win::wxWindow:wxWindow()) -> bool() +-type wxIdleEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec canSend(Win) -> boolean() when + Win::wxWindow:wxWindow(). canSend(#wx_ref{type=WinT,ref=WinRef}) -> ?CLASS(WinT,wxWindow), wxe_util:call(?wxIdleEvent_CanSend, <>). -%% @spec () -> WxIdleMode -%% WxIdleMode = integer() %% @doc See external documentation. -%%
WxIdleMode is one of ?wxIDLE_PROCESS_ALL | ?wxIDLE_PROCESS_SPECIFIED +%%
Res = ?wxIDLE_PROCESS_ALL | ?wxIDLE_PROCESS_SPECIFIED +-spec getMode() -> wx:wx_enum(). getMode() -> wxe_util:call(?wxIdleEvent_GetMode, <<>>). -%% @spec (This::wxIdleEvent()) -> ok %% @equiv requestMore(This, []) +-spec requestMore(This) -> ok when + This::wxIdleEvent(). + requestMore(This) when is_record(This, wx_ref) -> requestMore(This, []). -%% @spec (This::wxIdleEvent(), [Option]) -> ok -%% Option = {needMore, bool()} %% @doc See external documentation. +-spec requestMore(This, [Option]) -> ok when + This::wxIdleEvent(), + Option :: {needMore, boolean()}. requestMore(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxIdleEvent), @@ -74,17 +79,18 @@ requestMore(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxIdleEvent_RequestMore, <>). -%% @spec (This::wxIdleEvent()) -> bool() %% @doc See external documentation. +-spec moreRequested(This) -> boolean() when + This::wxIdleEvent(). moreRequested(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxIdleEvent), wxe_util:call(?wxIdleEvent_MoreRequested, <>). -%% @spec (Mode::WxIdleMode) -> ok -%% WxIdleMode = integer() %% @doc See external documentation. -%%
WxIdleMode is one of ?wxIDLE_PROCESS_ALL | ?wxIDLE_PROCESS_SPECIFIED +%%
Mode = ?wxIDLE_PROCESS_ALL | ?wxIDLE_PROCESS_SPECIFIED +-spec setMode(Mode) -> ok when + Mode::wx:wx_enum(). setMode(Mode) when is_integer(Mode) -> wxe_util:cast(?wxIdleEvent_SetMode, diff --git a/lib/wx/src/gen/wxImage.erl b/lib/wx/src/gen/wxImage.erl index ea41a78a40..3f8cb2be22 100644 --- a/lib/wx/src/gen/wxImage.erl +++ b/lib/wx/src/gen/wxImage.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 @@ -47,30 +47,32 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxImage/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxImage() +-type wxImage() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxImage(). new() -> wxe_util:construct(?wxImage_new_0, <<>>). -%% @spec (Name::string()) -> wxImage() %% @equiv new(Name, []) +-spec new(Name) -> wxImage() when + Name::string(). + new(Name) when is_list(Name) -> new(Name, []). -%% @spec (X::integer()|string(),X::integer()|term()) -> wxImage() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Width::integer(), Height::integer()) -> new(Width,Height, [])

-%%

-%% new(Name::string(), [Option]) -> wxImage() -%%
Option = {type, integer()} | {index, integer()} -%%

+-spec new(Width, Height) -> wxImage() when + Width::integer(), Height::integer(); + (Name, [Option]) -> wxImage() when + Name::string(), + Option :: {type, integer()} + | {index, integer()}. new(Width,Height) when is_integer(Width),is_integer(Height) -> @@ -85,19 +87,15 @@ new(Name, Options) wxe_util:construct(?wxImage_new_2, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (X::integer()|string(),X::integer()|string(),X::binary()|term()) -> wxImage() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Width::integer(), Height::integer(), Data::binary()) -> new(Width,Height,Data, [])

-%%

-%% new(Width::integer(), Height::integer(), [Option]) -> wxImage() -%%
Option = {clear, bool()} -%%

-%%

-%% new(Name::string(), Mimetype::string(), [Option]) -> wxImage() -%%
Option = {index, integer()} -%%

+-spec new(Width, Height, Data) -> wxImage() when + Width::integer(), Height::integer(), Data::binary(); + (Width, Height, [Option]) -> wxImage() when + Width::integer(), Height::integer(), + Option :: {clear, boolean()}; + (Name, Mimetype, [Option]) -> wxImage() when + Name::string(), Mimetype::string(), + Option :: {index, integer()}. new(Width,Height,Data) when is_integer(Width),is_integer(Height),is_binary(Data) -> @@ -119,15 +117,12 @@ new(Name,Mimetype, Options) wxe_util:construct(?wxImage_new_3_1, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8,(byte_size(Mimetype_UC)):32/?UI,(Mimetype_UC)/binary, 0:(((8- ((4+byte_size(Mimetype_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (Width::integer(),Height::integer(),Data::binary(),X::binary()|term()) -> wxImage() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Width::integer(), Height::integer(), Data::binary(), Alpha::binary()) -> new(Width,Height,Data,Alpha, [])

-%%

-%% new(Width::integer(), Height::integer(), Data::binary(), [Option]) -> wxImage() -%%
Option = {static_data, bool()} -%%

+-spec new(Width, Height, Data, Alpha) -> wxImage() when + Width::integer(), Height::integer(), Data::binary(), Alpha::binary(); + (Width, Height, Data, [Option]) -> wxImage() when + Width::integer(), Height::integer(), Data::binary(), + Option :: {static_data, boolean()}. new(Width,Height,Data,Alpha) when is_integer(Width),is_integer(Height),is_binary(Data),is_binary(Alpha) -> @@ -141,9 +136,10 @@ new(Width,Height,Data, Options) wxe_util:construct(?wxImage_new_4, <>). -%% @spec (Width::integer(), Height::integer(), Data::binary(), Alpha::binary(), [Option]) -> wxImage() -%% Option = {static_data, bool()} %% @doc See external documentation. +-spec new(Width, Height, Data, Alpha, [Option]) -> wxImage() when + Width::integer(), Height::integer(), Data::binary(), Alpha::binary(), + Option :: {static_data, boolean()}. new(Width,Height,Data,Alpha, Options) when is_integer(Width),is_integer(Height),is_binary(Data),is_binary(Alpha),is_list(Options) -> wxe_util:send_bin(Data), @@ -154,39 +150,45 @@ new(Width,Height,Data,Alpha, Options) wxe_util:construct(?wxImage_new_5, <>). -%% @spec (This::wxImage(), Radius::integer()) -> wxImage() %% @doc See external documentation. +-spec blur(This, Radius) -> wxImage() when + This::wxImage(), Radius::integer(). blur(#wx_ref{type=ThisT,ref=ThisRef},Radius) when is_integer(Radius) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_Blur, <>). -%% @spec (This::wxImage(), Radius::integer()) -> wxImage() %% @doc See external documentation. +-spec blurHorizontal(This, Radius) -> wxImage() when + This::wxImage(), Radius::integer(). blurHorizontal(#wx_ref{type=ThisT,ref=ThisRef},Radius) when is_integer(Radius) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_BlurHorizontal, <>). -%% @spec (This::wxImage(), Radius::integer()) -> wxImage() %% @doc See external documentation. +-spec blurVertical(This, Radius) -> wxImage() when + This::wxImage(), Radius::integer(). blurVertical(#wx_ref{type=ThisT,ref=ThisRef},Radius) when is_integer(Radius) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_BlurVertical, <>). -%% @spec (This::wxImage()) -> bool() %% @equiv convertAlphaToMask(This, []) +-spec convertAlphaToMask(This) -> boolean() when + This::wxImage(). + convertAlphaToMask(This) when is_record(This, wx_ref) -> convertAlphaToMask(This, []). -%% @spec (This::wxImage(), [Option]) -> bool() -%% Option = {threshold, integer()} %% @doc See external documentation. +-spec convertAlphaToMask(This, [Option]) -> boolean() when + This::wxImage(), + Option :: {threshold, integer()}. convertAlphaToMask(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -196,15 +198,20 @@ convertAlphaToMask(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_ConvertAlphaToMask, <>). -%% @spec (This::wxImage()) -> wxImage() %% @equiv convertToGreyscale(This, []) +-spec convertToGreyscale(This) -> wxImage() when + This::wxImage(). + convertToGreyscale(This) when is_record(This, wx_ref) -> convertToGreyscale(This, []). -%% @spec (This::wxImage(), [Option]) -> wxImage() -%% Option = {lr, float()} | {lg, float()} | {lb, float()} %% @doc See external documentation. +-spec convertToGreyscale(This, [Option]) -> wxImage() when + This::wxImage(), + Option :: {lr, float()} + | {lg, float()} + | {lb, float()}. convertToGreyscale(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -216,36 +223,37 @@ convertToGreyscale(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_ConvertToGreyscale, <>). -%% @spec (This::wxImage(), R::integer(), G::integer(), B::integer()) -> wxImage() %% @doc See external documentation. +-spec convertToMono(This, R, G, B) -> wxImage() when + This::wxImage(), R::integer(), G::integer(), B::integer(). convertToMono(#wx_ref{type=ThisT,ref=ThisRef},R,G,B) when is_integer(R),is_integer(G),is_integer(B) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_ConvertToMono, <>). -%% @spec (This::wxImage()) -> wxImage() %% @doc See external documentation. +-spec copy(This) -> wxImage() when + This::wxImage(). copy(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_Copy, <>). -%% @spec (This::wxImage(), Width::integer(), Height::integer()) -> bool() %% @equiv create(This,Width,Height, []) +-spec create(This, Width, Height) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(). + create(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> create(This,Width,Height, []). -%% @spec (This::wxImage(),Width::integer(),Height::integer(),X::binary()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% create(This::wxImage(), Width::integer(), Height::integer(), Data::binary()) -> create(This,Width,Height,Data, [])

-%%

-%% create(This::wxImage(), Width::integer(), Height::integer(), [Option]) -> bool() -%%
Option = {clear, bool()} -%%

+-spec create(This, Width, Height, Data) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), Data::binary(); + (This, Width, Height, [Option]) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), + Option :: {clear, boolean()}. create(This,Width,Height,Data) when is_record(This, wx_ref),is_integer(Width),is_integer(Height),is_binary(Data) -> @@ -259,15 +267,12 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxImage_Create_3, <>). -%% @spec (This::wxImage(),Width::integer(),Height::integer(),Data::binary(),X::binary()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% create(This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary()) -> create(This,Width,Height,Data,Alpha, [])

-%%

-%% create(This::wxImage(), Width::integer(), Height::integer(), Data::binary(), [Option]) -> bool() -%%
Option = {static_data, bool()} -%%

+-spec create(This, Width, Height, Data, Alpha) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary(); + (This, Width, Height, Data, [Option]) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), Data::binary(), + Option :: {static_data, boolean()}. create(This,Width,Height,Data,Alpha) when is_record(This, wx_ref),is_integer(Width),is_integer(Height),is_binary(Data),is_binary(Alpha) -> @@ -282,9 +287,10 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height,Data, Options) wxe_util:call(?wxImage_Create_4, <>). -%% @spec (This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary(), [Option]) -> bool() -%% Option = {static_data, bool()} %% @doc See external documentation. +-spec create(This, Width, Height, Data, Alpha, [Option]) -> boolean() when + This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary(), + Option :: {static_data, boolean()}. create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height,Data,Alpha, Options) when is_integer(Width),is_integer(Height),is_binary(Data),is_binary(Alpha),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -296,22 +302,30 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height,Data,Alpha, Options) wxe_util:call(?wxImage_Create_5, <>). -%% @spec (This::wxImage()) -> ok %% @doc See external documentation. +-spec 'Destroy'(This) -> ok when + This::wxImage(). 'Destroy'(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_Destroy, <>). -%% @spec (This::wxImage()) -> {bool(), R::integer(), G::integer(), B::integer()} %% @equiv findFirstUnusedColour(This, []) +-spec findFirstUnusedColour(This) -> Result when + Result ::{Res ::boolean(), R::integer(), G::integer(), B::integer()}, + This::wxImage(). + findFirstUnusedColour(This) when is_record(This, wx_ref) -> findFirstUnusedColour(This, []). -%% @spec (This::wxImage(), [Option]) -> {bool(), R::integer(), G::integer(), B::integer()} -%% Option = {startR, integer()} | {startG, integer()} | {startB, integer()} %% @doc See external documentation. +-spec findFirstUnusedColour(This, [Option]) -> Result when + Result :: {Res ::boolean(), R::integer(), G::integer(), B::integer()}, + This::wxImage(), + Option :: {startR, integer()} + | {startG, integer()} + | {startB, integer()}. findFirstUnusedColour(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -323,59 +337,67 @@ findFirstUnusedColour(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_FindFirstUnusedColour, <>). -%% @spec () -> string() %% @doc See external documentation. +-spec getImageExtWildcard() -> string(). getImageExtWildcard() -> wxe_util:call(?wxImage_GetImageExtWildcard, <<>>). -%% @spec (This::wxImage()) -> binary() %% @doc See external documentation. +-spec getAlpha(This) -> binary() when + This::wxImage(). getAlpha(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetAlpha_0, <>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> integer() %% @doc See external documentation. +-spec getAlpha(This, X, Y) -> integer() when + This::wxImage(), X::integer(), Y::integer(). getAlpha(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetAlpha_2, <>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> integer() %% @doc See external documentation. +-spec getBlue(This, X, Y) -> integer() when + This::wxImage(), X::integer(), Y::integer(). getBlue(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetBlue, <>). -%% @spec (This::wxImage()) -> binary() %% @doc See external documentation. +-spec getData(This) -> binary() when + This::wxImage(). getData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetData, <>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> integer() %% @doc See external documentation. +-spec getGreen(This, X, Y) -> integer() when + This::wxImage(), X::integer(), Y::integer(). getGreen(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetGreen, <>). -%% @spec (Name::string()) -> integer() %% @equiv getImageCount(Name, []) +-spec getImageCount(Name) -> integer() when + Name::string(). + getImageCount(Name) when is_list(Name) -> getImageCount(Name, []). -%% @spec (Name::string(), [Option]) -> integer() -%% Option = {type, integer()} %% @doc See external documentation. +-spec getImageCount(Name, [Option]) -> integer() when + Name::string(), + Option :: {type, integer()}. getImageCount(Name, Options) when is_list(Name),is_list(Options) -> Name_UC = unicode:characters_to_binary([Name,0]), @@ -385,87 +407,100 @@ getImageCount(Name, Options) wxe_util:call(?wxImage_GetImageCount, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxImage()) -> integer() %% @doc See external documentation. +-spec getHeight(This) -> integer() when + This::wxImage(). getHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetHeight, <>). -%% @spec (This::wxImage()) -> integer() %% @doc See external documentation. +-spec getMaskBlue(This) -> integer() when + This::wxImage(). getMaskBlue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetMaskBlue, <>). -%% @spec (This::wxImage()) -> integer() %% @doc See external documentation. +-spec getMaskGreen(This) -> integer() when + This::wxImage(). getMaskGreen(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetMaskGreen, <>). -%% @spec (This::wxImage()) -> integer() %% @doc See external documentation. +-spec getMaskRed(This) -> integer() when + This::wxImage(). getMaskRed(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetMaskRed, <>). -%% @spec (This::wxImage()) -> {bool(), R::integer(), G::integer(), B::integer()} %% @doc See external documentation. +-spec getOrFindMaskColour(This) -> Result when + Result ::{Res ::boolean(), R::integer(), G::integer(), B::integer()}, + This::wxImage(). getOrFindMaskColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetOrFindMaskColour, <>). -%% @spec (This::wxImage()) -> wxPalette:wxPalette() %% @doc See external documentation. +-spec getPalette(This) -> wxPalette:wxPalette() when + This::wxImage(). getPalette(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetPalette, <>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> integer() %% @doc See external documentation. +-spec getRed(This, X, Y) -> integer() when + This::wxImage(), X::integer(), Y::integer(). getRed(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetRed, <>). -%% @spec (This::wxImage(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> wxImage() %% @doc See external documentation. +-spec getSubImage(This, Rect) -> wxImage() when + This::wxImage(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. getSubImage(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetSubImage, <>). -%% @spec (This::wxImage()) -> integer() %% @doc See external documentation. +-spec getWidth(This) -> integer() when + This::wxImage(). getWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_GetWidth, <>). -%% @spec (This::wxImage()) -> bool() %% @doc See external documentation. +-spec hasAlpha(This) -> boolean() when + This::wxImage(). hasAlpha(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_HasAlpha, <>). -%% @spec (This::wxImage()) -> bool() %% @doc See external documentation. +-spec hasMask(This) -> boolean() when + This::wxImage(). hasMask(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_HasMask, <>). -%% @spec (This::wxImage(), Name::string()) -> string() %% @doc See external documentation. +-spec getOption(This, Name) -> string() when + This::wxImage(), Name::string(). getOption(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxImage), @@ -473,8 +508,9 @@ getOption(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxImage_GetOption, <>). -%% @spec (This::wxImage(), Name::string()) -> integer() %% @doc See external documentation. +-spec getOptionInt(This, Name) -> integer() when + This::wxImage(), Name::string(). getOptionInt(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxImage), @@ -482,8 +518,9 @@ getOptionInt(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxImage_GetOptionInt, <>). -%% @spec (This::wxImage(), Name::string()) -> bool() %% @doc See external documentation. +-spec hasOption(This, Name) -> boolean() when + This::wxImage(), Name::string(). hasOption(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxImage), @@ -491,28 +528,32 @@ hasOption(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxImage_HasOption, <>). -%% @spec (This::wxImage()) -> ok %% @doc See external documentation. +-spec initAlpha(This) -> ok when + This::wxImage(). initAlpha(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_InitAlpha, <>). -%% @spec () -> ok %% @doc See external documentation. +-spec initStandardHandlers() -> ok. initStandardHandlers() -> wxe_util:cast(?wxImage_InitStandardHandlers, <<>>). -%% @spec (This::wxImage(), X::integer(), Y::integer()) -> bool() %% @equiv isTransparent(This,X,Y, []) +-spec isTransparent(This, X, Y) -> boolean() when + This::wxImage(), X::integer(), Y::integer(). + isTransparent(This,X,Y) when is_record(This, wx_ref),is_integer(X),is_integer(Y) -> isTransparent(This,X,Y, []). -%% @spec (This::wxImage(), X::integer(), Y::integer(), [Option]) -> bool() -%% Option = {threshold, integer()} %% @doc See external documentation. +-spec isTransparent(This, X, Y, [Option]) -> boolean() when + This::wxImage(), X::integer(), Y::integer(), + Option :: {threshold, integer()}. isTransparent(#wx_ref{type=ThisT,ref=ThisRef},X,Y, Options) when is_integer(X),is_integer(Y),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -522,15 +563,19 @@ isTransparent(#wx_ref{type=ThisT,ref=ThisRef},X,Y, Options) wxe_util:call(?wxImage_IsTransparent, <>). -%% @spec (This::wxImage(), Name::string()) -> bool() %% @equiv loadFile(This,Name, []) +-spec loadFile(This, Name) -> boolean() when + This::wxImage(), Name::string(). + loadFile(This,Name) when is_record(This, wx_ref),is_list(Name) -> loadFile(This,Name, []). -%% @spec (This::wxImage(), Name::string(), [Option]) -> bool() -%% Option = {type, integer()} | {index, integer()} %% @doc See external documentation. +-spec loadFile(This, Name, [Option]) -> boolean() when + This::wxImage(), Name::string(), + Option :: {type, integer()} + | {index, integer()}. loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name, Options) when is_list(Name),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -542,9 +587,10 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name, Options) wxe_util:call(?wxImage_LoadFile_2, <>). -%% @spec (This::wxImage(), Name::string(), Mimetype::string(), [Option]) -> bool() -%% Option = {index, integer()} %% @doc See external documentation. +-spec loadFile(This, Name, Mimetype, [Option]) -> boolean() when + This::wxImage(), Name::string(), Mimetype::string(), + Option :: {index, integer()}. loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Mimetype, Options) when is_list(Name),is_list(Mimetype),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -556,30 +602,35 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Mimetype, Options) wxe_util:call(?wxImage_LoadFile_3, <>). -%% @spec (This::wxImage()) -> bool() %% @doc See external documentation. +-spec ok(This) -> boolean() when + This::wxImage(). ok(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImage), wxe_util:call(?wxImage_Ok, <>). -%% @spec (Name::string()) -> bool() %% @doc See external documentation. +-spec removeHandler(Name) -> boolean() when + Name::string(). removeHandler(Name) when is_list(Name) -> Name_UC = unicode:characters_to_binary([Name,0]), wxe_util:call(?wxImage_RemoveHandler, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxImage()) -> wxImage() %% @equiv mirror(This, []) +-spec mirror(This) -> wxImage() when + This::wxImage(). + mirror(This) when is_record(This, wx_ref) -> mirror(This, []). -%% @spec (This::wxImage(), [Option]) -> wxImage() -%% Option = {horizontally, bool()} %% @doc See external documentation. +-spec mirror(This, [Option]) -> wxImage() when + This::wxImage(), + Option :: {horizontally, boolean()}. mirror(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -589,23 +640,27 @@ mirror(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_Mirror, <>). -%% @spec (This::wxImage(), R1::integer(), G1::integer(), B1::integer(), R2::integer(), G2::integer(), B2::integer()) -> ok %% @doc See external documentation. +-spec replace(This, R1, G1, B1, R2, G2, B2) -> ok when + This::wxImage(), R1::integer(), G1::integer(), B1::integer(), R2::integer(), G2::integer(), B2::integer(). replace(#wx_ref{type=ThisT,ref=ThisRef},R1,G1,B1,R2,G2,B2) when is_integer(R1),is_integer(G1),is_integer(B1),is_integer(R2),is_integer(G2),is_integer(B2) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_Replace, <>). -%% @spec (This::wxImage(), Width::integer(), Height::integer()) -> wxImage() %% @equiv rescale(This,Width,Height, []) +-spec rescale(This, Width, Height) -> wxImage() when + This::wxImage(), Width::integer(), Height::integer(). + rescale(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> rescale(This,Width,Height, []). -%% @spec (This::wxImage(), Width::integer(), Height::integer(), [Option]) -> wxImage() -%% Option = {quality, integer()} %% @doc See external documentation. +-spec rescale(This, Width, Height, [Option]) -> wxImage() when + This::wxImage(), Width::integer(), Height::integer(), + Option :: {quality, integer()}. rescale(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -615,15 +670,20 @@ rescale(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxImage_Rescale, <>). -%% @spec (This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}) -> wxImage() %% @equiv resize(This,Size,Pos, []) +-spec resize(This, Size, Pos) -> wxImage() when + This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}. + resize(This,Size={SizeW,SizeH},Pos={PosX,PosY}) when is_record(This, wx_ref),is_integer(SizeW),is_integer(SizeH),is_integer(PosX),is_integer(PosY) -> resize(This,Size,Pos, []). -%% @spec (This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}, [Option]) -> wxImage() -%% Option = {r, integer()} | {g, integer()} | {b, integer()} %% @doc See external documentation. +-spec resize(This, Size, Pos, [Option]) -> wxImage() when + This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}, + Option :: {r, integer()} + | {g, integer()} + | {b, integer()}. resize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH},{PosX,PosY}, Options) when is_integer(SizeW),is_integer(SizeH),is_integer(PosX),is_integer(PosY),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -635,15 +695,19 @@ resize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH},{PosX,PosY}, Options) wxe_util:call(?wxImage_Resize, <>). -%% @spec (This::wxImage(), Angle::float(), Centre_of_rotation::{X::integer(), Y::integer()}) -> wxImage() %% @equiv rotate(This,Angle,Centre_of_rotation, []) +-spec rotate(This, Angle, Centre_of_rotation) -> wxImage() when + This::wxImage(), Angle::float(), Centre_of_rotation::{X::integer(), Y::integer()}. + rotate(This,Angle,Centre_of_rotation={Centre_of_rotationX,Centre_of_rotationY}) when is_record(This, wx_ref),is_float(Angle),is_integer(Centre_of_rotationX),is_integer(Centre_of_rotationY) -> rotate(This,Angle,Centre_of_rotation, []). -%% @spec (This::wxImage(), Angle::float(), Centre_of_rotation::{X::integer(), Y::integer()}, [Option]) -> wxImage() -%% Option = {interpolating, bool()} | {offset_after_rotation, {X::integer(), Y::integer()}} %% @doc See external documentation. +-spec rotate(This, Angle, Centre_of_rotation, [Option]) -> wxImage() when + This::wxImage(), Angle::float(), Centre_of_rotation::{X::integer(), Y::integer()}, + Option :: {interpolating, boolean()} + | {offset_after_rotation, {X::integer(), Y::integer()}}. rotate(#wx_ref{type=ThisT,ref=ThisRef},Angle,{Centre_of_rotationX,Centre_of_rotationY}, Options) when is_float(Angle),is_integer(Centre_of_rotationX),is_integer(Centre_of_rotationY),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -654,23 +718,27 @@ rotate(#wx_ref{type=ThisT,ref=ThisRef},Angle,{Centre_of_rotationX,Centre_of_rota wxe_util:call(?wxImage_Rotate, <>). -%% @spec (This::wxImage(), Angle::float()) -> ok %% @doc See external documentation. +-spec rotateHue(This, Angle) -> ok when + This::wxImage(), Angle::float(). rotateHue(#wx_ref{type=ThisT,ref=ThisRef},Angle) when is_float(Angle) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_RotateHue, <>). -%% @spec (This::wxImage()) -> wxImage() %% @equiv rotate90(This, []) +-spec rotate90(This) -> wxImage() when + This::wxImage(). + rotate90(This) when is_record(This, wx_ref) -> rotate90(This, []). -%% @spec (This::wxImage(), [Option]) -> wxImage() -%% Option = {clockwise, bool()} %% @doc See external documentation. +-spec rotate90(This, [Option]) -> wxImage() when + This::wxImage(), + Option :: {clockwise, boolean()}. rotate90(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -680,8 +748,9 @@ rotate90(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxImage_Rotate90, <>). -%% @spec (This::wxImage(), Name::string()) -> bool() %% @doc See external documentation. +-spec saveFile(This, Name) -> boolean() when + This::wxImage(), Name::string(). saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxImage), @@ -689,15 +758,11 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxImage_SaveFile_1, <>). -%% @spec (This::wxImage(),Name::string(),X::integer()|string()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% saveFile(This::wxImage(), Name::string(), Type::integer()) -> bool() -%%

-%%

-%% saveFile(This::wxImage(), Name::string(), Mimetype::string()) -> bool() -%%

+-spec saveFile(This, Name, Type) -> boolean() when + This::wxImage(), Name::string(), Type::integer(); + (This, Name, Mimetype) -> boolean() when + This::wxImage(), Name::string(), Mimetype::string(). saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Type) when is_list(Name),is_integer(Type) -> ?CLASS(ThisT,wxImage), @@ -712,15 +777,18 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef},Name,Mimetype) wxe_util:call(?wxImage_SaveFile_2_1, <>). -%% @spec (This::wxImage(), Width::integer(), Height::integer()) -> wxImage() %% @equiv scale(This,Width,Height, []) +-spec scale(This, Width, Height) -> wxImage() when + This::wxImage(), Width::integer(), Height::integer(). + scale(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> scale(This,Width,Height, []). -%% @spec (This::wxImage(), Width::integer(), Height::integer(), [Option]) -> wxImage() -%% Option = {quality, integer()} %% @doc See external documentation. +-spec scale(This, Width, Height, [Option]) -> wxImage() when + This::wxImage(), Width::integer(), Height::integer(), + Option :: {quality, integer()}. scale(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -730,15 +798,20 @@ scale(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxImage_Scale, <>). -%% @spec (This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}) -> wxImage() %% @equiv size(This,Size,Pos, []) +-spec size(This, Size, Pos) -> wxImage() when + This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}. + size(This,Size={SizeW,SizeH},Pos={PosX,PosY}) when is_record(This, wx_ref),is_integer(SizeW),is_integer(SizeH),is_integer(PosX),is_integer(PosY) -> size(This,Size,Pos, []). -%% @spec (This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}, [Option]) -> wxImage() -%% Option = {r, integer()} | {g, integer()} | {b, integer()} %% @doc See external documentation. +-spec size(This, Size, Pos, [Option]) -> wxImage() when + This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}, + Option :: {r, integer()} + | {g, integer()} + | {b, integer()}. size(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH},{PosX,PosY}, Options) when is_integer(SizeW),is_integer(SizeH),is_integer(PosX),is_integer(PosY),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -750,15 +823,18 @@ size(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH},{PosX,PosY}, Options) wxe_util:call(?wxImage_Size, <>). -%% @spec (This::wxImage(), Alpha::binary()) -> ok %% @equiv setAlpha(This,Alpha, []) +-spec setAlpha(This, Alpha) -> ok when + This::wxImage(), Alpha::binary(). + setAlpha(This,Alpha) when is_record(This, wx_ref),is_binary(Alpha) -> setAlpha(This,Alpha, []). -%% @spec (This::wxImage(), Alpha::binary(), [Option]) -> ok -%% Option = {static_data, bool()} %% @doc See external documentation. +-spec setAlpha(This, Alpha, [Option]) -> ok when + This::wxImage(), Alpha::binary(), + Option :: {static_data, boolean()}. setAlpha(#wx_ref{type=ThisT,ref=ThisRef},Alpha, Options) when is_binary(Alpha),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -769,23 +845,27 @@ setAlpha(#wx_ref{type=ThisT,ref=ThisRef},Alpha, Options) wxe_util:cast(?wxImage_SetAlpha_2, <>). -%% @spec (This::wxImage(), X::integer(), Y::integer(), Alpha::integer()) -> ok %% @doc See external documentation. +-spec setAlpha(This, X, Y, Alpha) -> ok when + This::wxImage(), X::integer(), Y::integer(), Alpha::integer(). setAlpha(#wx_ref{type=ThisT,ref=ThisRef},X,Y,Alpha) when is_integer(X),is_integer(Y),is_integer(Alpha) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_SetAlpha_3, <>). -%% @spec (This::wxImage(), Data::binary()) -> ok %% @equiv setData(This,Data, []) +-spec setData(This, Data) -> ok when + This::wxImage(), Data::binary(). + setData(This,Data) when is_record(This, wx_ref),is_binary(Data) -> setData(This,Data, []). -%% @spec (This::wxImage(), Data::binary(), [Option]) -> ok -%% Option = {static_data, bool()} %% @doc See external documentation. +-spec setData(This, Data, [Option]) -> ok when + This::wxImage(), Data::binary(), + Option :: {static_data, boolean()}. setData(#wx_ref{type=ThisT,ref=ThisRef},Data, Options) when is_binary(Data),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -796,15 +876,18 @@ setData(#wx_ref{type=ThisT,ref=ThisRef},Data, Options) wxe_util:cast(?wxImage_SetData_2, <>). -%% @spec (This::wxImage(), Data::binary(), New_width::integer(), New_height::integer()) -> ok %% @equiv setData(This,Data,New_width,New_height, []) +-spec setData(This, Data, New_width, New_height) -> ok when + This::wxImage(), Data::binary(), New_width::integer(), New_height::integer(). + setData(This,Data,New_width,New_height) when is_record(This, wx_ref),is_binary(Data),is_integer(New_width),is_integer(New_height) -> setData(This,Data,New_width,New_height, []). -%% @spec (This::wxImage(), Data::binary(), New_width::integer(), New_height::integer(), [Option]) -> ok -%% Option = {static_data, bool()} %% @doc See external documentation. +-spec setData(This, Data, New_width, New_height, [Option]) -> ok when + This::wxImage(), Data::binary(), New_width::integer(), New_height::integer(), + Option :: {static_data, boolean()}. setData(#wx_ref{type=ThisT,ref=ThisRef},Data,New_width,New_height, Options) when is_binary(Data),is_integer(New_width),is_integer(New_height),is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -815,15 +898,18 @@ setData(#wx_ref{type=ThisT,ref=ThisRef},Data,New_width,New_height, Options) wxe_util:cast(?wxImage_SetData_4, <>). -%% @spec (This::wxImage()) -> ok %% @equiv setMask(This, []) +-spec setMask(This) -> ok when + This::wxImage(). + setMask(This) when is_record(This, wx_ref) -> setMask(This, []). -%% @spec (This::wxImage(), [Option]) -> ok -%% Option = {mask, bool()} %% @doc See external documentation. +-spec setMask(This, [Option]) -> ok when + This::wxImage(), + Option :: {mask, boolean()}. setMask(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxImage), @@ -833,16 +919,18 @@ setMask(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxImage_SetMask, <>). -%% @spec (This::wxImage(), R::integer(), G::integer(), B::integer()) -> ok %% @doc See external documentation. +-spec setMaskColour(This, R, G, B) -> ok when + This::wxImage(), R::integer(), G::integer(), B::integer(). setMaskColour(#wx_ref{type=ThisT,ref=ThisRef},R,G,B) when is_integer(R),is_integer(G),is_integer(B) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_SetMaskColour, <>). -%% @spec (This::wxImage(), Mask::wxImage(), Mr::integer(), Mg::integer(), Mb::integer()) -> bool() %% @doc See external documentation. +-spec setMaskFromImage(This, Mask, Mr, Mg, Mb) -> boolean() when + This::wxImage(), Mask::wxImage(), Mr::integer(), Mg::integer(), Mb::integer(). setMaskFromImage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MaskT,ref=MaskRef},Mr,Mg,Mb) when is_integer(Mr),is_integer(Mg),is_integer(Mb) -> ?CLASS(ThisT,wxImage), @@ -850,15 +938,11 @@ setMaskFromImage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MaskT,ref=MaskRef} wxe_util:call(?wxImage_SetMaskFromImage, <>). -%% @spec (This::wxImage(),Name::string(),X::integer()|string()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setOption(This::wxImage(), Name::string(), Value::integer()) -> ok -%%

-%%

-%% setOption(This::wxImage(), Name::string(), Value::string()) -> ok -%%

+-spec setOption(This, Name, Value) -> ok when + This::wxImage(), Name::string(), Value::integer(); + (This, Name, Value) -> ok when + This::wxImage(), Name::string(), Value::string(). setOption(#wx_ref{type=ThisT,ref=ThisRef},Name,Value) when is_list(Name),is_integer(Value) -> ?CLASS(ThisT,wxImage), @@ -873,32 +957,35 @@ setOption(#wx_ref{type=ThisT,ref=ThisRef},Name,Value) wxe_util:cast(?wxImage_SetOption_2_1, <>). -%% @spec (This::wxImage(), Palette::wxPalette:wxPalette()) -> ok %% @doc See external documentation. +-spec setPalette(This, Palette) -> ok when + This::wxImage(), Palette::wxPalette:wxPalette(). setPalette(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PaletteT,ref=PaletteRef}) -> ?CLASS(ThisT,wxImage), ?CLASS(PaletteT,wxPalette), wxe_util:cast(?wxImage_SetPalette, <>). -%% @spec (This::wxImage(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, R::integer(), G::integer(), B::integer()) -> ok %% @doc See external documentation. +-spec setRGB(This, Rect, R, G, B) -> ok when + This::wxImage(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, R::integer(), G::integer(), B::integer(). setRGB(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH},R,G,B) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),is_integer(R),is_integer(G),is_integer(B) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_SetRGB_4, <>). -%% @spec (This::wxImage(), X::integer(), Y::integer(), R::integer(), G::integer(), B::integer()) -> ok %% @doc See external documentation. +-spec setRGB(This, X, Y, R, G, B) -> ok when + This::wxImage(), X::integer(), Y::integer(), R::integer(), G::integer(), B::integer(). setRGB(#wx_ref{type=ThisT,ref=ThisRef},X,Y,R,G,B) when is_integer(X),is_integer(Y),is_integer(R),is_integer(G),is_integer(B) -> ?CLASS(ThisT,wxImage), wxe_util:cast(?wxImage_SetRGB_5, <>). -%% @spec (This::wxImage()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxImage) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxImage), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxImageList.erl b/lib/wx/src/gen/wxImageList.erl index f805a234df..a2049ce052 100644 --- a/lib/wx/src/gen/wxImageList.erl +++ b/lib/wx/src/gen/wxImageList.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 @@ -31,24 +31,30 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxImageList/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxImageList() +-type wxImageList() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxImageList(). new() -> wxe_util:construct(?wxImageList_new_0, <<>>). -%% @spec (Width::integer(), Height::integer()) -> wxImageList() %% @equiv new(Width,Height, []) +-spec new(Width, Height) -> wxImageList() when + Width::integer(), Height::integer(). + new(Width,Height) when is_integer(Width),is_integer(Height) -> new(Width,Height, []). -%% @spec (Width::integer(), Height::integer(), [Option]) -> wxImageList() -%% Option = {mask, bool()} | {initialCount, integer()} %% @doc See external documentation. +-spec new(Width, Height, [Option]) -> wxImageList() when + Width::integer(), Height::integer(), + Option :: {mask, boolean()} + | {initialCount, integer()}. new(Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> MOpts = fun({mask, Mask}, Acc) -> [<<1:32/?UI,(wxe_util:from_bool(Mask)):32/?UI>>|Acc]; @@ -58,23 +64,20 @@ new(Width,Height, Options) wxe_util:construct(?wxImageList_new_3, <>). -%% @spec (This::wxImageList(), Bitmap::wxBitmap:wxBitmap()) -> integer() %% @doc See external documentation. +-spec add(This, Bitmap) -> integer() when + This::wxImageList(), Bitmap::wxBitmap:wxBitmap(). add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef}) -> ?CLASS(ThisT,wxImageList), ?CLASS(BitmapT,wxBitmap), wxe_util:call(?wxImageList_Add_1, <>). -%% @spec (This::wxImageList(),Bitmap::wxBitmap:wxBitmap(),X::term()) -> integer() %% @doc See external documentation. -%%
Alternatives: -%%

-%% add(This::wxImageList(), Bitmap::wxBitmap:wxBitmap(), Mask::wxBitmap:wxBitmap()) -> integer() -%%

-%%

-%% add(This::wxImageList(), Bitmap::wxBitmap:wxBitmap(), MaskColour::wx:colour()) -> integer() -%%

+-spec add(This, Bitmap, Mask) -> integer() when + This::wxImageList(), Bitmap::wxBitmap:wxBitmap(), Mask::wxBitmap:wxBitmap(); + (This, Bitmap, MaskColour) -> integer() when + This::wxImageList(), Bitmap::wxBitmap:wxBitmap(), MaskColour::wx:wx_colour(). add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef},#wx_ref{type=MaskT,ref=MaskRef}) -> ?CLASS(ThisT,wxImageList), ?CLASS(BitmapT,wxBitmap), @@ -88,15 +91,19 @@ add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef},MaskColo wxe_util:call(?wxImageList_Add_2_1, <>). -%% @spec (This::wxImageList(), Width::integer(), Height::integer()) -> bool() %% @equiv create(This,Width,Height, []) +-spec create(This, Width, Height) -> boolean() when + This::wxImageList(), Width::integer(), Height::integer(). + create(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> create(This,Width,Height, []). -%% @spec (This::wxImageList(), Width::integer(), Height::integer(), [Option]) -> bool() -%% Option = {mask, bool()} | {initialCount, integer()} %% @doc See external documentation. +-spec create(This, Width, Height, [Option]) -> boolean() when + This::wxImageList(), Width::integer(), Height::integer(), + Option :: {mask, boolean()} + | {initialCount, integer()}. create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxImageList), @@ -107,15 +114,19 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxImageList_Create, <>). -%% @spec (This::wxImageList(), Index::integer(), Dc::wxDC:wxDC(), X::integer(), Y::integer()) -> bool() %% @equiv draw(This,Index,Dc,X,Y, []) +-spec draw(This, Index, Dc, X, Y) -> boolean() when + This::wxImageList(), Index::integer(), Dc::wxDC:wxDC(), X::integer(), Y::integer(). + draw(This,Index,Dc,X,Y) when is_record(This, wx_ref),is_integer(Index),is_record(Dc, wx_ref),is_integer(X),is_integer(Y) -> draw(This,Index,Dc,X,Y, []). -%% @spec (This::wxImageList(), Index::integer(), Dc::wxDC:wxDC(), X::integer(), Y::integer(), [Option]) -> bool() -%% Option = {flags, integer()} | {solidBackground, bool()} %% @doc See external documentation. +-spec draw(This, Index, Dc, X, Y, [Option]) -> boolean() when + This::wxImageList(), Index::integer(), Dc::wxDC:wxDC(), X::integer(), Y::integer(), + Option :: {flags, integer()} + | {solidBackground, boolean()}. draw(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=DcT,ref=DcRef},X,Y, Options) when is_integer(Index),is_integer(X),is_integer(Y),is_list(Options) -> ?CLASS(ThisT,wxImageList), @@ -127,54 +138,62 @@ draw(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=DcT,ref=DcRef},X,Y, Opti wxe_util:call(?wxImageList_Draw, <>). -%% @spec (This::wxImageList(), Index::integer()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getBitmap(This, Index) -> wxBitmap:wxBitmap() when + This::wxImageList(), Index::integer(). getBitmap(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxImageList), wxe_util:call(?wxImageList_GetBitmap, <>). -%% @spec (This::wxImageList(), Index::integer()) -> wxIcon:wxIcon() %% @doc See external documentation. +-spec getIcon(This, Index) -> wxIcon:wxIcon() when + This::wxImageList(), Index::integer(). getIcon(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxImageList), wxe_util:call(?wxImageList_GetIcon, <>). -%% @spec (This::wxImageList()) -> integer() %% @doc See external documentation. +-spec getImageCount(This) -> integer() when + This::wxImageList(). getImageCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImageList), wxe_util:call(?wxImageList_GetImageCount, <>). -%% @spec (This::wxImageList(), Index::integer()) -> {bool(), Width::integer(), Height::integer()} %% @doc See external documentation. +-spec getSize(This, Index) -> Result when + Result ::{Res ::boolean(), Width::integer(), Height::integer()}, + This::wxImageList(), Index::integer(). getSize(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxImageList), wxe_util:call(?wxImageList_GetSize, <>). -%% @spec (This::wxImageList(), Index::integer()) -> bool() %% @doc See external documentation. +-spec remove(This, Index) -> boolean() when + This::wxImageList(), Index::integer(). remove(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxImageList), wxe_util:call(?wxImageList_Remove, <>). -%% @spec (This::wxImageList()) -> bool() %% @doc See external documentation. +-spec removeAll(This) -> boolean() when + This::wxImageList(). removeAll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxImageList), wxe_util:call(?wxImageList_RemoveAll, <>). -%% @spec (This::wxImageList(), Index::integer(), Bitmap::wxBitmap:wxBitmap()) -> bool() %% @doc See external documentation. +-spec replace(This, Index, Bitmap) -> boolean() when + This::wxImageList(), Index::integer(), Bitmap::wxBitmap:wxBitmap(). replace(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=BitmapT,ref=BitmapRef}) when is_integer(Index) -> ?CLASS(ThisT,wxImageList), @@ -182,8 +201,9 @@ replace(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=BitmapT,ref=BitmapRef wxe_util:call(?wxImageList_Replace_2, <>). -%% @spec (This::wxImageList(), Index::integer(), Bitmap::wxBitmap:wxBitmap(), Mask::wxBitmap:wxBitmap()) -> bool() %% @doc See external documentation. +-spec replace(This, Index, Bitmap, Mask) -> boolean() when + This::wxImageList(), Index::integer(), Bitmap::wxBitmap:wxBitmap(), Mask::wxBitmap:wxBitmap(). replace(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=BitmapT,ref=BitmapRef},#wx_ref{type=MaskT,ref=MaskRef}) when is_integer(Index) -> ?CLASS(ThisT,wxImageList), @@ -192,8 +212,8 @@ replace(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=BitmapT,ref=BitmapRef wxe_util:call(?wxImageList_Replace_3, <>). -%% @spec (This::wxImageList()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxImageList) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxImageList), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxJoystickEvent.erl b/lib/wx/src/gen/wxJoystickEvent.erl index 2f149a50f8..979c36cd8c 100644 --- a/lib/wx/src/gen/wxJoystickEvent.erl +++ b/lib/wx/src/gen/wxJoystickEvent.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 @@ -39,19 +39,24 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxJoystickEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxJoystickEvent()) -> bool() +-type wxJoystickEvent() :: wx:wx_object(). %% @equiv buttonDown(This, []) +-spec buttonDown(This) -> boolean() when + This::wxJoystickEvent(). + buttonDown(This) when is_record(This, wx_ref) -> buttonDown(This, []). -%% @spec (This::wxJoystickEvent(), [Option]) -> bool() -%% Option = {but, integer()} %% @doc See external documentation. +-spec buttonDown(This, [Option]) -> boolean() when + This::wxJoystickEvent(), + Option :: {but, integer()}. buttonDown(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxJoystickEvent), @@ -61,15 +66,18 @@ buttonDown(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxJoystickEvent_ButtonDown, <>). -%% @spec (This::wxJoystickEvent()) -> bool() %% @equiv buttonIsDown(This, []) +-spec buttonIsDown(This) -> boolean() when + This::wxJoystickEvent(). + buttonIsDown(This) when is_record(This, wx_ref) -> buttonIsDown(This, []). -%% @spec (This::wxJoystickEvent(), [Option]) -> bool() -%% Option = {but, integer()} %% @doc See external documentation. +-spec buttonIsDown(This, [Option]) -> boolean() when + This::wxJoystickEvent(), + Option :: {but, integer()}. buttonIsDown(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxJoystickEvent), @@ -79,15 +87,18 @@ buttonIsDown(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxJoystickEvent_ButtonIsDown, <>). -%% @spec (This::wxJoystickEvent()) -> bool() %% @equiv buttonUp(This, []) +-spec buttonUp(This) -> boolean() when + This::wxJoystickEvent(). + buttonUp(This) when is_record(This, wx_ref) -> buttonUp(This, []). -%% @spec (This::wxJoystickEvent(), [Option]) -> bool() -%% Option = {but, integer()} %% @doc See external documentation. +-spec buttonUp(This, [Option]) -> boolean() when + This::wxJoystickEvent(), + Option :: {but, integer()}. buttonUp(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxJoystickEvent), @@ -97,57 +108,65 @@ buttonUp(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxJoystickEvent_ButtonUp, <>). -%% @spec (This::wxJoystickEvent()) -> integer() %% @doc See external documentation. +-spec getButtonChange(This) -> integer() when + This::wxJoystickEvent(). getButtonChange(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxJoystickEvent), wxe_util:call(?wxJoystickEvent_GetButtonChange, <>). -%% @spec (This::wxJoystickEvent()) -> integer() %% @doc See external documentation. +-spec getButtonState(This) -> integer() when + This::wxJoystickEvent(). getButtonState(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxJoystickEvent), wxe_util:call(?wxJoystickEvent_GetButtonState, <>). -%% @spec (This::wxJoystickEvent()) -> integer() %% @doc See external documentation. +-spec getJoystick(This) -> integer() when + This::wxJoystickEvent(). getJoystick(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxJoystickEvent), wxe_util:call(?wxJoystickEvent_GetJoystick, <>). -%% @spec (This::wxJoystickEvent()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxJoystickEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxJoystickEvent), wxe_util:call(?wxJoystickEvent_GetPosition, <>). -%% @spec (This::wxJoystickEvent()) -> integer() %% @doc See external documentation. +-spec getZPosition(This) -> integer() when + This::wxJoystickEvent(). getZPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxJoystickEvent), wxe_util:call(?wxJoystickEvent_GetZPosition, <>). -%% @spec (This::wxJoystickEvent()) -> bool() %% @doc See external documentation. +-spec isButton(This) -> boolean() when + This::wxJoystickEvent(). isButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxJoystickEvent), wxe_util:call(?wxJoystickEvent_IsButton, <>). -%% @spec (This::wxJoystickEvent()) -> bool() %% @doc See external documentation. +-spec isMove(This) -> boolean() when + This::wxJoystickEvent(). isMove(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxJoystickEvent), wxe_util:call(?wxJoystickEvent_IsMove, <>). -%% @spec (This::wxJoystickEvent()) -> bool() %% @doc See external documentation. +-spec isZMove(This) -> boolean() when + This::wxJoystickEvent(). isZMove(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxJoystickEvent), wxe_util:call(?wxJoystickEvent_IsZMove, diff --git a/lib/wx/src/gen/wxKeyEvent.erl b/lib/wx/src/gen/wxKeyEvent.erl index edda5ee0a6..107d4be685 100644 --- a/lib/wx/src/gen/wxKeyEvent.erl +++ b/lib/wx/src/gen/wxKeyEvent.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 @@ -39,103 +39,119 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxKeyEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxKeyEvent()) -> bool() +-type wxKeyEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec altDown(This) -> boolean() when + This::wxKeyEvent(). altDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_AltDown, <>). -%% @spec (This::wxKeyEvent()) -> bool() %% @doc See external documentation. +-spec cmdDown(This) -> boolean() when + This::wxKeyEvent(). cmdDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_CmdDown, <>). -%% @spec (This::wxKeyEvent()) -> bool() %% @doc See external documentation. +-spec controlDown(This) -> boolean() when + This::wxKeyEvent(). controlDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_ControlDown, <>). -%% @spec (This::wxKeyEvent()) -> integer() %% @doc See external documentation. +-spec getKeyCode(This) -> integer() when + This::wxKeyEvent(). getKeyCode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_GetKeyCode, <>). -%% @spec (This::wxKeyEvent()) -> integer() %% @doc See external documentation. +-spec getModifiers(This) -> integer() when + This::wxKeyEvent(). getModifiers(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_GetModifiers, <>). -%% @spec (This::wxKeyEvent()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxKeyEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_GetPosition, <>). -%% @spec (This::wxKeyEvent()) -> integer() %% @doc See external documentation. +-spec getRawKeyCode(This) -> integer() when + This::wxKeyEvent(). getRawKeyCode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_GetRawKeyCode, <>). -%% @spec (This::wxKeyEvent()) -> integer() %% @doc See external documentation. +-spec getRawKeyFlags(This) -> integer() when + This::wxKeyEvent(). getRawKeyFlags(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_GetRawKeyFlags, <>). -%% @spec (This::wxKeyEvent()) -> integer() %% @doc See external documentation. +-spec getUnicodeKey(This) -> integer() when + This::wxKeyEvent(). getUnicodeKey(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_GetUnicodeKey, <>). -%% @spec (This::wxKeyEvent()) -> integer() %% @doc See external documentation. +-spec getX(This) -> integer() when + This::wxKeyEvent(). getX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_GetX, <>). -%% @spec (This::wxKeyEvent()) -> integer() %% @doc See external documentation. +-spec getY(This) -> integer() when + This::wxKeyEvent(). getY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_GetY, <>). -%% @spec (This::wxKeyEvent()) -> bool() %% @doc See external documentation. +-spec hasModifiers(This) -> boolean() when + This::wxKeyEvent(). hasModifiers(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_HasModifiers, <>). -%% @spec (This::wxKeyEvent()) -> bool() %% @doc See external documentation. +-spec metaDown(This) -> boolean() when + This::wxKeyEvent(). metaDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_MetaDown, <>). -%% @spec (This::wxKeyEvent()) -> bool() %% @doc See external documentation. +-spec shiftDown(This) -> boolean() when + This::wxKeyEvent(). shiftDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxKeyEvent), wxe_util:call(?wxKeyEvent_ShiftDown, diff --git a/lib/wx/src/gen/wxLayoutAlgorithm.erl b/lib/wx/src/gen/wxLayoutAlgorithm.erl index c17abeaed1..c9a7314c87 100644 --- a/lib/wx/src/gen/wxLayoutAlgorithm.erl +++ b/lib/wx/src/gen/wxLayoutAlgorithm.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 @@ -30,24 +30,29 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxLayoutAlgorithm/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxLayoutAlgorithm() +-type wxLayoutAlgorithm() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxLayoutAlgorithm(). new() -> wxe_util:construct(?wxLayoutAlgorithm_new, <<>>). -%% @spec (This::wxLayoutAlgorithm(), Frame::wxFrame:wxFrame()) -> bool() %% @equiv layoutFrame(This,Frame, []) +-spec layoutFrame(This, Frame) -> boolean() when + This::wxLayoutAlgorithm(), Frame::wxFrame:wxFrame(). + layoutFrame(This,Frame) when is_record(This, wx_ref),is_record(Frame, wx_ref) -> layoutFrame(This,Frame, []). -%% @spec (This::wxLayoutAlgorithm(), Frame::wxFrame:wxFrame(), [Option]) -> bool() -%% Option = {mainWindow, wxWindow:wxWindow()} %% @doc See external documentation. +-spec layoutFrame(This, Frame, [Option]) -> boolean() when + This::wxLayoutAlgorithm(), Frame::wxFrame:wxFrame(), + Option :: {mainWindow, wxWindow:wxWindow()}. layoutFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxLayoutAlgorithm), @@ -58,15 +63,18 @@ layoutFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef}, O wxe_util:call(?wxLayoutAlgorithm_LayoutFrame, <>). -%% @spec (This::wxLayoutAlgorithm(), Frame::wxMDIParentFrame:wxMDIParentFrame()) -> bool() %% @equiv layoutMDIFrame(This,Frame, []) +-spec layoutMDIFrame(This, Frame) -> boolean() when + This::wxLayoutAlgorithm(), Frame::wxMDIParentFrame:wxMDIParentFrame(). + layoutMDIFrame(This,Frame) when is_record(This, wx_ref),is_record(Frame, wx_ref) -> layoutMDIFrame(This,Frame, []). -%% @spec (This::wxLayoutAlgorithm(), Frame::wxMDIParentFrame:wxMDIParentFrame(), [Option]) -> bool() -%% Option = {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}} %% @doc See external documentation. +-spec layoutMDIFrame(This, Frame, [Option]) -> boolean() when + This::wxLayoutAlgorithm(), Frame::wxMDIParentFrame:wxMDIParentFrame(), + Option :: {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}}. layoutMDIFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxLayoutAlgorithm), @@ -77,15 +85,18 @@ layoutMDIFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef} wxe_util:call(?wxLayoutAlgorithm_LayoutMDIFrame, <>). -%% @spec (This::wxLayoutAlgorithm(), Frame::wxWindow:wxWindow()) -> bool() %% @equiv layoutWindow(This,Frame, []) +-spec layoutWindow(This, Frame) -> boolean() when + This::wxLayoutAlgorithm(), Frame::wxWindow:wxWindow(). + layoutWindow(This,Frame) when is_record(This, wx_ref),is_record(Frame, wx_ref) -> layoutWindow(This,Frame, []). -%% @spec (This::wxLayoutAlgorithm(), Frame::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {mainWindow, wxWindow:wxWindow()} %% @doc See external documentation. +-spec layoutWindow(This, Frame, [Option]) -> boolean() when + This::wxLayoutAlgorithm(), Frame::wxWindow:wxWindow(), + Option :: {mainWindow, wxWindow:wxWindow()}. layoutWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxLayoutAlgorithm), @@ -96,8 +107,8 @@ layoutWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef}, wxe_util:call(?wxLayoutAlgorithm_LayoutWindow, <>). -%% @spec (This::wxLayoutAlgorithm()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxLayoutAlgorithm) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxLayoutAlgorithm), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxListBox.erl b/lib/wx/src/gen/wxListBox.erl index cc30bf95e4..5cd8ba8127 100644 --- a/lib/wx/src/gen/wxListBox.erl +++ b/lib/wx/src/gen/wxListBox.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,6 +74,7 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxListBox/0]). %% @hidden parent_class(wxControlWithItems) -> true; parent_class(wxControl) -> true; @@ -81,21 +82,29 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxListBox() +-type wxListBox() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxListBox(). new() -> wxe_util:construct(?wxListBox_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxListBox() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxListBox() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxListBox() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {choices, [[string()]]} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxListBox() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {choices, [[string()]]} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -109,15 +118,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxListBox_new_3, <>). -%% @spec (This::wxListBox(), Parent::wxWindow:wxWindow(), Id::integer(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]) -> bool() %% @equiv create(This,Parent,Id,Pos,Size,Choices, []) +-spec create(This, Parent, Id, Pos, Size, Choices) -> boolean() when + This::wxListBox(), Parent::wxWindow:wxWindow(), Id::integer(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]. + create(This,Parent,Id,Pos={PosX,PosY},Size={SizeW,SizeH},Choices) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices) -> create(This,Parent,Id,Pos,Size,Choices, []). -%% @spec (This::wxListBox(), Parent::wxWindow:wxWindow(), Id::integer(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], [Option]) -> bool() -%% Option = {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Pos, Size, Choices, [Option]) -> boolean() when + This::wxListBox(), Parent::wxWindow:wxWindow(), Id::integer(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], + Option :: {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,{PosX,PosY},{SizeW,SizeH},Choices, Options) when is_integer(Id),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices),is_list(Options) -> ?CLASS(ThisT,wxListBox), @@ -131,23 +144,27 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,{P wxe_util:call(?wxListBox_Create, <>|| UC_Str <- Choices_UCA>>)/binary, 0:(((8- ((0 + lists:sum([byte_size(S)+4||S<-Choices_UCA])) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxListBox(), N::integer()) -> ok %% @doc See external documentation. +-spec deselect(This, N) -> ok when + This::wxListBox(), N::integer(). deselect(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListBox), wxe_util:cast(?wxListBox_Deselect, <>). -%% @spec (This::wxListBox()) -> {integer(), ASelections::[integer()]} %% @doc See external documentation. +-spec getSelections(This) -> Result when + Result ::{Res ::integer(), ASelections::[integer()]}, + This::wxListBox(). getSelections(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListBox), wxe_util:call(?wxListBox_GetSelections, <>). -%% @spec (This::wxListBox(), Items::[[string()]], Pos::integer()) -> ok %% @doc See external documentation. +-spec insertItems(This, Items, Pos) -> ok when + This::wxListBox(), Items::[[string()]], Pos::integer(). insertItems(#wx_ref{type=ThisT,ref=ThisRef},Items,Pos) when is_list(Items),is_integer(Pos) -> ?CLASS(ThisT,wxListBox), @@ -156,16 +173,18 @@ insertItems(#wx_ref{type=ThisT,ref=ThisRef},Items,Pos) wxe_util:cast(?wxListBox_InsertItems, <>|| UC_Str <- Items_UCA>>)/binary, 0:(((8- ((0 + lists:sum([byte_size(S)+4||S<-Items_UCA])) band 16#7)) band 16#7))/unit:8,Pos:32/?UI>>). -%% @spec (This::wxListBox(), N::integer()) -> bool() %% @doc See external documentation. +-spec isSelected(This, N) -> boolean() when + This::wxListBox(), N::integer(). isSelected(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListBox), wxe_util:call(?wxListBox_IsSelected, <>). -%% @spec (This::wxListBox(), Items::[[string()]]) -> ok %% @doc See external documentation. +-spec set(This, Items) -> ok when + This::wxListBox(), Items::[[string()]]. set(#wx_ref{type=ThisT,ref=ThisRef},Items) when is_list(Items) -> ?CLASS(ThisT,wxListBox), @@ -174,23 +193,20 @@ set(#wx_ref{type=ThisT,ref=ThisRef},Items) wxe_util:cast(?wxListBox_Set, <>|| UC_Str <- Items_UCA>>)/binary, 0:(((8- ((0 + lists:sum([byte_size(S)+4||S<-Items_UCA])) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxListBox(), Point::{X::integer(), Y::integer()}) -> integer() %% @doc See external documentation. +-spec hitTest(This, Point) -> integer() when + This::wxListBox(), Point::{X::integer(), Y::integer()}. hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PointX,PointY}) when is_integer(PointX),is_integer(PointY) -> ?CLASS(ThisT,wxListBox), wxe_util:call(?wxListBox_HitTest, <>). -%% @spec (This::wxListBox(),X::integer()|string()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setFirstItem(This::wxListBox(), N::integer()) -> ok -%%

-%%

-%% setFirstItem(This::wxListBox(), S::string()) -> ok -%%

+-spec setFirstItem(This, N) -> ok when + This::wxListBox(), N::integer(); + (This, S) -> ok when + This::wxListBox(), S::string(). setFirstItem(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListBox), @@ -203,8 +219,8 @@ setFirstItem(#wx_ref{type=ThisT,ref=ThisRef},S) wxe_util:cast(?wxListBox_SetFirstItem_1_1, <>). -%% @spec (This::wxListBox()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxListBox) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxListBox), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxListCtrl.erl b/lib/wx/src/gen/wxListCtrl.erl index fa99897171..ae2db0ae2f 100644 --- a/lib/wx/src/gen/wxListCtrl.erl +++ b/lib/wx/src/gen/wxListCtrl.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 @@ -83,12 +83,14 @@ show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1,update/1, updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxListCtrl/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxListCtrl() :: wx:wx_object(). %% @spec () -> wxListCtrl() %% @doc See external documentation. @@ -141,15 +143,18 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) BinOpt = list_to_binary(lists:foldl(MOpts, [<<0:32>>], Options)), wxe_util:construct(?wxListCtrl_new_2, <>). -%% @spec (This::wxListCtrl()) -> bool() %% @equiv arrange(This, []) +-spec arrange(This) -> boolean() when + This::wxListCtrl(). + arrange(This) when is_record(This, wx_ref) -> arrange(This, []). -%% @spec (This::wxListCtrl(), [Option]) -> bool() -%% Option = {flag, integer()} %% @doc See external documentation. +-spec arrange(This, [Option]) -> boolean() when + This::wxListCtrl(), + Option :: {flag, integer()}. arrange(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxListCtrl), @@ -159,8 +164,9 @@ arrange(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxListCtrl_Arrange, <>). -%% @spec (This::wxListCtrl(), ImageList::wxImageList:wxImageList(), Which::integer()) -> ok %% @doc See external documentation. +-spec assignImageList(This, ImageList, Which) -> ok when + This::wxListCtrl(), ImageList::wxImageList:wxImageList(), Which::integer(). assignImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef},Which) when is_integer(Which) -> ?CLASS(ThisT,wxListCtrl), @@ -168,8 +174,9 @@ assignImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=Imag wxe_util:cast(?wxListCtrl_AssignImageList, <>). -%% @spec (This::wxListCtrl()) -> ok %% @doc See external documentation. +-spec clearAll(This) -> ok when + This::wxListCtrl(). clearAll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:cast(?wxListCtrl_ClearAll, @@ -210,61 +217,64 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxListCtrl_Create, <>). -%% @spec (This::wxListCtrl()) -> bool() %% @doc See external documentation. +-spec deleteAllItems(This) -> boolean() when + This::wxListCtrl(). deleteAllItems(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_DeleteAllItems, <>). -%% @spec (This::wxListCtrl(), Col::integer()) -> bool() %% @doc See external documentation. +-spec deleteColumn(This, Col) -> boolean() when + This::wxListCtrl(), Col::integer(). deleteColumn(#wx_ref{type=ThisT,ref=ThisRef},Col) when is_integer(Col) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_DeleteColumn, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> bool() %% @doc See external documentation. +-spec deleteItem(This, Item) -> boolean() when + This::wxListCtrl(), Item::integer(). deleteItem(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_DeleteItem, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> wxTextCtrl:wxTextCtrl() %% @doc See external documentation. +-spec editLabel(This, Item) -> wxTextCtrl:wxTextCtrl() when + This::wxListCtrl(), Item::integer(). editLabel(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_EditLabel, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> bool() %% @doc See external documentation. +-spec ensureVisible(This, Item) -> boolean() when + This::wxListCtrl(), Item::integer(). ensureVisible(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_EnsureVisible, <>). -%% @spec (This::wxListCtrl(), Start::integer(), Str::string()) -> integer() %% @equiv findItem(This,Start,Str, []) +-spec findItem(This, Start, Str) -> integer() when + This::wxListCtrl(), Start::integer(), Str::string(). + findItem(This,Start,Str) when is_record(This, wx_ref),is_integer(Start),is_list(Str) -> findItem(This,Start,Str, []). -%% @spec (This::wxListCtrl(),Start::integer(),X::string()|term(),X::term()|integer()) -> integer() %% @doc See external documentation. -%%
Alternatives: -%%

-%% findItem(This::wxListCtrl(), Start::integer(), Str::string(), [Option]) -> integer() -%%
Option = {partial, bool()} -%%

-%%

-%% findItem(This::wxListCtrl(), Start::integer(), Pt::{X::integer(), Y::integer()}, Direction::integer()) -> integer() -%%

+-spec findItem(This, Start, Str, [Option]) -> integer() when + This::wxListCtrl(), Start::integer(), Str::string(), + Option :: {partial, boolean()}; + (This, Start, Pt, Direction) -> integer() when + This::wxListCtrl(), Start::integer(), Pt::{X::integer(), Y::integer()}, Direction::integer(). findItem(#wx_ref{type=ThisT,ref=ThisRef},Start,Str, Options) when is_integer(Start),is_list(Str),is_list(Options) -> ?CLASS(ThisT,wxListCtrl), @@ -280,8 +290,9 @@ findItem(#wx_ref{type=ThisT,ref=ThisRef},Start,{PtX,PtY},Direction) wxe_util:call(?wxListCtrl_FindItem_3_1, <>). -%% @spec (This::wxListCtrl(), Col::integer(), Item::wxListItem:wxListItem()) -> bool() %% @doc See external documentation. +-spec getColumn(This, Col, Item) -> boolean() when + This::wxListCtrl(), Col::integer(), Item::wxListItem:wxListItem(). getColumn(#wx_ref{type=ThisT,ref=ThisRef},Col,#wx_ref{type=ItemT,ref=ItemRef}) when is_integer(Col) -> ?CLASS(ThisT,wxListCtrl), @@ -289,99 +300,113 @@ getColumn(#wx_ref{type=ThisT,ref=ThisRef},Col,#wx_ref{type=ItemT,ref=ItemRef}) wxe_util:call(?wxListCtrl_GetColumn, <>). -%% @spec (This::wxListCtrl()) -> integer() %% @doc See external documentation. +-spec getColumnCount(This) -> integer() when + This::wxListCtrl(). getColumnCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetColumnCount, <>). -%% @spec (This::wxListCtrl(), Col::integer()) -> integer() %% @doc See external documentation. +-spec getColumnWidth(This, Col) -> integer() when + This::wxListCtrl(), Col::integer(). getColumnWidth(#wx_ref{type=ThisT,ref=ThisRef},Col) when is_integer(Col) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetColumnWidth, <>). -%% @spec (This::wxListCtrl()) -> integer() %% @doc See external documentation. +-spec getCountPerPage(This) -> integer() when + This::wxListCtrl(). getCountPerPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetCountPerPage, <>). -%% @spec (This::wxListCtrl()) -> wxTextCtrl:wxTextCtrl() %% @doc See external documentation. +-spec getEditControl(This) -> wxTextCtrl:wxTextCtrl() when + This::wxListCtrl(). getEditControl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetEditControl, <>). -%% @spec (This::wxListCtrl(), Which::integer()) -> wxImageList:wxImageList() %% @doc See external documentation. +-spec getImageList(This, Which) -> wxImageList:wxImageList() when + This::wxListCtrl(), Which::integer(). getImageList(#wx_ref{type=ThisT,ref=ThisRef},Which) when is_integer(Which) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetImageList, <>). -%% @spec (This::wxListCtrl(), Info::wxListItem:wxListItem()) -> bool() %% @doc See external documentation. +-spec getItem(This, Info) -> boolean() when + This::wxListCtrl(), Info::wxListItem:wxListItem(). getItem(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=InfoT,ref=InfoRef}) -> ?CLASS(ThisT,wxListCtrl), ?CLASS(InfoT,wxListItem), wxe_util:call(?wxListCtrl_GetItem, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> wx:colour() %% @doc See external documentation. +-spec getItemBackgroundColour(This, Item) -> wx:wx_colour() when + This::wxListCtrl(), Item::integer(). getItemBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetItemBackgroundColour, <>). -%% @spec (This::wxListCtrl()) -> integer() %% @doc See external documentation. +-spec getItemCount(This) -> integer() when + This::wxListCtrl(). getItemCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetItemCount, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> integer() %% @doc See external documentation. +-spec getItemData(This, Item) -> integer() when + This::wxListCtrl(), Item::integer(). getItemData(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetItemData, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getItemFont(This, Item) -> wxFont:wxFont() when + This::wxListCtrl(), Item::integer(). getItemFont(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetItemFont, <>). -%% @spec (This::wxListCtrl(), Item::integer(), Pos::{X::integer(), Y::integer()}) -> bool() %% @doc See external documentation. +-spec getItemPosition(This, Item, Pos) -> boolean() when + This::wxListCtrl(), Item::integer(), Pos::{X::integer(), Y::integer()}. getItemPosition(#wx_ref{type=ThisT,ref=ThisRef},Item,{PosX,PosY}) when is_integer(Item),is_integer(PosX),is_integer(PosY) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetItemPosition, <>). -%% @spec (This::wxListCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool() %% @equiv getItemRect(This,Item,Rect, []) +-spec getItemRect(This, Item, Rect) -> boolean() when + This::wxListCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. + getItemRect(This,Item,Rect={RectX,RectY,RectW,RectH}) when is_record(This, wx_ref),is_integer(Item),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> getItemRect(This,Item,Rect, []). -%% @spec (This::wxListCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, [Option]) -> bool() -%% Option = {code, integer()} %% @doc See external documentation. +-spec getItemRect(This, Item, Rect, [Option]) -> boolean() when + This::wxListCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, + Option :: {code, integer()}. getItemRect(#wx_ref{type=ThisT,ref=ThisRef},Item,{RectX,RectY,RectW,RectH}, Options) when is_integer(Item),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),is_list(Options) -> ?CLASS(ThisT,wxListCtrl), @@ -391,46 +416,54 @@ getItemRect(#wx_ref{type=ThisT,ref=ThisRef},Item,{RectX,RectY,RectW,RectH}, Opti wxe_util:call(?wxListCtrl_GetItemRect, <>). -%% @spec (This::wxListCtrl()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getItemSpacing(This) -> {W::integer(), H::integer()} when + This::wxListCtrl(). getItemSpacing(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetItemSpacing, <>). -%% @spec (This::wxListCtrl(), Item::integer(), StateMask::integer()) -> integer() %% @doc See external documentation. +-spec getItemState(This, Item, StateMask) -> integer() when + This::wxListCtrl(), Item::integer(), StateMask::integer(). getItemState(#wx_ref{type=ThisT,ref=ThisRef},Item,StateMask) when is_integer(Item),is_integer(StateMask) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetItemState, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> string() %% @doc See external documentation. +-spec getItemText(This, Item) -> string() when + This::wxListCtrl(), Item::integer(). getItemText(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetItemText, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> wx:colour() %% @doc See external documentation. +-spec getItemTextColour(This, Item) -> wx:wx_colour() when + This::wxListCtrl(), Item::integer(). getItemTextColour(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetItemTextColour, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> integer() %% @equiv getNextItem(This,Item, []) +-spec getNextItem(This, Item) -> integer() when + This::wxListCtrl(), Item::integer(). + getNextItem(This,Item) when is_record(This, wx_ref),is_integer(Item) -> getNextItem(This,Item, []). -%% @spec (This::wxListCtrl(), Item::integer(), [Option]) -> integer() -%% Option = {geometry, integer()} | {state, integer()} %% @doc See external documentation. +-spec getNextItem(This, Item, [Option]) -> integer() when + This::wxListCtrl(), Item::integer(), + Option :: {geometry, integer()} + | {state, integer()}. getNextItem(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) when is_integer(Item),is_list(Options) -> ?CLASS(ThisT,wxListCtrl), @@ -441,50 +474,53 @@ getNextItem(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) wxe_util:call(?wxListCtrl_GetNextItem, <>). -%% @spec (This::wxListCtrl()) -> integer() %% @doc See external documentation. +-spec getSelectedItemCount(This) -> integer() when + This::wxListCtrl(). getSelectedItemCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetSelectedItemCount, <>). -%% @spec (This::wxListCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getTextColour(This) -> wx:wx_colour() when + This::wxListCtrl(). getTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetTextColour, <>). -%% @spec (This::wxListCtrl()) -> integer() %% @doc See external documentation. +-spec getTopItem(This) -> integer() when + This::wxListCtrl(). getTopItem(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetTopItem, <>). -%% @spec (This::wxListCtrl()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getViewRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxListCtrl(). getViewRect(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_GetViewRect, <>). -%% @spec (This::wxListCtrl(), Point::{X::integer(), Y::integer()}) -> {integer(), Flags::integer()} %% @doc See external documentation. +-spec hitTest(This, Point) -> Result when + Result ::{Res ::integer(), Flags::integer()}, + This::wxListCtrl(), Point::{X::integer(), Y::integer()}. hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PointX,PointY}) when is_integer(PointX),is_integer(PointY) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_HitTest, <>). -%% @spec (This::wxListCtrl(),Col::integer(),X::string()|term()) -> integer() %% @doc See external documentation. -%%
Alternatives: -%%

-%% insertColumn(This::wxListCtrl(), Col::integer(), Heading::string()) -> insertColumn(This,Col,Heading, [])

-%%

-%% insertColumn(This::wxListCtrl(), Col::integer(), Info::wxListItem:wxListItem()) -> integer() -%%

+-spec insertColumn(This, Col, Heading) -> integer() when + This::wxListCtrl(), Col::integer(), Heading::string(); + (This, Col, Info) -> integer() when + This::wxListCtrl(), Col::integer(), Info::wxListItem:wxListItem(). insertColumn(This,Col,Heading) when is_record(This, wx_ref),is_integer(Col),is_list(Heading) -> @@ -496,9 +532,11 @@ insertColumn(#wx_ref{type=ThisT,ref=ThisRef},Col,#wx_ref{type=InfoT,ref=InfoRef} wxe_util:call(?wxListCtrl_InsertColumn_2, <>). -%% @spec (This::wxListCtrl(), Col::integer(), Heading::string(), [Option]) -> integer() -%% Option = {format, integer()} | {width, integer()} %% @doc See external documentation. +-spec insertColumn(This, Col, Heading, [Option]) -> integer() when + This::wxListCtrl(), Col::integer(), Heading::string(), + Option :: {format, integer()} + | {width, integer()}. insertColumn(#wx_ref{type=ThisT,ref=ThisRef},Col,Heading, Options) when is_integer(Col),is_list(Heading),is_list(Options) -> ?CLASS(ThisT,wxListCtrl), @@ -510,23 +548,20 @@ insertColumn(#wx_ref{type=ThisT,ref=ThisRef},Col,Heading, Options) wxe_util:call(?wxListCtrl_InsertColumn_3, <>). -%% @spec (This::wxListCtrl(), Info::wxListItem:wxListItem()) -> integer() %% @doc See external documentation. +-spec insertItem(This, Info) -> integer() when + This::wxListCtrl(), Info::wxListItem:wxListItem(). insertItem(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=InfoT,ref=InfoRef}) -> ?CLASS(ThisT,wxListCtrl), ?CLASS(InfoT,wxListItem), wxe_util:call(?wxListCtrl_InsertItem_1, <>). -%% @spec (This::wxListCtrl(),Index::integer(),X::integer()|string()) -> integer() %% @doc See external documentation. -%%
Alternatives: -%%

-%% insertItem(This::wxListCtrl(), Index::integer(), ImageIndex::integer()) -> integer() -%%

-%%

-%% insertItem(This::wxListCtrl(), Index::integer(), Label::string()) -> integer() -%%

+-spec insertItem(This, Index, ImageIndex) -> integer() when + This::wxListCtrl(), Index::integer(), ImageIndex::integer(); + (This, Index, Label) -> integer() when + This::wxListCtrl(), Index::integer(), Label::string(). insertItem(#wx_ref{type=ThisT,ref=ThisRef},Index,ImageIndex) when is_integer(Index),is_integer(ImageIndex) -> ?CLASS(ThisT,wxListCtrl), @@ -539,8 +574,9 @@ insertItem(#wx_ref{type=ThisT,ref=ThisRef},Index,Label) wxe_util:call(?wxListCtrl_InsertItem_2_1, <>). -%% @spec (This::wxListCtrl(), Index::integer(), Label::string(), ImageIndex::integer()) -> integer() %% @doc See external documentation. +-spec insertItem(This, Index, Label, ImageIndex) -> integer() when + This::wxListCtrl(), Index::integer(), Label::string(), ImageIndex::integer(). insertItem(#wx_ref{type=ThisT,ref=ThisRef},Index,Label,ImageIndex) when is_integer(Index),is_list(Label),is_integer(ImageIndex) -> ?CLASS(ThisT,wxListCtrl), @@ -548,40 +584,45 @@ insertItem(#wx_ref{type=ThisT,ref=ThisRef},Index,Label,ImageIndex) wxe_util:call(?wxListCtrl_InsertItem_3, <>). -%% @spec (This::wxListCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec refreshItem(This, Item) -> ok when + This::wxListCtrl(), Item::integer(). refreshItem(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), wxe_util:cast(?wxListCtrl_RefreshItem, <>). -%% @spec (This::wxListCtrl(), ItemFrom::integer(), ItemTo::integer()) -> ok %% @doc See external documentation. +-spec refreshItems(This, ItemFrom, ItemTo) -> ok when + This::wxListCtrl(), ItemFrom::integer(), ItemTo::integer(). refreshItems(#wx_ref{type=ThisT,ref=ThisRef},ItemFrom,ItemTo) when is_integer(ItemFrom),is_integer(ItemTo) -> ?CLASS(ThisT,wxListCtrl), wxe_util:cast(?wxListCtrl_RefreshItems, <>). -%% @spec (This::wxListCtrl(), Dx::integer(), Dy::integer()) -> bool() %% @doc See external documentation. +-spec scrollList(This, Dx, Dy) -> boolean() when + This::wxListCtrl(), Dx::integer(), Dy::integer(). scrollList(#wx_ref{type=ThisT,ref=ThisRef},Dx,Dy) when is_integer(Dx),is_integer(Dy) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_ScrollList, <>). -%% @spec (This::wxListCtrl(), Colour::wx:colour()) -> bool() %% @doc See external documentation. +-spec setBackgroundColour(This, Colour) -> boolean() when + This::wxListCtrl(), Colour::wx:wx_colour(). setBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_SetBackgroundColour, <>). -%% @spec (This::wxListCtrl(), Col::integer(), Item::wxListItem:wxListItem()) -> bool() %% @doc See external documentation. +-spec setColumn(This, Col, Item) -> boolean() when + This::wxListCtrl(), Col::integer(), Item::wxListItem:wxListItem(). setColumn(#wx_ref{type=ThisT,ref=ThisRef},Col,#wx_ref{type=ItemT,ref=ItemRef}) when is_integer(Col) -> ?CLASS(ThisT,wxListCtrl), @@ -589,16 +630,18 @@ setColumn(#wx_ref{type=ThisT,ref=ThisRef},Col,#wx_ref{type=ItemT,ref=ItemRef}) wxe_util:call(?wxListCtrl_SetColumn, <>). -%% @spec (This::wxListCtrl(), Col::integer(), Width::integer()) -> bool() %% @doc See external documentation. +-spec setColumnWidth(This, Col, Width) -> boolean() when + This::wxListCtrl(), Col::integer(), Width::integer(). setColumnWidth(#wx_ref{type=ThisT,ref=ThisRef},Col,Width) when is_integer(Col),is_integer(Width) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_SetColumnWidth, <>). -%% @spec (This::wxListCtrl(), ImageList::wxImageList:wxImageList(), Which::integer()) -> ok %% @doc See external documentation. +-spec setImageList(This, ImageList, Which) -> ok when + This::wxListCtrl(), ImageList::wxImageList:wxImageList(), Which::integer(). setImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef},Which) when is_integer(Which) -> ?CLASS(ThisT,wxListCtrl), @@ -606,23 +649,27 @@ setImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageLi wxe_util:cast(?wxListCtrl_SetImageList, <>). -%% @spec (This::wxListCtrl(), Info::wxListItem:wxListItem()) -> bool() %% @doc See external documentation. +-spec setItem(This, Info) -> boolean() when + This::wxListCtrl(), Info::wxListItem:wxListItem(). setItem(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=InfoT,ref=InfoRef}) -> ?CLASS(ThisT,wxListCtrl), ?CLASS(InfoT,wxListItem), wxe_util:call(?wxListCtrl_SetItem_1, <>). -%% @spec (This::wxListCtrl(), Index::integer(), Col::integer(), Label::string()) -> integer() %% @equiv setItem(This,Index,Col,Label, []) +-spec setItem(This, Index, Col, Label) -> integer() when + This::wxListCtrl(), Index::integer(), Col::integer(), Label::string(). + setItem(This,Index,Col,Label) when is_record(This, wx_ref),is_integer(Index),is_integer(Col),is_list(Label) -> setItem(This,Index,Col,Label, []). -%% @spec (This::wxListCtrl(), Index::integer(), Col::integer(), Label::string(), [Option]) -> integer() -%% Option = {imageId, integer()} %% @doc See external documentation. +-spec setItem(This, Index, Col, Label, [Option]) -> integer() when + This::wxListCtrl(), Index::integer(), Col::integer(), Label::string(), + Option :: {imageId, integer()}. setItem(#wx_ref{type=ThisT,ref=ThisRef},Index,Col,Label, Options) when is_integer(Index),is_integer(Col),is_list(Label),is_list(Options) -> ?CLASS(ThisT,wxListCtrl), @@ -633,32 +680,36 @@ setItem(#wx_ref{type=ThisT,ref=ThisRef},Index,Col,Label, Options) wxe_util:call(?wxListCtrl_SetItem_4, <>). -%% @spec (This::wxListCtrl(), Item::integer(), Col::wx:colour()) -> ok %% @doc See external documentation. +-spec setItemBackgroundColour(This, Item, Col) -> ok when + This::wxListCtrl(), Item::integer(), Col::wx:wx_colour(). setItemBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Item,Col) when is_integer(Item),tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxListCtrl), wxe_util:cast(?wxListCtrl_SetItemBackgroundColour, <>). -%% @spec (This::wxListCtrl(), Count::integer()) -> ok %% @doc See external documentation. +-spec setItemCount(This, Count) -> ok when + This::wxListCtrl(), Count::integer(). setItemCount(#wx_ref{type=ThisT,ref=ThisRef},Count) when is_integer(Count) -> ?CLASS(ThisT,wxListCtrl), wxe_util:cast(?wxListCtrl_SetItemCount, <>). -%% @spec (This::wxListCtrl(), Item::integer(), Data::integer()) -> bool() %% @doc See external documentation. +-spec setItemData(This, Item, Data) -> boolean() when + This::wxListCtrl(), Item::integer(), Data::integer(). setItemData(#wx_ref{type=ThisT,ref=ThisRef},Item,Data) when is_integer(Item),is_integer(Data) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_SetItemData, <>). -%% @spec (This::wxListCtrl(), Item::integer(), F::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setItemFont(This, Item, F) -> ok when + This::wxListCtrl(), Item::integer(), F::wxFont:wxFont(). setItemFont(#wx_ref{type=ThisT,ref=ThisRef},Item,#wx_ref{type=FT,ref=FRef}) when is_integer(Item) -> ?CLASS(ThisT,wxListCtrl), @@ -666,15 +717,18 @@ setItemFont(#wx_ref{type=ThisT,ref=ThisRef},Item,#wx_ref{type=FT,ref=FRef}) wxe_util:cast(?wxListCtrl_SetItemFont, <>). -%% @spec (This::wxListCtrl(), Item::integer(), Image::integer()) -> bool() %% @equiv setItemImage(This,Item,Image, []) +-spec setItemImage(This, Item, Image) -> boolean() when + This::wxListCtrl(), Item::integer(), Image::integer(). + setItemImage(This,Item,Image) when is_record(This, wx_ref),is_integer(Item),is_integer(Image) -> setItemImage(This,Item,Image, []). -%% @spec (This::wxListCtrl(), Item::integer(), Image::integer(), [Option]) -> bool() -%% Option = {selImage, integer()} %% @doc See external documentation. +-spec setItemImage(This, Item, Image, [Option]) -> boolean() when + This::wxListCtrl(), Item::integer(), Image::integer(), + Option :: {selImage, integer()}. setItemImage(#wx_ref{type=ThisT,ref=ThisRef},Item,Image, Options) when is_integer(Item),is_integer(Image),is_list(Options) -> ?CLASS(ThisT,wxListCtrl), @@ -684,32 +738,36 @@ setItemImage(#wx_ref{type=ThisT,ref=ThisRef},Item,Image, Options) wxe_util:call(?wxListCtrl_SetItemImage, <>). -%% @spec (This::wxListCtrl(), Item::integer(), Column::integer(), Image::integer()) -> bool() %% @doc See external documentation. +-spec setItemColumnImage(This, Item, Column, Image) -> boolean() when + This::wxListCtrl(), Item::integer(), Column::integer(), Image::integer(). setItemColumnImage(#wx_ref{type=ThisT,ref=ThisRef},Item,Column,Image) when is_integer(Item),is_integer(Column),is_integer(Image) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_SetItemColumnImage, <>). -%% @spec (This::wxListCtrl(), Item::integer(), Pos::{X::integer(), Y::integer()}) -> bool() %% @doc See external documentation. +-spec setItemPosition(This, Item, Pos) -> boolean() when + This::wxListCtrl(), Item::integer(), Pos::{X::integer(), Y::integer()}. setItemPosition(#wx_ref{type=ThisT,ref=ThisRef},Item,{PosX,PosY}) when is_integer(Item),is_integer(PosX),is_integer(PosY) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_SetItemPosition, <>). -%% @spec (This::wxListCtrl(), Item::integer(), State::integer(), StateMask::integer()) -> bool() %% @doc See external documentation. +-spec setItemState(This, Item, State, StateMask) -> boolean() when + This::wxListCtrl(), Item::integer(), State::integer(), StateMask::integer(). setItemState(#wx_ref{type=ThisT,ref=ThisRef},Item,State,StateMask) when is_integer(Item),is_integer(State),is_integer(StateMask) -> ?CLASS(ThisT,wxListCtrl), wxe_util:call(?wxListCtrl_SetItemState, <>). -%% @spec (This::wxListCtrl(), Item::integer(), Str::string()) -> ok %% @doc See external documentation. +-spec setItemText(This, Item, Str) -> ok when + This::wxListCtrl(), Item::integer(), Str::string(). setItemText(#wx_ref{type=ThisT,ref=ThisRef},Item,Str) when is_integer(Item),is_list(Str) -> ?CLASS(ThisT,wxListCtrl), @@ -717,23 +775,27 @@ setItemText(#wx_ref{type=ThisT,ref=ThisRef},Item,Str) wxe_util:cast(?wxListCtrl_SetItemText, <>). -%% @spec (This::wxListCtrl(), Item::integer(), Col::wx:colour()) -> ok %% @doc See external documentation. +-spec setItemTextColour(This, Item, Col) -> ok when + This::wxListCtrl(), Item::integer(), Col::wx:wx_colour(). setItemTextColour(#wx_ref{type=ThisT,ref=ThisRef},Item,Col) when is_integer(Item),tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxListCtrl), wxe_util:cast(?wxListCtrl_SetItemTextColour, <>). -%% @spec (This::wxListCtrl(), Style::integer()) -> ok %% @equiv setSingleStyle(This,Style, []) +-spec setSingleStyle(This, Style) -> ok when + This::wxListCtrl(), Style::integer(). + setSingleStyle(This,Style) when is_record(This, wx_ref),is_integer(Style) -> setSingleStyle(This,Style, []). -%% @spec (This::wxListCtrl(), Style::integer(), [Option]) -> ok -%% Option = {add, bool()} %% @doc See external documentation. +-spec setSingleStyle(This, Style, [Option]) -> ok when + This::wxListCtrl(), Style::integer(), + Option :: {add, boolean()}. setSingleStyle(#wx_ref{type=ThisT,ref=ThisRef},Style, Options) when is_integer(Style),is_list(Options) -> ?CLASS(ThisT,wxListCtrl), @@ -743,16 +805,18 @@ setSingleStyle(#wx_ref{type=ThisT,ref=ThisRef},Style, Options) wxe_util:cast(?wxListCtrl_SetSingleStyle, <>). -%% @spec (This::wxListCtrl(), Col::wx:colour()) -> ok %% @doc See external documentation. +-spec setTextColour(This, Col) -> ok when + This::wxListCtrl(), Col::wx:wx_colour(). setTextColour(#wx_ref{type=ThisT,ref=ThisRef},Col) when tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxListCtrl), wxe_util:cast(?wxListCtrl_SetTextColour, <>). -%% @spec (This::wxListCtrl(), Style::integer()) -> ok %% @doc See external documentation. +-spec setWindowStyleFlag(This, Style) -> ok when + This::wxListCtrl(), Style::integer(). setWindowStyleFlag(#wx_ref{type=ThisT,ref=ThisRef},Style) when is_integer(Style) -> ?CLASS(ThisT,wxListCtrl), @@ -777,8 +841,8 @@ sortItems(#wx_ref{type=ThisT,ref=ThisRef}, SortCallBack) end, SortId = wxe_util:get_cbId(Sort), wxe_util:call(?wxListCtrl_SortItems, <>). -%% @spec (This::wxListCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxListCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxListCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxListEvent.erl b/lib/wx/src/gen/wxListEvent.erl index f7d8658acc..f09dee4e32 100644 --- a/lib/wx/src/gen/wxListEvent.erl +++ b/lib/wx/src/gen/wxListEvent.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 @@ -42,98 +42,113 @@ isSelection/1,parent_class/1,resumePropagation/2,setInt/2,setString/2, shouldPropagate/1,skip/1,skip/2,stopPropagation/1,veto/1]). +-export_type([wxListEvent/0]). %% @hidden parent_class(wxNotifyEvent) -> true; parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxListEvent()) -> integer() +-type wxListEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getCacheFrom(This) -> integer() when + This::wxListEvent(). getCacheFrom(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetCacheFrom, <>). -%% @spec (This::wxListEvent()) -> integer() %% @doc See external documentation. +-spec getCacheTo(This) -> integer() when + This::wxListEvent(). getCacheTo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetCacheTo, <>). -%% @spec (This::wxListEvent()) -> integer() %% @doc See external documentation. +-spec getKeyCode(This) -> integer() when + This::wxListEvent(). getKeyCode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetKeyCode, <>). -%% @spec (This::wxListEvent()) -> integer() %% @doc See external documentation. +-spec getIndex(This) -> integer() when + This::wxListEvent(). getIndex(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetIndex, <>). -%% @spec (This::wxListEvent()) -> integer() %% @doc See external documentation. +-spec getColumn(This) -> integer() when + This::wxListEvent(). getColumn(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetColumn, <>). -%% @spec (This::wxListEvent()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPoint(This) -> {X::integer(), Y::integer()} when + This::wxListEvent(). getPoint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetPoint, <>). -%% @spec (This::wxListEvent()) -> string() %% @doc See external documentation. +-spec getLabel(This) -> string() when + This::wxListEvent(). getLabel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetLabel, <>). -%% @spec (This::wxListEvent()) -> string() %% @doc See external documentation. +-spec getText(This) -> string() when + This::wxListEvent(). getText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetText, <>). -%% @spec (This::wxListEvent()) -> integer() %% @doc See external documentation. +-spec getImage(This) -> integer() when + This::wxListEvent(). getImage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetImage, <>). -%% @spec (This::wxListEvent()) -> integer() %% @doc See external documentation. +-spec getData(This) -> integer() when + This::wxListEvent(). getData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetData, <>). -%% @spec (This::wxListEvent()) -> integer() %% @doc See external documentation. +-spec getMask(This) -> integer() when + This::wxListEvent(). getMask(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetMask, <>). -%% @spec (This::wxListEvent()) -> wxListItem:wxListItem() %% @doc See external documentation. +-spec getItem(This) -> wxListItem:wxListItem() when + This::wxListEvent(). getItem(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_GetItem, <>). -%% @spec (This::wxListEvent()) -> bool() %% @doc See external documentation. +-spec isEditCancelled(This) -> boolean() when + This::wxListEvent(). isEditCancelled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListEvent), wxe_util:call(?wxListEvent_IsEditCancelled, diff --git a/lib/wx/src/gen/wxListItem.erl b/lib/wx/src/gen/wxListItem.erl index 326f674b28..f5662f8942 100644 --- a/lib/wx/src/gen/wxListItem.erl +++ b/lib/wx/src/gen/wxListItem.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 @@ -33,184 +33,207 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxListItem/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxListItem() +-type wxListItem() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxListItem(). new() -> wxe_util:construct(?wxListItem_new_0, <<>>). -%% @spec (Item::wxListItem()) -> wxListItem() %% @doc See external documentation. +-spec new(Item) -> wxListItem() when + Item::wxListItem(). new(#wx_ref{type=ItemT,ref=ItemRef}) -> ?CLASS(ItemT,wxListItem), wxe_util:construct(?wxListItem_new_1, <>). -%% @spec (This::wxListItem()) -> ok %% @doc See external documentation. +-spec clear(This) -> ok when + This::wxListItem(). clear(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_Clear, <>). -%% @spec (This::wxListItem()) -> WxListColumnFormat -%% WxListColumnFormat = integer() %% @doc See external documentation. -%%
WxListColumnFormat is one of ?wxLIST_FORMAT_LEFT | ?wxLIST_FORMAT_RIGHT | ?wxLIST_FORMAT_CENTRE | ?wxLIST_FORMAT_CENTER +%%
Res = ?wxLIST_FORMAT_LEFT | ?wxLIST_FORMAT_RIGHT | ?wxLIST_FORMAT_CENTRE | ?wxLIST_FORMAT_CENTER +-spec getAlign(This) -> wx:wx_enum() when + This::wxListItem(). getAlign(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetAlign, <>). -%% @spec (This::wxListItem()) -> wx:colour() %% @doc See external documentation. +-spec getBackgroundColour(This) -> wx:wx_colour() when + This::wxListItem(). getBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetBackgroundColour, <>). -%% @spec (This::wxListItem()) -> integer() %% @doc See external documentation. +-spec getColumn(This) -> integer() when + This::wxListItem(). getColumn(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetColumn, <>). -%% @spec (This::wxListItem()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getFont(This) -> wxFont:wxFont() when + This::wxListItem(). getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetFont, <>). -%% @spec (This::wxListItem()) -> integer() %% @doc See external documentation. +-spec getId(This) -> integer() when + This::wxListItem(). getId(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetId, <>). -%% @spec (This::wxListItem()) -> integer() %% @doc See external documentation. +-spec getImage(This) -> integer() when + This::wxListItem(). getImage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetImage, <>). -%% @spec (This::wxListItem()) -> integer() %% @doc See external documentation. +-spec getMask(This) -> integer() when + This::wxListItem(). getMask(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetMask, <>). -%% @spec (This::wxListItem()) -> integer() %% @doc See external documentation. +-spec getState(This) -> integer() when + This::wxListItem(). getState(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetState, <>). -%% @spec (This::wxListItem()) -> string() %% @doc See external documentation. +-spec getText(This) -> string() when + This::wxListItem(). getText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetText, <>). -%% @spec (This::wxListItem()) -> wx:colour() %% @doc See external documentation. +-spec getTextColour(This) -> wx:wx_colour() when + This::wxListItem(). getTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetTextColour, <>). -%% @spec (This::wxListItem()) -> integer() %% @doc See external documentation. +-spec getWidth(This) -> integer() when + This::wxListItem(). getWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItem), wxe_util:call(?wxListItem_GetWidth, <>). -%% @spec (This::wxListItem(), Align::WxListColumnFormat) -> ok -%% WxListColumnFormat = integer() %% @doc See external documentation. -%%
WxListColumnFormat is one of ?wxLIST_FORMAT_LEFT | ?wxLIST_FORMAT_RIGHT | ?wxLIST_FORMAT_CENTRE | ?wxLIST_FORMAT_CENTER +%%
Align = ?wxLIST_FORMAT_LEFT | ?wxLIST_FORMAT_RIGHT | ?wxLIST_FORMAT_CENTRE | ?wxLIST_FORMAT_CENTER +-spec setAlign(This, Align) -> ok when + This::wxListItem(), Align::wx:wx_enum(). setAlign(#wx_ref{type=ThisT,ref=ThisRef},Align) when is_integer(Align) -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetAlign, <>). -%% @spec (This::wxListItem(), ColBack::wx:colour()) -> ok %% @doc See external documentation. +-spec setBackgroundColour(This, ColBack) -> ok when + This::wxListItem(), ColBack::wx:wx_colour(). setBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},ColBack) when tuple_size(ColBack) =:= 3; tuple_size(ColBack) =:= 4 -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetBackgroundColour, <>). -%% @spec (This::wxListItem(), Col::integer()) -> ok %% @doc See external documentation. +-spec setColumn(This, Col) -> ok when + This::wxListItem(), Col::integer(). setColumn(#wx_ref{type=ThisT,ref=ThisRef},Col) when is_integer(Col) -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetColumn, <>). -%% @spec (This::wxListItem(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setFont(This, Font) -> ok when + This::wxListItem(), Font::wxFont:wxFont(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxListItem), ?CLASS(FontT,wxFont), wxe_util:cast(?wxListItem_SetFont, <>). -%% @spec (This::wxListItem(), Id::integer()) -> ok %% @doc See external documentation. +-spec setId(This, Id) -> ok when + This::wxListItem(), Id::integer(). setId(#wx_ref{type=ThisT,ref=ThisRef},Id) when is_integer(Id) -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetId, <>). -%% @spec (This::wxListItem(), Image::integer()) -> ok %% @doc See external documentation. +-spec setImage(This, Image) -> ok when + This::wxListItem(), Image::integer(). setImage(#wx_ref{type=ThisT,ref=ThisRef},Image) when is_integer(Image) -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetImage, <>). -%% @spec (This::wxListItem(), Mask::integer()) -> ok %% @doc See external documentation. +-spec setMask(This, Mask) -> ok when + This::wxListItem(), Mask::integer(). setMask(#wx_ref{type=ThisT,ref=ThisRef},Mask) when is_integer(Mask) -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetMask, <>). -%% @spec (This::wxListItem(), State::integer()) -> ok %% @doc See external documentation. +-spec setState(This, State) -> ok when + This::wxListItem(), State::integer(). setState(#wx_ref{type=ThisT,ref=ThisRef},State) when is_integer(State) -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetState, <>). -%% @spec (This::wxListItem(), StateMask::integer()) -> ok %% @doc See external documentation. +-spec setStateMask(This, StateMask) -> ok when + This::wxListItem(), StateMask::integer(). setStateMask(#wx_ref{type=ThisT,ref=ThisRef},StateMask) when is_integer(StateMask) -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetStateMask, <>). -%% @spec (This::wxListItem(), Text::string()) -> ok %% @doc See external documentation. +-spec setText(This, Text) -> ok when + This::wxListItem(), Text::string(). setText(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxListItem), @@ -218,24 +241,26 @@ setText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxListItem_SetText, <>). -%% @spec (This::wxListItem(), ColText::wx:colour()) -> ok %% @doc See external documentation. +-spec setTextColour(This, ColText) -> ok when + This::wxListItem(), ColText::wx:wx_colour(). setTextColour(#wx_ref{type=ThisT,ref=ThisRef},ColText) when tuple_size(ColText) =:= 3; tuple_size(ColText) =:= 4 -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetTextColour, <>). -%% @spec (This::wxListItem(), Width::integer()) -> ok %% @doc See external documentation. +-spec setWidth(This, Width) -> ok when + This::wxListItem(), Width::integer(). setWidth(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxListItem), wxe_util:cast(?wxListItem_SetWidth, <>). -%% @spec (This::wxListItem()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxListItem) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxListItem), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxListItemAttr.erl b/lib/wx/src/gen/wxListItemAttr.erl index 1a43c71854..4616e551ec 100644 --- a/lib/wx/src/gen/wxListItemAttr.erl +++ b/lib/wx/src/gen/wxListItemAttr.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 @@ -31,91 +31,103 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxListItemAttr/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxListItemAttr() +-type wxListItemAttr() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxListItemAttr(). new() -> wxe_util:construct(?wxListItemAttr_new_0, <<>>). -%% @spec (ColText::wx:colour(), ColBack::wx:colour(), Font::wxFont:wxFont()) -> wxListItemAttr() %% @doc See external documentation. +-spec new(ColText, ColBack, Font) -> wxListItemAttr() when + ColText::wx:wx_colour(), ColBack::wx:wx_colour(), Font::wxFont:wxFont(). new(ColText,ColBack,#wx_ref{type=FontT,ref=FontRef}) when tuple_size(ColText) =:= 3; tuple_size(ColText) =:= 4,tuple_size(ColBack) =:= 3; tuple_size(ColBack) =:= 4 -> ?CLASS(FontT,wxFont), wxe_util:construct(?wxListItemAttr_new_3, <<(wxe_util:colour_bin(ColText)):16/binary,(wxe_util:colour_bin(ColBack)):16/binary,FontRef:32/?UI>>). -%% @spec (This::wxListItemAttr()) -> wx:colour() %% @doc See external documentation. +-spec getBackgroundColour(This) -> wx:wx_colour() when + This::wxListItemAttr(). getBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItemAttr), wxe_util:call(?wxListItemAttr_GetBackgroundColour, <>). -%% @spec (This::wxListItemAttr()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getFont(This) -> wxFont:wxFont() when + This::wxListItemAttr(). getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItemAttr), wxe_util:call(?wxListItemAttr_GetFont, <>). -%% @spec (This::wxListItemAttr()) -> wx:colour() %% @doc See external documentation. +-spec getTextColour(This) -> wx:wx_colour() when + This::wxListItemAttr(). getTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItemAttr), wxe_util:call(?wxListItemAttr_GetTextColour, <>). -%% @spec (This::wxListItemAttr()) -> bool() %% @doc See external documentation. +-spec hasBackgroundColour(This) -> boolean() when + This::wxListItemAttr(). hasBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItemAttr), wxe_util:call(?wxListItemAttr_HasBackgroundColour, <>). -%% @spec (This::wxListItemAttr()) -> bool() %% @doc See external documentation. +-spec hasFont(This) -> boolean() when + This::wxListItemAttr(). hasFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItemAttr), wxe_util:call(?wxListItemAttr_HasFont, <>). -%% @spec (This::wxListItemAttr()) -> bool() %% @doc See external documentation. +-spec hasTextColour(This) -> boolean() when + This::wxListItemAttr(). hasTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListItemAttr), wxe_util:call(?wxListItemAttr_HasTextColour, <>). -%% @spec (This::wxListItemAttr(), ColBack::wx:colour()) -> ok %% @doc See external documentation. +-spec setBackgroundColour(This, ColBack) -> ok when + This::wxListItemAttr(), ColBack::wx:wx_colour(). setBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},ColBack) when tuple_size(ColBack) =:= 3; tuple_size(ColBack) =:= 4 -> ?CLASS(ThisT,wxListItemAttr), wxe_util:cast(?wxListItemAttr_SetBackgroundColour, <>). -%% @spec (This::wxListItemAttr(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setFont(This, Font) -> ok when + This::wxListItemAttr(), Font::wxFont:wxFont(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxListItemAttr), ?CLASS(FontT,wxFont), wxe_util:cast(?wxListItemAttr_SetFont, <>). -%% @spec (This::wxListItemAttr(), ColText::wx:colour()) -> ok %% @doc See external documentation. +-spec setTextColour(This, ColText) -> ok when + This::wxListItemAttr(), ColText::wx:wx_colour(). setTextColour(#wx_ref{type=ThisT,ref=ThisRef},ColText) when tuple_size(ColText) =:= 3; tuple_size(ColText) =:= 4 -> ?CLASS(ThisT,wxListItemAttr), wxe_util:cast(?wxListItemAttr_SetTextColour, <>). -%% @spec (This::wxListItemAttr()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxListItemAttr) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxListItemAttr), wxe_util:destroy(?wxListItemAttr_destroy,Obj), diff --git a/lib/wx/src/gen/wxListView.erl b/lib/wx/src/gen/wxListView.erl index 95a233a562..87cc28cd15 100644 --- a/lib/wx/src/gen/wxListView.erl +++ b/lib/wx/src/gen/wxListView.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 @@ -70,67 +70,78 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxListView/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxListView(), Col::integer()) -> ok +-type wxListView() :: wx:wx_object(). %% @doc See external documentation. +-spec clearColumnImage(This, Col) -> ok when + This::wxListView(), Col::integer(). clearColumnImage(#wx_ref{type=ThisT,ref=ThisRef},Col) when is_integer(Col) -> ?CLASS(ThisT,wxListView), wxe_util:cast(?wxListView_ClearColumnImage, <>). -%% @spec (This::wxListView(), Index::integer()) -> ok %% @doc See external documentation. +-spec focus(This, Index) -> ok when + This::wxListView(), Index::integer(). focus(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxListView), wxe_util:cast(?wxListView_Focus, <>). -%% @spec (This::wxListView()) -> integer() %% @doc See external documentation. +-spec getFirstSelected(This) -> integer() when + This::wxListView(). getFirstSelected(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListView), wxe_util:call(?wxListView_GetFirstSelected, <>). -%% @spec (This::wxListView()) -> integer() %% @doc See external documentation. +-spec getFocusedItem(This) -> integer() when + This::wxListView(). getFocusedItem(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListView), wxe_util:call(?wxListView_GetFocusedItem, <>). -%% @spec (This::wxListView(), Item::integer()) -> integer() %% @doc See external documentation. +-spec getNextSelected(This, Item) -> integer() when + This::wxListView(), Item::integer(). getNextSelected(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxListView), wxe_util:call(?wxListView_GetNextSelected, <>). -%% @spec (This::wxListView(), Index::integer()) -> bool() %% @doc See external documentation. +-spec isSelected(This, Index) -> boolean() when + This::wxListView(), Index::integer(). isSelected(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxListView), wxe_util:call(?wxListView_IsSelected, <>). -%% @spec (This::wxListView(), N::integer()) -> ok %% @equiv select(This,N, []) +-spec select(This, N) -> ok when + This::wxListView(), N::integer(). + select(This,N) when is_record(This, wx_ref),is_integer(N) -> select(This,N, []). -%% @spec (This::wxListView(), N::integer(), [Option]) -> ok -%% Option = {on, bool()} %% @doc See external documentation. +-spec select(This, N, [Option]) -> ok when + This::wxListView(), N::integer(), + Option :: {on, boolean()}. select(#wx_ref{type=ThisT,ref=ThisRef},N, Options) when is_integer(N),is_list(Options) -> ?CLASS(ThisT,wxListView), @@ -140,8 +151,9 @@ select(#wx_ref{type=ThisT,ref=ThisRef},N, Options) wxe_util:cast(?wxListView_Select, <>). -%% @spec (This::wxListView(), Col::integer(), Image::integer()) -> ok %% @doc See external documentation. +-spec setColumnImage(This, Col, Image) -> ok when + This::wxListView(), Col::integer(), Image::integer(). setColumnImage(#wx_ref{type=ThisT,ref=ThisRef},Col,Image) when is_integer(Col),is_integer(Image) -> ?CLASS(ThisT,wxListView), diff --git a/lib/wx/src/gen/wxListbook.erl b/lib/wx/src/gen/wxListbook.erl index c204dc87a1..bacc615004 100644 --- a/lib/wx/src/gen/wxListbook.erl +++ b/lib/wx/src/gen/wxListbook.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2011. All Rights Reserved. +%% Copyright Ericsson AB 2009-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([wxListbook/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxListbook() +-type wxListbook() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxListbook(). new() -> wxe_util:construct(?wxListbook_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxListbook() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxListbook() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxListbook() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxListbook() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -106,15 +113,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxListbook_new_3, <>). -%% @spec (This::wxListbook(), Page::wxWindow:wxWindow(), Text::string()) -> bool() %% @equiv addPage(This,Page,Text, []) +-spec addPage(This, Page, Text) -> boolean() when + This::wxListbook(), 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::wxListbook(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool() -%% Option = {bSelect, bool()} | {imageId, integer()} %% @doc See external documentation. +-spec addPage(This, Page, Text, [Option]) -> boolean() when + This::wxListbook(), 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,wxListbook), @@ -127,15 +138,18 @@ addPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageT,ref=PageRef},Text, Op wxe_util:call(?wxListbook_AddPage, <>). -%% @spec (This::wxListbook()) -> ok %% @equiv advanceSelection(This, []) +-spec advanceSelection(This) -> ok when + This::wxListbook(). + advanceSelection(This) when is_record(This, wx_ref) -> advanceSelection(This, []). -%% @spec (This::wxListbook(), [Option]) -> ok -%% Option = {forward, bool()} %% @doc See external documentation. +-spec advanceSelection(This, [Option]) -> ok when + This::wxListbook(), + Option :: {forward, boolean()}. advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxListbook), @@ -145,23 +159,29 @@ advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxListbook_AdvanceSelection, <>). -%% @spec (This::wxListbook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec assignImageList(This, ImageList) -> ok when + This::wxListbook(), ImageList::wxImageList:wxImageList(). assignImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxListbook), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxListbook_AssignImageList, <>). -%% @spec (This::wxListbook(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxListbook(), 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::wxListbook(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxListbook(), 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,wxListbook), @@ -174,98 +194,114 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxListbook_Create, <>). -%% @spec (This::wxListbook()) -> bool() %% @doc See external documentation. +-spec deleteAllPages(This) -> boolean() when + This::wxListbook(). deleteAllPages(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_DeleteAllPages, <>). -%% @spec (This::wxListbook(), N::integer()) -> bool() %% @doc See external documentation. +-spec deletePage(This, N) -> boolean() when + This::wxListbook(), N::integer(). deletePage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_DeletePage, <>). -%% @spec (This::wxListbook(), N::integer()) -> bool() %% @doc See external documentation. +-spec removePage(This, N) -> boolean() when + This::wxListbook(), N::integer(). removePage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_RemovePage, <>). -%% @spec (This::wxListbook()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getCurrentPage(This) -> wxWindow:wxWindow() when + This::wxListbook(). getCurrentPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_GetCurrentPage, <>). -%% @spec (This::wxListbook()) -> wxImageList:wxImageList() %% @doc See external documentation. +-spec getImageList(This) -> wxImageList:wxImageList() when + This::wxListbook(). getImageList(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_GetImageList, <>). -%% @spec (This::wxListbook(), N::integer()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getPage(This, N) -> wxWindow:wxWindow() when + This::wxListbook(), N::integer(). getPage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_GetPage, <>). -%% @spec (This::wxListbook()) -> integer() %% @doc See external documentation. +-spec getPageCount(This) -> integer() when + This::wxListbook(). getPageCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_GetPageCount, <>). -%% @spec (This::wxListbook(), N::integer()) -> integer() %% @doc See external documentation. +-spec getPageImage(This, N) -> integer() when + This::wxListbook(), N::integer(). getPageImage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_GetPageImage, <>). -%% @spec (This::wxListbook(), N::integer()) -> string() %% @doc See external documentation. +-spec getPageText(This, N) -> string() when + This::wxListbook(), N::integer(). getPageText(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_GetPageText, <>). -%% @spec (This::wxListbook()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxListbook(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_GetSelection, <>). -%% @spec (This::wxListbook(), Pt::{X::integer(), Y::integer()}) -> {integer(), Flags::integer()} %% @doc See external documentation. +-spec hitTest(This, Pt) -> Result when + Result ::{Res ::integer(), Flags::integer()}, + This::wxListbook(), Pt::{X::integer(), Y::integer()}. hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_HitTest, <>). -%% @spec (This::wxListbook(), N::integer(), Page::wxWindow:wxWindow(), Text::string()) -> bool() %% @equiv insertPage(This,N,Page,Text, []) +-spec insertPage(This, N, Page, Text) -> boolean() when + This::wxListbook(), N::integer(), Page::wxWindow:wxWindow(), Text::string(). + insertPage(This,N,Page,Text) when is_record(This, wx_ref),is_integer(N),is_record(Page, wx_ref),is_list(Text) -> insertPage(This,N,Page,Text, []). -%% @spec (This::wxListbook(), N::integer(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool() -%% Option = {bSelect, bool()} | {imageId, integer()} %% @doc See external documentation. +-spec insertPage(This, N, Page, Text, [Option]) -> boolean() when + This::wxListbook(), N::integer(), Page::wxWindow:wxWindow(), Text::string(), + Option :: {bSelect, boolean()} + | {imageId, integer()}. insertPage(#wx_ref{type=ThisT,ref=ThisRef},N,#wx_ref{type=PageT,ref=PageRef},Text, Options) when is_integer(N),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxListbook), @@ -278,32 +314,36 @@ insertPage(#wx_ref{type=ThisT,ref=ThisRef},N,#wx_ref{type=PageT,ref=PageRef},Tex wxe_util:call(?wxListbook_InsertPage, <>). -%% @spec (This::wxListbook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec setImageList(This, ImageList) -> ok when + This::wxListbook(), ImageList::wxImageList:wxImageList(). setImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxListbook), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxListbook_SetImageList, <>). -%% @spec (This::wxListbook(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setPageSize(This, Size) -> ok when + This::wxListbook(), Size::{W::integer(), H::integer()}. setPageSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxListbook), wxe_util:cast(?wxListbook_SetPageSize, <>). -%% @spec (This::wxListbook(), N::integer(), ImageId::integer()) -> bool() %% @doc See external documentation. +-spec setPageImage(This, N, ImageId) -> boolean() when + This::wxListbook(), N::integer(), ImageId::integer(). setPageImage(#wx_ref{type=ThisT,ref=ThisRef},N,ImageId) when is_integer(N),is_integer(ImageId) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_SetPageImage, <>). -%% @spec (This::wxListbook(), N::integer(), StrText::string()) -> bool() %% @doc See external documentation. +-spec setPageText(This, N, StrText) -> boolean() when + This::wxListbook(), N::integer(), StrText::string(). setPageText(#wx_ref{type=ThisT,ref=ThisRef},N,StrText) when is_integer(N),is_list(StrText) -> ?CLASS(ThisT,wxListbook), @@ -311,24 +351,26 @@ setPageText(#wx_ref{type=ThisT,ref=ThisRef},N,StrText) wxe_util:call(?wxListbook_SetPageText, <>). -%% @spec (This::wxListbook(), N::integer()) -> integer() %% @doc See external documentation. +-spec setSelection(This, N) -> integer() when + This::wxListbook(), N::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_SetSelection, <>). -%% @spec (This::wxListbook(), N::integer()) -> integer() %% @doc See external documentation. +-spec changeSelection(This, N) -> integer() when + This::wxListbook(), N::integer(). changeSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxListbook), wxe_util:call(?wxListbook_ChangeSelection, <>). -%% @spec (This::wxListbook()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxListbook) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxListbook), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxLogNull.erl b/lib/wx/src/gen/wxLogNull.erl index 676fdf6d85..fb53e0d151 100644 --- a/lib/wx/src/gen/wxLogNull.erl +++ b/lib/wx/src/gen/wxLogNull.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -29,17 +29,19 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxLogNull/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxLogNull() +-type wxLogNull() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxLogNull(). new() -> wxe_util:construct(?wxLogNull_new, <<>>). -%% @spec (This::wxLogNull()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxLogNull) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxLogNull), wxe_util:destroy(?wxLogNull_destroy,Obj), diff --git a/lib/wx/src/gen/wxMDIChildFrame.erl b/lib/wx/src/gen/wxMDIChildFrame.erl index d3e1edda55..6b9905b72b 100644 --- a/lib/wx/src/gen/wxMDIChildFrame.erl +++ b/lib/wx/src/gen/wxMDIChildFrame.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 @@ -80,6 +80,7 @@ thaw/1,transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxMDIChildFrame/0]). %% @hidden parent_class(wxFrame) -> true; parent_class(wxTopLevelWindow) -> true; @@ -87,21 +88,27 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMDIChildFrame() +-type wxMDIChildFrame() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxMDIChildFrame(). new() -> wxe_util:construct(?wxMDIChildFrame_new_0, <<>>). -%% @spec (Parent::wxMDIParentFrame:wxMDIParentFrame(), Id::integer(), Title::string()) -> wxMDIChildFrame() %% @equiv new(Parent,Id,Title, []) +-spec new(Parent, Id, Title) -> wxMDIChildFrame() when + Parent::wxMDIParentFrame:wxMDIParentFrame(), Id::integer(), Title::string(). + new(Parent,Id,Title) when is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> new(Parent,Id,Title, []). -%% @spec (Parent::wxMDIParentFrame:wxMDIParentFrame(), Id::integer(), Title::string(), [Option]) -> wxMDIChildFrame() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, Title, [Option]) -> wxMDIChildFrame() when + Parent::wxMDIParentFrame:wxMDIParentFrame(), Id::integer(), Title::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ParentT,wxMDIParentFrame), @@ -114,22 +121,28 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) wxe_util:construct(?wxMDIChildFrame_new_4, <>). -%% @spec (This::wxMDIChildFrame()) -> ok %% @doc See external documentation. +-spec activate(This) -> ok when + This::wxMDIChildFrame(). activate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMDIChildFrame), wxe_util:cast(?wxMDIChildFrame_Activate, <>). -%% @spec (This::wxMDIChildFrame(), Parent::wxMDIParentFrame:wxMDIParentFrame(), Id::integer(), Title::string()) -> bool() %% @equiv create(This,Parent,Id,Title, []) +-spec create(This, Parent, Id, Title) -> boolean() when + This::wxMDIChildFrame(), Parent::wxMDIParentFrame:wxMDIParentFrame(), Id::integer(), Title::string(). + create(This,Parent,Id,Title) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> create(This,Parent,Id,Title, []). -%% @spec (This::wxMDIChildFrame(), Parent::wxMDIParentFrame:wxMDIParentFrame(), Id::integer(), Title::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, Title, [Option]) -> boolean() when + This::wxMDIChildFrame(), Parent::wxMDIParentFrame:wxMDIParentFrame(), Id::integer(), Title::string(), + 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,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ThisT,wxMDIChildFrame), @@ -143,15 +156,18 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Ti wxe_util:call(?wxMDIChildFrame_Create, <>). -%% @spec (This::wxMDIChildFrame()) -> ok %% @equiv maximize(This, []) +-spec maximize(This) -> ok when + This::wxMDIChildFrame(). + maximize(This) when is_record(This, wx_ref) -> maximize(This, []). -%% @spec (This::wxMDIChildFrame(), [Option]) -> ok -%% Option = {maximize, bool()} %% @doc See external documentation. +-spec maximize(This, [Option]) -> ok when + This::wxMDIChildFrame(), + Option :: {maximize, boolean()}. maximize(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMDIChildFrame), @@ -161,15 +177,16 @@ maximize(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxMDIChildFrame_Maximize, <>). -%% @spec (This::wxMDIChildFrame()) -> ok %% @doc See external documentation. +-spec restore(This) -> ok when + This::wxMDIChildFrame(). restore(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMDIChildFrame), wxe_util:cast(?wxMDIChildFrame_Restore, <>). -%% @spec (This::wxMDIChildFrame()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMDIChildFrame) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMDIChildFrame), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMDIClientWindow.erl b/lib/wx/src/gen/wxMDIClientWindow.erl index 79a11b4eb7..7399b8be26 100644 --- a/lib/wx/src/gen/wxMDIClientWindow.erl +++ b/lib/wx/src/gen/wxMDIClientWindow.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 @@ -68,26 +68,31 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxMDIClientWindow/0]). %% @hidden parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMDIClientWindow() +-type wxMDIClientWindow() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxMDIClientWindow(). new() -> wxe_util:construct(?wxMDIClientWindow_new_0, <<>>). -%% @spec (Parent::wxMDIParentFrame:wxMDIParentFrame()) -> wxMDIClientWindow() %% @equiv new(Parent, []) +-spec new(Parent) -> wxMDIClientWindow() when + Parent::wxMDIParentFrame:wxMDIParentFrame(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxMDIParentFrame:wxMDIParentFrame(), [Option]) -> wxMDIClientWindow() -%% Option = {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxMDIClientWindow() when + Parent::wxMDIParentFrame:wxMDIParentFrame(), + Option :: {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxMDIParentFrame), @@ -97,15 +102,18 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxMDIClientWindow_new_2, <>). -%% @spec (This::wxMDIClientWindow(), Parent::wxMDIParentFrame:wxMDIParentFrame()) -> bool() %% @equiv createClient(This,Parent, []) +-spec createClient(This, Parent) -> boolean() when + This::wxMDIClientWindow(), Parent::wxMDIParentFrame:wxMDIParentFrame(). + createClient(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> createClient(This,Parent, []). -%% @spec (This::wxMDIClientWindow(), Parent::wxMDIParentFrame:wxMDIParentFrame(), [Option]) -> bool() -%% Option = {style, integer()} %% @doc See external documentation. +-spec createClient(This, Parent, [Option]) -> boolean() when + This::wxMDIClientWindow(), Parent::wxMDIParentFrame:wxMDIParentFrame(), + Option :: {style, integer()}. createClient(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMDIClientWindow), @@ -116,8 +124,8 @@ createClient(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef} wxe_util:call(?wxMDIClientWindow_CreateClient, <>). -%% @spec (This::wxMDIClientWindow()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMDIClientWindow) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMDIClientWindow), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMDIParentFrame.erl b/lib/wx/src/gen/wxMDIParentFrame.erl index 7f8a305876..545d52c3cd 100644 --- a/lib/wx/src/gen/wxMDIParentFrame.erl +++ b/lib/wx/src/gen/wxMDIParentFrame.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 @@ -82,6 +82,7 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxMDIParentFrame/0]). %% @hidden parent_class(wxFrame) -> true; parent_class(wxTopLevelWindow) -> true; @@ -89,21 +90,27 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMDIParentFrame() +-type wxMDIParentFrame() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxMDIParentFrame(). new() -> wxe_util:construct(?wxMDIParentFrame_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string()) -> wxMDIParentFrame() %% @equiv new(Parent,Id,Title, []) +-spec new(Parent, Id, Title) -> wxMDIParentFrame() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(). + new(Parent,Id,Title) when is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> new(Parent,Id,Title, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), [Option]) -> wxMDIParentFrame() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, Title, [Option]) -> wxMDIParentFrame() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -116,43 +123,52 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) wxe_util:construct(?wxMDIParentFrame_new_4, <>). -%% @spec (This::wxMDIParentFrame()) -> ok %% @doc See external documentation. +-spec activateNext(This) -> ok when + This::wxMDIParentFrame(). activateNext(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMDIParentFrame), wxe_util:cast(?wxMDIParentFrame_ActivateNext, <>). -%% @spec (This::wxMDIParentFrame()) -> ok %% @doc See external documentation. +-spec activatePrevious(This) -> ok when + This::wxMDIParentFrame(). activatePrevious(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMDIParentFrame), wxe_util:cast(?wxMDIParentFrame_ActivatePrevious, <>). -%% @spec (This::wxMDIParentFrame()) -> ok %% @doc See external documentation. +-spec arrangeIcons(This) -> ok when + This::wxMDIParentFrame(). arrangeIcons(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMDIParentFrame), wxe_util:cast(?wxMDIParentFrame_ArrangeIcons, <>). -%% @spec (This::wxMDIParentFrame()) -> ok %% @doc See external documentation. +-spec cascade(This) -> ok when + This::wxMDIParentFrame(). cascade(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMDIParentFrame), wxe_util:cast(?wxMDIParentFrame_Cascade, <>). -%% @spec (This::wxMDIParentFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string()) -> bool() %% @equiv create(This,Parent,Id,Title, []) +-spec create(This, Parent, Id, Title) -> boolean() when + This::wxMDIParentFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(). + create(This,Parent,Id,Title) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> create(This,Parent,Id,Title, []). -%% @spec (This::wxMDIParentFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, Title, [Option]) -> boolean() when + This::wxMDIParentFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), + 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,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ThisT,wxMDIParentFrame), @@ -166,31 +182,35 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Ti wxe_util:call(?wxMDIParentFrame_Create, <>). -%% @spec (This::wxMDIParentFrame()) -> wxMDIChildFrame:wxMDIChildFrame() %% @doc See external documentation. +-spec getActiveChild(This) -> wxMDIChildFrame:wxMDIChildFrame() when + This::wxMDIParentFrame(). getActiveChild(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMDIParentFrame), wxe_util:call(?wxMDIParentFrame_GetActiveChild, <>). -%% @spec (This::wxMDIParentFrame()) -> wxMDIClientWindow:wxMDIClientWindow() %% @doc See external documentation. +-spec getClientWindow(This) -> wxMDIClientWindow:wxMDIClientWindow() when + This::wxMDIParentFrame(). getClientWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMDIParentFrame), wxe_util:call(?wxMDIParentFrame_GetClientWindow, <>). -%% @spec (This::wxMDIParentFrame()) -> ok %% @equiv tile(This, []) +-spec tile(This) -> ok when + This::wxMDIParentFrame(). + tile(This) when is_record(This, wx_ref) -> tile(This, []). -%% @spec (This::wxMDIParentFrame(), [Option]) -> ok -%% Option = {orient, WxOrientation} -%% WxOrientation = integer() %% @doc See external documentation. -%%
WxOrientation is one of ?wxHORIZONTAL | ?wxVERTICAL | ?wxBOTH +%%
Orient = ?wxHORIZONTAL | ?wxVERTICAL | ?wxBOTH +-spec tile(This, [Option]) -> ok when + This::wxMDIParentFrame(), + Option :: {orient, wx:wx_enum()}. tile(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMDIParentFrame), @@ -200,8 +220,8 @@ tile(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxMDIParentFrame_Tile, <>). -%% @spec (This::wxMDIParentFrame()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMDIParentFrame) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMDIParentFrame), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMask.erl b/lib/wx/src/gen/wxMask.erl index 3b5d3340ea..488cddc260 100644 --- a/lib/wx/src/gen/wxMask.erl +++ b/lib/wx/src/gen/wxMask.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 @@ -29,31 +29,30 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxMask/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMask() +-type wxMask() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxMask(). new() -> wxe_util:construct(?wxMask_new_0, <<>>). -%% @spec (Bitmap::wxBitmap:wxBitmap()) -> wxMask() %% @doc See external documentation. +-spec new(Bitmap) -> wxMask() when + Bitmap::wxBitmap:wxBitmap(). new(#wx_ref{type=BitmapT,ref=BitmapRef}) -> ?CLASS(BitmapT,wxBitmap), wxe_util:construct(?wxMask_new_1, <>). -%% @spec (Bitmap::wxBitmap:wxBitmap(),X::integer()|term()) -> wxMask() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Bitmap::wxBitmap:wxBitmap(), PaletteIndex::integer()) -> wxMask() -%%

-%%

-%% new(Bitmap::wxBitmap:wxBitmap(), Colour::wx:colour()) -> wxMask() -%%

+-spec new(Bitmap, PaletteIndex) -> wxMask() when + Bitmap::wxBitmap:wxBitmap(), PaletteIndex::integer(); + (Bitmap, Colour) -> wxMask() when + Bitmap::wxBitmap:wxBitmap(), Colour::wx:wx_colour(). new(#wx_ref{type=BitmapT,ref=BitmapRef},PaletteIndex) when is_integer(PaletteIndex) -> ?CLASS(BitmapT,wxBitmap), @@ -65,23 +64,20 @@ new(#wx_ref{type=BitmapT,ref=BitmapRef},Colour) wxe_util:construct(?wxMask_new_2_1, <>). -%% @spec (This::wxMask(), Bitmap::wxBitmap:wxBitmap()) -> bool() %% @doc See external documentation. +-spec create(This, Bitmap) -> boolean() when + This::wxMask(), Bitmap::wxBitmap:wxBitmap(). create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef}) -> ?CLASS(ThisT,wxMask), ?CLASS(BitmapT,wxBitmap), wxe_util:call(?wxMask_Create_1, <>). -%% @spec (This::wxMask(),Bitmap::wxBitmap:wxBitmap(),X::integer()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% create(This::wxMask(), Bitmap::wxBitmap:wxBitmap(), PaletteIndex::integer()) -> bool() -%%

-%%

-%% create(This::wxMask(), Bitmap::wxBitmap:wxBitmap(), Colour::wx:colour()) -> bool() -%%

+-spec create(This, Bitmap, PaletteIndex) -> boolean() when + This::wxMask(), Bitmap::wxBitmap:wxBitmap(), PaletteIndex::integer(); + (This, Bitmap, Colour) -> boolean() when + This::wxMask(), Bitmap::wxBitmap:wxBitmap(), Colour::wx:wx_colour(). create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef},PaletteIndex) when is_integer(PaletteIndex) -> ?CLASS(ThisT,wxMask), @@ -95,8 +91,8 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef},Colou wxe_util:call(?wxMask_Create_2_1, <>). -%% @spec (This::wxMask()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMask) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMask), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMaximizeEvent.erl b/lib/wx/src/gen/wxMaximizeEvent.erl index 6dd371908b..5f7b7e890d 100644 --- a/lib/wx/src/gen/wxMaximizeEvent.erl +++ b/lib/wx/src/gen/wxMaximizeEvent.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 @@ -37,10 +37,12 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxMaximizeEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxMaximizeEvent() :: wx:wx_object(). %% From wxEvent %% @hidden stopPropagation(This) -> wxEvent:stopPropagation(This). diff --git a/lib/wx/src/gen/wxMemoryDC.erl b/lib/wx/src/gen/wxMemoryDC.erl index d17ebba4b7..a8e287eb0a 100644 --- a/lib/wx/src/gen/wxMemoryDC.erl +++ b/lib/wx/src/gen/wxMemoryDC.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 @@ -52,18 +52,21 @@ setPen/2,setTextBackground/2,setTextForeground/2,setUserScale/3,startDoc/2, startPage/1]). +-export_type([wxMemoryDC/0]). %% @hidden parent_class(wxDC) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMemoryDC() +-type wxMemoryDC() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxMemoryDC(). new() -> wxe_util:construct(?wxMemoryDC_new_0, <<>>). -%% @spec (Dc::wxDC:wxDC() | wxBitmap:wxBitmap()) -> wxMemoryDC() %% @doc See external documentation. +-spec new(Dc) -> wxMemoryDC() when + Dc::wxDC:wxDC() | wxBitmap:wxBitmap(). new(#wx_ref{type=DcT,ref=DcRef}) -> DcOP = case ?CLASS_T(DcT,wxDC) of true -> @@ -74,24 +77,26 @@ new(#wx_ref{type=DcT,ref=DcRef}) -> wxe_util:construct(DcOP, <>). -%% @spec (This::wxMemoryDC(), Bmp::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec selectObject(This, Bmp) -> ok when + This::wxMemoryDC(), Bmp::wxBitmap:wxBitmap(). selectObject(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef}) -> ?CLASS(ThisT,wxMemoryDC), ?CLASS(BmpT,wxBitmap), wxe_util:cast(?wxMemoryDC_SelectObject, <>). -%% @spec (This::wxMemoryDC(), Bmp::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec selectObjectAsSource(This, Bmp) -> ok when + This::wxMemoryDC(), Bmp::wxBitmap:wxBitmap(). selectObjectAsSource(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef}) -> ?CLASS(ThisT,wxMemoryDC), ?CLASS(BmpT,wxBitmap), wxe_util:cast(?wxMemoryDC_SelectObjectAsSource, <>). -%% @spec (This::wxMemoryDC()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMemoryDC) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMemoryDC), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMenu.erl b/lib/wx/src/gen/wxMenu.erl index 615a845d11..dd674b117d 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 external documentation. +-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, <>). -%% @spec (Title::string(), [Option]) -> wxMenu() -%% Option = {style, integer()} %% @doc See external documentation. +-spec new(Title, [Option]) -> wxMenu() when + Title::string(), + Option :: {style, integer()}. new(Title, Options) when is_list(Title),is_list(Options) -> Title_UC = unicode:characters_to_binary([Title,0]), @@ -72,31 +76,30 @@ 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 external documentation. +-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, <>). -%% @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::string(). + 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 external documentation. -%%
Alternatives: -%%

-%% append(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu()) -> append(This,Itemid,Text,Submenu, [])

-%%

-%% append(This::wxMenu(), Itemid::integer(), Text::string(), [Option]) -> wxMenuItem:wxMenuItem() -%%
Option = {help, string()} | {kind, WxItemKind} -%%
WxItemKind = integer() -%%
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -%%

+-spec append(This, Itemid, Text, Submenu) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu(); + (This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::string(), + Option :: {help, string()} + | {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 +115,12 @@ append(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_Append_3, <>). -%% @spec (This::wxMenu(),Itemid::integer(),Text::string(),X::string()|wxMenu(),X::bool()|term()) -> ok|wxMenuItem:wxMenuItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% append(This::wxMenu(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::bool()) -> ok -%%

-%%

-%% append(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu(), [Option]) -> wxMenuItem:wxMenuItem() -%%
Option = {help, string()} -%%

+-spec append(This, Itemid, Text, Help, IsCheckable) -> ok when + This::wxMenu(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::boolean(); + (This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu(), + Option :: {help, string()}. 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 +139,18 @@ append(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text,#wx_ref{type=SubmenuT,ref=Sub wxe_util:call(?wxMenu_Append_4_1, <>). -%% @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::string(). + 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 external documentation. +-spec appendCheckItem(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::string(), + Option :: {help, string()}. 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 +161,18 @@ appendCheckItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_AppendCheckItem, <>). -%% @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::string(). + 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 external documentation. +-spec appendRadioItem(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::string(), + Option :: {help, string()}. 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 +183,36 @@ appendRadioItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_AppendRadioItem, <>). -%% @spec (This::wxMenu()) -> wxMenuItem:wxMenuItem() %% @doc See external documentation. +-spec appendSeparator(This) -> wxMenuItem:wxMenuItem() when + This::wxMenu(). appendSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_AppendSeparator, <>). -%% @spec (This::wxMenu()) -> ok %% @doc See external documentation. +-spec break(This) -> ok when + This::wxMenu(). break(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:cast(?wxMenu_Break, <>). -%% @spec (This::wxMenu(), Itemid::integer(), Check::bool()) -> ok %% @doc See external documentation. +-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, <>). -%% @spec (This::wxMenu(),X::integer()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% delete(This::wxMenu(), Itemid::integer()) -> bool() -%%

-%%

-%% delete(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> bool() -%%

+-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 +224,11 @@ delete(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> wxe_util:call(?wxMenu_Delete_1_1, <>). -%% @spec (This::wxMenu(),X::integer()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% 'Destroy'(This::wxMenu(), Itemid::integer()) -> bool() -%%

-%%

-%% 'Destroy'(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> bool() -%%

+-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 +240,20 @@ delete(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> wxe_util:call(?wxMenu_Destroy_1_1, <>). -%% @spec (This::wxMenu(), Itemid::integer(), Enable::bool()) -> ok %% @doc See external documentation. +-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, <>). -%% @spec (This::wxMenu(),X::integer()|string()) -> wxMenuItem:wxMenuItem()|integer() %% @doc See external documentation. -%%
Alternatives: -%%

-%% findItem(This::wxMenu(), Itemid::integer()) -> wxMenuItem:wxMenuItem() -%%

-%%

-%% findItem(This::wxMenu(), Item::string()) -> integer() -%%

+-spec findItem(This, Itemid) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(); + (This, Item) -> integer() when + This::wxMenu(), Item::string(). findItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenu), @@ -269,59 +266,62 @@ findItem(#wx_ref{type=ThisT,ref=ThisRef},Item) wxe_util:call(?wxMenu_FindItem_1, <>). -%% @spec (This::wxMenu(), Position::integer()) -> wxMenuItem:wxMenuItem() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxMenu(), Itemid::integer()) -> string() %% @doc See external documentation. +-spec getHelpString(This, Itemid) -> string() 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, <>). -%% @spec (This::wxMenu(), Itemid::integer()) -> string() %% @doc See external documentation. +-spec getLabel(This, Itemid) -> string() 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, <>). -%% @spec (This::wxMenu()) -> integer() %% @doc See external documentation. +-spec getMenuItemCount(This) -> integer() when + This::wxMenu(). getMenuItemCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_GetMenuItemCount, <>). -%% @spec (This::wxMenu()) -> [wxMenuItem:wxMenuItem()] %% @doc See external documentation. +-spec getMenuItems(This) -> [wxMenuItem:wxMenuItem()] when + This::wxMenu(). getMenuItems(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_GetMenuItems, <>). -%% @spec (This::wxMenu()) -> string() %% @doc See external documentation. +-spec getTitle(This) -> string() when + This::wxMenu(). getTitle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_GetTitle, <>). -%% @spec (This::wxMenu(),Pos::integer(),X::integer()|term()) -> wxMenuItem:wxMenuItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% insert(This::wxMenu(), Pos::integer(), Itemid::integer()) -> insert(This,Pos,Itemid, [])

-%%

-%% insert(This::wxMenu(), Pos::integer(), Item::wxMenuItem:wxMenuItem()) -> wxMenuItem:wxMenuItem() -%%

+-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 +333,13 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=ItemT,ref=ItemRef}) wxe_util:call(?wxMenu_Insert_2, <>). -%% @spec (This::wxMenu(), Pos::integer(), Itemid::integer(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {text, string()} | {help, string()} | {kind, WxItemKind} -%% WxItemKind = integer() %% @doc See external documentation. -%%
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +%%
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, string()} + | {help, string()} + | {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 +351,20 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid, Options) wxe_util:call(?wxMenu_Insert_3, <>). -%% @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::string(), 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 external documentation. -%%
Alternatives: -%%

-%% insert(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::bool()) -> ok -%%

-%%

-%% insert(This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Submenu::wxMenu(), [Option]) -> wxMenuItem:wxMenuItem() -%%
Option = {help, string()} -%%

+-spec insert(This, Pos, Itemid, Text, Help, IsCheckable) -> ok when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::boolean(); + (This, Pos, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), Submenu::wxMenu(), + Option :: {help, string()}. 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 +383,18 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid,Text,#wx_ref{type=SubmenuT,ref wxe_util:call(?wxMenu_Insert_5_1, <>). -%% @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::string(). + 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 external documentation. +-spec insertCheckItem(This, Pos, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), + Option :: {help, string()}. 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 +405,18 @@ insertCheckItem(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid,Text, Options) wxe_util:call(?wxMenu_InsertCheckItem, <>). -%% @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::string(). + 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 external documentation. +-spec insertRadioItem(This, Pos, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Pos::integer(), Itemid::integer(), Text::string(), + Option :: {help, string()}. 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 +427,38 @@ insertRadioItem(#wx_ref{type=ThisT,ref=ThisRef},Pos,Itemid,Text, Options) wxe_util:call(?wxMenu_InsertRadioItem, <>). -%% @spec (This::wxMenu(), Pos::integer()) -> wxMenuItem:wxMenuItem() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxMenu(), Itemid::integer()) -> bool() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxMenu(), Itemid::integer()) -> bool() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxMenu(),X::integer()|term()) -> wxMenuItem:wxMenuItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% prepend(This::wxMenu(), Itemid::integer()) -> prepend(This,Itemid, [])

-%%

-%% prepend(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> wxMenuItem:wxMenuItem() -%%

+-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 +469,13 @@ prepend(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> wxe_util:call(?wxMenu_Prepend_1, <>). -%% @spec (This::wxMenu(), Itemid::integer(), [Option]) -> wxMenuItem:wxMenuItem() -%% Option = {text, string()} | {help, string()} | {kind, WxItemKind} -%% WxItemKind = integer() %% @doc See external documentation. -%%
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +%%
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, string()} + | {help, string()} + | {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 +487,20 @@ prepend(#wx_ref{type=ThisT,ref=ThisRef},Itemid, Options) wxe_util:call(?wxMenu_Prepend_2, <>). -%% @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::string(), 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 external documentation. -%%
Alternatives: -%%

-%% prepend(This::wxMenu(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::bool()) -> ok -%%

-%%

-%% prepend(This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu(), [Option]) -> wxMenuItem:wxMenuItem() -%%
Option = {help, string()} -%%

+-spec prepend(This, Itemid, Text, Help, IsCheckable) -> ok when + This::wxMenu(), Itemid::integer(), Text::string(), Help::string(), IsCheckable::boolean(); + (This, Itemid, Text, Submenu, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::string(), Submenu::wxMenu(), + Option :: {help, string()}. 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 +519,18 @@ prepend(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text,#wx_ref{type=SubmenuT,ref=Su wxe_util:call(?wxMenu_Prepend_4_1, <>). -%% @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::string(). + 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 external documentation. +-spec prependCheckItem(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::string(), + Option :: {help, string()}. 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 +541,18 @@ prependCheckItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_PrependCheckItem, <>). -%% @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::string(). + 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 external documentation. +-spec prependRadioItem(This, Itemid, Text, [Option]) -> wxMenuItem:wxMenuItem() when + This::wxMenu(), Itemid::integer(), Text::string(), + Option :: {help, string()}. 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 +563,19 @@ prependRadioItem(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Text, Options) wxe_util:call(?wxMenu_PrependRadioItem, <>). -%% @spec (This::wxMenu()) -> wxMenuItem:wxMenuItem() %% @doc See external documentation. +-spec prependSeparator(This) -> wxMenuItem:wxMenuItem() when + This::wxMenu(). prependSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenu), wxe_util:call(?wxMenu_PrependSeparator, <>). -%% @spec (This::wxMenu(),X::integer()|term()) -> wxMenuItem:wxMenuItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% remove(This::wxMenu(), Itemid::integer()) -> wxMenuItem:wxMenuItem() -%%

-%%

-%% remove(This::wxMenu(), Item::wxMenuItem:wxMenuItem()) -> wxMenuItem:wxMenuItem() -%%

+-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 +587,9 @@ remove(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> wxe_util:call(?wxMenu_Remove_1_1, <>). -%% @spec (This::wxMenu(), Itemid::integer(), HelpString::string()) -> ok %% @doc See external documentation. +-spec setHelpString(This, Itemid, HelpString) -> ok when + This::wxMenu(), Itemid::integer(), HelpString::string(). setHelpString(#wx_ref{type=ThisT,ref=ThisRef},Itemid,HelpString) when is_integer(Itemid),is_list(HelpString) -> ?CLASS(ThisT,wxMenu), @@ -587,8 +597,9 @@ setHelpString(#wx_ref{type=ThisT,ref=ThisRef},Itemid,HelpString) wxe_util:cast(?wxMenu_SetHelpString, <>). -%% @spec (This::wxMenu(), Itemid::integer(), Label::string()) -> ok %% @doc See external documentation. +-spec setLabel(This, Itemid, Label) -> ok when + This::wxMenu(), Itemid::integer(), Label::string(). setLabel(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Label) when is_integer(Itemid),is_list(Label) -> ?CLASS(ThisT,wxMenu), @@ -596,8 +607,9 @@ setLabel(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Label) wxe_util:cast(?wxMenu_SetLabel, <>). -%% @spec (This::wxMenu(), Title::string()) -> ok %% @doc See external documentation. +-spec setTitle(This, Title) -> ok when + This::wxMenu(), Title::string(). setTitle(#wx_ref{type=ThisT,ref=ThisRef},Title) when is_list(Title) -> ?CLASS(ThisT,wxMenu), @@ -605,8 +617,8 @@ setTitle(#wx_ref{type=ThisT,ref=ThisRef},Title) wxe_util:cast(?wxMenu_SetTitle, <>). -%% @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), diff --git a/lib/wx/src/gen/wxMenuBar.erl b/lib/wx/src/gen/wxMenuBar.erl index 4ed1b2cbe6..3538e58791 100644 --- a/lib/wx/src/gen/wxMenuBar.erl +++ b/lib/wx/src/gen/wxMenuBar.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 @@ -72,26 +72,30 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxMenuBar/0]). %% @hidden parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMenuBar() +-type wxMenuBar() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxMenuBar(). new() -> wxe_util:construct(?wxMenuBar_new_0, <<>>). -%% @spec (Style::integer()) -> wxMenuBar() %% @doc See external documentation. +-spec new(Style) -> wxMenuBar() when + Style::integer(). new(Style) when is_integer(Style) -> wxe_util:construct(?wxMenuBar_new_1, <>). -%% @spec (This::wxMenuBar(), Menu::wxMenu:wxMenu(), Title::string()) -> bool() %% @doc See external documentation. +-spec append(This, Menu, Title) -> boolean() when + This::wxMenuBar(), Menu::wxMenu:wxMenu(), Title::string(). append(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MenuT,ref=MenuRef},Title) when is_list(Title) -> ?CLASS(ThisT,wxMenuBar), @@ -100,23 +104,27 @@ append(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MenuT,ref=MenuRef},Title) wxe_util:call(?wxMenuBar_Append, <>). -%% @spec (This::wxMenuBar(), Itemid::integer(), Check::bool()) -> ok %% @doc See external documentation. +-spec check(This, Itemid, Check) -> ok when + This::wxMenuBar(), Itemid::integer(), Check::boolean(). check(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Check) when is_integer(Itemid),is_boolean(Check) -> ?CLASS(ThisT,wxMenuBar), wxe_util:cast(?wxMenuBar_Check, <>). -%% @spec (This::wxMenuBar()) -> bool() %% @equiv enable(This, []) +-spec enable(This) -> boolean() when + This::wxMenuBar(). + enable(This) when is_record(This, wx_ref) -> enable(This, []). -%% @spec (This::wxMenuBar(), [Option]) -> bool() -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enable(This, [Option]) -> boolean() when + This::wxMenuBar(), + Option :: {enable, boolean()}. enable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMenuBar), @@ -126,24 +134,27 @@ enable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxMenuBar_Enable_1, <>). -%% @spec (This::wxMenuBar(), Itemid::integer(), Enable::bool()) -> ok %% @doc See external documentation. +-spec enable(This, Itemid, Enable) -> ok when + This::wxMenuBar(), Itemid::integer(), Enable::boolean(). enable(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Enable) when is_integer(Itemid),is_boolean(Enable) -> ?CLASS(ThisT,wxMenuBar), wxe_util:cast(?wxMenuBar_Enable_2, <>). -%% @spec (This::wxMenuBar(), Pos::integer(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enableTop(This, Pos, Flag) -> ok when + This::wxMenuBar(), Pos::integer(), Flag::boolean(). enableTop(#wx_ref{type=ThisT,ref=ThisRef},Pos,Flag) when is_integer(Pos),is_boolean(Flag) -> ?CLASS(ThisT,wxMenuBar), wxe_util:cast(?wxMenuBar_EnableTop, <>). -%% @spec (This::wxMenuBar(), Title::string()) -> integer() %% @doc See external documentation. +-spec findMenu(This, Title) -> integer() when + This::wxMenuBar(), Title::string(). findMenu(#wx_ref{type=ThisT,ref=ThisRef},Title) when is_list(Title) -> ?CLASS(ThisT,wxMenuBar), @@ -151,8 +162,9 @@ findMenu(#wx_ref{type=ThisT,ref=ThisRef},Title) wxe_util:call(?wxMenuBar_FindMenu, <>). -%% @spec (This::wxMenuBar(), MenuString::string(), ItemString::string()) -> integer() %% @doc See external documentation. +-spec findMenuItem(This, MenuString, ItemString) -> integer() when + This::wxMenuBar(), MenuString::string(), ItemString::string(). findMenuItem(#wx_ref{type=ThisT,ref=ThisRef},MenuString,ItemString) when is_list(MenuString),is_list(ItemString) -> ?CLASS(ThisT,wxMenuBar), @@ -161,62 +173,70 @@ findMenuItem(#wx_ref{type=ThisT,ref=ThisRef},MenuString,ItemString) wxe_util:call(?wxMenuBar_FindMenuItem, <>). -%% @spec (This::wxMenuBar(), Id::integer()) -> wxMenuItem:wxMenuItem() %% @doc See external documentation. +-spec findItem(This, Id) -> wxMenuItem:wxMenuItem() when + This::wxMenuBar(), Id::integer(). findItem(#wx_ref{type=ThisT,ref=ThisRef},Id) when is_integer(Id) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_FindItem, <>). -%% @spec (This::wxMenuBar(), Itemid::integer()) -> string() %% @doc See external documentation. +-spec getHelpString(This, Itemid) -> string() when + This::wxMenuBar(), Itemid::integer(). getHelpString(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_GetHelpString, <>). -%% @spec (This::wxMenuBar()) -> string() %% @doc See external documentation. +-spec getLabel(This) -> string() when + This::wxMenuBar(). getLabel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_GetLabel_0, <>). -%% @spec (This::wxMenuBar(), Itemid::integer()) -> string() %% @doc See external documentation. +-spec getLabel(This, Itemid) -> string() when + This::wxMenuBar(), Itemid::integer(). getLabel(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_GetLabel_1, <>). -%% @spec (This::wxMenuBar(), Pos::integer()) -> string() %% @doc See external documentation. +-spec getLabelTop(This, Pos) -> string() when + This::wxMenuBar(), Pos::integer(). getLabelTop(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_GetLabelTop, <>). -%% @spec (This::wxMenuBar(), Pos::integer()) -> wxMenu:wxMenu() %% @doc See external documentation. +-spec getMenu(This, Pos) -> wxMenu:wxMenu() when + This::wxMenuBar(), Pos::integer(). getMenu(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_GetMenu, <>). -%% @spec (This::wxMenuBar()) -> integer() %% @doc See external documentation. +-spec getMenuCount(This) -> integer() when + This::wxMenuBar(). getMenuCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_GetMenuCount, <>). -%% @spec (This::wxMenuBar(), Pos::integer(), Menu::wxMenu:wxMenu(), Title::string()) -> bool() %% @doc See external documentation. +-spec insert(This, Pos, Menu, Title) -> boolean() when + This::wxMenuBar(), Pos::integer(), Menu::wxMenu:wxMenu(), Title::string(). insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=MenuT,ref=MenuRef},Title) when is_integer(Pos),is_list(Title) -> ?CLASS(ThisT,wxMenuBar), @@ -225,39 +245,44 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=MenuT,ref=MenuRef},Title wxe_util:call(?wxMenuBar_Insert, <>). -%% @spec (This::wxMenuBar(), Itemid::integer()) -> bool() %% @doc See external documentation. +-spec isChecked(This, Itemid) -> boolean() when + This::wxMenuBar(), Itemid::integer(). isChecked(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_IsChecked, <>). -%% @spec (This::wxMenuBar()) -> bool() %% @doc See external documentation. +-spec isEnabled(This) -> boolean() when + This::wxMenuBar(). isEnabled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_IsEnabled_0, <>). -%% @spec (This::wxMenuBar(), Itemid::integer()) -> bool() %% @doc See external documentation. +-spec isEnabled(This, Itemid) -> boolean() when + This::wxMenuBar(), Itemid::integer(). isEnabled(#wx_ref{type=ThisT,ref=ThisRef},Itemid) when is_integer(Itemid) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_IsEnabled_1, <>). -%% @spec (This::wxMenuBar(), Pos::integer()) -> wxMenu:wxMenu() %% @doc See external documentation. +-spec remove(This, Pos) -> wxMenu:wxMenu() when + This::wxMenuBar(), Pos::integer(). remove(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxMenuBar), wxe_util:call(?wxMenuBar_Remove, <>). -%% @spec (This::wxMenuBar(), Pos::integer(), Menu::wxMenu:wxMenu(), Title::string()) -> wxMenu:wxMenu() %% @doc See external documentation. +-spec replace(This, Pos, Menu, Title) -> wxMenu:wxMenu() when + This::wxMenuBar(), Pos::integer(), Menu::wxMenu:wxMenu(), Title::string(). replace(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=MenuT,ref=MenuRef},Title) when is_integer(Pos),is_list(Title) -> ?CLASS(ThisT,wxMenuBar), @@ -266,8 +291,9 @@ replace(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=MenuT,ref=MenuRef},Titl wxe_util:call(?wxMenuBar_Replace, <>). -%% @spec (This::wxMenuBar(), Itemid::integer(), HelpString::string()) -> ok %% @doc See external documentation. +-spec setHelpString(This, Itemid, HelpString) -> ok when + This::wxMenuBar(), Itemid::integer(), HelpString::string(). setHelpString(#wx_ref{type=ThisT,ref=ThisRef},Itemid,HelpString) when is_integer(Itemid),is_list(HelpString) -> ?CLASS(ThisT,wxMenuBar), @@ -275,8 +301,9 @@ setHelpString(#wx_ref{type=ThisT,ref=ThisRef},Itemid,HelpString) wxe_util:cast(?wxMenuBar_SetHelpString, <>). -%% @spec (This::wxMenuBar(), S::string()) -> ok %% @doc See external documentation. +-spec setLabel(This, S) -> ok when + This::wxMenuBar(), S::string(). setLabel(#wx_ref{type=ThisT,ref=ThisRef},S) when is_list(S) -> ?CLASS(ThisT,wxMenuBar), @@ -284,8 +311,9 @@ setLabel(#wx_ref{type=ThisT,ref=ThisRef},S) wxe_util:cast(?wxMenuBar_SetLabel_1, <>). -%% @spec (This::wxMenuBar(), Itemid::integer(), Label::string()) -> ok %% @doc See external documentation. +-spec setLabel(This, Itemid, Label) -> ok when + This::wxMenuBar(), Itemid::integer(), Label::string(). setLabel(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Label) when is_integer(Itemid),is_list(Label) -> ?CLASS(ThisT,wxMenuBar), @@ -293,8 +321,9 @@ setLabel(#wx_ref{type=ThisT,ref=ThisRef},Itemid,Label) wxe_util:cast(?wxMenuBar_SetLabel_2, <>). -%% @spec (This::wxMenuBar(), Pos::integer(), Label::string()) -> ok %% @doc See external documentation. +-spec setLabelTop(This, Pos, Label) -> ok when + This::wxMenuBar(), Pos::integer(), Label::string(). setLabelTop(#wx_ref{type=ThisT,ref=ThisRef},Pos,Label) when is_integer(Pos),is_list(Label) -> ?CLASS(ThisT,wxMenuBar), @@ -302,8 +331,8 @@ setLabelTop(#wx_ref{type=ThisT,ref=ThisRef},Pos,Label) wxe_util:cast(?wxMenuBar_SetLabelTop, <>). -%% @spec (This::wxMenuBar()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMenuBar) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMenuBar), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMenuEvent.erl b/lib/wx/src/gen/wxMenuEvent.erl index fe368e679a..84c4760aa6 100644 --- a/lib/wx/src/gen/wxMenuEvent.erl +++ b/lib/wx/src/gen/wxMenuEvent.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 @@ -37,26 +37,31 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxMenuEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxMenuEvent()) -> wxMenu:wxMenu() +-type wxMenuEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getMenu(This) -> wxMenu:wxMenu() when + This::wxMenuEvent(). getMenu(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuEvent), wxe_util:call(?wxMenuEvent_GetMenu, <>). -%% @spec (This::wxMenuEvent()) -> integer() %% @doc See external documentation. +-spec getMenuId(This) -> integer() when + This::wxMenuEvent(). getMenuId(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuEvent), wxe_util:call(?wxMenuEvent_GetMenuId, <>). -%% @spec (This::wxMenuEvent()) -> bool() %% @doc See external documentation. +-spec isPopup(This) -> boolean() when + This::wxMenuEvent(). isPopup(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuEvent), wxe_util:call(?wxMenuEvent_IsPopup, diff --git a/lib/wx/src/gen/wxMenuItem.erl b/lib/wx/src/gen/wxMenuItem.erl index e2bbe681c5..76ce8408ed 100644 --- a/lib/wx/src/gen/wxMenuItem.erl +++ b/lib/wx/src/gen/wxMenuItem.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 @@ -32,19 +32,26 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxMenuItem/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMenuItem() +-type wxMenuItem() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxMenuItem(). + new() -> new([]). -%% @spec ([Option]) -> wxMenuItem() -%% Option = {parentMenu, wxMenu:wxMenu()} | {id, integer()} | {text, string()} | {help, string()} | {kind, WxItemKind} | {subMenu, wxMenu:wxMenu()} -%% WxItemKind = integer() %% @doc See external documentation. -%%
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +%%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +-spec new([Option]) -> wxMenuItem() when + Option :: {parentMenu, wxMenu:wxMenu()} + | {id, integer()} + | {text, string()} + | {help, string()} + | {kind, wx:wx_enum()} + | {subMenu, wxMenu:wxMenu()}. new(Options) when is_list(Options) -> MOpts = fun({parentMenu, #wx_ref{type=ParentMenuT,ref=ParentMenuRef}}, Acc) -> ?CLASS(ParentMenuT,wxMenu),[<<1:32/?UI,ParentMenuRef:32/?UI>>|Acc]; @@ -58,15 +65,18 @@ new(Options) wxe_util:construct(?wxMenuItem_new, <>). -%% @spec (This::wxMenuItem()) -> ok %% @equiv check(This, []) +-spec check(This) -> ok when + This::wxMenuItem(). + check(This) when is_record(This, wx_ref) -> check(This, []). -%% @spec (This::wxMenuItem(), [Option]) -> ok -%% Option = {check, bool()} %% @doc See external documentation. +-spec check(This, [Option]) -> ok when + This::wxMenuItem(), + Option :: {check, boolean()}. check(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMenuItem), @@ -76,15 +86,18 @@ check(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxMenuItem_Check, <>). -%% @spec (This::wxMenuItem()) -> ok %% @equiv enable(This, []) +-spec enable(This) -> ok when + This::wxMenuItem(). + enable(This) when is_record(This, wx_ref) -> enable(This, []). -%% @spec (This::wxMenuItem(), [Option]) -> ok -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enable(This, [Option]) -> ok when + This::wxMenuItem(), + Option :: {enable, boolean()}. enable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMenuItem), @@ -94,117 +107,132 @@ enable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxMenuItem_Enable, <>). -%% @spec (This::wxMenuItem()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getBitmap(This) -> wxBitmap:wxBitmap() when + This::wxMenuItem(). getBitmap(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_GetBitmap, <>). -%% @spec (This::wxMenuItem()) -> string() %% @doc See external documentation. +-spec getHelp(This) -> string() when + This::wxMenuItem(). getHelp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_GetHelp, <>). -%% @spec (This::wxMenuItem()) -> integer() %% @doc See external documentation. +-spec getId(This) -> integer() when + This::wxMenuItem(). getId(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_GetId, <>). -%% @spec (This::wxMenuItem()) -> WxItemKind -%% WxItemKind = integer() %% @doc See external documentation. -%%
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +%%
Res = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +-spec getKind(This) -> wx:wx_enum() when + This::wxMenuItem(). getKind(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_GetKind, <>). -%% @spec (This::wxMenuItem()) -> string() %% @doc See external documentation. +-spec getLabel(This) -> string() when + This::wxMenuItem(). getLabel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_GetLabel, <>). -%% @spec (Text::string()) -> string() %% @doc See external documentation. +-spec getLabelFromText(Text) -> string() when + Text::string(). getLabelFromText(Text) when is_list(Text) -> Text_UC = unicode:characters_to_binary([Text,0]), wxe_util:call(?wxMenuItem_GetLabelFromText, <<(byte_size(Text_UC)):32/?UI,(Text_UC)/binary, 0:(((8- ((4+byte_size(Text_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxMenuItem()) -> wxMenu:wxMenu() %% @doc See external documentation. +-spec getMenu(This) -> wxMenu:wxMenu() when + This::wxMenuItem(). getMenu(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_GetMenu, <>). -%% @spec (This::wxMenuItem()) -> string() %% @doc See external documentation. +-spec getText(This) -> string() when + This::wxMenuItem(). getText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_GetText, <>). -%% @spec (This::wxMenuItem()) -> wxMenu:wxMenu() %% @doc See external documentation. +-spec getSubMenu(This) -> wxMenu:wxMenu() when + This::wxMenuItem(). getSubMenu(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_GetSubMenu, <>). -%% @spec (This::wxMenuItem()) -> bool() %% @doc See external documentation. +-spec isCheckable(This) -> boolean() when + This::wxMenuItem(). isCheckable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_IsCheckable, <>). -%% @spec (This::wxMenuItem()) -> bool() %% @doc See external documentation. +-spec isChecked(This) -> boolean() when + This::wxMenuItem(). isChecked(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_IsChecked, <>). -%% @spec (This::wxMenuItem()) -> bool() %% @doc See external documentation. +-spec isEnabled(This) -> boolean() when + This::wxMenuItem(). isEnabled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_IsEnabled, <>). -%% @spec (This::wxMenuItem()) -> bool() %% @doc See external documentation. +-spec isSeparator(This) -> boolean() when + This::wxMenuItem(). isSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_IsSeparator, <>). -%% @spec (This::wxMenuItem()) -> bool() %% @doc See external documentation. +-spec isSubMenu(This) -> boolean() when + This::wxMenuItem(). isSubMenu(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMenuItem), wxe_util:call(?wxMenuItem_IsSubMenu, <>). -%% @spec (This::wxMenuItem(), Bitmap::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec setBitmap(This, Bitmap) -> ok when + This::wxMenuItem(), Bitmap::wxBitmap:wxBitmap(). setBitmap(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef}) -> ?CLASS(ThisT,wxMenuItem), ?CLASS(BitmapT,wxBitmap), wxe_util:cast(?wxMenuItem_SetBitmap, <>). -%% @spec (This::wxMenuItem(), Str::string()) -> ok %% @doc See external documentation. +-spec setHelp(This, Str) -> ok when + This::wxMenuItem(), Str::string(). setHelp(#wx_ref{type=ThisT,ref=ThisRef},Str) when is_list(Str) -> ?CLASS(ThisT,wxMenuItem), @@ -212,24 +240,27 @@ setHelp(#wx_ref{type=ThisT,ref=ThisRef},Str) wxe_util:cast(?wxMenuItem_SetHelp, <>). -%% @spec (This::wxMenuItem(), Menu::wxMenu:wxMenu()) -> ok %% @doc See external documentation. +-spec setMenu(This, Menu) -> ok when + This::wxMenuItem(), Menu::wxMenu:wxMenu(). setMenu(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MenuT,ref=MenuRef}) -> ?CLASS(ThisT,wxMenuItem), ?CLASS(MenuT,wxMenu), wxe_util:cast(?wxMenuItem_SetMenu, <>). -%% @spec (This::wxMenuItem(), Menu::wxMenu:wxMenu()) -> ok %% @doc See external documentation. +-spec setSubMenu(This, Menu) -> ok when + This::wxMenuItem(), Menu::wxMenu:wxMenu(). setSubMenu(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MenuT,ref=MenuRef}) -> ?CLASS(ThisT,wxMenuItem), ?CLASS(MenuT,wxMenu), wxe_util:cast(?wxMenuItem_SetSubMenu, <>). -%% @spec (This::wxMenuItem(), Str::string()) -> ok %% @doc See external documentation. +-spec setText(This, Str) -> ok when + This::wxMenuItem(), Str::string(). setText(#wx_ref{type=ThisT,ref=ThisRef},Str) when is_list(Str) -> ?CLASS(ThisT,wxMenuItem), @@ -237,8 +268,8 @@ setText(#wx_ref{type=ThisT,ref=ThisRef},Str) wxe_util:cast(?wxMenuItem_SetText, <>). -%% @spec (This::wxMenuItem()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMenuItem) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMenuItem), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMessageDialog.erl b/lib/wx/src/gen/wxMessageDialog.erl index d13bb7cb6e..0748b22530 100644 --- a/lib/wx/src/gen/wxMessageDialog.erl +++ b/lib/wx/src/gen/wxMessageDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxMessageDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,15 +85,21 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Parent::wxWindow:wxWindow(), Message::string()) -> wxMessageDialog() +-type wxMessageDialog() :: wx:wx_object(). %% @equiv new(Parent,Message, []) +-spec new(Parent, Message) -> wxMessageDialog() when + Parent::wxWindow:wxWindow(), Message::string(). + new(Parent,Message) when is_record(Parent, wx_ref),is_list(Message) -> new(Parent,Message, []). -%% @spec (Parent::wxWindow:wxWindow(), Message::string(), [Option]) -> wxMessageDialog() -%% Option = {caption, string()} | {style, integer()} | {pos, {X::integer(), Y::integer()}} %% @doc See external documentation. +-spec new(Parent, Message, [Option]) -> wxMessageDialog() when + Parent::wxWindow:wxWindow(), Message::string(), + Option :: {caption, string()} + | {style, integer()} + | {pos, {X::integer(), Y::integer()}}. new(#wx_ref{type=ParentT,ref=ParentRef},Message, Options) when is_list(Message),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -105,8 +112,8 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Message, Options) wxe_util:construct(?wxMessageDialog_new, <>). -%% @spec (This::wxMessageDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMessageDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMessageDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMiniFrame.erl b/lib/wx/src/gen/wxMiniFrame.erl index 108ebcfb0e..0ddec78c0e 100644 --- a/lib/wx/src/gen/wxMiniFrame.erl +++ b/lib/wx/src/gen/wxMiniFrame.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 @@ -80,6 +80,7 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxMiniFrame/0]). %% @hidden parent_class(wxFrame) -> true; parent_class(wxTopLevelWindow) -> true; @@ -87,21 +88,27 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMiniFrame() +-type wxMiniFrame() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxMiniFrame(). new() -> wxe_util:construct(?wxMiniFrame_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string()) -> wxMiniFrame() %% @equiv new(Parent,Id,Title, []) +-spec new(Parent, Id, Title) -> wxMiniFrame() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(). + new(Parent,Id,Title) when is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> new(Parent,Id,Title, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), [Option]) -> wxMiniFrame() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, Title, [Option]) -> wxMiniFrame() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -114,15 +121,20 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title, Options) wxe_util:construct(?wxMiniFrame_new_4, <>). -%% @spec (This::wxMiniFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string()) -> bool() %% @equiv create(This,Parent,Id,Title, []) +-spec create(This, Parent, Id, Title) -> boolean() when + This::wxMiniFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(). + create(This,Parent,Id,Title) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Title) -> create(This,Parent,Id,Title, []). -%% @spec (This::wxMiniFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, Title, [Option]) -> boolean() when + This::wxMiniFrame(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), + 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,Title, Options) when is_integer(Id),is_list(Title),is_list(Options) -> ?CLASS(ThisT,wxMiniFrame), @@ -136,8 +148,8 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Ti wxe_util:call(?wxMiniFrame_Create, <>). -%% @spec (This::wxMiniFrame()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMiniFrame) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMiniFrame), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMirrorDC.erl b/lib/wx/src/gen/wxMirrorDC.erl index c218bd7e72..53fa259fb3 100644 --- a/lib/wx/src/gen/wxMirrorDC.erl +++ b/lib/wx/src/gen/wxMirrorDC.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 @@ -52,20 +52,23 @@ setPen/2,setTextBackground/2,setTextForeground/2,setUserScale/3,startDoc/2, startPage/1]). +-export_type([wxMirrorDC/0]). %% @hidden parent_class(wxDC) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Dc::wxDC:wxDC(), Mirror::bool()) -> wxMirrorDC() +-type wxMirrorDC() :: wx:wx_object(). %% @doc See external documentation. +-spec new(Dc, Mirror) -> wxMirrorDC() when + Dc::wxDC:wxDC(), Mirror::boolean(). new(#wx_ref{type=DcT,ref=DcRef},Mirror) when is_boolean(Mirror) -> ?CLASS(DcT,wxDC), wxe_util:construct(?wxMirrorDC_new, <>). -%% @spec (This::wxMirrorDC()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMirrorDC) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMirrorDC), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxMouseCaptureChangedEvent.erl b/lib/wx/src/gen/wxMouseCaptureChangedEvent.erl index cb921bf2df..659582b611 100644 --- a/lib/wx/src/gen/wxMouseCaptureChangedEvent.erl +++ b/lib/wx/src/gen/wxMouseCaptureChangedEvent.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 @@ -37,12 +37,15 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxMouseCaptureChangedEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxMouseCaptureChangedEvent()) -> wxWindow:wxWindow() +-type wxMouseCaptureChangedEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getCapturedWindow(This) -> wxWindow:wxWindow() when + This::wxMouseCaptureChangedEvent(). getCapturedWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseCaptureChangedEvent), wxe_util:call(?wxMouseCaptureChangedEvent_GetCapturedWindow, diff --git a/lib/wx/src/gen/wxMouseEvent.erl b/lib/wx/src/gen/wxMouseEvent.erl index a91d2a2e99..97ea9e908f 100644 --- a/lib/wx/src/gen/wxMouseEvent.erl +++ b/lib/wx/src/gen/wxMouseEvent.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 @@ -43,34 +43,41 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxMouseEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxMouseEvent()) -> bool() +-type wxMouseEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec altDown(This) -> boolean() when + This::wxMouseEvent(). altDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_AltDown, <>). -%% @spec (This::wxMouseEvent(), But::integer()) -> bool() %% @doc See external documentation. +-spec button(This, But) -> boolean() when + This::wxMouseEvent(), But::integer(). button(#wx_ref{type=ThisT,ref=ThisRef},But) when is_integer(But) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Button, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @equiv buttonDClick(This, []) +-spec buttonDClick(This) -> boolean() when + This::wxMouseEvent(). + buttonDClick(This) when is_record(This, wx_ref) -> buttonDClick(This, []). -%% @spec (This::wxMouseEvent(), [Option]) -> bool() -%% Option = {but, integer()} %% @doc See external documentation. +-spec buttonDClick(This, [Option]) -> boolean() when + This::wxMouseEvent(), + Option :: {but, integer()}. buttonDClick(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMouseEvent), @@ -80,15 +87,18 @@ buttonDClick(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxMouseEvent_ButtonDClick, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @equiv buttonDown(This, []) +-spec buttonDown(This) -> boolean() when + This::wxMouseEvent(). + buttonDown(This) when is_record(This, wx_ref) -> buttonDown(This, []). -%% @spec (This::wxMouseEvent(), [Option]) -> bool() -%% Option = {but, integer()} %% @doc See external documentation. +-spec buttonDown(This, [Option]) -> boolean() when + This::wxMouseEvent(), + Option :: {but, integer()}. buttonDown(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMouseEvent), @@ -98,15 +108,18 @@ buttonDown(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxMouseEvent_ButtonDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @equiv buttonUp(This, []) +-spec buttonUp(This) -> boolean() when + This::wxMouseEvent(). + buttonUp(This) when is_record(This, wx_ref) -> buttonUp(This, []). -%% @spec (This::wxMouseEvent(), [Option]) -> bool() -%% Option = {but, integer()} %% @doc See external documentation. +-spec buttonUp(This, [Option]) -> boolean() when + This::wxMouseEvent(), + Option :: {but, integer()}. buttonUp(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxMouseEvent), @@ -116,212 +129,242 @@ buttonUp(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxMouseEvent_ButtonUp, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec cmdDown(This) -> boolean() when + This::wxMouseEvent(). cmdDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_CmdDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec controlDown(This) -> boolean() when + This::wxMouseEvent(). controlDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_ControlDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec dragging(This) -> boolean() when + This::wxMouseEvent(). dragging(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Dragging, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec entering(This) -> boolean() when + This::wxMouseEvent(). entering(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Entering, <>). -%% @spec (This::wxMouseEvent()) -> integer() %% @doc See external documentation. +-spec getButton(This) -> integer() when + This::wxMouseEvent(). getButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetButton, <>). -%% @spec (This::wxMouseEvent()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxMouseEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetPosition, <>). -%% @spec (This::wxMouseEvent(), Dc::wxDC:wxDC()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getLogicalPosition(This, Dc) -> {X::integer(), Y::integer()} when + This::wxMouseEvent(), Dc::wxDC:wxDC(). getLogicalPosition(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DcT,ref=DcRef}) -> ?CLASS(ThisT,wxMouseEvent), ?CLASS(DcT,wxDC), wxe_util:call(?wxMouseEvent_GetLogicalPosition, <>). -%% @spec (This::wxMouseEvent()) -> integer() %% @doc See external documentation. +-spec getLinesPerAction(This) -> integer() when + This::wxMouseEvent(). getLinesPerAction(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetLinesPerAction, <>). -%% @spec (This::wxMouseEvent()) -> integer() %% @doc See external documentation. +-spec getWheelRotation(This) -> integer() when + This::wxMouseEvent(). getWheelRotation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetWheelRotation, <>). -%% @spec (This::wxMouseEvent()) -> integer() %% @doc See external documentation. +-spec getWheelDelta(This) -> integer() when + This::wxMouseEvent(). getWheelDelta(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetWheelDelta, <>). -%% @spec (This::wxMouseEvent()) -> integer() %% @doc See external documentation. +-spec getX(This) -> integer() when + This::wxMouseEvent(). getX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetX, <>). -%% @spec (This::wxMouseEvent()) -> integer() %% @doc See external documentation. +-spec getY(This) -> integer() when + This::wxMouseEvent(). getY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_GetY, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec isButton(This) -> boolean() when + This::wxMouseEvent(). isButton(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_IsButton, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec isPageScroll(This) -> boolean() when + This::wxMouseEvent(). isPageScroll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_IsPageScroll, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec leaving(This) -> boolean() when + This::wxMouseEvent(). leaving(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Leaving, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec leftDClick(This) -> boolean() when + This::wxMouseEvent(). leftDClick(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_LeftDClick, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec leftDown(This) -> boolean() when + This::wxMouseEvent(). leftDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_LeftDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec leftIsDown(This) -> boolean() when + This::wxMouseEvent(). leftIsDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_LeftIsDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec leftUp(This) -> boolean() when + This::wxMouseEvent(). leftUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_LeftUp, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec metaDown(This) -> boolean() when + This::wxMouseEvent(). metaDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MetaDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec middleDClick(This) -> boolean() when + This::wxMouseEvent(). middleDClick(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MiddleDClick, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec middleDown(This) -> boolean() when + This::wxMouseEvent(). middleDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MiddleDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec middleIsDown(This) -> boolean() when + This::wxMouseEvent(). middleIsDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MiddleIsDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec middleUp(This) -> boolean() when + This::wxMouseEvent(). middleUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_MiddleUp, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec moving(This) -> boolean() when + This::wxMouseEvent(). moving(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_Moving, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec rightDClick(This) -> boolean() when + This::wxMouseEvent(). rightDClick(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_RightDClick, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec rightDown(This) -> boolean() when + This::wxMouseEvent(). rightDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_RightDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec rightIsDown(This) -> boolean() when + This::wxMouseEvent(). rightIsDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_RightIsDown, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec rightUp(This) -> boolean() when + This::wxMouseEvent(). rightUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_RightUp, <>). -%% @spec (This::wxMouseEvent()) -> bool() %% @doc See external documentation. +-spec shiftDown(This) -> boolean() when + This::wxMouseEvent(). shiftDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMouseEvent), wxe_util:call(?wxMouseEvent_ShiftDown, diff --git a/lib/wx/src/gen/wxMoveEvent.erl b/lib/wx/src/gen/wxMoveEvent.erl index 97cf803310..b2f2fa74df 100644 --- a/lib/wx/src/gen/wxMoveEvent.erl +++ b/lib/wx/src/gen/wxMoveEvent.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 @@ -37,12 +37,15 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxMoveEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxMoveEvent()) -> {X::integer(), Y::integer()} +-type wxMoveEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxMoveEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMoveEvent), wxe_util:call(?wxMoveEvent_GetPosition, diff --git a/lib/wx/src/gen/wxMultiChoiceDialog.erl b/lib/wx/src/gen/wxMultiChoiceDialog.erl index 6fae0c4860..7c19a1ca42 100644 --- a/lib/wx/src/gen/wxMultiChoiceDialog.erl +++ b/lib/wx/src/gen/wxMultiChoiceDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxMultiChoiceDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,21 +85,26 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxMultiChoiceDialog() +-type wxMultiChoiceDialog() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxMultiChoiceDialog(). new() -> wxe_util:construct(?wxMultiChoiceDialog_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Message::string(), Caption::string(), Choices::[[string()]]) -> wxMultiChoiceDialog() %% @equiv new(Parent,Message,Caption,Choices, []) +-spec new(Parent, Message, Caption, Choices) -> wxMultiChoiceDialog() when + Parent::wxWindow:wxWindow(), Message::string(), Caption::string(), Choices::[[string()]]. + new(Parent,Message,Caption,Choices) when is_record(Parent, wx_ref),is_list(Message),is_list(Caption),is_list(Choices) -> new(Parent,Message,Caption,Choices, []). -%% @spec (Parent::wxWindow:wxWindow(), Message::string(), Caption::string(), Choices::[[string()]], [Option]) -> wxMultiChoiceDialog() -%% Option = {style, integer()} | {pos, {X::integer(), Y::integer()}} %% @doc See external documentation. +-spec new(Parent, Message, Caption, Choices, [Option]) -> wxMultiChoiceDialog() when + Parent::wxWindow:wxWindow(), Message::string(), Caption::string(), Choices::[[string()]], + Option :: {style, integer()} + | {pos, {X::integer(), Y::integer()}}. new(#wx_ref{type=ParentT,ref=ParentRef},Message,Caption,Choices, Options) when is_list(Message),is_list(Caption),is_list(Choices),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -113,15 +119,17 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Message,Caption,Choices, Options) wxe_util:construct(?wxMultiChoiceDialog_new_5, <>|| UC_Str <- Choices_UCA>>)/binary, 0:(((8- ((4 + lists:sum([byte_size(S)+4||S<-Choices_UCA])) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxMultiChoiceDialog()) -> [integer()] %% @doc See external documentation. +-spec getSelections(This) -> [integer()] when + This::wxMultiChoiceDialog(). getSelections(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxMultiChoiceDialog), wxe_util:call(?wxMultiChoiceDialog_GetSelections, <>). -%% @spec (This::wxMultiChoiceDialog(), Selections::[integer()]) -> ok %% @doc See external documentation. +-spec setSelections(This, Selections) -> ok when + This::wxMultiChoiceDialog(), Selections::[integer()]. setSelections(#wx_ref{type=ThisT,ref=ThisRef},Selections) when is_list(Selections) -> ?CLASS(ThisT,wxMultiChoiceDialog), @@ -129,8 +137,8 @@ setSelections(#wx_ref{type=ThisT,ref=ThisRef},Selections) <> || C <- Selections>>)/binary, 0:(((0+length(Selections)) rem 2)*32)>>). -%% @spec (This::wxMultiChoiceDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxMultiChoiceDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxMultiChoiceDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxNavigationKeyEvent.erl b/lib/wx/src/gen/wxNavigationKeyEvent.erl index 7cf7dff9aa..7559639fcd 100644 --- a/lib/wx/src/gen/wxNavigationKeyEvent.erl +++ b/lib/wx/src/gen/wxNavigationKeyEvent.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 @@ -38,64 +38,74 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxNavigationKeyEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxNavigationKeyEvent()) -> bool() +-type wxNavigationKeyEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getDirection(This) -> boolean() when + This::wxNavigationKeyEvent(). getDirection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNavigationKeyEvent), wxe_util:call(?wxNavigationKeyEvent_GetDirection, <>). -%% @spec (This::wxNavigationKeyEvent(), BForward::bool()) -> ok %% @doc See external documentation. +-spec setDirection(This, BForward) -> ok when + This::wxNavigationKeyEvent(), BForward::boolean(). setDirection(#wx_ref{type=ThisT,ref=ThisRef},BForward) when is_boolean(BForward) -> ?CLASS(ThisT,wxNavigationKeyEvent), wxe_util:cast(?wxNavigationKeyEvent_SetDirection, <>). -%% @spec (This::wxNavigationKeyEvent()) -> bool() %% @doc See external documentation. +-spec isWindowChange(This) -> boolean() when + This::wxNavigationKeyEvent(). isWindowChange(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNavigationKeyEvent), wxe_util:call(?wxNavigationKeyEvent_IsWindowChange, <>). -%% @spec (This::wxNavigationKeyEvent(), BIs::bool()) -> ok %% @doc See external documentation. +-spec setWindowChange(This, BIs) -> ok when + This::wxNavigationKeyEvent(), BIs::boolean(). setWindowChange(#wx_ref{type=ThisT,ref=ThisRef},BIs) when is_boolean(BIs) -> ?CLASS(ThisT,wxNavigationKeyEvent), wxe_util:cast(?wxNavigationKeyEvent_SetWindowChange, <>). -%% @spec (This::wxNavigationKeyEvent()) -> bool() %% @doc See external documentation. +-spec isFromTab(This) -> boolean() when + This::wxNavigationKeyEvent(). isFromTab(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNavigationKeyEvent), wxe_util:call(?wxNavigationKeyEvent_IsFromTab, <>). -%% @spec (This::wxNavigationKeyEvent(), BIs::bool()) -> ok %% @doc See external documentation. +-spec setFromTab(This, BIs) -> ok when + This::wxNavigationKeyEvent(), BIs::boolean(). setFromTab(#wx_ref{type=ThisT,ref=ThisRef},BIs) when is_boolean(BIs) -> ?CLASS(ThisT,wxNavigationKeyEvent), wxe_util:cast(?wxNavigationKeyEvent_SetFromTab, <>). -%% @spec (This::wxNavigationKeyEvent()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getCurrentFocus(This) -> wxWindow:wxWindow() when + This::wxNavigationKeyEvent(). getCurrentFocus(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNavigationKeyEvent), wxe_util:call(?wxNavigationKeyEvent_GetCurrentFocus, <>). -%% @spec (This::wxNavigationKeyEvent(), Win::wxWindow:wxWindow()) -> ok %% @doc See external documentation. +-spec setCurrentFocus(This, Win) -> ok when + This::wxNavigationKeyEvent(), Win::wxWindow:wxWindow(). setCurrentFocus(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WinT,ref=WinRef}) -> ?CLASS(ThisT,wxNavigationKeyEvent), ?CLASS(WinT,wxWindow), diff --git a/lib/wx/src/gen/wxNcPaintEvent.erl b/lib/wx/src/gen/wxNcPaintEvent.erl index b45420a2fc..4dd292a0be 100644 --- a/lib/wx/src/gen/wxNcPaintEvent.erl +++ b/lib/wx/src/gen/wxNcPaintEvent.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 @@ -37,10 +37,12 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxNcPaintEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxNcPaintEvent() :: wx:wx_object(). %% From wxEvent %% @hidden stopPropagation(This) -> wxEvent:stopPropagation(This). 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 external documentation. +-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 external documentation. +-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, <>). -%% @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 external documentation. +-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, <>). -%% @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 external documentation. +-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, <>). -%% @spec (This::wxNotebook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-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, <>). -%% @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 external documentation. +-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, <>). -%% @spec (This::wxNotebook()) -> bool() %% @doc See external documentation. +-spec deleteAllPages(This) -> boolean() when + This::wxNotebook(). deleteAllPages(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotebook), wxe_util:call(?wxNotebook_DeleteAllPages, <>). -%% @spec (This::wxNotebook(), NPage::integer()) -> bool() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook(), NPage::integer()) -> bool() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getCurrentPage(This) -> wxWindow:wxWindow() when + This::wxNotebook(). getCurrentPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotebook), wxe_util:call(?wxNotebook_GetCurrentPage, <>). -%% @spec (This::wxNotebook()) -> wxImageList:wxImageList() %% @doc See external documentation. +-spec getImageList(This) -> wxImageList:wxImageList() when + This::wxNotebook(). getImageList(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotebook), wxe_util:call(?wxNotebook_GetImageList, <>). -%% @spec (This::wxNotebook(), N::integer()) -> wxWindow:wxWindow() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook()) -> integer() %% @doc See external documentation. +-spec getPageCount(This) -> integer() when + This::wxNotebook(). getPageCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotebook), wxe_util:call(?wxNotebook_GetPageCount, <>). -%% @spec (This::wxNotebook(), NPage::integer()) -> integer() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook(), NPage::integer()) -> string() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook()) -> integer() %% @doc See external documentation. +-spec getRowCount(This) -> integer() when + This::wxNotebook(). getRowCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotebook), wxe_util:call(?wxNotebook_GetRowCount, <>). -%% @spec (This::wxNotebook()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxNotebook(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotebook), wxe_util:call(?wxNotebook_GetSelection, <>). -%% @spec (This::wxNotebook()) -> wx:colour() %% @doc See external documentation. +-spec getThemeBackgroundColour(This) -> wx:wx_colour() when + This::wxNotebook(). getThemeBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotebook), wxe_util:call(?wxNotebook_GetThemeBackgroundColour, <>). -%% @spec (This::wxNotebook(), Pt::{X::integer(), Y::integer()}) -> {integer(), Flags::integer()} %% @doc See external documentation. +-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, <>). -%% @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 external documentation. +-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, <>). -%% @spec (This::wxNotebook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook(), Padding::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook(), NPage::integer(), NImage::integer()) -> bool() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook(), NPage::integer(), StrText::string()) -> bool() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook(), NPage::integer()) -> integer() %% @doc See external documentation. +-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, <>). -%% @spec (This::wxNotebook(), NPage::integer()) -> integer() %% @doc See external documentation. +-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, <>). -%% @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), diff --git a/lib/wx/src/gen/wxNotebookEvent.erl b/lib/wx/src/gen/wxNotebookEvent.erl index 6be826bdd2..72c0bb9cf4 100644 --- a/lib/wx/src/gen/wxNotebookEvent.erl +++ b/lib/wx/src/gen/wxNotebookEvent.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 @@ -41,36 +41,42 @@ isSelection/1,parent_class/1,resumePropagation/2,setInt/2,setString/2, shouldPropagate/1,skip/1,skip/2,stopPropagation/1,veto/1]). +-export_type([wxNotebookEvent/0]). %% @hidden parent_class(wxNotifyEvent) -> true; parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxNotebookEvent()) -> integer() +-type wxNotebookEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getOldSelection(This) -> integer() when + This::wxNotebookEvent(). getOldSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotebookEvent), wxe_util:call(?wxNotebookEvent_GetOldSelection, <>). -%% @spec (This::wxNotebookEvent()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxNotebookEvent(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotebookEvent), wxe_util:call(?wxNotebookEvent_GetSelection, <>). -%% @spec (This::wxNotebookEvent(), NOldSel::integer()) -> ok %% @doc See external documentation. +-spec setOldSelection(This, NOldSel) -> ok when + This::wxNotebookEvent(), NOldSel::integer(). setOldSelection(#wx_ref{type=ThisT,ref=ThisRef},NOldSel) when is_integer(NOldSel) -> ?CLASS(ThisT,wxNotebookEvent), wxe_util:cast(?wxNotebookEvent_SetOldSelection, <>). -%% @spec (This::wxNotebookEvent(), NSel::integer()) -> ok %% @doc See external documentation. +-spec setSelection(This, NSel) -> ok when + This::wxNotebookEvent(), NSel::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},NSel) when is_integer(NSel) -> ?CLASS(ThisT,wxNotebookEvent), diff --git a/lib/wx/src/gen/wxNotifyEvent.erl b/lib/wx/src/gen/wxNotifyEvent.erl index b2a6da16f0..7ba23469be 100644 --- a/lib/wx/src/gen/wxNotifyEvent.erl +++ b/lib/wx/src/gen/wxNotifyEvent.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 @@ -36,27 +36,32 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxNotifyEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxNotifyEvent()) -> ok +-type wxNotifyEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec allow(This) -> ok when + This::wxNotifyEvent(). allow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotifyEvent), wxe_util:cast(?wxNotifyEvent_Allow, <>). -%% @spec (This::wxNotifyEvent()) -> bool() %% @doc See external documentation. +-spec isAllowed(This) -> boolean() when + This::wxNotifyEvent(). isAllowed(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotifyEvent), wxe_util:call(?wxNotifyEvent_IsAllowed, <>). -%% @spec (This::wxNotifyEvent()) -> ok %% @doc See external documentation. +-spec veto(This) -> ok when + This::wxNotifyEvent(). veto(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxNotifyEvent), wxe_util:cast(?wxNotifyEvent_Veto, diff --git a/lib/wx/src/gen/wxPageSetupDialog.erl b/lib/wx/src/gen/wxPageSetupDialog.erl index 2c11863a21..227e72b679 100644 --- a/lib/wx/src/gen/wxPageSetupDialog.erl +++ b/lib/wx/src/gen/wxPageSetupDialog.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 @@ -29,18 +29,23 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPageSetupDialog/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Parent::wxWindow:wxWindow()) -> wxPageSetupDialog() +-type wxPageSetupDialog() :: wx:wx_object(). %% @equiv new(Parent, []) +-spec new(Parent) -> wxPageSetupDialog() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxPageSetupDialog() -%% Option = {data, wxPageSetupDialogData:wxPageSetupDialogData()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxPageSetupDialog() when + Parent::wxWindow:wxWindow(), + Option :: {data, wxPageSetupDialogData:wxPageSetupDialogData()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -50,22 +55,24 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxPageSetupDialog_new, <>). -%% @spec (This::wxPageSetupDialog()) -> wxPageSetupDialogData:wxPageSetupDialogData() %% @doc See external documentation. +-spec getPageSetupData(This) -> wxPageSetupDialogData:wxPageSetupDialogData() when + This::wxPageSetupDialog(). getPageSetupData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialog), wxe_util:call(?wxPageSetupDialog_GetPageSetupData, <>). -%% @spec (This::wxPageSetupDialog()) -> integer() %% @doc See external documentation. +-spec showModal(This) -> integer() when + This::wxPageSetupDialog(). showModal(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialog), wxe_util:call(?wxPageSetupDialog_ShowModal, <>). -%% @spec (This::wxPageSetupDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPageSetupDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPageSetupDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPageSetupDialogData.erl b/lib/wx/src/gen/wxPageSetupDialogData.erl index 00b4ca2a36..4670526067 100644 --- a/lib/wx/src/gen/wxPageSetupDialogData.erl +++ b/lib/wx/src/gen/wxPageSetupDialogData.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 @@ -36,17 +36,20 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPageSetupDialogData/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxPageSetupDialogData() +-type wxPageSetupDialogData() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxPageSetupDialogData(). new() -> wxe_util:construct(?wxPageSetupDialogData_new_0, <<>>). -%% @spec (PrintData::wxPrintData:wxPrintData() | wxPageSetupDialogData()) -> wxPageSetupDialogData() %% @doc See external documentation. +-spec new(PrintData) -> wxPageSetupDialogData() when + PrintData::wxPrintData:wxPrintData() | wxPageSetupDialogData(). new(#wx_ref{type=PrintDataT,ref=PrintDataRef}) -> PrintDataOP = case ?CLASS_T(PrintDataT,wxPrintData) of true -> @@ -57,216 +60,239 @@ new(#wx_ref{type=PrintDataT,ref=PrintDataRef}) -> wxe_util:construct(PrintDataOP, <>). -%% @spec (This::wxPageSetupDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enableHelp(This, Flag) -> ok when + This::wxPageSetupDialogData(), Flag::boolean(). enableHelp(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_EnableHelp, <>). -%% @spec (This::wxPageSetupDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enableMargins(This, Flag) -> ok when + This::wxPageSetupDialogData(), Flag::boolean(). enableMargins(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_EnableMargins, <>). -%% @spec (This::wxPageSetupDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enableOrientation(This, Flag) -> ok when + This::wxPageSetupDialogData(), Flag::boolean(). enableOrientation(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_EnableOrientation, <>). -%% @spec (This::wxPageSetupDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enablePaper(This, Flag) -> ok when + This::wxPageSetupDialogData(), Flag::boolean(). enablePaper(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_EnablePaper, <>). -%% @spec (This::wxPageSetupDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enablePrinter(This, Flag) -> ok when + This::wxPageSetupDialogData(), Flag::boolean(). enablePrinter(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_EnablePrinter, <>). -%% @spec (This::wxPageSetupDialogData()) -> bool() %% @doc See external documentation. +-spec getDefaultMinMargins(This) -> boolean() when + This::wxPageSetupDialogData(). getDefaultMinMargins(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetDefaultMinMargins, <>). -%% @spec (This::wxPageSetupDialogData()) -> bool() %% @doc See external documentation. +-spec getEnableMargins(This) -> boolean() when + This::wxPageSetupDialogData(). getEnableMargins(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetEnableMargins, <>). -%% @spec (This::wxPageSetupDialogData()) -> bool() %% @doc See external documentation. +-spec getEnableOrientation(This) -> boolean() when + This::wxPageSetupDialogData(). getEnableOrientation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetEnableOrientation, <>). -%% @spec (This::wxPageSetupDialogData()) -> bool() %% @doc See external documentation. +-spec getEnablePaper(This) -> boolean() when + This::wxPageSetupDialogData(). getEnablePaper(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetEnablePaper, <>). -%% @spec (This::wxPageSetupDialogData()) -> bool() %% @doc See external documentation. +-spec getEnablePrinter(This) -> boolean() when + This::wxPageSetupDialogData(). getEnablePrinter(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetEnablePrinter, <>). -%% @spec (This::wxPageSetupDialogData()) -> bool() %% @doc See external documentation. +-spec getEnableHelp(This) -> boolean() when + This::wxPageSetupDialogData(). getEnableHelp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetEnableHelp, <>). -%% @spec (This::wxPageSetupDialogData()) -> bool() %% @doc See external documentation. +-spec getDefaultInfo(This) -> boolean() when + This::wxPageSetupDialogData(). getDefaultInfo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetDefaultInfo, <>). -%% @spec (This::wxPageSetupDialogData()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getMarginTopLeft(This) -> {X::integer(), Y::integer()} when + This::wxPageSetupDialogData(). getMarginTopLeft(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetMarginTopLeft, <>). -%% @spec (This::wxPageSetupDialogData()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getMarginBottomRight(This) -> {X::integer(), Y::integer()} when + This::wxPageSetupDialogData(). getMarginBottomRight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetMarginBottomRight, <>). -%% @spec (This::wxPageSetupDialogData()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getMinMarginTopLeft(This) -> {X::integer(), Y::integer()} when + This::wxPageSetupDialogData(). getMinMarginTopLeft(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetMinMarginTopLeft, <>). -%% @spec (This::wxPageSetupDialogData()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getMinMarginBottomRight(This) -> {X::integer(), Y::integer()} when + This::wxPageSetupDialogData(). getMinMarginBottomRight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetMinMarginBottomRight, <>). -%% @spec (This::wxPageSetupDialogData()) -> integer() %% @doc See external documentation. +-spec getPaperId(This) -> integer() when + This::wxPageSetupDialogData(). getPaperId(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetPaperId, <>). -%% @spec (This::wxPageSetupDialogData()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getPaperSize(This) -> {W::integer(), H::integer()} when + This::wxPageSetupDialogData(). getPaperSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetPaperSize, <>). -%% @spec (This::wxPageSetupDialogData()) -> wxPrintData:wxPrintData() %% @doc See external documentation. +-spec getPrintData(This) -> wxPrintData:wxPrintData() when + This::wxPageSetupDialogData(). getPrintData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_GetPrintData, <>). -%% @spec (This::wxPageSetupDialogData()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxPageSetupDialogData(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:call(?wxPageSetupDialogData_IsOk, <>). -%% @spec (This::wxPageSetupDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec setDefaultInfo(This, Flag) -> ok when + This::wxPageSetupDialogData(), Flag::boolean(). setDefaultInfo(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_SetDefaultInfo, <>). -%% @spec (This::wxPageSetupDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec setDefaultMinMargins(This, Flag) -> ok when + This::wxPageSetupDialogData(), Flag::boolean(). setDefaultMinMargins(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_SetDefaultMinMargins, <>). -%% @spec (This::wxPageSetupDialogData(), Pt::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec setMarginTopLeft(This, Pt) -> ok when + This::wxPageSetupDialogData(), Pt::{X::integer(), Y::integer()}. setMarginTopLeft(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_SetMarginTopLeft, <>). -%% @spec (This::wxPageSetupDialogData(), Pt::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec setMarginBottomRight(This, Pt) -> ok when + This::wxPageSetupDialogData(), Pt::{X::integer(), Y::integer()}. setMarginBottomRight(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_SetMarginBottomRight, <>). -%% @spec (This::wxPageSetupDialogData(), Pt::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec setMinMarginTopLeft(This, Pt) -> ok when + This::wxPageSetupDialogData(), Pt::{X::integer(), Y::integer()}. setMinMarginTopLeft(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_SetMinMarginTopLeft, <>). -%% @spec (This::wxPageSetupDialogData(), Pt::{X::integer(), Y::integer()}) -> ok %% @doc See external documentation. +-spec setMinMarginBottomRight(This, Pt) -> ok when + This::wxPageSetupDialogData(), Pt::{X::integer(), Y::integer()}. setMinMarginBottomRight(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_SetMinMarginBottomRight, <>). -%% @spec (This::wxPageSetupDialogData(), Id::integer()) -> ok %% @doc See external documentation. +-spec setPaperId(This, Id) -> ok when + This::wxPageSetupDialogData(), Id::integer(). setPaperId(#wx_ref{type=ThisT,ref=ThisRef},Id) when is_integer(Id) -> ?CLASS(ThisT,wxPageSetupDialogData), wxe_util:cast(?wxPageSetupDialogData_SetPaperId, <>). -%% @spec (This::wxPageSetupDialogData(),X::integer()|term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setPaperSize(This::wxPageSetupDialogData(), Id::integer()) -> ok -%%

-%%

-%% setPaperSize(This::wxPageSetupDialogData(), Sz::{W::integer(), H::integer()}) -> ok -%%

+-spec setPaperSize(This, Id) -> ok when + This::wxPageSetupDialogData(), Id::integer(); + (This, Sz) -> ok when + This::wxPageSetupDialogData(), Sz::{W::integer(), H::integer()}. setPaperSize(#wx_ref{type=ThisT,ref=ThisRef},Id) when is_integer(Id) -> ?CLASS(ThisT,wxPageSetupDialogData), @@ -278,16 +304,17 @@ setPaperSize(#wx_ref{type=ThisT,ref=ThisRef},{SzW,SzH}) wxe_util:cast(?wxPageSetupDialogData_SetPaperSize_1_1, <>). -%% @spec (This::wxPageSetupDialogData(), PrintData::wxPrintData:wxPrintData()) -> ok %% @doc See external documentation. +-spec setPrintData(This, PrintData) -> ok when + This::wxPageSetupDialogData(), PrintData::wxPrintData:wxPrintData(). setPrintData(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PrintDataT,ref=PrintDataRef}) -> ?CLASS(ThisT,wxPageSetupDialogData), ?CLASS(PrintDataT,wxPrintData), wxe_util:cast(?wxPageSetupDialogData_SetPrintData, <>). -%% @spec (This::wxPageSetupDialogData()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPageSetupDialogData) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPageSetupDialogData), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPaintDC.erl b/lib/wx/src/gen/wxPaintDC.erl index 47d5947097..e81772b87b 100644 --- a/lib/wx/src/gen/wxPaintDC.erl +++ b/lib/wx/src/gen/wxPaintDC.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 @@ -53,26 +53,29 @@ setPen/2,setTextBackground/2,setTextForeground/2,setUserScale/3,startDoc/2, startPage/1]). +-export_type([wxPaintDC/0]). %% @hidden parent_class(wxWindowDC) -> true; parent_class(wxDC) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxPaintDC() +-type wxPaintDC() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxPaintDC(). new() -> wxe_util:construct(?wxPaintDC_new_0, <<>>). -%% @spec (Win::wxWindow:wxWindow()) -> wxPaintDC() %% @doc See external documentation. +-spec new(Win) -> wxPaintDC() when + Win::wxWindow:wxWindow(). new(#wx_ref{type=WinT,ref=WinRef}) -> ?CLASS(WinT,wxWindow), wxe_util:construct(?wxPaintDC_new_1, <>). -%% @spec (This::wxPaintDC()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPaintDC) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPaintDC), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPaintEvent.erl b/lib/wx/src/gen/wxPaintEvent.erl index 2603e61623..a13db607a4 100644 --- a/lib/wx/src/gen/wxPaintEvent.erl +++ b/lib/wx/src/gen/wxPaintEvent.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 @@ -37,10 +37,12 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxPaintEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxPaintEvent() :: wx:wx_object(). %% From wxEvent %% @hidden stopPropagation(This) -> wxEvent:stopPropagation(This). diff --git a/lib/wx/src/gen/wxPalette.erl b/lib/wx/src/gen/wxPalette.erl index 3d8e811988..a3005bff80 100644 --- a/lib/wx/src/gen/wxPalette.erl +++ b/lib/wx/src/gen/wxPalette.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 @@ -30,17 +30,20 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPalette/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxPalette() +-type wxPalette() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxPalette(). new() -> wxe_util:construct(?wxPalette_new_0, <<>>). -%% @spec (Red::binary(), Green::binary(), Blue::binary()) -> wxPalette() %% @doc See external documentation. +-spec new(Red, Green, Blue) -> wxPalette() when + Red::binary(), Green::binary(), Blue::binary(). new(Red,Green,Blue) when is_binary(Red),is_binary(Green),is_binary(Blue) -> wxe_util:send_bin(Red), @@ -49,8 +52,9 @@ new(Red,Green,Blue) wxe_util:construct(?wxPalette_new_4, <<>>). -%% @spec (This::wxPalette(), Red::binary(), Green::binary(), Blue::binary()) -> bool() %% @doc See external documentation. +-spec create(This, Red, Green, Blue) -> boolean() when + This::wxPalette(), Red::binary(), Green::binary(), Blue::binary(). create(#wx_ref{type=ThisT,ref=ThisRef},Red,Green,Blue) when is_binary(Red),is_binary(Green),is_binary(Blue) -> ?CLASS(ThisT,wxPalette), @@ -60,38 +64,43 @@ create(#wx_ref{type=ThisT,ref=ThisRef},Red,Green,Blue) wxe_util:call(?wxPalette_Create, <>). -%% @spec (This::wxPalette()) -> integer() %% @doc See external documentation. +-spec getColoursCount(This) -> integer() when + This::wxPalette(). getColoursCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPalette), wxe_util:call(?wxPalette_GetColoursCount, <>). -%% @spec (This::wxPalette(), Red::integer(), Green::integer(), Blue::integer()) -> integer() %% @doc See external documentation. +-spec getPixel(This, Red, Green, Blue) -> integer() when + This::wxPalette(), Red::integer(), Green::integer(), Blue::integer(). getPixel(#wx_ref{type=ThisT,ref=ThisRef},Red,Green,Blue) when is_integer(Red),is_integer(Green),is_integer(Blue) -> ?CLASS(ThisT,wxPalette), wxe_util:call(?wxPalette_GetPixel, <>). -%% @spec (This::wxPalette(), Pixel::integer()) -> {bool(), Red::integer(), Green::integer(), Blue::integer()} %% @doc See external documentation. +-spec getRGB(This, Pixel) -> Result when + Result ::{Res ::boolean(), Red::integer(), Green::integer(), Blue::integer()}, + This::wxPalette(), Pixel::integer(). getRGB(#wx_ref{type=ThisT,ref=ThisRef},Pixel) when is_integer(Pixel) -> ?CLASS(ThisT,wxPalette), wxe_util:call(?wxPalette_GetRGB, <>). -%% @spec (This::wxPalette()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxPalette(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPalette), wxe_util:call(?wxPalette_IsOk, <>). -%% @spec (This::wxPalette()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPalette) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPalette), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPaletteChangedEvent.erl b/lib/wx/src/gen/wxPaletteChangedEvent.erl index 1831bf1375..aa9ae68ec2 100644 --- a/lib/wx/src/gen/wxPaletteChangedEvent.erl +++ b/lib/wx/src/gen/wxPaletteChangedEvent.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 @@ -37,20 +37,24 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxPaletteChangedEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxPaletteChangedEvent(), Win::wxWindow:wxWindow()) -> ok +-type wxPaletteChangedEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec setChangedWindow(This, Win) -> ok when + This::wxPaletteChangedEvent(), Win::wxWindow:wxWindow(). setChangedWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WinT,ref=WinRef}) -> ?CLASS(ThisT,wxPaletteChangedEvent), ?CLASS(WinT,wxWindow), wxe_util:cast(?wxPaletteChangedEvent_SetChangedWindow, <>). -%% @spec (This::wxPaletteChangedEvent()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getChangedWindow(This) -> wxWindow:wxWindow() when + This::wxPaletteChangedEvent(). getChangedWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPaletteChangedEvent), wxe_util:call(?wxPaletteChangedEvent_GetChangedWindow, diff --git a/lib/wx/src/gen/wxPanel.erl b/lib/wx/src/gen/wxPanel.erl index 59fba03102..fb1781a775 100644 --- a/lib/wx/src/gen/wxPanel.erl +++ b/lib/wx/src/gen/wxPanel.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 @@ -68,26 +68,34 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxPanel/0]). %% @hidden parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxPanel() +-type wxPanel() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxPanel(). new() -> wxe_util:construct(?wxPanel_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxPanel() %% @equiv new(Parent, []) +-spec new(Parent) -> wxPanel() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxPanel() -%% Option = {winid, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxPanel() when + Parent::wxWindow:wxWindow(), + Option :: {winid, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -100,15 +108,18 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxPanel_new_2, <>). -%% @spec (Parent::wxWindow:wxWindow(), X::integer(), Y::integer(), Width::integer(), Height::integer()) -> wxPanel() %% @equiv new(Parent,X,Y,Width,Height, []) +-spec new(Parent, X, Y, Width, Height) -> wxPanel() when + Parent::wxWindow:wxWindow(), X::integer(), Y::integer(), Width::integer(), Height::integer(). + new(Parent,X,Y,Width,Height) when is_record(Parent, wx_ref),is_integer(X),is_integer(Y),is_integer(Width),is_integer(Height) -> new(Parent,X,Y,Width,Height, []). -%% @spec (Parent::wxWindow:wxWindow(), X::integer(), Y::integer(), Width::integer(), Height::integer(), [Option]) -> wxPanel() -%% Option = {style, integer()} %% @doc See external documentation. +-spec new(Parent, X, Y, Width, Height, [Option]) -> wxPanel() when + Parent::wxWindow:wxWindow(), X::integer(), Y::integer(), Width::integer(), Height::integer(), + Option :: {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},X,Y,Width,Height, Options) when is_integer(X),is_integer(Y),is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -118,15 +129,16 @@ new(#wx_ref{type=ParentT,ref=ParentRef},X,Y,Width,Height, Options) wxe_util:construct(?wxPanel_new_6, <>). -%% @spec (This::wxPanel()) -> ok %% @doc See external documentation. +-spec initDialog(This) -> ok when + This::wxPanel(). initDialog(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPanel), wxe_util:cast(?wxPanel_InitDialog, <>). -%% @spec (This::wxPanel()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPanel) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPanel), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPasswordEntryDialog.erl b/lib/wx/src/gen/wxPasswordEntryDialog.erl index 07a0bcef56..7508bf6506 100644 --- a/lib/wx/src/gen/wxPasswordEntryDialog.erl +++ b/lib/wx/src/gen/wxPasswordEntryDialog.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 @@ -79,6 +79,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxPasswordEntryDialog/0]). %% @hidden parent_class(wxTextEntryDialog) -> true; parent_class(wxDialog) -> true; @@ -87,15 +88,22 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Parent::wxWindow:wxWindow(), Message::string()) -> wxPasswordEntryDialog() +-type wxPasswordEntryDialog() :: wx:wx_object(). %% @equiv new(Parent,Message, []) +-spec new(Parent, Message) -> wxPasswordEntryDialog() when + Parent::wxWindow:wxWindow(), Message::string(). + new(Parent,Message) when is_record(Parent, wx_ref),is_list(Message) -> new(Parent,Message, []). -%% @spec (Parent::wxWindow:wxWindow(), Message::string(), [Option]) -> wxPasswordEntryDialog() -%% Option = {caption, string()} | {value, string()} | {style, integer()} | {pos, {X::integer(), Y::integer()}} %% @doc See external documentation. +-spec new(Parent, Message, [Option]) -> wxPasswordEntryDialog() when + Parent::wxWindow:wxWindow(), Message::string(), + Option :: {caption, string()} + | {value, string()} + | {style, integer()} + | {pos, {X::integer(), Y::integer()}}. new(#wx_ref{type=ParentT,ref=ParentRef},Message, Options) when is_list(Message),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -109,8 +117,8 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Message, Options) wxe_util:construct(?wxPasswordEntryDialog_new, <>). -%% @spec (This::wxPasswordEntryDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPasswordEntryDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPasswordEntryDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPen.erl b/lib/wx/src/gen/wxPen.erl index ada95b0ee3..629f3edfd7 100644 --- a/lib/wx/src/gen/wxPen.erl +++ b/lib/wx/src/gen/wxPen.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 @@ -31,24 +31,30 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPen/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxPen() +-type wxPen() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxPen(). new() -> wxe_util:construct(?wxPen_new_0, <<>>). -%% @spec (Colour::wx:colour()) -> wxPen() %% @equiv new(Colour, []) +-spec new(Colour) -> wxPen() when + Colour::wx:wx_colour(). + new(Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> new(Colour, []). -%% @spec (Colour::wx:colour(), [Option]) -> wxPen() -%% Option = {width, integer()} | {style, integer()} %% @doc See external documentation. +-spec new(Colour, [Option]) -> wxPen() when + Colour::wx:wx_colour(), + Option :: {width, integer()} + | {style, integer()}. new(Colour, Options) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4,is_list(Options) -> MOpts = fun({width, Width}, Acc) -> [<<1:32/?UI,Width:32/?UI>>|Acc]; @@ -58,98 +64,110 @@ new(Colour, Options) wxe_util:construct(?wxPen_new_2, <<(wxe_util:colour_bin(Colour)):16/binary, BinOpt/binary>>). -%% @spec (This::wxPen()) -> integer() %% @doc See external documentation. +-spec getCap(This) -> integer() when + This::wxPen(). getCap(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPen), wxe_util:call(?wxPen_GetCap, <>). -%% @spec (This::wxPen()) -> wx:colour() %% @doc See external documentation. +-spec getColour(This) -> wx:wx_colour() when + This::wxPen(). getColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPen), wxe_util:call(?wxPen_GetColour, <>). -%% @spec (This::wxPen()) -> integer() %% @doc See external documentation. +-spec getJoin(This) -> integer() when + This::wxPen(). getJoin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPen), wxe_util:call(?wxPen_GetJoin, <>). -%% @spec (This::wxPen()) -> integer() %% @doc See external documentation. +-spec getStyle(This) -> integer() when + This::wxPen(). getStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPen), wxe_util:call(?wxPen_GetStyle, <>). -%% @spec (This::wxPen()) -> integer() %% @doc See external documentation. +-spec getWidth(This) -> integer() when + This::wxPen(). getWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPen), wxe_util:call(?wxPen_GetWidth, <>). -%% @spec (This::wxPen()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxPen(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPen), wxe_util:call(?wxPen_IsOk, <>). -%% @spec (This::wxPen(), CapStyle::integer()) -> ok %% @doc See external documentation. +-spec setCap(This, CapStyle) -> ok when + This::wxPen(), CapStyle::integer(). setCap(#wx_ref{type=ThisT,ref=ThisRef},CapStyle) when is_integer(CapStyle) -> ?CLASS(ThisT,wxPen), wxe_util:cast(?wxPen_SetCap, <>). -%% @spec (This::wxPen(), Colour::wx:colour()) -> ok %% @doc See external documentation. +-spec setColour(This, Colour) -> ok when + This::wxPen(), Colour::wx:wx_colour(). setColour(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxPen), wxe_util:cast(?wxPen_SetColour_1, <>). -%% @spec (This::wxPen(), Red::integer(), Green::integer(), Blue::integer()) -> ok %% @doc See external documentation. +-spec setColour(This, Red, Green, Blue) -> ok when + This::wxPen(), Red::integer(), Green::integer(), Blue::integer(). setColour(#wx_ref{type=ThisT,ref=ThisRef},Red,Green,Blue) when is_integer(Red),is_integer(Green),is_integer(Blue) -> ?CLASS(ThisT,wxPen), wxe_util:cast(?wxPen_SetColour_3, <>). -%% @spec (This::wxPen(), JoinStyle::integer()) -> ok %% @doc See external documentation. +-spec setJoin(This, JoinStyle) -> ok when + This::wxPen(), JoinStyle::integer(). setJoin(#wx_ref{type=ThisT,ref=ThisRef},JoinStyle) when is_integer(JoinStyle) -> ?CLASS(ThisT,wxPen), wxe_util:cast(?wxPen_SetJoin, <>). -%% @spec (This::wxPen(), Style::integer()) -> ok %% @doc See external documentation. +-spec setStyle(This, Style) -> ok when + This::wxPen(), Style::integer(). setStyle(#wx_ref{type=ThisT,ref=ThisRef},Style) when is_integer(Style) -> ?CLASS(ThisT,wxPen), wxe_util:cast(?wxPen_SetStyle, <>). -%% @spec (This::wxPen(), Width::integer()) -> ok %% @doc See external documentation. +-spec setWidth(This, Width) -> ok when + This::wxPen(), Width::integer(). setWidth(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxPen), wxe_util:cast(?wxPen_SetWidth, <>). -%% @spec (This::wxPen()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPen) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPen), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPickerBase.erl b/lib/wx/src/gen/wxPickerBase.erl index e60ab4f9d8..2253127d84 100644 --- a/lib/wx/src/gen/wxPickerBase.erl +++ b/lib/wx/src/gen/wxPickerBase.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 @@ -72,87 +72,101 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxPickerBase/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxPickerBase(), Newmargin::integer()) -> ok +-type wxPickerBase() :: wx:wx_object(). %% @doc See external documentation. +-spec setInternalMargin(This, Newmargin) -> ok when + This::wxPickerBase(), Newmargin::integer(). setInternalMargin(#wx_ref{type=ThisT,ref=ThisRef},Newmargin) when is_integer(Newmargin) -> ?CLASS(ThisT,wxPickerBase), wxe_util:cast(?wxPickerBase_SetInternalMargin, <>). -%% @spec (This::wxPickerBase()) -> integer() %% @doc See external documentation. +-spec getInternalMargin(This) -> integer() when + This::wxPickerBase(). getInternalMargin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPickerBase), wxe_util:call(?wxPickerBase_GetInternalMargin, <>). -%% @spec (This::wxPickerBase(), Prop::integer()) -> ok %% @doc See external documentation. +-spec setTextCtrlProportion(This, Prop) -> ok when + This::wxPickerBase(), Prop::integer(). setTextCtrlProportion(#wx_ref{type=ThisT,ref=ThisRef},Prop) when is_integer(Prop) -> ?CLASS(ThisT,wxPickerBase), wxe_util:cast(?wxPickerBase_SetTextCtrlProportion, <>). -%% @spec (This::wxPickerBase(), Prop::integer()) -> ok %% @doc See external documentation. +-spec setPickerCtrlProportion(This, Prop) -> ok when + This::wxPickerBase(), Prop::integer(). setPickerCtrlProportion(#wx_ref{type=ThisT,ref=ThisRef},Prop) when is_integer(Prop) -> ?CLASS(ThisT,wxPickerBase), wxe_util:cast(?wxPickerBase_SetPickerCtrlProportion, <>). -%% @spec (This::wxPickerBase()) -> integer() %% @doc See external documentation. +-spec getTextCtrlProportion(This) -> integer() when + This::wxPickerBase(). getTextCtrlProportion(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPickerBase), wxe_util:call(?wxPickerBase_GetTextCtrlProportion, <>). -%% @spec (This::wxPickerBase()) -> integer() %% @doc See external documentation. +-spec getPickerCtrlProportion(This) -> integer() when + This::wxPickerBase(). getPickerCtrlProportion(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPickerBase), wxe_util:call(?wxPickerBase_GetPickerCtrlProportion, <>). -%% @spec (This::wxPickerBase()) -> bool() %% @doc See external documentation. +-spec hasTextCtrl(This) -> boolean() when + This::wxPickerBase(). hasTextCtrl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPickerBase), wxe_util:call(?wxPickerBase_HasTextCtrl, <>). -%% @spec (This::wxPickerBase()) -> wxTextCtrl:wxTextCtrl() %% @doc See external documentation. +-spec getTextCtrl(This) -> wxTextCtrl:wxTextCtrl() when + This::wxPickerBase(). getTextCtrl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPickerBase), wxe_util:call(?wxPickerBase_GetTextCtrl, <>). -%% @spec (This::wxPickerBase()) -> bool() %% @doc See external documentation. +-spec isTextCtrlGrowable(This) -> boolean() when + This::wxPickerBase(). isTextCtrlGrowable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPickerBase), wxe_util:call(?wxPickerBase_IsTextCtrlGrowable, <>). -%% @spec (This::wxPickerBase()) -> ok %% @equiv setPickerCtrlGrowable(This, []) +-spec setPickerCtrlGrowable(This) -> ok when + This::wxPickerBase(). + setPickerCtrlGrowable(This) when is_record(This, wx_ref) -> setPickerCtrlGrowable(This, []). -%% @spec (This::wxPickerBase(), [Option]) -> ok -%% Option = {grow, bool()} %% @doc See external documentation. +-spec setPickerCtrlGrowable(This, [Option]) -> ok when + This::wxPickerBase(), + Option :: {grow, boolean()}. setPickerCtrlGrowable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxPickerBase), @@ -162,15 +176,18 @@ setPickerCtrlGrowable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxPickerBase_SetPickerCtrlGrowable, <>). -%% @spec (This::wxPickerBase()) -> ok %% @equiv setTextCtrlGrowable(This, []) +-spec setTextCtrlGrowable(This) -> ok when + This::wxPickerBase(). + setTextCtrlGrowable(This) when is_record(This, wx_ref) -> setTextCtrlGrowable(This, []). -%% @spec (This::wxPickerBase(), [Option]) -> ok -%% Option = {grow, bool()} %% @doc See external documentation. +-spec setTextCtrlGrowable(This, [Option]) -> ok when + This::wxPickerBase(), + Option :: {grow, boolean()}. setTextCtrlGrowable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxPickerBase), @@ -180,8 +197,9 @@ setTextCtrlGrowable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxPickerBase_SetTextCtrlGrowable, <>). -%% @spec (This::wxPickerBase()) -> bool() %% @doc See external documentation. +-spec isPickerCtrlGrowable(This) -> boolean() when + This::wxPickerBase(). isPickerCtrlGrowable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPickerBase), wxe_util:call(?wxPickerBase_IsPickerCtrlGrowable, diff --git a/lib/wx/src/gen/wxPostScriptDC.erl b/lib/wx/src/gen/wxPostScriptDC.erl index df3edfade9..4e08ef8c81 100644 --- a/lib/wx/src/gen/wxPostScriptDC.erl +++ b/lib/wx/src/gen/wxPostScriptDC.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 @@ -52,38 +52,42 @@ setPen/2,setTextBackground/2,setTextForeground/2,setUserScale/3,startDoc/2, startPage/1]). +-export_type([wxPostScriptDC/0]). %% @hidden parent_class(wxDC) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxPostScriptDC() +-type wxPostScriptDC() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxPostScriptDC(). new() -> wxe_util:construct(?wxPostScriptDC_new_0, <<>>). -%% @spec (PrintData::wxPrintData:wxPrintData()) -> wxPostScriptDC() %% @doc See external documentation. +-spec new(PrintData) -> wxPostScriptDC() when + PrintData::wxPrintData:wxPrintData(). new(#wx_ref{type=PrintDataT,ref=PrintDataRef}) -> ?CLASS(PrintDataT,wxPrintData), wxe_util:construct(?wxPostScriptDC_new_1, <>). -%% @spec (Ppi::integer()) -> ok %% @doc See external documentation. +-spec setResolution(Ppi) -> ok when + Ppi::integer(). setResolution(Ppi) when is_integer(Ppi) -> wxe_util:cast(?wxPostScriptDC_SetResolution, <>). -%% @spec () -> integer() %% @doc See external documentation. +-spec getResolution() -> integer(). getResolution() -> wxe_util:call(?wxPostScriptDC_GetResolution, <<>>). -%% @spec (This::wxPostScriptDC()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPostScriptDC) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPostScriptDC), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPreviewCanvas.erl b/lib/wx/src/gen/wxPreviewCanvas.erl index d33aeedb70..cc9f43e5e4 100644 --- a/lib/wx/src/gen/wxPreviewCanvas.erl +++ b/lib/wx/src/gen/wxPreviewCanvas.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 @@ -74,6 +74,7 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxPreviewCanvas/0]). %% @hidden parent_class(wxScrolledWindow) -> true; parent_class(wxPanel) -> true; @@ -81,6 +82,7 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxPreviewCanvas() :: wx:wx_object(). %% From wxScrolledWindow %% @hidden setTargetWindow(This,Target) -> wxScrolledWindow:setTargetWindow(This,Target). diff --git a/lib/wx/src/gen/wxPreviewControlBar.erl b/lib/wx/src/gen/wxPreviewControlBar.erl index e85af625e2..b59ac18443 100644 --- a/lib/wx/src/gen/wxPreviewControlBar.erl +++ b/lib/wx/src/gen/wxPreviewControlBar.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 @@ -70,21 +70,28 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxPreviewControlBar/0]). %% @hidden parent_class(wxPanel) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Preview::wxPrintPreview:wxPrintPreview(), Buttons::integer(), Parent::wxWindow:wxWindow()) -> wxPreviewControlBar() +-type wxPreviewControlBar() :: wx:wx_object(). %% @equiv new(Preview,Buttons,Parent, []) +-spec new(Preview, Buttons, Parent) -> wxPreviewControlBar() when + Preview::wxPrintPreview:wxPrintPreview(), Buttons::integer(), Parent::wxWindow:wxWindow(). + new(Preview,Buttons,Parent) when is_record(Preview, wx_ref),is_integer(Buttons),is_record(Parent, wx_ref) -> new(Preview,Buttons,Parent, []). -%% @spec (Preview::wxPrintPreview:wxPrintPreview(), Buttons::integer(), Parent::wxWindow:wxWindow(), [Option]) -> wxPreviewControlBar() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Preview, Buttons, Parent, [Option]) -> wxPreviewControlBar() when + Preview::wxPrintPreview:wxPrintPreview(), Buttons::integer(), Parent::wxWindow:wxWindow(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=PreviewT,ref=PreviewRef},Buttons,#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_integer(Buttons),is_list(Options) -> ?CLASS(PreviewT,wxPrintPreview), @@ -97,37 +104,41 @@ new(#wx_ref{type=PreviewT,ref=PreviewRef},Buttons,#wx_ref{type=ParentT,ref=Paren wxe_util:construct(?wxPreviewControlBar_new, <>). -%% @spec (This::wxPreviewControlBar()) -> ok %% @doc See external documentation. +-spec createButtons(This) -> ok when + This::wxPreviewControlBar(). createButtons(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPreviewControlBar), wxe_util:cast(?wxPreviewControlBar_CreateButtons, <>). -%% @spec (This::wxPreviewControlBar()) -> wxPrintPreview:wxPrintPreview() %% @doc See external documentation. +-spec getPrintPreview(This) -> wxPrintPreview:wxPrintPreview() when + This::wxPreviewControlBar(). getPrintPreview(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPreviewControlBar), wxe_util:call(?wxPreviewControlBar_GetPrintPreview, <>). -%% @spec (This::wxPreviewControlBar()) -> integer() %% @doc See external documentation. +-spec getZoomControl(This) -> integer() when + This::wxPreviewControlBar(). getZoomControl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPreviewControlBar), wxe_util:call(?wxPreviewControlBar_GetZoomControl, <>). -%% @spec (This::wxPreviewControlBar(), Zoom::integer()) -> ok %% @doc See external documentation. +-spec setZoomControl(This, Zoom) -> ok when + This::wxPreviewControlBar(), Zoom::integer(). setZoomControl(#wx_ref{type=ThisT,ref=ThisRef},Zoom) when is_integer(Zoom) -> ?CLASS(ThisT,wxPreviewControlBar), wxe_util:cast(?wxPreviewControlBar_SetZoomControl, <>). -%% @spec (This::wxPreviewControlBar()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPreviewControlBar) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPreviewControlBar), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPreviewFrame.erl b/lib/wx/src/gen/wxPreviewFrame.erl index da43f86030..162e7b1621 100644 --- a/lib/wx/src/gen/wxPreviewFrame.erl +++ b/lib/wx/src/gen/wxPreviewFrame.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 @@ -81,6 +81,7 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxPreviewFrame/0]). %% @hidden parent_class(wxFrame) -> true; parent_class(wxTopLevelWindow) -> true; @@ -88,15 +89,22 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Preview::wxPrintPreview:wxPrintPreview(), Parent::wxWindow:wxWindow()) -> wxPreviewFrame() +-type wxPreviewFrame() :: wx:wx_object(). %% @equiv new(Preview,Parent, []) +-spec new(Preview, Parent) -> wxPreviewFrame() when + Preview::wxPrintPreview:wxPrintPreview(), Parent::wxWindow:wxWindow(). + new(Preview,Parent) when is_record(Preview, wx_ref),is_record(Parent, wx_ref) -> new(Preview,Parent, []). -%% @spec (Preview::wxPrintPreview:wxPrintPreview(), Parent::wxWindow:wxWindow(), [Option]) -> wxPreviewFrame() -%% Option = {title, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Preview, Parent, [Option]) -> wxPreviewFrame() when + Preview::wxPrintPreview:wxPrintPreview(), Parent::wxWindow:wxWindow(), + Option :: {title, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=PreviewT,ref=PreviewRef},#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(PreviewT,wxPrintPreview), @@ -110,37 +118,41 @@ new(#wx_ref{type=PreviewT,ref=PreviewRef},#wx_ref{type=ParentT,ref=ParentRef}, O wxe_util:construct(?wxPreviewFrame_new, <>). -%% @spec (This::wxPreviewFrame()) -> ok %% @doc See external documentation. +-spec createControlBar(This) -> ok when + This::wxPreviewFrame(). createControlBar(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPreviewFrame), wxe_util:cast(?wxPreviewFrame_CreateControlBar, <>). -%% @spec (This::wxPreviewFrame()) -> ok %% @doc See external documentation. +-spec createCanvas(This) -> ok when + This::wxPreviewFrame(). createCanvas(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPreviewFrame), wxe_util:cast(?wxPreviewFrame_CreateCanvas, <>). -%% @spec (This::wxPreviewFrame()) -> ok %% @doc See external documentation. +-spec initialize(This) -> ok when + This::wxPreviewFrame(). initialize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPreviewFrame), wxe_util:cast(?wxPreviewFrame_Initialize, <>). -%% @spec (This::wxPreviewFrame(), Event::wxCloseEvent:wxCloseEvent()) -> ok %% @doc See external documentation. +-spec onCloseWindow(This, Event) -> ok when + This::wxPreviewFrame(), Event::wxCloseEvent:wxCloseEvent(). onCloseWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=EventT,ref=EventRef}) -> ?CLASS(ThisT,wxPreviewFrame), ?CLASS(EventT,wxCloseEvent), wxe_util:cast(?wxPreviewFrame_OnCloseWindow, <>). -%% @spec (This::wxPreviewFrame()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPreviewFrame) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPreviewFrame), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPrintData.erl b/lib/wx/src/gen/wxPrintData.erl index f3e8ad3612..5b5f872abc 100644 --- a/lib/wx/src/gen/wxPrintData.erl +++ b/lib/wx/src/gen/wxPrintData.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 @@ -32,158 +32,175 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPrintData/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxPrintData() +-type wxPrintData() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxPrintData(). new() -> wxe_util:construct(?wxPrintData_new_0, <<>>). -%% @spec (PrintData::wxPrintData()) -> wxPrintData() %% @doc See external documentation. +-spec new(PrintData) -> wxPrintData() when + PrintData::wxPrintData(). new(#wx_ref{type=PrintDataT,ref=PrintDataRef}) -> ?CLASS(PrintDataT,wxPrintData), wxe_util:construct(?wxPrintData_new_1, <>). -%% @spec (This::wxPrintData()) -> bool() %% @doc See external documentation. +-spec getCollate(This) -> boolean() when + This::wxPrintData(). getCollate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_GetCollate, <>). -%% @spec (This::wxPrintData()) -> WxPrintBin -%% WxPrintBin = integer() %% @doc See external documentation. -%%
WxPrintBin is one of ?wxPRINTBIN_DEFAULT | ?wxPRINTBIN_ONLYONE | ?wxPRINTBIN_LOWER | ?wxPRINTBIN_MIDDLE | ?wxPRINTBIN_MANUAL | ?wxPRINTBIN_ENVELOPE | ?wxPRINTBIN_ENVMANUAL | ?wxPRINTBIN_AUTO | ?wxPRINTBIN_TRACTOR | ?wxPRINTBIN_SMALLFMT | ?wxPRINTBIN_LARGEFMT | ?wxPRINTBIN_LARGECAPACITY | ?wxPRINTBIN_CASSETTE | ?wxPRINTBIN_FORMSOURCE | ?wxPRINTBIN_USER +%%
Res = ?wxPRINTBIN_DEFAULT | ?wxPRINTBIN_ONLYONE | ?wxPRINTBIN_LOWER | ?wxPRINTBIN_MIDDLE | ?wxPRINTBIN_MANUAL | ?wxPRINTBIN_ENVELOPE | ?wxPRINTBIN_ENVMANUAL | ?wxPRINTBIN_AUTO | ?wxPRINTBIN_TRACTOR | ?wxPRINTBIN_SMALLFMT | ?wxPRINTBIN_LARGEFMT | ?wxPRINTBIN_LARGECAPACITY | ?wxPRINTBIN_CASSETTE | ?wxPRINTBIN_FORMSOURCE | ?wxPRINTBIN_USER +-spec getBin(This) -> wx:wx_enum() when + This::wxPrintData(). getBin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_GetBin, <>). -%% @spec (This::wxPrintData()) -> bool() %% @doc See external documentation. +-spec getColour(This) -> boolean() when + This::wxPrintData(). getColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_GetColour, <>). -%% @spec (This::wxPrintData()) -> WxDuplexMode -%% WxDuplexMode = integer() %% @doc See external documentation. -%%
WxDuplexMode is one of ?wxDUPLEX_SIMPLEX | ?wxDUPLEX_HORIZONTAL | ?wxDUPLEX_VERTICAL +%%
Res = ?wxDUPLEX_SIMPLEX | ?wxDUPLEX_HORIZONTAL | ?wxDUPLEX_VERTICAL +-spec getDuplex(This) -> wx:wx_enum() when + This::wxPrintData(). getDuplex(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_GetDuplex, <>). -%% @spec (This::wxPrintData()) -> integer() %% @doc See external documentation. +-spec getNoCopies(This) -> integer() when + This::wxPrintData(). getNoCopies(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_GetNoCopies, <>). -%% @spec (This::wxPrintData()) -> integer() %% @doc See external documentation. +-spec getOrientation(This) -> integer() when + This::wxPrintData(). getOrientation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_GetOrientation, <>). -%% @spec (This::wxPrintData()) -> integer() %% @doc See external documentation. +-spec getPaperId(This) -> integer() when + This::wxPrintData(). getPaperId(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_GetPaperId, <>). -%% @spec (This::wxPrintData()) -> string() %% @doc See external documentation. +-spec getPrinterName(This) -> string() when + This::wxPrintData(). getPrinterName(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_GetPrinterName, <>). -%% @spec (This::wxPrintData()) -> integer() %% @doc See external documentation. +-spec getQuality(This) -> integer() when + This::wxPrintData(). getQuality(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_GetQuality, <>). -%% @spec (This::wxPrintData()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxPrintData(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintData), wxe_util:call(?wxPrintData_IsOk, <>). -%% @spec (This::wxPrintData(), Bin::WxPrintBin) -> ok -%% WxPrintBin = integer() %% @doc See external documentation. -%%
WxPrintBin is one of ?wxPRINTBIN_DEFAULT | ?wxPRINTBIN_ONLYONE | ?wxPRINTBIN_LOWER | ?wxPRINTBIN_MIDDLE | ?wxPRINTBIN_MANUAL | ?wxPRINTBIN_ENVELOPE | ?wxPRINTBIN_ENVMANUAL | ?wxPRINTBIN_AUTO | ?wxPRINTBIN_TRACTOR | ?wxPRINTBIN_SMALLFMT | ?wxPRINTBIN_LARGEFMT | ?wxPRINTBIN_LARGECAPACITY | ?wxPRINTBIN_CASSETTE | ?wxPRINTBIN_FORMSOURCE | ?wxPRINTBIN_USER +%%
Bin = ?wxPRINTBIN_DEFAULT | ?wxPRINTBIN_ONLYONE | ?wxPRINTBIN_LOWER | ?wxPRINTBIN_MIDDLE | ?wxPRINTBIN_MANUAL | ?wxPRINTBIN_ENVELOPE | ?wxPRINTBIN_ENVMANUAL | ?wxPRINTBIN_AUTO | ?wxPRINTBIN_TRACTOR | ?wxPRINTBIN_SMALLFMT | ?wxPRINTBIN_LARGEFMT | ?wxPRINTBIN_LARGECAPACITY | ?wxPRINTBIN_CASSETTE | ?wxPRINTBIN_FORMSOURCE | ?wxPRINTBIN_USER +-spec setBin(This, Bin) -> ok when + This::wxPrintData(), Bin::wx:wx_enum(). setBin(#wx_ref{type=ThisT,ref=ThisRef},Bin) when is_integer(Bin) -> ?CLASS(ThisT,wxPrintData), wxe_util:cast(?wxPrintData_SetBin, <>). -%% @spec (This::wxPrintData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec setCollate(This, Flag) -> ok when + This::wxPrintData(), Flag::boolean(). setCollate(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPrintData), wxe_util:cast(?wxPrintData_SetCollate, <>). -%% @spec (This::wxPrintData(), Colour::bool()) -> ok %% @doc See external documentation. +-spec setColour(This, Colour) -> ok when + This::wxPrintData(), Colour::boolean(). setColour(#wx_ref{type=ThisT,ref=ThisRef},Colour) when is_boolean(Colour) -> ?CLASS(ThisT,wxPrintData), wxe_util:cast(?wxPrintData_SetColour, <>). -%% @spec (This::wxPrintData(), Duplex::WxDuplexMode) -> ok -%% WxDuplexMode = integer() %% @doc See external documentation. -%%
WxDuplexMode is one of ?wxDUPLEX_SIMPLEX | ?wxDUPLEX_HORIZONTAL | ?wxDUPLEX_VERTICAL +%%
Duplex = ?wxDUPLEX_SIMPLEX | ?wxDUPLEX_HORIZONTAL | ?wxDUPLEX_VERTICAL +-spec setDuplex(This, Duplex) -> ok when + This::wxPrintData(), Duplex::wx:wx_enum(). setDuplex(#wx_ref{type=ThisT,ref=ThisRef},Duplex) when is_integer(Duplex) -> ?CLASS(ThisT,wxPrintData), wxe_util:cast(?wxPrintData_SetDuplex, <>). -%% @spec (This::wxPrintData(), V::integer()) -> ok %% @doc See external documentation. +-spec setNoCopies(This, V) -> ok when + This::wxPrintData(), V::integer(). setNoCopies(#wx_ref{type=ThisT,ref=ThisRef},V) when is_integer(V) -> ?CLASS(ThisT,wxPrintData), wxe_util:cast(?wxPrintData_SetNoCopies, <>). -%% @spec (This::wxPrintData(), Orient::integer()) -> ok %% @doc See external documentation. +-spec setOrientation(This, Orient) -> ok when + This::wxPrintData(), Orient::integer(). setOrientation(#wx_ref{type=ThisT,ref=ThisRef},Orient) when is_integer(Orient) -> ?CLASS(ThisT,wxPrintData), wxe_util:cast(?wxPrintData_SetOrientation, <>). -%% @spec (This::wxPrintData(), SizeId::integer()) -> ok %% @doc See external documentation. +-spec setPaperId(This, SizeId) -> ok when + This::wxPrintData(), SizeId::integer(). setPaperId(#wx_ref{type=ThisT,ref=ThisRef},SizeId) when is_integer(SizeId) -> ?CLASS(ThisT,wxPrintData), wxe_util:cast(?wxPrintData_SetPaperId, <>). -%% @spec (This::wxPrintData(), Name::string()) -> ok %% @doc See external documentation. +-spec setPrinterName(This, Name) -> ok when + This::wxPrintData(), Name::string(). setPrinterName(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxPrintData), @@ -191,16 +208,17 @@ setPrinterName(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:cast(?wxPrintData_SetPrinterName, <>). -%% @spec (This::wxPrintData(), Quality::integer()) -> ok %% @doc See external documentation. +-spec setQuality(This, Quality) -> ok when + This::wxPrintData(), Quality::integer(). setQuality(#wx_ref{type=ThisT,ref=ThisRef},Quality) when is_integer(Quality) -> ?CLASS(ThisT,wxPrintData), wxe_util:cast(?wxPrintData_SetQuality, <>). -%% @spec (This::wxPrintData()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPrintData) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPrintData), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPrintDialog.erl b/lib/wx/src/gen/wxPrintDialog.erl index a2f4bfa4eb..3e38bd5f10 100644 --- a/lib/wx/src/gen/wxPrintDialog.erl +++ b/lib/wx/src/gen/wxPrintDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxPrintDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,22 +85,21 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Parent::wxWindow:wxWindow()) -> wxPrintDialog() +-type wxPrintDialog() :: wx:wx_object(). %% @equiv new(Parent, []) +-spec new(Parent) -> wxPrintDialog() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(),X::term()) -> wxPrintDialog() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Parent::wxWindow:wxWindow(), [Option]) -> wxPrintDialog() -%%
Option = {data, wxPrintDialogData:wxPrintDialogData()} -%%

-%%

-%% new(Parent::wxWindow:wxWindow(), Data::wxPrintData:wxPrintData()) -> wxPrintDialog() -%%

+-spec new(Parent, [Option]) -> wxPrintDialog() when + Parent::wxWindow:wxWindow(), + Option :: {data, wxPrintDialogData:wxPrintDialogData()}; + (Parent, Data) -> wxPrintDialog() when + Parent::wxWindow:wxWindow(), Data::wxPrintData:wxPrintData(). new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -114,22 +114,24 @@ new(#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=DataT,ref=DataRef}) -> wxe_util:construct(?wxPrintDialog_new_2_1, <>). -%% @spec (This::wxPrintDialog()) -> wxPrintDialogData:wxPrintDialogData() %% @doc See external documentation. +-spec getPrintDialogData(This) -> wxPrintDialogData:wxPrintDialogData() when + This::wxPrintDialog(). getPrintDialogData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialog), wxe_util:call(?wxPrintDialog_GetPrintDialogData, <>). -%% @spec (This::wxPrintDialog()) -> wxDC:wxDC() %% @doc See external documentation. +-spec getPrintDC(This) -> wxDC:wxDC() when + This::wxPrintDialog(). getPrintDC(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialog), wxe_util:call(?wxPrintDialog_GetPrintDC, <>). -%% @spec (This::wxPrintDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPrintDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPrintDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPrintDialogData.erl b/lib/wx/src/gen/wxPrintDialogData.erl index a7e8d41f2e..ec554bfb88 100644 --- a/lib/wx/src/gen/wxPrintDialogData.erl +++ b/lib/wx/src/gen/wxPrintDialogData.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 @@ -33,17 +33,20 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPrintDialogData/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxPrintDialogData() +-type wxPrintDialogData() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxPrintDialogData(). new() -> wxe_util:construct(?wxPrintDialogData_new_0, <<>>). -%% @spec (DialogData::wxPrintDialogData() | wxPrintData:wxPrintData()) -> wxPrintDialogData() %% @doc See external documentation. +-spec new(DialogData) -> wxPrintDialogData() when + DialogData::wxPrintDialogData() | wxPrintData:wxPrintData(). new(#wx_ref{type=DialogDataT,ref=DialogDataRef}) -> DialogDataOP = case ?CLASS_T(DialogDataT,wxPrintDialogData) of true -> @@ -54,189 +57,213 @@ new(#wx_ref{type=DialogDataT,ref=DialogDataRef}) -> wxe_util:construct(DialogDataOP, <>). -%% @spec (This::wxPrintDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enableHelp(This, Flag) -> ok when + This::wxPrintDialogData(), Flag::boolean(). enableHelp(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_EnableHelp, <>). -%% @spec (This::wxPrintDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enablePageNumbers(This, Flag) -> ok when + This::wxPrintDialogData(), Flag::boolean(). enablePageNumbers(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_EnablePageNumbers, <>). -%% @spec (This::wxPrintDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enablePrintToFile(This, Flag) -> ok when + This::wxPrintDialogData(), Flag::boolean(). enablePrintToFile(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_EnablePrintToFile, <>). -%% @spec (This::wxPrintDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec enableSelection(This, Flag) -> ok when + This::wxPrintDialogData(), Flag::boolean(). enableSelection(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_EnableSelection, <>). -%% @spec (This::wxPrintDialogData()) -> bool() %% @doc See external documentation. +-spec getAllPages(This) -> boolean() when + This::wxPrintDialogData(). getAllPages(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetAllPages, <>). -%% @spec (This::wxPrintDialogData()) -> bool() %% @doc See external documentation. +-spec getCollate(This) -> boolean() when + This::wxPrintDialogData(). getCollate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetCollate, <>). -%% @spec (This::wxPrintDialogData()) -> integer() %% @doc See external documentation. +-spec getFromPage(This) -> integer() when + This::wxPrintDialogData(). getFromPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetFromPage, <>). -%% @spec (This::wxPrintDialogData()) -> integer() %% @doc See external documentation. +-spec getMaxPage(This) -> integer() when + This::wxPrintDialogData(). getMaxPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetMaxPage, <>). -%% @spec (This::wxPrintDialogData()) -> integer() %% @doc See external documentation. +-spec getMinPage(This) -> integer() when + This::wxPrintDialogData(). getMinPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetMinPage, <>). -%% @spec (This::wxPrintDialogData()) -> integer() %% @doc See external documentation. +-spec getNoCopies(This) -> integer() when + This::wxPrintDialogData(). getNoCopies(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetNoCopies, <>). -%% @spec (This::wxPrintDialogData()) -> wxPrintData:wxPrintData() %% @doc See external documentation. +-spec getPrintData(This) -> wxPrintData:wxPrintData() when + This::wxPrintDialogData(). getPrintData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetPrintData, <>). -%% @spec (This::wxPrintDialogData()) -> bool() %% @doc See external documentation. +-spec getPrintToFile(This) -> boolean() when + This::wxPrintDialogData(). getPrintToFile(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetPrintToFile, <>). -%% @spec (This::wxPrintDialogData()) -> bool() %% @doc See external documentation. +-spec getSelection(This) -> boolean() when + This::wxPrintDialogData(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetSelection, <>). -%% @spec (This::wxPrintDialogData()) -> integer() %% @doc See external documentation. +-spec getToPage(This) -> integer() when + This::wxPrintDialogData(). getToPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_GetToPage, <>). -%% @spec (This::wxPrintDialogData()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxPrintDialogData(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:call(?wxPrintDialogData_IsOk, <>). -%% @spec (This::wxPrintDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec setCollate(This, Flag) -> ok when + This::wxPrintDialogData(), Flag::boolean(). setCollate(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_SetCollate, <>). -%% @spec (This::wxPrintDialogData(), V::integer()) -> ok %% @doc See external documentation. +-spec setFromPage(This, V) -> ok when + This::wxPrintDialogData(), V::integer(). setFromPage(#wx_ref{type=ThisT,ref=ThisRef},V) when is_integer(V) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_SetFromPage, <>). -%% @spec (This::wxPrintDialogData(), V::integer()) -> ok %% @doc See external documentation. +-spec setMaxPage(This, V) -> ok when + This::wxPrintDialogData(), V::integer(). setMaxPage(#wx_ref{type=ThisT,ref=ThisRef},V) when is_integer(V) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_SetMaxPage, <>). -%% @spec (This::wxPrintDialogData(), V::integer()) -> ok %% @doc See external documentation. +-spec setMinPage(This, V) -> ok when + This::wxPrintDialogData(), V::integer(). setMinPage(#wx_ref{type=ThisT,ref=ThisRef},V) when is_integer(V) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_SetMinPage, <>). -%% @spec (This::wxPrintDialogData(), V::integer()) -> ok %% @doc See external documentation. +-spec setNoCopies(This, V) -> ok when + This::wxPrintDialogData(), V::integer(). setNoCopies(#wx_ref{type=ThisT,ref=ThisRef},V) when is_integer(V) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_SetNoCopies, <>). -%% @spec (This::wxPrintDialogData(), PrintData::wxPrintData:wxPrintData()) -> ok %% @doc See external documentation. +-spec setPrintData(This, PrintData) -> ok when + This::wxPrintDialogData(), PrintData::wxPrintData:wxPrintData(). setPrintData(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PrintDataT,ref=PrintDataRef}) -> ?CLASS(ThisT,wxPrintDialogData), ?CLASS(PrintDataT,wxPrintData), wxe_util:cast(?wxPrintDialogData_SetPrintData, <>). -%% @spec (This::wxPrintDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec setPrintToFile(This, Flag) -> ok when + This::wxPrintDialogData(), Flag::boolean(). setPrintToFile(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_SetPrintToFile, <>). -%% @spec (This::wxPrintDialogData(), Flag::bool()) -> ok %% @doc See external documentation. +-spec setSelection(This, Flag) -> ok when + This::wxPrintDialogData(), Flag::boolean(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_boolean(Flag) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_SetSelection, <>). -%% @spec (This::wxPrintDialogData(), V::integer()) -> ok %% @doc See external documentation. +-spec setToPage(This, V) -> ok when + This::wxPrintDialogData(), V::integer(). setToPage(#wx_ref{type=ThisT,ref=ThisRef},V) when is_integer(V) -> ?CLASS(ThisT,wxPrintDialogData), wxe_util:cast(?wxPrintDialogData_SetToPage, <>). -%% @spec (This::wxPrintDialogData()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPrintDialogData) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPrintDialogData), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPrintPreview.erl b/lib/wx/src/gen/wxPrintPreview.erl index 6f9a0f653f..717589c871 100644 --- a/lib/wx/src/gen/wxPrintPreview.erl +++ b/lib/wx/src/gen/wxPrintPreview.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 @@ -32,18 +32,24 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPrintPreview/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Printout::wxPrintout:wxPrintout()) -> wxPrintPreview() +-type wxPrintPreview() :: wx:wx_object(). %% @equiv new(Printout, []) +-spec new(Printout) -> wxPrintPreview() when + Printout::wxPrintout:wxPrintout(). + new(Printout) when is_record(Printout, wx_ref) -> new(Printout, []). -%% @spec (Printout::wxPrintout:wxPrintout(), [Option]) -> wxPrintPreview() -%% Option = {printoutForPrinting, wxPrintout:wxPrintout()} | {data, wxPrintDialogData:wxPrintDialogData()} %% @doc See external documentation. +-spec new(Printout, [Option]) -> wxPrintPreview() when + Printout::wxPrintout:wxPrintout(), + Option :: {printoutForPrinting, wxPrintout:wxPrintout()} + | {data, wxPrintDialogData:wxPrintDialogData()}. new(#wx_ref{type=PrintoutT,ref=PrintoutRef}, Options) when is_list(Options) -> ?CLASS(PrintoutT,wxPrintout), @@ -54,8 +60,9 @@ new(#wx_ref{type=PrintoutT,ref=PrintoutRef}, Options) wxe_util:construct(?wxPrintPreview_new_2, <>). -%% @spec (Printout::wxPrintout:wxPrintout(), PrintoutForPrinting::wxPrintout:wxPrintout(), Data::wxPrintData:wxPrintData()) -> wxPrintPreview() %% @doc See external documentation. +-spec new(Printout, PrintoutForPrinting, Data) -> wxPrintPreview() when + Printout::wxPrintout:wxPrintout(), PrintoutForPrinting::wxPrintout:wxPrintout(), Data::wxPrintData:wxPrintData(). new(#wx_ref{type=PrintoutT,ref=PrintoutRef},#wx_ref{type=PrintoutForPrintingT,ref=PrintoutForPrintingRef},#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(PrintoutT,wxPrintout), ?CLASS(PrintoutForPrintingT,wxPrintout), @@ -63,64 +70,73 @@ new(#wx_ref{type=PrintoutT,ref=PrintoutRef},#wx_ref{type=PrintoutForPrintingT,re wxe_util:construct(?wxPrintPreview_new_3, <>). -%% @spec (This::wxPrintPreview()) -> wxPreviewCanvas:wxPreviewCanvas() %% @doc See external documentation. +-spec getCanvas(This) -> wxPreviewCanvas:wxPreviewCanvas() when + This::wxPrintPreview(). getCanvas(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetCanvas, <>). -%% @spec (This::wxPrintPreview()) -> integer() %% @doc See external documentation. +-spec getCurrentPage(This) -> integer() when + This::wxPrintPreview(). getCurrentPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetCurrentPage, <>). -%% @spec (This::wxPrintPreview()) -> wxFrame:wxFrame() %% @doc See external documentation. +-spec getFrame(This) -> wxFrame:wxFrame() when + This::wxPrintPreview(). getFrame(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetFrame, <>). -%% @spec (This::wxPrintPreview()) -> integer() %% @doc See external documentation. +-spec getMaxPage(This) -> integer() when + This::wxPrintPreview(). getMaxPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetMaxPage, <>). -%% @spec (This::wxPrintPreview()) -> integer() %% @doc See external documentation. +-spec getMinPage(This) -> integer() when + This::wxPrintPreview(). getMinPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetMinPage, <>). -%% @spec (This::wxPrintPreview()) -> wxPrintout:wxPrintout() %% @doc See external documentation. +-spec getPrintout(This) -> wxPrintout:wxPrintout() when + This::wxPrintPreview(). getPrintout(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetPrintout, <>). -%% @spec (This::wxPrintPreview()) -> wxPrintout:wxPrintout() %% @doc See external documentation. +-spec getPrintoutForPrinting(This) -> wxPrintout:wxPrintout() when + This::wxPrintPreview(). getPrintoutForPrinting(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_GetPrintoutForPrinting, <>). -%% @spec (This::wxPrintPreview()) -> bool() %% @doc See external documentation. +-spec isOk(This) -> boolean() when + This::wxPrintPreview(). isOk(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_IsOk, <>). -%% @spec (This::wxPrintPreview(), Canvas::wxPreviewCanvas:wxPreviewCanvas(), Dc::wxDC:wxDC()) -> bool() %% @doc See external documentation. +-spec paintPage(This, Canvas, Dc) -> boolean() when + This::wxPrintPreview(), Canvas::wxPreviewCanvas:wxPreviewCanvas(), Dc::wxDC:wxDC(). paintPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CanvasT,ref=CanvasRef},#wx_ref{type=DcT,ref=DcRef}) -> ?CLASS(ThisT,wxPrintPreview), ?CLASS(CanvasT,wxPreviewCanvas), @@ -128,64 +144,71 @@ paintPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CanvasT,ref=CanvasRef},#w wxe_util:call(?wxPrintPreview_PaintPage, <>). -%% @spec (This::wxPrintPreview(), Interactive::bool()) -> bool() %% @doc See external documentation. +-spec print(This, Interactive) -> boolean() when + This::wxPrintPreview(), Interactive::boolean(). print(#wx_ref{type=ThisT,ref=ThisRef},Interactive) when is_boolean(Interactive) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_Print, <>). -%% @spec (This::wxPrintPreview(), PageNum::integer()) -> bool() %% @doc See external documentation. +-spec renderPage(This, PageNum) -> boolean() when + This::wxPrintPreview(), PageNum::integer(). renderPage(#wx_ref{type=ThisT,ref=ThisRef},PageNum) when is_integer(PageNum) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_RenderPage, <>). -%% @spec (This::wxPrintPreview(), Canvas::wxPreviewCanvas:wxPreviewCanvas()) -> ok %% @doc See external documentation. +-spec setCanvas(This, Canvas) -> ok when + This::wxPrintPreview(), Canvas::wxPreviewCanvas:wxPreviewCanvas(). setCanvas(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CanvasT,ref=CanvasRef}) -> ?CLASS(ThisT,wxPrintPreview), ?CLASS(CanvasT,wxPreviewCanvas), wxe_util:cast(?wxPrintPreview_SetCanvas, <>). -%% @spec (This::wxPrintPreview(), PageNum::integer()) -> bool() %% @doc See external documentation. +-spec setCurrentPage(This, PageNum) -> boolean() when + This::wxPrintPreview(), PageNum::integer(). setCurrentPage(#wx_ref{type=ThisT,ref=ThisRef},PageNum) when is_integer(PageNum) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:call(?wxPrintPreview_SetCurrentPage, <>). -%% @spec (This::wxPrintPreview(), Frame::wxFrame:wxFrame()) -> ok %% @doc See external documentation. +-spec setFrame(This, Frame) -> ok when + This::wxPrintPreview(), Frame::wxFrame:wxFrame(). setFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef}) -> ?CLASS(ThisT,wxPrintPreview), ?CLASS(FrameT,wxFrame), wxe_util:cast(?wxPrintPreview_SetFrame, <>). -%% @spec (This::wxPrintPreview(), Printout::wxPrintout:wxPrintout()) -> ok %% @doc See external documentation. +-spec setPrintout(This, Printout) -> ok when + This::wxPrintPreview(), Printout::wxPrintout:wxPrintout(). setPrintout(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PrintoutT,ref=PrintoutRef}) -> ?CLASS(ThisT,wxPrintPreview), ?CLASS(PrintoutT,wxPrintout), wxe_util:cast(?wxPrintPreview_SetPrintout, <>). -%% @spec (This::wxPrintPreview(), Percent::integer()) -> ok %% @doc See external documentation. +-spec setZoom(This, Percent) -> ok when + This::wxPrintPreview(), Percent::integer(). setZoom(#wx_ref{type=ThisT,ref=ThisRef},Percent) when is_integer(Percent) -> ?CLASS(ThisT,wxPrintPreview), wxe_util:cast(?wxPrintPreview_SetZoom, <>). -%% @spec (This::wxPrintPreview()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPrintPreview) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPrintPreview), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPrinter.erl b/lib/wx/src/gen/wxPrinter.erl index af9afe18af..64c70bd75f 100644 --- a/lib/wx/src/gen/wxPrinter.erl +++ b/lib/wx/src/gen/wxPrinter.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 @@ -30,17 +30,20 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPrinter/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxPrinter() +-type wxPrinter() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxPrinter(). + new() -> new([]). -%% @spec ([Option]) -> wxPrinter() -%% Option = {data, wxPrintDialogData:wxPrintDialogData()} %% @doc See external documentation. +-spec new([Option]) -> wxPrinter() when + Option :: {data, wxPrintDialogData:wxPrintDialogData()}. new(Options) when is_list(Options) -> MOpts = fun({data, #wx_ref{type=DataT,ref=DataRef}}, Acc) -> ?CLASS(DataT,wxPrintDialogData),[<<1:32/?UI,DataRef:32/?UI>>|Acc]; @@ -49,8 +52,9 @@ new(Options) wxe_util:construct(?wxPrinter_new, <>). -%% @spec (This::wxPrinter(), Parent::wxWindow:wxWindow(), Printout::wxPrintout:wxPrintout()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec createAbortWindow(This, Parent, Printout) -> wxWindow:wxWindow() when + This::wxPrinter(), Parent::wxWindow:wxWindow(), Printout::wxPrintout:wxPrintout(). createAbortWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=PrintoutT,ref=PrintoutRef}) -> ?CLASS(ThisT,wxPrinter), ?CLASS(ParentT,wxWindow), @@ -58,37 +62,41 @@ createAbortWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=Paren wxe_util:call(?wxPrinter_CreateAbortWindow, <>). -%% @spec (This::wxPrinter()) -> bool() %% @doc See external documentation. +-spec getAbort(This) -> boolean() when + This::wxPrinter(). getAbort(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrinter), wxe_util:call(?wxPrinter_GetAbort, <>). -%% @spec () -> WxPrinterError -%% WxPrinterError = integer() %% @doc See external documentation. -%%
WxPrinterError is one of ?wxPRINTER_NO_ERROR | ?wxPRINTER_CANCELLED | ?wxPRINTER_ERROR +%%
Res = ?wxPRINTER_NO_ERROR | ?wxPRINTER_CANCELLED | ?wxPRINTER_ERROR +-spec getLastError() -> wx:wx_enum(). getLastError() -> wxe_util:call(?wxPrinter_GetLastError, <<>>). -%% @spec (This::wxPrinter()) -> wxPrintDialogData:wxPrintDialogData() %% @doc See external documentation. +-spec getPrintDialogData(This) -> wxPrintDialogData:wxPrintDialogData() when + This::wxPrinter(). getPrintDialogData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrinter), wxe_util:call(?wxPrinter_GetPrintDialogData, <>). -%% @spec (This::wxPrinter(), Parent::wxWindow:wxWindow(), Printout::wxPrintout:wxPrintout()) -> bool() %% @equiv print(This,Parent,Printout, []) +-spec print(This, Parent, Printout) -> boolean() when + This::wxPrinter(), Parent::wxWindow:wxWindow(), Printout::wxPrintout:wxPrintout(). + print(This,Parent,Printout) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_record(Printout, wx_ref) -> print(This,Parent,Printout, []). -%% @spec (This::wxPrinter(), Parent::wxWindow:wxWindow(), Printout::wxPrintout:wxPrintout(), [Option]) -> bool() -%% Option = {prompt, bool()} %% @doc See external documentation. +-spec print(This, Parent, Printout, [Option]) -> boolean() when + This::wxPrinter(), Parent::wxWindow:wxWindow(), Printout::wxPrintout:wxPrintout(), + Option :: {prompt, boolean()}. print(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=PrintoutT,ref=PrintoutRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxPrinter), @@ -100,16 +108,18 @@ print(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},#wx_re wxe_util:call(?wxPrinter_Print, <>). -%% @spec (This::wxPrinter(), Parent::wxWindow:wxWindow()) -> wxDC:wxDC() %% @doc See external documentation. +-spec printDialog(This, Parent) -> wxDC:wxDC() when + This::wxPrinter(), Parent::wxWindow:wxWindow(). printDialog(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}) -> ?CLASS(ThisT,wxPrinter), ?CLASS(ParentT,wxWindow), wxe_util:call(?wxPrinter_PrintDialog, <>). -%% @spec (This::wxPrinter(), Parent::wxWindow:wxWindow(), Printout::wxPrintout:wxPrintout(), Message::string()) -> ok %% @doc See external documentation. +-spec reportError(This, Parent, Printout, Message) -> ok when + This::wxPrinter(), Parent::wxWindow:wxWindow(), Printout::wxPrintout:wxPrintout(), Message::string(). reportError(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},#wx_ref{type=PrintoutT,ref=PrintoutRef},Message) when is_list(Message) -> ?CLASS(ThisT,wxPrinter), @@ -119,16 +129,17 @@ reportError(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, wxe_util:cast(?wxPrinter_ReportError, <>). -%% @spec (This::wxPrinter(), Parent::wxWindow:wxWindow()) -> bool() %% @doc See external documentation. +-spec setup(This, Parent) -> boolean() when + This::wxPrinter(), Parent::wxWindow:wxWindow(). setup(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}) -> ?CLASS(ThisT,wxPrinter), ?CLASS(ParentT,wxWindow), wxe_util:call(?wxPrinter_Setup, <>). -%% @spec (This::wxPrinter()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPrinter) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPrinter), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxPrintout.erl b/lib/wx/src/gen/wxPrintout.erl index a34c030275..2afb9a54f7 100644 --- a/lib/wx/src/gen/wxPrintout.erl +++ b/lib/wx/src/gen/wxPrintout.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 @@ -34,9 +34,11 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxPrintout/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxPrintout() :: wx:wx_object(). %% @spec (Title::string(), OnPrintPage::function()) -> wxPrintout:wxPrintout() %% @doc @equiv new(Title, OnPrintPage, []) @@ -118,80 +120,91 @@ new(Title, OnPrintPage, Opts) when is_list(Title), is_function(OnPrintPage), is_ OnPrintPageId:32/?UI, BinOpt/binary>>). -%% @spec (This::wxPrintout()) -> wxDC:wxDC() %% @doc See external documentation. +-spec getDC(This) -> wxDC:wxDC() when + This::wxPrintout(). getDC(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_GetDC, <>). -%% @spec (This::wxPrintout()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getPageSizeMM(This) -> {W::integer(), H::integer()} when + This::wxPrintout(). getPageSizeMM(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_GetPageSizeMM, <>). -%% @spec (This::wxPrintout()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getPageSizePixels(This) -> {W::integer(), H::integer()} when + This::wxPrintout(). getPageSizePixels(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_GetPageSizePixels, <>). -%% @spec (This::wxPrintout()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getPaperRectPixels(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxPrintout(). getPaperRectPixels(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_GetPaperRectPixels, <>). -%% @spec (This::wxPrintout()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPPIPrinter(This) -> {X::integer(), Y::integer()} when + This::wxPrintout(). getPPIPrinter(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_GetPPIPrinter, <>). -%% @spec (This::wxPrintout()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPPIScreen(This) -> {X::integer(), Y::integer()} when + This::wxPrintout(). getPPIScreen(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_GetPPIScreen, <>). -%% @spec (This::wxPrintout()) -> string() %% @doc See external documentation. +-spec getTitle(This) -> string() when + This::wxPrintout(). getTitle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_GetTitle, <>). -%% @spec (This::wxPrintout()) -> bool() %% @doc See external documentation. +-spec isPreview(This) -> boolean() when + This::wxPrintout(). isPreview(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_IsPreview, <>). -%% @spec (This::wxPrintout(), ImageSize::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec fitThisSizeToPaper(This, ImageSize) -> ok when + This::wxPrintout(), ImageSize::{W::integer(), H::integer()}. fitThisSizeToPaper(#wx_ref{type=ThisT,ref=ThisRef},{ImageSizeW,ImageSizeH}) when is_integer(ImageSizeW),is_integer(ImageSizeH) -> ?CLASS(ThisT,wxPrintout), wxe_util:cast(?wxPrintout_FitThisSizeToPaper, <>). -%% @spec (This::wxPrintout(), ImageSize::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec fitThisSizeToPage(This, ImageSize) -> ok when + This::wxPrintout(), ImageSize::{W::integer(), H::integer()}. fitThisSizeToPage(#wx_ref{type=ThisT,ref=ThisRef},{ImageSizeW,ImageSizeH}) when is_integer(ImageSizeW),is_integer(ImageSizeH) -> ?CLASS(ThisT,wxPrintout), wxe_util:cast(?wxPrintout_FitThisSizeToPage, <>). -%% @spec (This::wxPrintout(), ImageSize::{W::integer(), H::integer()}, PageSetupData::wxPageSetupDialogData:wxPageSetupDialogData()) -> ok %% @doc See external documentation. +-spec fitThisSizeToPageMargins(This, ImageSize, PageSetupData) -> ok when + This::wxPrintout(), ImageSize::{W::integer(), H::integer()}, PageSetupData::wxPageSetupDialogData:wxPageSetupDialogData(). fitThisSizeToPageMargins(#wx_ref{type=ThisT,ref=ThisRef},{ImageSizeW,ImageSizeH},#wx_ref{type=PageSetupDataT,ref=PageSetupDataRef}) when is_integer(ImageSizeW),is_integer(ImageSizeH) -> ?CLASS(ThisT,wxPrintout), @@ -199,75 +212,84 @@ fitThisSizeToPageMargins(#wx_ref{type=ThisT,ref=ThisRef},{ImageSizeW,ImageSizeH} wxe_util:cast(?wxPrintout_FitThisSizeToPageMargins, <>). -%% @spec (This::wxPrintout()) -> ok %% @doc See external documentation. +-spec mapScreenSizeToPaper(This) -> ok when + This::wxPrintout(). mapScreenSizeToPaper(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:cast(?wxPrintout_MapScreenSizeToPaper, <>). -%% @spec (This::wxPrintout()) -> ok %% @doc See external documentation. +-spec mapScreenSizeToPage(This) -> ok when + This::wxPrintout(). mapScreenSizeToPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:cast(?wxPrintout_MapScreenSizeToPage, <>). -%% @spec (This::wxPrintout(), PageSetupData::wxPageSetupDialogData:wxPageSetupDialogData()) -> ok %% @doc See external documentation. +-spec mapScreenSizeToPageMargins(This, PageSetupData) -> ok when + This::wxPrintout(), PageSetupData::wxPageSetupDialogData:wxPageSetupDialogData(). mapScreenSizeToPageMargins(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageSetupDataT,ref=PageSetupDataRef}) -> ?CLASS(ThisT,wxPrintout), ?CLASS(PageSetupDataT,wxPageSetupDialogData), wxe_util:cast(?wxPrintout_MapScreenSizeToPageMargins, <>). -%% @spec (This::wxPrintout()) -> ok %% @doc See external documentation. +-spec mapScreenSizeToDevice(This) -> ok when + This::wxPrintout(). mapScreenSizeToDevice(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:cast(?wxPrintout_MapScreenSizeToDevice, <>). -%% @spec (This::wxPrintout()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getLogicalPaperRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxPrintout(). getLogicalPaperRect(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_GetLogicalPaperRect, <>). -%% @spec (This::wxPrintout()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getLogicalPageRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxPrintout(). getLogicalPageRect(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxPrintout), wxe_util:call(?wxPrintout_GetLogicalPageRect, <>). -%% @spec (This::wxPrintout(), PageSetupData::wxPageSetupDialogData:wxPageSetupDialogData()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getLogicalPageMarginsRect(This, PageSetupData) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxPrintout(), PageSetupData::wxPageSetupDialogData:wxPageSetupDialogData(). getLogicalPageMarginsRect(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageSetupDataT,ref=PageSetupDataRef}) -> ?CLASS(ThisT,wxPrintout), ?CLASS(PageSetupDataT,wxPageSetupDialogData), wxe_util:call(?wxPrintout_GetLogicalPageMarginsRect, <>). -%% @spec (This::wxPrintout(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec setLogicalOrigin(This, X, Y) -> ok when + This::wxPrintout(), X::integer(), Y::integer(). setLogicalOrigin(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxPrintout), wxe_util:cast(?wxPrintout_SetLogicalOrigin, <>). -%% @spec (This::wxPrintout(), Xoff::integer(), Yoff::integer()) -> ok %% @doc See external documentation. +-spec offsetLogicalOrigin(This, Xoff, Yoff) -> ok when + This::wxPrintout(), Xoff::integer(), Yoff::integer(). offsetLogicalOrigin(#wx_ref{type=ThisT,ref=ThisRef},Xoff,Yoff) when is_integer(Xoff),is_integer(Yoff) -> ?CLASS(ThisT,wxPrintout), wxe_util:cast(?wxPrintout_OffsetLogicalOrigin, <>). -%% @spec (This::wxPrintout()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxPrintout) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxPrintout), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxProgressDialog.erl b/lib/wx/src/gen/wxProgressDialog.erl index 69e73454b5..679e87aab2 100644 --- a/lib/wx/src/gen/wxProgressDialog.erl +++ b/lib/wx/src/gen/wxProgressDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxProgressDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,15 +85,21 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Title::string(), Message::string()) -> wxProgressDialog() +-type wxProgressDialog() :: wx:wx_object(). %% @equiv new(Title,Message, []) +-spec new(Title, Message) -> wxProgressDialog() when + Title::string(), Message::string(). + new(Title,Message) when is_list(Title),is_list(Message) -> new(Title,Message, []). -%% @spec (Title::string(), Message::string(), [Option]) -> wxProgressDialog() -%% Option = {maximum, integer()} | {parent, wxWindow:wxWindow()} | {style, integer()} %% @doc See external documentation. +-spec new(Title, Message, [Option]) -> wxProgressDialog() when + Title::string(), Message::string(), + Option :: {maximum, integer()} + | {parent, wxWindow:wxWindow()} + | {style, integer()}. new(Title,Message, Options) when is_list(Title),is_list(Message),is_list(Options) -> Title_UC = unicode:characters_to_binary([Title,0]), @@ -105,29 +112,34 @@ new(Title,Message, Options) wxe_util:construct(?wxProgressDialog_new, <<(byte_size(Title_UC)):32/?UI,(Title_UC)/binary, 0:(((8- ((4+byte_size(Title_UC)) band 16#7)) band 16#7))/unit:8,(byte_size(Message_UC)):32/?UI,(Message_UC)/binary, 0:(((8- ((4+byte_size(Message_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxProgressDialog()) -> ok %% @doc See external documentation. +-spec resume(This) -> ok when + This::wxProgressDialog(). resume(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxProgressDialog), wxe_util:cast(?wxProgressDialog_Resume, <>). -%% @spec (This::wxProgressDialog()) -> ok %% @doc See external documentation. +-spec update(This) -> ok when + This::wxProgressDialog(). update(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxProgressDialog), wxe_util:cast(?wxProgressDialog_Update_0, <>). -%% @spec (This::wxProgressDialog(), Value::integer()) -> bool() %% @equiv update(This,Value, []) +-spec update(This, Value) -> boolean() when + This::wxProgressDialog(), Value::integer(). + update(This,Value) when is_record(This, wx_ref),is_integer(Value) -> update(This,Value, []). -%% @spec (This::wxProgressDialog(), Value::integer(), [Option]) -> bool() -%% Option = {newmsg, string()} %% @doc See external documentation. +-spec update(This, Value, [Option]) -> boolean() when + This::wxProgressDialog(), Value::integer(), + Option :: {newmsg, string()}. update(#wx_ref{type=ThisT,ref=ThisRef},Value, Options) when is_integer(Value),is_list(Options) -> ?CLASS(ThisT,wxProgressDialog), @@ -137,8 +149,8 @@ update(#wx_ref{type=ThisT,ref=ThisRef},Value, Options) wxe_util:call(?wxProgressDialog_Update_2, <>). -%% @spec (This::wxProgressDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxProgressDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxProgressDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxQueryNewPaletteEvent.erl b/lib/wx/src/gen/wxQueryNewPaletteEvent.erl index 96c493e4a6..8123d62fe1 100644 --- a/lib/wx/src/gen/wxQueryNewPaletteEvent.erl +++ b/lib/wx/src/gen/wxQueryNewPaletteEvent.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 @@ -37,20 +37,24 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxQueryNewPaletteEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxQueryNewPaletteEvent(), Realized::bool()) -> ok +-type wxQueryNewPaletteEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec setPaletteRealized(This, Realized) -> ok when + This::wxQueryNewPaletteEvent(), Realized::boolean(). setPaletteRealized(#wx_ref{type=ThisT,ref=ThisRef},Realized) when is_boolean(Realized) -> ?CLASS(ThisT,wxQueryNewPaletteEvent), wxe_util:cast(?wxQueryNewPaletteEvent_SetPaletteRealized, <>). -%% @spec (This::wxQueryNewPaletteEvent()) -> bool() %% @doc See external documentation. +-spec getPaletteRealized(This) -> boolean() when + This::wxQueryNewPaletteEvent(). getPaletteRealized(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxQueryNewPaletteEvent), wxe_util:call(?wxQueryNewPaletteEvent_GetPaletteRealized, diff --git a/lib/wx/src/gen/wxRadioBox.erl b/lib/wx/src/gen/wxRadioBox.erl index 766a691108..4d02633922 100644 --- a/lib/wx/src/gen/wxRadioBox.erl +++ b/lib/wx/src/gen/wxRadioBox.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 @@ -72,21 +72,28 @@ thaw/1,transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxRadioBox/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]) -> wxRadioBox() +-type wxRadioBox() :: wx:wx_object(). %% @equiv new(Parent,Id,Title,Pos,Size,Choices, []) +-spec new(Parent, Id, Title, Pos, Size, Choices) -> wxRadioBox() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]. + new(Parent,Id,Title,Pos={PosX,PosY},Size={SizeW,SizeH},Choices) when is_record(Parent, wx_ref),is_integer(Id),is_list(Title),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices) -> new(Parent,Id,Title,Pos,Size,Choices, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], [Option]) -> wxRadioBox() -%% Option = {majorDim, integer()} | {style, integer()} | {val, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, Title, Pos, Size, Choices, [Option]) -> wxRadioBox() when + Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], + Option :: {majorDim, integer()} + | {style, integer()} + | {val, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title,{PosX,PosY},{SizeW,SizeH},Choices, Options) when is_integer(Id),is_list(Title),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -101,15 +108,20 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Title,{PosX,PosY},{SizeW,SizeH},Choic wxe_util:construct(?wxRadioBox_new, <>|| UC_Str <- Choices_UCA>>)/binary, 0:(((8- ((4 + lists:sum([byte_size(S)+4||S<-Choices_UCA])) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxRadioBox(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]) -> bool() %% @equiv create(This,Parent,Id,Title,Pos,Size,Choices, []) +-spec create(This, Parent, Id, Title, Pos, Size, Choices) -> boolean() when + This::wxRadioBox(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]]. + create(This,Parent,Id,Title,Pos={PosX,PosY},Size={SizeW,SizeH},Choices) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Title),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices) -> create(This,Parent,Id,Title,Pos,Size,Choices, []). -%% @spec (This::wxRadioBox(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], [Option]) -> bool() -%% Option = {majorDim, integer()} | {style, integer()} | {val, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Title, Pos, Size, Choices, [Option]) -> boolean() when + This::wxRadioBox(), Parent::wxWindow:wxWindow(), Id::integer(), Title::string(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}, Choices::[[string()]], + Option :: {majorDim, integer()} + | {style, integer()} + | {val, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Title,{PosX,PosY},{SizeW,SizeH},Choices, Options) when is_integer(Id),is_list(Title),is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH),is_list(Choices),is_list(Options) -> ?CLASS(ThisT,wxRadioBox), @@ -125,21 +137,20 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Ti wxe_util:call(?wxRadioBox_Create, <>|| UC_Str <- Choices_UCA>>)/binary, 0:(((8- ((4 + lists:sum([byte_size(S)+4||S<-Choices_UCA])) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxRadioBox()) -> bool() %% @equiv enable(This, []) +-spec enable(This) -> boolean() when + This::wxRadioBox(). + enable(This) when is_record(This, wx_ref) -> enable(This, []). -%% @spec (This::wxRadioBox(),X::integer()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% enable(This::wxRadioBox(), N::integer()) -> enable(This,N, [])

-%%

-%% enable(This::wxRadioBox(), [Option]) -> bool() -%%
Option = {enable, bool()} -%%

+-spec enable(This, N) -> boolean() when + This::wxRadioBox(), N::integer(); + (This, [Option]) -> boolean() when + This::wxRadioBox(), + Option :: {enable, boolean()}. enable(This,N) when is_record(This, wx_ref),is_integer(N) -> @@ -153,9 +164,10 @@ enable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxRadioBox_Enable_1, <>). -%% @spec (This::wxRadioBox(), N::integer(), [Option]) -> bool() -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enable(This, N, [Option]) -> boolean() when + This::wxRadioBox(), N::integer(), + Option :: {enable, boolean()}. enable(#wx_ref{type=ThisT,ref=ThisRef},N, Options) when is_integer(N),is_list(Options) -> ?CLASS(ThisT,wxRadioBox), @@ -165,44 +177,46 @@ enable(#wx_ref{type=ThisT,ref=ThisRef},N, Options) wxe_util:call(?wxRadioBox_Enable_2, <>). -%% @spec (This::wxRadioBox()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxRadioBox(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxRadioBox), wxe_util:call(?wxRadioBox_GetSelection, <>). -%% @spec (This::wxRadioBox(), N::integer()) -> string() %% @doc See external documentation. +-spec getString(This, N) -> string() when + This::wxRadioBox(), N::integer(). getString(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxRadioBox), wxe_util:call(?wxRadioBox_GetString, <>). -%% @spec (This::wxRadioBox(), N::integer()) -> ok %% @doc See external documentation. +-spec setSelection(This, N) -> ok when + This::wxRadioBox(), N::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxRadioBox), wxe_util:cast(?wxRadioBox_SetSelection, <>). -%% @spec (This::wxRadioBox()) -> bool() %% @equiv show(This, []) +-spec show(This) -> boolean() when + This::wxRadioBox(). + show(This) when is_record(This, wx_ref) -> show(This, []). -%% @spec (This::wxRadioBox(),X::integer()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% show(This::wxRadioBox(), N::integer()) -> show(This,N, [])

-%%

-%% show(This::wxRadioBox(), [Option]) -> bool() -%%
Option = {show, bool()} -%%

+-spec show(This, N) -> boolean() when + This::wxRadioBox(), N::integer(); + (This, [Option]) -> boolean() when + This::wxRadioBox(), + Option :: {show, boolean()}. show(This,N) when is_record(This, wx_ref),is_integer(N) -> @@ -216,9 +230,10 @@ show(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxRadioBox_Show_1, <>). -%% @spec (This::wxRadioBox(), N::integer(), [Option]) -> bool() -%% Option = {show, bool()} %% @doc See external documentation. +-spec show(This, N, [Option]) -> boolean() when + This::wxRadioBox(), N::integer(), + Option :: {show, boolean()}. show(#wx_ref{type=ThisT,ref=ThisRef},N, Options) when is_integer(N),is_list(Options) -> ?CLASS(ThisT,wxRadioBox), @@ -228,62 +243,70 @@ show(#wx_ref{type=ThisT,ref=ThisRef},N, Options) wxe_util:call(?wxRadioBox_Show_2, <>). -%% @spec (This::wxRadioBox()) -> integer() %% @doc See external documentation. +-spec getColumnCount(This) -> integer() when + This::wxRadioBox(). getColumnCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxRadioBox), wxe_util:call(?wxRadioBox_GetColumnCount, <>). -%% @spec (This::wxRadioBox(), N::integer()) -> string() %% @doc See external documentation. +-spec getItemHelpText(This, N) -> string() when + This::wxRadioBox(), N::integer(). getItemHelpText(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxRadioBox), wxe_util:call(?wxRadioBox_GetItemHelpText, <>). -%% @spec (This::wxRadioBox(), Item::integer()) -> wxToolTip:wxToolTip() %% @doc See external documentation. +-spec getItemToolTip(This, Item) -> wxToolTip:wxToolTip() when + This::wxRadioBox(), Item::integer(). getItemToolTip(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxRadioBox), wxe_util:call(?wxRadioBox_GetItemToolTip, <>). -%% @spec (This::wxRadioBox(), Pt::{X::integer(), Y::integer()}) -> integer() %% @doc See external documentation. +-spec getItemFromPoint(This, Pt) -> integer() when + This::wxRadioBox(), Pt::{X::integer(), Y::integer()}. getItemFromPoint(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxRadioBox), wxe_util:call(?wxRadioBox_GetItemFromPoint, <>). -%% @spec (This::wxRadioBox()) -> integer() %% @doc See external documentation. +-spec getRowCount(This) -> integer() when + This::wxRadioBox(). getRowCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxRadioBox), wxe_util:call(?wxRadioBox_GetRowCount, <>). -%% @spec (This::wxRadioBox(), N::integer()) -> bool() %% @doc See external documentation. +-spec isItemEnabled(This, N) -> boolean() when + This::wxRadioBox(), N::integer(). isItemEnabled(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxRadioBox), wxe_util:call(?wxRadioBox_IsItemEnabled, <>). -%% @spec (This::wxRadioBox(), N::integer()) -> bool() %% @doc See external documentation. +-spec isItemShown(This, N) -> boolean() when + This::wxRadioBox(), N::integer(). isItemShown(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxRadioBox), wxe_util:call(?wxRadioBox_IsItemShown, <>). -%% @spec (This::wxRadioBox(), N::integer(), HelpText::string()) -> ok %% @doc See external documentation. +-spec setItemHelpText(This, N, HelpText) -> ok when + This::wxRadioBox(), N::integer(), HelpText::string(). setItemHelpText(#wx_ref{type=ThisT,ref=ThisRef},N,HelpText) when is_integer(N),is_list(HelpText) -> ?CLASS(ThisT,wxRadioBox), @@ -291,8 +314,9 @@ setItemHelpText(#wx_ref{type=ThisT,ref=ThisRef},N,HelpText) wxe_util:cast(?wxRadioBox_SetItemHelpText, <>). -%% @spec (This::wxRadioBox(), Item::integer(), Text::string()) -> ok %% @doc See external documentation. +-spec setItemToolTip(This, Item, Text) -> ok when + This::wxRadioBox(), Item::integer(), Text::string(). setItemToolTip(#wx_ref{type=ThisT,ref=ThisRef},Item,Text) when is_integer(Item),is_list(Text) -> ?CLASS(ThisT,wxRadioBox), @@ -300,8 +324,8 @@ setItemToolTip(#wx_ref{type=ThisT,ref=ThisRef},Item,Text) wxe_util:cast(?wxRadioBox_SetItemToolTip, <>). -%% @spec (This::wxRadioBox()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxRadioBox) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxRadioBox), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxRadioButton.erl b/lib/wx/src/gen/wxRadioButton.erl index c4665837b5..d95972da22 100644 --- a/lib/wx/src/gen/wxRadioButton.erl +++ b/lib/wx/src/gen/wxRadioButton.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 @@ -69,27 +69,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxRadioButton/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxRadioButton() +-type wxRadioButton() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxRadioButton(). new() -> wxe_util:construct(?wxRadioButton_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> wxRadioButton() %% @equiv new(Parent,Id,Label, []) +-spec new(Parent, Id, Label) -> wxRadioButton() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + new(Parent,Id,Label) when is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> new(Parent,Id,Label, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> wxRadioButton() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, Label, [Option]) -> wxRadioButton() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -103,15 +111,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) wxe_util:construct(?wxRadioButton_new_4, <>). -%% @spec (This::wxRadioButton(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> bool() %% @equiv create(This,Parent,Id,Label, []) +-spec create(This, Parent, Id, Label) -> boolean() when + This::wxRadioButton(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + create(This,Parent,Id,Label) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> create(This,Parent,Id,Label, []). -%% @spec (This::wxRadioButton(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Label, [Option]) -> boolean() when + This::wxRadioButton(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ThisT,wxRadioButton), @@ -126,23 +140,25 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,La wxe_util:call(?wxRadioButton_Create, <>). -%% @spec (This::wxRadioButton()) -> bool() %% @doc See external documentation. +-spec getValue(This) -> boolean() when + This::wxRadioButton(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxRadioButton), wxe_util:call(?wxRadioButton_GetValue, <>). -%% @spec (This::wxRadioButton(), Val::bool()) -> ok %% @doc See external documentation. +-spec setValue(This, Val) -> ok when + This::wxRadioButton(), Val::boolean(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Val) when is_boolean(Val) -> ?CLASS(ThisT,wxRadioButton), wxe_util:cast(?wxRadioButton_SetValue, <>). -%% @spec (This::wxRadioButton()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxRadioButton) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxRadioButton), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxRegion.erl b/lib/wx/src/gen/wxRegion.erl index 9107a4d6b1..0239558a5a 100644 --- a/lib/wx/src/gen/wxRegion.erl +++ b/lib/wx/src/gen/wxRegion.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2011. All Rights Reserved. +%% Copyright Ericsson AB 2008-2012. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -32,24 +32,22 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxRegion/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxRegion() +-type wxRegion() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxRegion(). new() -> wxe_util:construct(?wxRegion_new_0, <<>>). -%% @spec (X::term()) -> wxRegion() %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Bmp::wxBitmap:wxBitmap()) -> wxRegion() -%%

-%%

-%% new(Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> wxRegion() -%%

+-spec new(Bmp) -> wxRegion() when + Bmp::wxBitmap:wxBitmap(); + (Rect) -> wxRegion() when + Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. new(#wx_ref{type=BmpT,ref=BmpRef}) -> ?CLASS(BmpT,wxBitmap), wxe_util:construct(?wxRegion_new_1_0, @@ -59,40 +57,36 @@ new({RectX,RectY,RectW,RectH}) wxe_util:construct(?wxRegion_new_1_1, <>). -%% @spec (TopLeft::{X::integer(), Y::integer()}, BottomRight::{X::integer(), Y::integer()}) -> wxRegion() %% @doc See external documentation. +-spec new(TopLeft, BottomRight) -> wxRegion() when + TopLeft::{X::integer(), Y::integer()}, BottomRight::{X::integer(), Y::integer()}. new({TopLeftX,TopLeftY},{BottomRightX,BottomRightY}) when is_integer(TopLeftX),is_integer(TopLeftY),is_integer(BottomRightX),is_integer(BottomRightY) -> wxe_util:construct(?wxRegion_new_2, <>). -%% @spec (X::integer(), Y::integer(), W::integer(), H::integer()) -> wxRegion() %% @doc See external documentation. +-spec new(X, Y, W, H) -> wxRegion() when + X::integer(), Y::integer(), W::integer(), H::integer(). new(X,Y,W,H) when is_integer(X),is_integer(Y),is_integer(W),is_integer(H) -> wxe_util:construct(?wxRegion_new_4, <>). -%% @spec (This::wxRegion()) -> ok %% @doc See external documentation. +-spec clear(This) -> ok when + This::wxRegion(). clear(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxRegion), wxe_util:cast(?wxRegion_Clear, <>). -%% @spec (This::wxRegion(),X::term()) -> WxRegionContain %% @doc See external documentation. -%%
Alternatives: -%%

-%% contains(This::wxRegion(), Pt::{X::integer(), Y::integer()}) -> WxRegionContain -%%
WxRegionContain = integer() -%%
WxRegionContain is one of ?wxOutRegion | ?wxPartRegion | ?wxInRegion -%%

-%%

-%% contains(This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> WxRegionContain -%%
WxRegionContain = integer() -%%
WxRegionContain is one of ?wxOutRegion | ?wxPartRegion | ?wxInRegion -%%

+%%
Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion +-spec contains(This, Pt) -> wx:wx_enum() when + This::wxRegion(), Pt::{X::integer(), Y::integer()}; + (This, Rect) -> wx:wx_enum() when + This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. contains(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxRegion), @@ -104,49 +98,47 @@ contains(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:call(?wxRegion_Contains_1_1, <>). -%% @spec (This::wxRegion(), X::integer(), Y::integer()) -> WxRegionContain -%% WxRegionContain = integer() %% @doc See external documentation. -%%
WxRegionContain is one of ?wxOutRegion | ?wxPartRegion | ?wxInRegion +%%
Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion +-spec contains(This, X, Y) -> wx:wx_enum() when + This::wxRegion(), X::integer(), Y::integer(). contains(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_Contains_2, <>). -%% @spec (This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> WxRegionContain -%% WxRegionContain = integer() %% @doc See external documentation. -%%
WxRegionContain is one of ?wxOutRegion | ?wxPartRegion | ?wxInRegion +%%
Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion +-spec contains(This, X, Y, W, H) -> wx:wx_enum() when + This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer(). contains(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_integer(X),is_integer(Y),is_integer(W),is_integer(H) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_Contains_4, <>). -%% @spec (This::wxRegion()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec convertToBitmap(This) -> wxBitmap:wxBitmap() when + This::wxRegion(). convertToBitmap(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_ConvertToBitmap, <>). -%% @spec (This::wxRegion()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getBox(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxRegion(). getBox(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_GetBox, <>). -%% @spec (This::wxRegion(),X::wxRegion()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% intersect(This::wxRegion(), Region::wxRegion()) -> bool() -%%

-%%

-%% intersect(This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool() -%%

+-spec intersect(This, Region) -> boolean() when + This::wxRegion(), Region::wxRegion(); + (This, Rect) -> boolean() when + This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. intersect(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=RegionT,ref=RegionRef}) -> ?CLASS(ThisT,wxRegion), ?CLASS(RegionT,wxRegion), @@ -158,30 +150,28 @@ intersect(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:call(?wxRegion_Intersect_1_1, <>). -%% @spec (This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool() %% @doc See external documentation. +-spec intersect(This, X, Y, W, H) -> boolean() when + This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer(). intersect(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_integer(X),is_integer(Y),is_integer(W),is_integer(H) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_Intersect_4, <>). -%% @spec (This::wxRegion()) -> bool() %% @doc See external documentation. +-spec isEmpty(This) -> boolean() when + This::wxRegion(). isEmpty(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_IsEmpty, <>). -%% @spec (This::wxRegion(),X::wxRegion()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% subtract(This::wxRegion(), Region::wxRegion()) -> bool() -%%

-%%

-%% subtract(This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool() -%%

+-spec subtract(This, Region) -> boolean() when + This::wxRegion(), Region::wxRegion(); + (This, Rect) -> boolean() when + This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. subtract(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=RegionT,ref=RegionRef}) -> ?CLASS(ThisT,wxRegion), ?CLASS(RegionT,wxRegion), @@ -193,39 +183,38 @@ subtract(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:call(?wxRegion_Subtract_1_1, <>). -%% @spec (This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool() %% @doc See external documentation. +-spec subtract(This, X, Y, W, H) -> boolean() when + This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer(). subtract(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_integer(X),is_integer(Y),is_integer(W),is_integer(H) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_Subtract_4, <>). -%% @spec (This::wxRegion(), Pt::{X::integer(), Y::integer()}) -> bool() %% @doc See external documentation. +-spec offset(This, Pt) -> boolean() when + This::wxRegion(), Pt::{X::integer(), Y::integer()}. offset(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_Offset_1, <>). -%% @spec (This::wxRegion(), X::integer(), Y::integer()) -> bool() %% @doc See external documentation. +-spec offset(This, X, Y) -> boolean() when + This::wxRegion(), X::integer(), Y::integer(). offset(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_Offset_2, <>). -%% @spec (This::wxRegion(),X::term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% union(This::wxRegion(), Region::wxRegion() | wxBitmap:wxBitmap()) -> bool() -%%

-%%

-%% union(This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool() -%%

+-spec union(This, Region) -> boolean() when + This::wxRegion(), Region::wxRegion() | wxBitmap:wxBitmap(); + (This, Rect) -> boolean() when + This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. union(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=RegionT,ref=RegionRef}) -> ?CLASS(ThisT,wxRegion), RegionOP = case ?CLASS_T(RegionT,wxRegion) of @@ -242,15 +231,18 @@ union(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:call(?wxRegion_Union_1_2, <>). -%% @spec (This::wxRegion(), Bmp::wxBitmap:wxBitmap(), Transp::wx:colour()) -> bool() %% @equiv union(This,Bmp,Transp, []) +-spec union(This, Bmp, Transp) -> boolean() when + This::wxRegion(), Bmp::wxBitmap:wxBitmap(), Transp::wx:wx_colour(). + union(This,Bmp,Transp) when is_record(This, wx_ref),is_record(Bmp, wx_ref),tuple_size(Transp) =:= 3; tuple_size(Transp) =:= 4 -> union(This,Bmp,Transp, []). -%% @spec (This::wxRegion(), Bmp::wxBitmap:wxBitmap(), Transp::wx:colour(), [Option]) -> bool() -%% Option = {tolerance, integer()} %% @doc See external documentation. +-spec union(This, Bmp, Transp, [Option]) -> boolean() when + This::wxRegion(), Bmp::wxBitmap:wxBitmap(), Transp::wx:wx_colour(), + Option :: {tolerance, integer()}. union(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef},Transp, Options) when tuple_size(Transp) =:= 3; tuple_size(Transp) =:= 4,is_list(Options) -> ?CLASS(ThisT,wxRegion), @@ -261,23 +253,20 @@ union(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BmpT,ref=BmpRef},Transp, Opti wxe_util:call(?wxRegion_Union_3, <>). -%% @spec (This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool() %% @doc See external documentation. +-spec union(This, X, Y, W, H) -> boolean() when + This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer(). union(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_integer(X),is_integer(Y),is_integer(W),is_integer(H) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_Union_4, <>). -%% @spec (This::wxRegion(),X::wxRegion()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% 'Xor'(This::wxRegion(), Region::wxRegion()) -> bool() -%%

-%%

-%% 'Xor'(This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool() -%%

+-spec 'Xor'(This, Region) -> boolean() when + This::wxRegion(), Region::wxRegion(); + (This, Rect) -> boolean() when + This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. 'Xor'(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=RegionT,ref=RegionRef}) -> ?CLASS(ThisT,wxRegion), ?CLASS(RegionT,wxRegion), @@ -289,16 +278,17 @@ union(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) wxe_util:call(?wxRegion_Xor_1_1, <>). -%% @spec (This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool() %% @doc See external documentation. +-spec 'Xor'(This, X, Y, W, H) -> boolean() when + This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer(). 'Xor'(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_integer(X),is_integer(Y),is_integer(W),is_integer(H) -> ?CLASS(ThisT,wxRegion), wxe_util:call(?wxRegion_Xor_4, <>). -%% @spec (This::wxRegion()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxRegion) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxRegion), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxSashEvent.erl b/lib/wx/src/gen/wxSashEvent.erl index f9c58a04b1..6ca4bf73ea 100644 --- a/lib/wx/src/gen/wxSashEvent.erl +++ b/lib/wx/src/gen/wxSashEvent.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 @@ -40,31 +40,34 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxSashEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxSashEvent()) -> WxSashEdgePosition -%% WxSashEdgePosition = integer() +-type wxSashEvent() :: wx:wx_object(). %% @doc See external documentation. -%%
WxSashEdgePosition is one of ?wxSASH_TOP | ?wxSASH_RIGHT | ?wxSASH_BOTTOM | ?wxSASH_LEFT | ?wxSASH_NONE +%%
Res = ?wxSASH_TOP | ?wxSASH_RIGHT | ?wxSASH_BOTTOM | ?wxSASH_LEFT | ?wxSASH_NONE +-spec getEdge(This) -> wx:wx_enum() when + This::wxSashEvent(). getEdge(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSashEvent), wxe_util:call(?wxSashEvent_GetEdge, <>). -%% @spec (This::wxSashEvent()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getDragRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxSashEvent(). getDragRect(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSashEvent), wxe_util:call(?wxSashEvent_GetDragRect, <>). -%% @spec (This::wxSashEvent()) -> WxSashDragStatus -%% WxSashDragStatus = integer() %% @doc See external documentation. -%%
WxSashDragStatus is one of ?wxSASH_STATUS_OK | ?wxSASH_STATUS_OUT_OF_RANGE +%%
Res = ?wxSASH_STATUS_OK | ?wxSASH_STATUS_OUT_OF_RANGE +-spec getDragStatus(This) -> wx:wx_enum() when + This::wxSashEvent(). getDragStatus(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSashEvent), wxe_util:call(?wxSashEvent_GetDragStatus, diff --git a/lib/wx/src/gen/wxSashLayoutWindow.erl b/lib/wx/src/gen/wxSashLayoutWindow.erl index eb8eb38011..252ff4d7dd 100644 --- a/lib/wx/src/gen/wxSashLayoutWindow.erl +++ b/lib/wx/src/gen/wxSashLayoutWindow.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,35 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxSashLayoutWindow/0]). %% @hidden parent_class(wxSashWindow) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSashLayoutWindow() +-type wxSashLayoutWindow() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxSashLayoutWindow(). new() -> wxe_util:construct(?wxSashLayoutWindow_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxSashLayoutWindow() %% @equiv new(Parent, []) +-spec new(Parent) -> wxSashLayoutWindow() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxSashLayoutWindow() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxSashLayoutWindow() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -107,15 +115,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxSashLayoutWindow_new_2, <>). -%% @spec (This::wxSashLayoutWindow(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxSashLayoutWindow(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxSashLayoutWindow(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxSashLayoutWindow(), Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {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}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSashLayoutWindow), @@ -129,54 +143,55 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxSashLayoutWindow_Create, <>). -%% @spec (This::wxSashLayoutWindow()) -> WxLayoutAlignment -%% WxLayoutAlignment = integer() %% @doc See external documentation. -%%
WxLayoutAlignment is one of ?wxLAYOUT_NONE | ?wxLAYOUT_TOP | ?wxLAYOUT_LEFT | ?wxLAYOUT_RIGHT | ?wxLAYOUT_BOTTOM +%%
Res = ?wxLAYOUT_NONE | ?wxLAYOUT_TOP | ?wxLAYOUT_LEFT | ?wxLAYOUT_RIGHT | ?wxLAYOUT_BOTTOM +-spec getAlignment(This) -> wx:wx_enum() when + This::wxSashLayoutWindow(). getAlignment(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSashLayoutWindow), wxe_util:call(?wxSashLayoutWindow_GetAlignment, <>). -%% @spec (This::wxSashLayoutWindow()) -> WxLayoutOrientation -%% WxLayoutOrientation = integer() %% @doc See external documentation. -%%
WxLayoutOrientation is one of ?wxLAYOUT_HORIZONTAL | ?wxLAYOUT_VERTICAL +%%
Res = ?wxLAYOUT_HORIZONTAL | ?wxLAYOUT_VERTICAL +-spec getOrientation(This) -> wx:wx_enum() when + This::wxSashLayoutWindow(). getOrientation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSashLayoutWindow), wxe_util:call(?wxSashLayoutWindow_GetOrientation, <>). -%% @spec (This::wxSashLayoutWindow(), Align::WxLayoutAlignment) -> ok -%% WxLayoutAlignment = integer() %% @doc See external documentation. -%%
WxLayoutAlignment is one of ?wxLAYOUT_NONE | ?wxLAYOUT_TOP | ?wxLAYOUT_LEFT | ?wxLAYOUT_RIGHT | ?wxLAYOUT_BOTTOM +%%
Align = ?wxLAYOUT_NONE | ?wxLAYOUT_TOP | ?wxLAYOUT_LEFT | ?wxLAYOUT_RIGHT | ?wxLAYOUT_BOTTOM +-spec setAlignment(This, Align) -> ok when + This::wxSashLayoutWindow(), Align::wx:wx_enum(). setAlignment(#wx_ref{type=ThisT,ref=ThisRef},Align) when is_integer(Align) -> ?CLASS(ThisT,wxSashLayoutWindow), wxe_util:cast(?wxSashLayoutWindow_SetAlignment, <>). -%% @spec (This::wxSashLayoutWindow(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setDefaultSize(This, Size) -> ok when + This::wxSashLayoutWindow(), Size::{W::integer(), H::integer()}. setDefaultSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxSashLayoutWindow), wxe_util:cast(?wxSashLayoutWindow_SetDefaultSize, <>). -%% @spec (This::wxSashLayoutWindow(), Orient::WxLayoutOrientation) -> ok -%% WxLayoutOrientation = integer() %% @doc See external documentation. -%%
WxLayoutOrientation is one of ?wxLAYOUT_HORIZONTAL | ?wxLAYOUT_VERTICAL +%%
Orient = ?wxLAYOUT_HORIZONTAL | ?wxLAYOUT_VERTICAL +-spec setOrientation(This, Orient) -> ok when + This::wxSashLayoutWindow(), Orient::wx:wx_enum(). setOrientation(#wx_ref{type=ThisT,ref=ThisRef},Orient) when is_integer(Orient) -> ?CLASS(ThisT,wxSashLayoutWindow), wxe_util:cast(?wxSashLayoutWindow_SetOrientation, <>). -%% @spec (This::wxSashLayoutWindow()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSashLayoutWindow) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSashLayoutWindow), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxSashWindow.erl b/lib/wx/src/gen/wxSashWindow.erl index 698cfb8fb6..c3f0d17eb4 100644 --- a/lib/wx/src/gen/wxSashWindow.erl +++ b/lib/wx/src/gen/wxSashWindow.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 @@ -70,26 +70,34 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxSashWindow/0]). %% @hidden parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSashWindow() +-type wxSashWindow() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxSashWindow(). new() -> wxe_util:construct(?wxSashWindow_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxSashWindow() %% @equiv new(Parent, []) +-spec new(Parent) -> wxSashWindow() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxSashWindow() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxSashWindow() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -102,88 +110,96 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxSashWindow_new_2, <>). -%% @spec (This::wxSashWindow(), Edge::WxSashEdgePosition) -> bool() -%% WxSashEdgePosition = integer() %% @doc See external documentation. -%%
WxSashEdgePosition is one of ?wxSASH_TOP | ?wxSASH_RIGHT | ?wxSASH_BOTTOM | ?wxSASH_LEFT | ?wxSASH_NONE +%%
Edge = ?wxSASH_TOP | ?wxSASH_RIGHT | ?wxSASH_BOTTOM | ?wxSASH_LEFT | ?wxSASH_NONE +-spec getSashVisible(This, Edge) -> boolean() when + This::wxSashWindow(), Edge::wx:wx_enum(). getSashVisible(#wx_ref{type=ThisT,ref=ThisRef},Edge) when is_integer(Edge) -> ?CLASS(ThisT,wxSashWindow), wxe_util:call(?wxSashWindow_GetSashVisible, <>). -%% @spec (This::wxSashWindow()) -> integer() %% @doc See external documentation. +-spec getMaximumSizeX(This) -> integer() when + This::wxSashWindow(). getMaximumSizeX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSashWindow), wxe_util:call(?wxSashWindow_GetMaximumSizeX, <>). -%% @spec (This::wxSashWindow()) -> integer() %% @doc See external documentation. +-spec getMaximumSizeY(This) -> integer() when + This::wxSashWindow(). getMaximumSizeY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSashWindow), wxe_util:call(?wxSashWindow_GetMaximumSizeY, <>). -%% @spec (This::wxSashWindow()) -> integer() %% @doc See external documentation. +-spec getMinimumSizeX(This) -> integer() when + This::wxSashWindow(). getMinimumSizeX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSashWindow), wxe_util:call(?wxSashWindow_GetMinimumSizeX, <>). -%% @spec (This::wxSashWindow()) -> integer() %% @doc See external documentation. +-spec getMinimumSizeY(This) -> integer() when + This::wxSashWindow(). getMinimumSizeY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSashWindow), wxe_util:call(?wxSashWindow_GetMinimumSizeY, <>). -%% @spec (This::wxSashWindow(), Max::integer()) -> ok %% @doc See external documentation. +-spec setMaximumSizeX(This, Max) -> ok when + This::wxSashWindow(), Max::integer(). setMaximumSizeX(#wx_ref{type=ThisT,ref=ThisRef},Max) when is_integer(Max) -> ?CLASS(ThisT,wxSashWindow), wxe_util:cast(?wxSashWindow_SetMaximumSizeX, <>). -%% @spec (This::wxSashWindow(), Max::integer()) -> ok %% @doc See external documentation. +-spec setMaximumSizeY(This, Max) -> ok when + This::wxSashWindow(), Max::integer(). setMaximumSizeY(#wx_ref{type=ThisT,ref=ThisRef},Max) when is_integer(Max) -> ?CLASS(ThisT,wxSashWindow), wxe_util:cast(?wxSashWindow_SetMaximumSizeY, <>). -%% @spec (This::wxSashWindow(), Min::integer()) -> ok %% @doc See external documentation. +-spec setMinimumSizeX(This, Min) -> ok when + This::wxSashWindow(), Min::integer(). setMinimumSizeX(#wx_ref{type=ThisT,ref=ThisRef},Min) when is_integer(Min) -> ?CLASS(ThisT,wxSashWindow), wxe_util:cast(?wxSashWindow_SetMinimumSizeX, <>). -%% @spec (This::wxSashWindow(), Min::integer()) -> ok %% @doc See external documentation. +-spec setMinimumSizeY(This, Min) -> ok when + This::wxSashWindow(), Min::integer(). setMinimumSizeY(#wx_ref{type=ThisT,ref=ThisRef},Min) when is_integer(Min) -> ?CLASS(ThisT,wxSashWindow), wxe_util:cast(?wxSashWindow_SetMinimumSizeY, <>). -%% @spec (This::wxSashWindow(), Edge::WxSashEdgePosition, Sash::bool()) -> ok -%% WxSashEdgePosition = integer() %% @doc See external documentation. -%%
WxSashEdgePosition is one of ?wxSASH_TOP | ?wxSASH_RIGHT | ?wxSASH_BOTTOM | ?wxSASH_LEFT | ?wxSASH_NONE +%%
Edge = ?wxSASH_TOP | ?wxSASH_RIGHT | ?wxSASH_BOTTOM | ?wxSASH_LEFT | ?wxSASH_NONE +-spec setSashVisible(This, Edge, Sash) -> ok when + This::wxSashWindow(), Edge::wx:wx_enum(), Sash::boolean(). setSashVisible(#wx_ref{type=ThisT,ref=ThisRef},Edge,Sash) when is_integer(Edge),is_boolean(Sash) -> ?CLASS(ThisT,wxSashWindow), wxe_util:cast(?wxSashWindow_SetSashVisible, <>). -%% @spec (This::wxSashWindow()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSashWindow) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSashWindow), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxScreenDC.erl b/lib/wx/src/gen/wxScreenDC.erl index 4d7466f4f1..baf9726946 100644 --- a/lib/wx/src/gen/wxScreenDC.erl +++ b/lib/wx/src/gen/wxScreenDC.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 @@ -52,18 +52,20 @@ setPen/2,setTextBackground/2,setTextForeground/2,setUserScale/3,startDoc/2, startPage/1]). +-export_type([wxScreenDC/0]). %% @hidden parent_class(wxDC) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxScreenDC() +-type wxScreenDC() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxScreenDC(). new() -> wxe_util:construct(?wxScreenDC_new, <<>>). -%% @spec (This::wxScreenDC()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxScreenDC) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxScreenDC), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxScrollBar.erl b/lib/wx/src/gen/wxScrollBar.erl index 5c7890009f..baa5918c9e 100644 --- a/lib/wx/src/gen/wxScrollBar.erl +++ b/lib/wx/src/gen/wxScrollBar.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 @@ -70,27 +70,35 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxScrollBar/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxScrollBar() +-type wxScrollBar() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxScrollBar(). new() -> wxe_util:construct(?wxScrollBar_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxScrollBar() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxScrollBar() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxScrollBar() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxScrollBar() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -103,15 +111,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxScrollBar_new_3, <>). -%% @spec (This::wxScrollBar(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxScrollBar(), 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::wxScrollBar(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxScrollBar(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxScrollBar), @@ -125,51 +139,59 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxScrollBar_Create, <>). -%% @spec (This::wxScrollBar()) -> integer() %% @doc See external documentation. +-spec getRange(This) -> integer() when + This::wxScrollBar(). getRange(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrollBar), wxe_util:call(?wxScrollBar_GetRange, <>). -%% @spec (This::wxScrollBar()) -> integer() %% @doc See external documentation. +-spec getPageSize(This) -> integer() when + This::wxScrollBar(). getPageSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrollBar), wxe_util:call(?wxScrollBar_GetPageSize, <>). -%% @spec (This::wxScrollBar()) -> integer() %% @doc See external documentation. +-spec getThumbPosition(This) -> integer() when + This::wxScrollBar(). getThumbPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrollBar), wxe_util:call(?wxScrollBar_GetThumbPosition, <>). -%% @spec (This::wxScrollBar()) -> integer() %% @doc See external documentation. +-spec getThumbSize(This) -> integer() when + This::wxScrollBar(). getThumbSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrollBar), wxe_util:call(?wxScrollBar_GetThumbSize, <>). -%% @spec (This::wxScrollBar(), ViewStart::integer()) -> ok %% @doc See external documentation. +-spec setThumbPosition(This, ViewStart) -> ok when + This::wxScrollBar(), ViewStart::integer(). setThumbPosition(#wx_ref{type=ThisT,ref=ThisRef},ViewStart) when is_integer(ViewStart) -> ?CLASS(ThisT,wxScrollBar), wxe_util:cast(?wxScrollBar_SetThumbPosition, <>). -%% @spec (This::wxScrollBar(), Position::integer(), ThumbSize::integer(), Range::integer(), PageSize::integer()) -> ok %% @equiv setScrollbar(This,Position,ThumbSize,Range,PageSize, []) +-spec setScrollbar(This, Position, ThumbSize, Range, PageSize) -> ok when + This::wxScrollBar(), Position::integer(), ThumbSize::integer(), Range::integer(), PageSize::integer(). + setScrollbar(This,Position,ThumbSize,Range,PageSize) when is_record(This, wx_ref),is_integer(Position),is_integer(ThumbSize),is_integer(Range),is_integer(PageSize) -> setScrollbar(This,Position,ThumbSize,Range,PageSize, []). -%% @spec (This::wxScrollBar(), Position::integer(), ThumbSize::integer(), Range::integer(), PageSize::integer(), [Option]) -> ok -%% Option = {refresh, bool()} %% @doc See external documentation. +-spec setScrollbar(This, Position, ThumbSize, Range, PageSize, [Option]) -> ok when + This::wxScrollBar(), Position::integer(), ThumbSize::integer(), Range::integer(), PageSize::integer(), + Option :: {refresh, boolean()}. setScrollbar(#wx_ref{type=ThisT,ref=ThisRef},Position,ThumbSize,Range,PageSize, Options) when is_integer(Position),is_integer(ThumbSize),is_integer(Range),is_integer(PageSize),is_list(Options) -> ?CLASS(ThisT,wxScrollBar), @@ -179,8 +201,8 @@ setScrollbar(#wx_ref{type=ThisT,ref=ThisRef},Position,ThumbSize,Range,PageSize, wxe_util:cast(?wxScrollBar_SetScrollbar, <>). -%% @spec (This::wxScrollBar()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxScrollBar) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxScrollBar), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxScrollEvent.erl b/lib/wx/src/gen/wxScrollEvent.erl index 61b99fa360..6939859d92 100644 --- a/lib/wx/src/gen/wxScrollEvent.erl +++ b/lib/wx/src/gen/wxScrollEvent.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,20 +40,24 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxScrollEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxScrollEvent()) -> integer() +-type wxScrollEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getOrientation(This) -> integer() when + This::wxScrollEvent(). getOrientation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrollEvent), wxe_util:call(?wxScrollEvent_GetOrientation, <>). -%% @spec (This::wxScrollEvent()) -> integer() %% @doc See external documentation. +-spec getPosition(This) -> integer() when + This::wxScrollEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrollEvent), wxe_util:call(?wxScrollEvent_GetPosition, diff --git a/lib/wx/src/gen/wxScrollWinEvent.erl b/lib/wx/src/gen/wxScrollWinEvent.erl index 6b33b6b564..c899d37dff 100644 --- a/lib/wx/src/gen/wxScrollWinEvent.erl +++ b/lib/wx/src/gen/wxScrollWinEvent.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 @@ -37,19 +37,23 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxScrollWinEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxScrollWinEvent()) -> integer() +-type wxScrollWinEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getOrientation(This) -> integer() when + This::wxScrollWinEvent(). getOrientation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrollWinEvent), wxe_util:call(?wxScrollWinEvent_GetOrientation, <>). -%% @spec (This::wxScrollWinEvent()) -> integer() %% @doc See external documentation. +-spec getPosition(This) -> integer() when + This::wxScrollWinEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrollWinEvent), wxe_util:call(?wxScrollWinEvent_GetPosition, diff --git a/lib/wx/src/gen/wxScrolledWindow.erl b/lib/wx/src/gen/wxScrolledWindow.erl index 0693a79760..b4ecc68a6c 100644 --- a/lib/wx/src/gen/wxScrolledWindow.erl +++ b/lib/wx/src/gen/wxScrolledWindow.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 @@ -72,27 +72,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxScrolledWindow/0]). %% @hidden parent_class(wxPanel) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxScrolledWindow() +-type wxScrolledWindow() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxScrolledWindow(). new() -> wxe_util:construct(?wxScrolledWindow_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxScrolledWindow() %% @equiv new(Parent, []) +-spec new(Parent) -> wxScrolledWindow() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxScrolledWindow() -%% Option = {winid, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxScrolledWindow() when + Parent::wxWindow:wxWindow(), + Option :: {winid, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -105,93 +113,108 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxScrolledWindow_new_2, <>). -%% @spec (This::wxScrolledWindow(), Pt::{X::integer(), Y::integer()}) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec calcScrolledPosition(This, Pt) -> {X::integer(), Y::integer()} when + This::wxScrolledWindow(), Pt::{X::integer(), Y::integer()}. calcScrolledPosition(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxScrolledWindow), wxe_util:call(?wxScrolledWindow_CalcScrolledPosition_1, <>). -%% @spec (This::wxScrolledWindow(), X::integer(), Y::integer()) -> {Xx::integer(), Yy::integer()} %% @doc See external documentation. +-spec calcScrolledPosition(This, X, Y) -> {Xx::integer(), Yy::integer()} when + This::wxScrolledWindow(), X::integer(), Y::integer(). calcScrolledPosition(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxScrolledWindow), wxe_util:call(?wxScrolledWindow_CalcScrolledPosition_4, <>). -%% @spec (This::wxScrolledWindow(), Pt::{X::integer(), Y::integer()}) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec calcUnscrolledPosition(This, Pt) -> {X::integer(), Y::integer()} when + This::wxScrolledWindow(), Pt::{X::integer(), Y::integer()}. calcUnscrolledPosition(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxScrolledWindow), wxe_util:call(?wxScrolledWindow_CalcUnscrolledPosition_1, <>). -%% @spec (This::wxScrolledWindow(), X::integer(), Y::integer()) -> {Xx::integer(), Yy::integer()} %% @doc See external documentation. +-spec calcUnscrolledPosition(This, X, Y) -> {Xx::integer(), Yy::integer()} when + This::wxScrolledWindow(), X::integer(), Y::integer(). calcUnscrolledPosition(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxScrolledWindow), wxe_util:call(?wxScrolledWindow_CalcUnscrolledPosition_4, <>). -%% @spec (This::wxScrolledWindow(), X_scrolling::bool(), Y_scrolling::bool()) -> ok %% @doc See external documentation. +-spec enableScrolling(This, X_scrolling, Y_scrolling) -> ok when + This::wxScrolledWindow(), X_scrolling::boolean(), Y_scrolling::boolean(). enableScrolling(#wx_ref{type=ThisT,ref=ThisRef},X_scrolling,Y_scrolling) when is_boolean(X_scrolling),is_boolean(Y_scrolling) -> ?CLASS(ThisT,wxScrolledWindow), wxe_util:cast(?wxScrolledWindow_EnableScrolling, <>). -%% @spec (This::wxScrolledWindow()) -> {PixelsPerUnitX::integer(), PixelsPerUnitY::integer()} %% @doc See external documentation. +-spec getScrollPixelsPerUnit(This) -> {PixelsPerUnitX::integer(), PixelsPerUnitY::integer()} when + This::wxScrolledWindow(). getScrollPixelsPerUnit(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrolledWindow), wxe_util:call(?wxScrolledWindow_GetScrollPixelsPerUnit, <>). -%% @spec (This::wxScrolledWindow()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getViewStart(This) -> {X::integer(), Y::integer()} when + This::wxScrolledWindow(). getViewStart(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxScrolledWindow), wxe_util:call(?wxScrolledWindow_GetViewStart, <>). -%% @spec (This::wxScrolledWindow(), Dc::wxDC:wxDC()) -> ok %% @doc See external documentation. +-spec doPrepareDC(This, Dc) -> ok when + This::wxScrolledWindow(), Dc::wxDC:wxDC(). doPrepareDC(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DcT,ref=DcRef}) -> ?CLASS(ThisT,wxScrolledWindow), ?CLASS(DcT,wxDC), wxe_util:cast(?wxScrolledWindow_DoPrepareDC, <>). -%% @spec (This::wxScrolledWindow(), Dc::wxDC:wxDC()) -> ok %% @doc See external documentation. +-spec prepareDC(This, Dc) -> ok when + This::wxScrolledWindow(), Dc::wxDC:wxDC(). prepareDC(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DcT,ref=DcRef}) -> ?CLASS(ThisT,wxScrolledWindow), ?CLASS(DcT,wxDC), wxe_util:cast(?wxScrolledWindow_PrepareDC, <>). -%% @spec (This::wxScrolledWindow(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec scroll(This, X, Y) -> ok when + This::wxScrolledWindow(), X::integer(), Y::integer(). scroll(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxScrolledWindow), wxe_util:cast(?wxScrolledWindow_Scroll, <>). -%% @spec (This::wxScrolledWindow(), PixelsPerUnitX::integer(), PixelsPerUnitY::integer(), NoUnitsX::integer(), NoUnitsY::integer()) -> ok %% @equiv setScrollbars(This,PixelsPerUnitX,PixelsPerUnitY,NoUnitsX,NoUnitsY, []) +-spec setScrollbars(This, PixelsPerUnitX, PixelsPerUnitY, NoUnitsX, NoUnitsY) -> ok when + This::wxScrolledWindow(), PixelsPerUnitX::integer(), PixelsPerUnitY::integer(), NoUnitsX::integer(), NoUnitsY::integer(). + setScrollbars(This,PixelsPerUnitX,PixelsPerUnitY,NoUnitsX,NoUnitsY) when is_record(This, wx_ref),is_integer(PixelsPerUnitX),is_integer(PixelsPerUnitY),is_integer(NoUnitsX),is_integer(NoUnitsY) -> setScrollbars(This,PixelsPerUnitX,PixelsPerUnitY,NoUnitsX,NoUnitsY, []). -%% @spec (This::wxScrolledWindow(), PixelsPerUnitX::integer(), PixelsPerUnitY::integer(), NoUnitsX::integer(), NoUnitsY::integer(), [Option]) -> ok -%% Option = {xPos, integer()} | {yPos, integer()} | {noRefresh, bool()} %% @doc See external documentation. +-spec setScrollbars(This, PixelsPerUnitX, PixelsPerUnitY, NoUnitsX, NoUnitsY, [Option]) -> ok when + This::wxScrolledWindow(), PixelsPerUnitX::integer(), PixelsPerUnitY::integer(), NoUnitsX::integer(), NoUnitsY::integer(), + Option :: {xPos, integer()} + | {yPos, integer()} + | {noRefresh, boolean()}. setScrollbars(#wx_ref{type=ThisT,ref=ThisRef},PixelsPerUnitX,PixelsPerUnitY,NoUnitsX,NoUnitsY, Options) when is_integer(PixelsPerUnitX),is_integer(PixelsPerUnitY),is_integer(NoUnitsX),is_integer(NoUnitsY),is_list(Options) -> ?CLASS(ThisT,wxScrolledWindow), @@ -203,24 +226,26 @@ setScrollbars(#wx_ref{type=ThisT,ref=ThisRef},PixelsPerUnitX,PixelsPerUnitY,NoUn wxe_util:cast(?wxScrolledWindow_SetScrollbars, <>). -%% @spec (This::wxScrolledWindow(), Xstep::integer(), Ystep::integer()) -> ok %% @doc See external documentation. +-spec setScrollRate(This, Xstep, Ystep) -> ok when + This::wxScrolledWindow(), Xstep::integer(), Ystep::integer(). setScrollRate(#wx_ref{type=ThisT,ref=ThisRef},Xstep,Ystep) when is_integer(Xstep),is_integer(Ystep) -> ?CLASS(ThisT,wxScrolledWindow), wxe_util:cast(?wxScrolledWindow_SetScrollRate, <>). -%% @spec (This::wxScrolledWindow(), Target::wxWindow:wxWindow()) -> ok %% @doc See external documentation. +-spec setTargetWindow(This, Target) -> ok when + This::wxScrolledWindow(), Target::wxWindow:wxWindow(). setTargetWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=TargetT,ref=TargetRef}) -> ?CLASS(ThisT,wxScrolledWindow), ?CLASS(TargetT,wxWindow), wxe_util:cast(?wxScrolledWindow_SetTargetWindow, <>). -%% @spec (This::wxScrolledWindow()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxScrolledWindow) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxScrolledWindow), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxSetCursorEvent.erl b/lib/wx/src/gen/wxSetCursorEvent.erl index 75a41eb6ad..23ff963001 100644 --- a/lib/wx/src/gen/wxSetCursorEvent.erl +++ b/lib/wx/src/gen/wxSetCursorEvent.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 @@ -37,40 +37,47 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxSetCursorEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxSetCursorEvent()) -> wxCursor:wxCursor() +-type wxSetCursorEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getCursor(This) -> wxCursor:wxCursor() when + This::wxSetCursorEvent(). getCursor(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSetCursorEvent), wxe_util:call(?wxSetCursorEvent_GetCursor, <>). -%% @spec (This::wxSetCursorEvent()) -> integer() %% @doc See external documentation. +-spec getX(This) -> integer() when + This::wxSetCursorEvent(). getX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSetCursorEvent), wxe_util:call(?wxSetCursorEvent_GetX, <>). -%% @spec (This::wxSetCursorEvent()) -> integer() %% @doc See external documentation. +-spec getY(This) -> integer() when + This::wxSetCursorEvent(). getY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSetCursorEvent), wxe_util:call(?wxSetCursorEvent_GetY, <>). -%% @spec (This::wxSetCursorEvent()) -> bool() %% @doc See external documentation. +-spec hasCursor(This) -> boolean() when + This::wxSetCursorEvent(). hasCursor(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSetCursorEvent), wxe_util:call(?wxSetCursorEvent_HasCursor, <>). -%% @spec (This::wxSetCursorEvent(), Cursor::wxCursor:wxCursor()) -> ok %% @doc See external documentation. +-spec setCursor(This, Cursor) -> ok when + This::wxSetCursorEvent(), Cursor::wxCursor:wxCursor(). setCursor(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CursorT,ref=CursorRef}) -> ?CLASS(ThisT,wxSetCursorEvent), ?CLASS(CursorT,wxCursor), diff --git a/lib/wx/src/gen/wxShowEvent.erl b/lib/wx/src/gen/wxShowEvent.erl index 7d5c8300d3..ffafa0978f 100644 --- a/lib/wx/src/gen/wxShowEvent.erl +++ b/lib/wx/src/gen/wxShowEvent.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 @@ -37,20 +37,24 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxShowEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxShowEvent(), Show::bool()) -> ok +-type wxShowEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec setShow(This, Show) -> ok when + This::wxShowEvent(), Show::boolean(). setShow(#wx_ref{type=ThisT,ref=ThisRef},Show) when is_boolean(Show) -> ?CLASS(ThisT,wxShowEvent), wxe_util:cast(?wxShowEvent_SetShow, <>). -%% @spec (This::wxShowEvent()) -> bool() %% @doc See external documentation. +-spec getShow(This) -> boolean() when + This::wxShowEvent(). getShow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxShowEvent), wxe_util:call(?wxShowEvent_GetShow, diff --git a/lib/wx/src/gen/wxSingleChoiceDialog.erl b/lib/wx/src/gen/wxSingleChoiceDialog.erl index e2b835917e..741e935e41 100644 --- a/lib/wx/src/gen/wxSingleChoiceDialog.erl +++ b/lib/wx/src/gen/wxSingleChoiceDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxSingleChoiceDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,21 +85,26 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSingleChoiceDialog() +-type wxSingleChoiceDialog() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxSingleChoiceDialog(). new() -> wxe_util:construct(?wxSingleChoiceDialog_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Message::string(), Caption::string(), Choices::[[string()]]) -> wxSingleChoiceDialog() %% @equiv new(Parent,Message,Caption,Choices, []) +-spec new(Parent, Message, Caption, Choices) -> wxSingleChoiceDialog() when + Parent::wxWindow:wxWindow(), Message::string(), Caption::string(), Choices::[[string()]]. + new(Parent,Message,Caption,Choices) when is_record(Parent, wx_ref),is_list(Message),is_list(Caption),is_list(Choices) -> new(Parent,Message,Caption,Choices, []). -%% @spec (Parent::wxWindow:wxWindow(), Message::string(), Caption::string(), Choices::[[string()]], [Option]) -> wxSingleChoiceDialog() -%% Option = {style, integer()} | {pos, {X::integer(), Y::integer()}} %% @doc See external documentation. +-spec new(Parent, Message, Caption, Choices, [Option]) -> wxSingleChoiceDialog() when + Parent::wxWindow:wxWindow(), Message::string(), Caption::string(), Choices::[[string()]], + Option :: {style, integer()} + | {pos, {X::integer(), Y::integer()}}. new(#wx_ref{type=ParentT,ref=ParentRef},Message,Caption,Choices, Options) when is_list(Message),is_list(Caption),is_list(Choices),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -113,30 +119,33 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Message,Caption,Choices, Options) wxe_util:construct(?wxSingleChoiceDialog_new_5, <>|| UC_Str <- Choices_UCA>>)/binary, 0:(((8- ((4 + lists:sum([byte_size(S)+4||S<-Choices_UCA])) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxSingleChoiceDialog()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxSingleChoiceDialog(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSingleChoiceDialog), wxe_util:call(?wxSingleChoiceDialog_GetSelection, <>). -%% @spec (This::wxSingleChoiceDialog()) -> string() %% @doc See external documentation. +-spec getStringSelection(This) -> string() when + This::wxSingleChoiceDialog(). getStringSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSingleChoiceDialog), wxe_util:call(?wxSingleChoiceDialog_GetStringSelection, <>). -%% @spec (This::wxSingleChoiceDialog(), Sel::integer()) -> ok %% @doc See external documentation. +-spec setSelection(This, Sel) -> ok when + This::wxSingleChoiceDialog(), Sel::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},Sel) when is_integer(Sel) -> ?CLASS(ThisT,wxSingleChoiceDialog), wxe_util:cast(?wxSingleChoiceDialog_SetSelection, <>). -%% @spec (This::wxSingleChoiceDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSingleChoiceDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSingleChoiceDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxSizeEvent.erl b/lib/wx/src/gen/wxSizeEvent.erl index 0898f4aed9..c51e48bc59 100644 --- a/lib/wx/src/gen/wxSizeEvent.erl +++ b/lib/wx/src/gen/wxSizeEvent.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 @@ -37,12 +37,15 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxSizeEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxSizeEvent()) -> {W::integer(), H::integer()} +-type wxSizeEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getSize(This) -> {W::integer(), H::integer()} when + This::wxSizeEvent(). getSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizeEvent), wxe_util:call(?wxSizeEvent_GetSize, diff --git a/lib/wx/src/gen/wxSizer.erl b/lib/wx/src/gen/wxSizer.erl index 0f1a92f379..999724d38f 100644 --- a/lib/wx/src/gen/wxSizer.erl +++ b/lib/wx/src/gen/wxSizer.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 @@ -36,27 +36,30 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxSizer/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer()) -> wxSizerItem:wxSizerItem() +-type wxSizer() :: wx:wx_object(). %% @equiv add(This,Window, []) +-spec add(This, Window) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(). + add(This,Window) when is_record(This, wx_ref),is_record(Window, wx_ref) -> add(This,Window, []). -%% @spec (This::wxSizer(),X::integer()|term(),X::integer()|term()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% add(This::wxSizer(), Width::integer(), Height::integer()) -> add(This,Width,Height, [])

-%%

-%% add(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), [Option]) -> wxSizerItem:wxSizerItem() -%%
Option = {proportion, integer()} | {flag, integer()} | {border, integer()} | {userData, wx:wx()} -%%

-%%

-%% add(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Flags::wxSizerFlags:wxSizerFlags()) -> wxSizerItem:wxSizerItem() -%%

+-spec add(This, Width, Height) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Width::integer(), Height::integer(); + (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(). add(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> @@ -91,9 +94,13 @@ add(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},#wx_ref{ wxe_util:call(WindowOP, <>). -%% @spec (This::wxSizer(), Width::integer(), Height::integer(), [Option]) -> wxSizerItem:wxSizerItem() -%% Option = {proportion, integer()} | {flag, integer()} | {border, integer()} | {userData, wx:wx()} %% @doc See external documentation. +-spec add(This, Width, Height, [Option]) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Width::integer(), Height::integer(), + Option :: {proportion, integer()} + | {flag, integer()} + | {border, integer()} + | {userData, wx:wx()}. add(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -106,23 +113,27 @@ add(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxSizer_Add_3, <>). -%% @spec (This::wxSizer(), Size::integer()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. +-spec addSpacer(This, Size) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Size::integer(). addSpacer(#wx_ref{type=ThisT,ref=ThisRef},Size) when is_integer(Size) -> ?CLASS(ThisT,wxSizer), wxe_util:call(?wxSizer_AddSpacer, <>). -%% @spec (This::wxSizer()) -> wxSizerItem:wxSizerItem() %% @equiv addStretchSpacer(This, []) +-spec addStretchSpacer(This) -> wxSizerItem:wxSizerItem() when + This::wxSizer(). + addStretchSpacer(This) when is_record(This, wx_ref) -> addStretchSpacer(This, []). -%% @spec (This::wxSizer(), [Option]) -> wxSizerItem:wxSizerItem() -%% Option = {prop, integer()} %% @doc See external documentation. +-spec addStretchSpacer(This, [Option]) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), + Option :: {prop, integer()}. addStretchSpacer(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -132,22 +143,26 @@ addStretchSpacer(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxSizer_AddStretchSpacer, <>). -%% @spec (This::wxSizer()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec calcMin(This) -> {W::integer(), H::integer()} when + This::wxSizer(). calcMin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizer), wxe_util:call(?wxSizer_CalcMin, <>). -%% @spec (This::wxSizer()) -> ok %% @equiv clear(This, []) +-spec clear(This) -> ok when + This::wxSizer(). + clear(This) when is_record(This, wx_ref) -> clear(This, []). -%% @spec (This::wxSizer(), [Option]) -> ok -%% Option = {delete_windows, bool()} %% @doc See external documentation. +-spec clear(This, [Option]) -> ok when + This::wxSizer(), + Option :: {delete_windows, boolean()}. clear(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -157,15 +172,11 @@ clear(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxSizer_Clear, <>). -%% @spec (This::wxSizer(),X::integer()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% detach(This::wxSizer(), Index::integer()) -> bool() -%%

-%%

-%% detach(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer()) -> bool() -%%

+-spec detach(This, Index) -> boolean() when + This::wxSizer(), Index::integer(); + (This, Window) -> boolean() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(). detach(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxSizer), @@ -182,37 +193,37 @@ detach(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> wxe_util:call(WindowOP, <>). -%% @spec (This::wxSizer(), Window::wxWindow:wxWindow()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec fit(This, Window) -> {W::integer(), H::integer()} when + This::wxSizer(), Window::wxWindow:wxWindow(). fit(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(ThisT,wxSizer), ?CLASS(WindowT,wxWindow), wxe_util:call(?wxSizer_Fit, <>). -%% @spec (This::wxSizer(), Window::wxWindow:wxWindow()) -> ok %% @doc See external documentation. +-spec fitInside(This, Window) -> ok when + This::wxSizer(), Window::wxWindow:wxWindow(). fitInside(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(ThisT,wxSizer), ?CLASS(WindowT,wxWindow), wxe_util:cast(?wxSizer_FitInside, <>). -%% @spec (This::wxSizer()) -> [wxSizerItem:wxSizerItem()] %% @doc See external documentation. +-spec getChildren(This) -> [wxSizerItem:wxSizerItem()] when + This::wxSizer(). getChildren(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizer), wxe_util:call(?wxSizer_GetChildren, <>). -%% @spec (This::wxSizer(),X::term()|integer()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% getItem(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer()) -> getItem(This,Window, [])

-%%

-%% getItem(This::wxSizer(), Index::integer()) -> wxSizerItem:wxSizerItem() -%%

+-spec getItem(This, Window) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(); + (This, Index) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Index::integer(). getItem(This,Window) when is_record(This, wx_ref),is_record(Window, wx_ref) -> @@ -223,9 +234,10 @@ getItem(#wx_ref{type=ThisT,ref=ThisRef},Index) wxe_util:call(?wxSizer_GetItem_1, <>). -%% @spec (This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), [Option]) -> wxSizerItem:wxSizerItem() -%% Option = {recursive, bool()} %% @doc See external documentation. +-spec getItem(This, Window, [Option]) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), + Option :: {recursive, boolean()}. getItem(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -241,35 +253,35 @@ getItem(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}, Opt wxe_util:call(WindowOP, <>). -%% @spec (This::wxSizer()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getSize(This) -> {W::integer(), H::integer()} when + This::wxSizer(). getSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizer), wxe_util:call(?wxSizer_GetSize, <>). -%% @spec (This::wxSizer()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxSizer(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizer), wxe_util:call(?wxSizer_GetPosition, <>). -%% @spec (This::wxSizer()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getMinSize(This) -> {W::integer(), H::integer()} when + This::wxSizer(). getMinSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizer), wxe_util:call(?wxSizer_GetMinSize, <>). -%% @spec (This::wxSizer(),X::term()|integer()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% hide(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer()) -> hide(This,Window, [])

-%%

-%% hide(This::wxSizer(), Index::integer()) -> bool() -%%

+-spec hide(This, Window) -> boolean() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(); + (This, Index) -> boolean() when + This::wxSizer(), Index::integer(). hide(This,Window) when is_record(This, wx_ref),is_record(Window, wx_ref) -> @@ -280,9 +292,10 @@ hide(#wx_ref{type=ThisT,ref=ThisRef},Index) wxe_util:call(?wxSizer_Hide_1, <>). -%% @spec (This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), [Option]) -> bool() -%% Option = {recursive, bool()} %% @doc See external documentation. +-spec hide(This, Window, [Option]) -> boolean() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), + Option :: {recursive, boolean()}. hide(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -298,8 +311,9 @@ hide(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}, Option wxe_util:call(WindowOP, <>). -%% @spec (This::wxSizer(), Index::integer(), Item::wxSizerItem:wxSizerItem()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. +-spec insert(This, Index, Item) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Index::integer(), Item::wxSizerItem:wxSizerItem(). insert(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=ItemT,ref=ItemRef}) when is_integer(Index) -> ?CLASS(ThisT,wxSizer), @@ -307,18 +321,17 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=ItemT,ref=ItemRef}) wxe_util:call(?wxSizer_Insert_2, <>). -%% @spec (This::wxSizer(),Index::integer(),X::integer()|term(),X::integer()|term()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% insert(This::wxSizer(), Index::integer(), Width::integer(), Height::integer()) -> insert(This,Index,Width,Height, [])

-%%

-%% insert(This::wxSizer(), Index::integer(), Window::wxWindow:wxWindow() | wxSizer(), [Option]) -> wxSizerItem:wxSizerItem() -%%
Option = {proportion, integer()} | {flag, integer()} | {border, integer()} | {userData, wx:wx()} -%%

-%%

-%% insert(This::wxSizer(), Index::integer(), Window::wxWindow:wxWindow() | wxSizer(), Flags::wxSizerFlags:wxSizerFlags()) -> wxSizerItem:wxSizerItem() -%%

+-spec insert(This, Index, Width, Height) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Index::integer(), Width::integer(), Height::integer(); + (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(). insert(This,Index,Width,Height) when is_record(This, wx_ref),is_integer(Index),is_integer(Width),is_integer(Height) -> @@ -354,9 +367,13 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=WindowT,ref=WindowRef} wxe_util:call(WindowOP, <>). -%% @spec (This::wxSizer(), Index::integer(), Width::integer(), Height::integer(), [Option]) -> wxSizerItem:wxSizerItem() -%% Option = {proportion, integer()} | {flag, integer()} | {border, integer()} | {userData, wx:wx()} %% @doc See external documentation. +-spec insert(This, Index, Width, Height, [Option]) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Index::integer(), Width::integer(), Height::integer(), + Option :: {proportion, integer()} + | {flag, integer()} + | {border, integer()} + | {userData, wx:wx()}. insert(#wx_ref{type=ThisT,ref=ThisRef},Index,Width,Height, Options) when is_integer(Index),is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -369,23 +386,27 @@ insert(#wx_ref{type=ThisT,ref=ThisRef},Index,Width,Height, Options) wxe_util:call(?wxSizer_Insert_4, <>). -%% @spec (This::wxSizer(), Index::integer(), Size::integer()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. +-spec insertSpacer(This, Index, Size) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Index::integer(), Size::integer(). insertSpacer(#wx_ref{type=ThisT,ref=ThisRef},Index,Size) when is_integer(Index),is_integer(Size) -> ?CLASS(ThisT,wxSizer), wxe_util:call(?wxSizer_InsertSpacer, <>). -%% @spec (This::wxSizer(), Index::integer()) -> wxSizerItem:wxSizerItem() %% @equiv insertStretchSpacer(This,Index, []) +-spec insertStretchSpacer(This, Index) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Index::integer(). + insertStretchSpacer(This,Index) when is_record(This, wx_ref),is_integer(Index) -> insertStretchSpacer(This,Index, []). -%% @spec (This::wxSizer(), Index::integer(), [Option]) -> wxSizerItem:wxSizerItem() -%% Option = {prop, integer()} %% @doc See external documentation. +-spec insertStretchSpacer(This, Index, [Option]) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Index::integer(), + Option :: {prop, integer()}. insertStretchSpacer(#wx_ref{type=ThisT,ref=ThisRef},Index, Options) when is_integer(Index),is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -395,15 +416,11 @@ insertStretchSpacer(#wx_ref{type=ThisT,ref=ThisRef},Index, Options) wxe_util:call(?wxSizer_InsertStretchSpacer, <>). -%% @spec (This::wxSizer(),X::integer()|term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% isShown(This::wxSizer(), Index::integer()) -> bool() -%%

-%%

-%% isShown(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer()) -> bool() -%%

+-spec isShown(This, Index) -> boolean() when + This::wxSizer(), Index::integer(); + (This, Window) -> boolean() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(). isShown(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxSizer), @@ -420,33 +437,34 @@ isShown(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> wxe_util:call(WindowOP, <>). -%% @spec (This::wxSizer()) -> ok %% @doc See external documentation. +-spec layout(This) -> ok when + This::wxSizer(). layout(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizer), wxe_util:cast(?wxSizer_Layout, <>). -%% @spec (This::wxSizer(), Item::wxSizerItem:wxSizerItem()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. +-spec prepend(This, Item) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Item::wxSizerItem:wxSizerItem(). prepend(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ItemT,ref=ItemRef}) -> ?CLASS(ThisT,wxSizer), ?CLASS(ItemT,wxSizerItem), wxe_util:call(?wxSizer_Prepend_1, <>). -%% @spec (This::wxSizer(),X::integer()|term(),X::integer()|term()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. -%%
Alternatives: -%%

-%% prepend(This::wxSizer(), Width::integer(), Height::integer()) -> prepend(This,Width,Height, [])

-%%

-%% prepend(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), [Option]) -> wxSizerItem:wxSizerItem() -%%
Option = {proportion, integer()} | {flag, integer()} | {border, integer()} | {userData, wx:wx()} -%%

-%%

-%% prepend(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Flags::wxSizerFlags:wxSizerFlags()) -> wxSizerItem:wxSizerItem() -%%

+-spec prepend(This, Width, Height) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Width::integer(), Height::integer(); + (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(). prepend(This,Width,Height) when is_record(This, wx_ref),is_integer(Width),is_integer(Height) -> @@ -481,9 +499,13 @@ prepend(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef},#wx_ wxe_util:call(WindowOP, <>). -%% @spec (This::wxSizer(), Width::integer(), Height::integer(), [Option]) -> wxSizerItem:wxSizerItem() -%% Option = {proportion, integer()} | {flag, integer()} | {border, integer()} | {userData, wx:wx()} %% @doc See external documentation. +-spec prepend(This, Width, Height, [Option]) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Width::integer(), Height::integer(), + Option :: {proportion, integer()} + | {flag, integer()} + | {border, integer()} + | {userData, wx:wx()}. prepend(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) when is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -496,23 +518,27 @@ prepend(#wx_ref{type=ThisT,ref=ThisRef},Width,Height, Options) wxe_util:call(?wxSizer_Prepend_3, <>). -%% @spec (This::wxSizer(), Size::integer()) -> wxSizerItem:wxSizerItem() %% @doc See external documentation. +-spec prependSpacer(This, Size) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), Size::integer(). prependSpacer(#wx_ref{type=ThisT,ref=ThisRef},Size) when is_integer(Size) -> ?CLASS(ThisT,wxSizer), wxe_util:call(?wxSizer_PrependSpacer, <>). -%% @spec (This::wxSizer()) -> wxSizerItem:wxSizerItem() %% @equiv prependStretchSpacer(This, []) +-spec prependStretchSpacer(This) -> wxSizerItem:wxSizerItem() when + This::wxSizer(). + prependStretchSpacer(This) when is_record(This, wx_ref) -> prependStretchSpacer(This, []). -%% @spec (This::wxSizer(), [Option]) -> wxSizerItem:wxSizerItem() -%% Option = {prop, integer()} %% @doc See external documentation. +-spec prependStretchSpacer(This, [Option]) -> wxSizerItem:wxSizerItem() when + This::wxSizer(), + Option :: {prop, integer()}. prependStretchSpacer(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -522,22 +548,19 @@ prependStretchSpacer(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxSizer_PrependStretchSpacer, <>). -%% @spec (This::wxSizer()) -> ok %% @doc See external documentation. +-spec recalcSizes(This) -> ok when + This::wxSizer(). recalcSizes(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizer), wxe_util:cast(?wxSizer_RecalcSizes, <>). -%% @spec (This::wxSizer(),X::integer()|wxSizer()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% remove(This::wxSizer(), Index::integer()) -> bool() -%%

-%%

-%% remove(This::wxSizer(), Sizer::wxSizer()) -> bool() -%%

+-spec remove(This, Index) -> boolean() when + This::wxSizer(), Index::integer(); + (This, Sizer) -> boolean() when + This::wxSizer(), Sizer::wxSizer(). remove(#wx_ref{type=ThisT,ref=ThisRef},Index) when is_integer(Index) -> ?CLASS(ThisT,wxSizer), @@ -549,14 +572,11 @@ remove(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SizerT,ref=SizerRef}) -> wxe_util:call(?wxSizer_Remove_1_1, <>). -%% @spec (This::wxSizer(),X::term()|integer(),X::term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% replace(This::wxSizer(), Oldwin::wxWindow:wxWindow() | wxSizer(), Newwin::wxWindow:wxWindow() | wxSizer()) -> replace(This,Oldwin,Newwin, [])

-%%

-%% replace(This::wxSizer(), Index::integer(), Newitem::wxSizerItem:wxSizerItem()) -> bool() -%%

+-spec replace(This, Oldwin, Newwin) -> boolean() when + This::wxSizer(), Oldwin::wxWindow:wxWindow() | wxSizer(), Newwin::wxWindow:wxWindow() | wxSizer(); + (This, Index, Newitem) -> boolean() when + This::wxSizer(), Index::integer(), Newitem::wxSizerItem:wxSizerItem(). replace(This,Oldwin,Newwin) when is_record(This, wx_ref),is_record(Oldwin, wx_ref),is_record(Newwin, wx_ref) -> @@ -568,9 +588,10 @@ replace(#wx_ref{type=ThisT,ref=ThisRef},Index,#wx_ref{type=NewitemT,ref=NewitemR wxe_util:call(?wxSizer_Replace_2, <>). -%% @spec (This::wxSizer(), Oldwin::wxWindow:wxWindow() | wxSizer(), Newwin::wxWindow:wxWindow() | wxSizer(), [Option]) -> bool() -%% Option = {recursive, bool()} %% @doc See external documentation. +-spec replace(This, Oldwin, Newwin, [Option]) -> boolean() when + This::wxSizer(), Oldwin::wxWindow:wxWindow() | wxSizer(), Newwin::wxWindow:wxWindow() | wxSizer(), + Option :: {recursive, boolean()}. replace(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=OldwinT,ref=OldwinRef},#wx_ref{type=NewwinT,ref=NewwinRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSizer), @@ -588,39 +609,38 @@ replace(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=OldwinT,ref=OldwinRef},#wx_ wxe_util:call(OldwinOP, <>). -%% @spec (This::wxSizer(), X::integer(), Y::integer(), Width::integer(), Height::integer()) -> ok %% @doc See external documentation. +-spec setDimension(This, X, Y, Width, Height) -> ok when + This::wxSizer(), X::integer(), Y::integer(), Width::integer(), Height::integer(). setDimension(#wx_ref{type=ThisT,ref=ThisRef},X,Y,Width,Height) when is_integer(X),is_integer(Y),is_integer(Width),is_integer(Height) -> ?CLASS(ThisT,wxSizer), wxe_util:cast(?wxSizer_SetDimension, <>). -%% @spec (This::wxSizer(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setMinSize(This, Size) -> ok when + This::wxSizer(), Size::{W::integer(), H::integer()}. setMinSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxSizer), wxe_util:cast(?wxSizer_SetMinSize_1, <>). -%% @spec (This::wxSizer(), Width::integer(), Height::integer()) -> ok %% @doc See external documentation. +-spec setMinSize(This, Width, Height) -> ok when + This::wxSizer(), Width::integer(), Height::integer(). setMinSize(#wx_ref{type=ThisT,ref=ThisRef},Width,Height) when is_integer(Width),is_integer(Height) -> ?CLASS(ThisT,wxSizer), wxe_util:cast(?wxSizer_SetMinSize_2, <>). -%% @spec (This::wxSizer(),X::integer()|term(),Size::{W::integer(), H::integer()}) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% setItemMinSize(This::wxSizer(), Index::integer(), Size::{W::integer(), H::integer()}) -> bool() -%%

-%%

-%% setItemMinSize(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Size::{W::integer(), H::integer()}) -> bool() -%%

+-spec setItemMinSize(This, Index, Size) -> boolean() when + This::wxSizer(), Index::integer(), Size::{W::integer(), H::integer()}; + (This, Window, Size) -> boolean() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Size::{W::integer(), H::integer()}. setItemMinSize(#wx_ref{type=ThisT,ref=ThisRef},Index,{SizeW,SizeH}) when is_integer(Index),is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxSizer), @@ -638,15 +658,11 @@ setItemMinSize(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRe wxe_util:call(WindowOP, <>). -%% @spec (This::wxSizer(),X::integer()|term(),Width::integer(),Height::integer()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% setItemMinSize(This::wxSizer(), Index::integer(), Width::integer(), Height::integer()) -> bool() -%%

-%%

-%% setItemMinSize(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Width::integer(), Height::integer()) -> bool() -%%

+-spec setItemMinSize(This, Index, Width, Height) -> boolean() when + This::wxSizer(), Index::integer(), Width::integer(), Height::integer(); + (This, Window, Width, Height) -> boolean() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), Width::integer(), Height::integer(). setItemMinSize(#wx_ref{type=ThisT,ref=ThisRef},Index,Width,Height) when is_integer(Index),is_integer(Width),is_integer(Height) -> ?CLASS(ThisT,wxSizer), @@ -664,32 +680,31 @@ setItemMinSize(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRe wxe_util:call(WindowOP, <>). -%% @spec (This::wxSizer(), Window::wxWindow:wxWindow()) -> ok %% @doc See external documentation. +-spec setSizeHints(This, Window) -> ok when + This::wxSizer(), Window::wxWindow:wxWindow(). setSizeHints(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(ThisT,wxSizer), ?CLASS(WindowT,wxWindow), wxe_util:cast(?wxSizer_SetSizeHints, <>). -%% @spec (This::wxSizer(), Window::wxWindow:wxWindow()) -> ok %% @doc See external documentation. +-spec setVirtualSizeHints(This, Window) -> ok when + This::wxSizer(), Window::wxWindow:wxWindow(). setVirtualSizeHints(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(ThisT,wxSizer), ?CLASS(WindowT,wxWindow), wxe_util:cast(?wxSizer_SetVirtualSizeHints, <>). -%% @spec (This::wxSizer(),X::integer()|term()|bool()) -> bool()|bool()|ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% show(This::wxSizer(), Index::integer()) -> show(This,Index, [])

-%%

-%% show(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer()) -> show(This,Window, [])

-%%

-%% show(This::wxSizer(), Show::bool()) -> ok -%%

+-spec show(This, Index) -> boolean() when + This::wxSizer(), Index::integer(); + (This, Window) -> boolean() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(); + (This, Show) -> ok when + This::wxSizer(), Show::boolean(). show(This,Index) when is_record(This, wx_ref),is_integer(Index) -> @@ -704,17 +719,14 @@ show(#wx_ref{type=ThisT,ref=ThisRef},Show) wxe_util:cast(?wxSizer_Show_1, <>). -%% @spec (This::wxSizer(),X::integer()|term(),[Option]) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% show(This::wxSizer(), Index::integer(), [Option]) -> bool() -%%
Option = {show, bool()} -%%

-%%

-%% show(This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), [Option]) -> bool() -%%
Option = {show, bool()} | {recursive, bool()} -%%

+-spec show(This, Index, [Option]) -> boolean() when + This::wxSizer(), Index::integer(), + Option :: {show, boolean()}; + (This, Window, [Option]) -> boolean() when + This::wxSizer(), Window::wxWindow:wxWindow() | wxSizer(), + Option :: {show, boolean()} + | {recursive, boolean()}. show(#wx_ref{type=ThisT,ref=ThisRef},Index, Options) when is_integer(Index),is_list(Options) -> ?CLASS(ThisT,wxSizer), diff --git a/lib/wx/src/gen/wxSizerFlags.erl b/lib/wx/src/gen/wxSizerFlags.erl index 2a25fd2c1a..e3bf7fed95 100644 --- a/lib/wx/src/gen/wxSizerFlags.erl +++ b/lib/wx/src/gen/wxSizerFlags.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 @@ -30,17 +30,20 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxSizerFlags/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSizerFlags() +-type wxSizerFlags() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxSizerFlags(). + new() -> new([]). -%% @spec ([Option]) -> wxSizerFlags() -%% Option = {proportion, integer()} %% @doc See external documentation. +-spec new([Option]) -> wxSizerFlags() when + Option :: {proportion, integer()}. new(Options) when is_list(Options) -> MOpts = fun({proportion, Proportion}, Acc) -> [<<1:32/?UI,Proportion:32/?UI>>|Acc]; @@ -49,23 +52,27 @@ new(Options) wxe_util:construct(?wxSizerFlags_new, <>). -%% @spec (This::wxSizerFlags(), Alignment::integer()) -> wxSizerFlags() %% @doc See external documentation. +-spec align(This, Alignment) -> wxSizerFlags() when + This::wxSizerFlags(), Alignment::integer(). align(#wx_ref{type=ThisT,ref=ThisRef},Alignment) when is_integer(Alignment) -> ?CLASS(ThisT,wxSizerFlags), wxe_util:call(?wxSizerFlags_Align, <>). -%% @spec (This::wxSizerFlags()) -> wxSizerFlags() %% @equiv border(This, []) +-spec border(This) -> wxSizerFlags() when + This::wxSizerFlags(). + border(This) when is_record(This, wx_ref) -> border(This, []). -%% @spec (This::wxSizerFlags(), [Option]) -> wxSizerFlags() -%% Option = {direction, integer()} %% @doc See external documentation. +-spec border(This, [Option]) -> wxSizerFlags() when + This::wxSizerFlags(), + Option :: {direction, integer()}. border(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSizerFlags), @@ -75,59 +82,66 @@ border(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxSizerFlags_Border_1, <>). -%% @spec (This::wxSizerFlags(), Direction::integer(), BorderInPixels::integer()) -> wxSizerFlags() %% @doc See external documentation. +-spec border(This, Direction, BorderInPixels) -> wxSizerFlags() when + This::wxSizerFlags(), Direction::integer(), BorderInPixels::integer(). border(#wx_ref{type=ThisT,ref=ThisRef},Direction,BorderInPixels) when is_integer(Direction),is_integer(BorderInPixels) -> ?CLASS(ThisT,wxSizerFlags), wxe_util:call(?wxSizerFlags_Border_2, <>). -%% @spec (This::wxSizerFlags()) -> wxSizerFlags() %% @doc See external documentation. +-spec center(This) -> wxSizerFlags() when + This::wxSizerFlags(). center(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerFlags), wxe_util:call(?wxSizerFlags_Center, <>). -%% @spec (This::wxSizerFlags()) -> wxSizerFlags() %% @doc See external documentation. +-spec centre(This) -> wxSizerFlags() when + This::wxSizerFlags(). centre(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerFlags), wxe_util:call(?wxSizerFlags_Centre, <>). -%% @spec (This::wxSizerFlags()) -> wxSizerFlags() %% @doc See external documentation. +-spec expand(This) -> wxSizerFlags() when + This::wxSizerFlags(). expand(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerFlags), wxe_util:call(?wxSizerFlags_Expand, <>). -%% @spec (This::wxSizerFlags()) -> wxSizerFlags() %% @doc See external documentation. +-spec left(This) -> wxSizerFlags() when + This::wxSizerFlags(). left(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerFlags), wxe_util:call(?wxSizerFlags_Left, <>). -%% @spec (This::wxSizerFlags(), Proportion::integer()) -> wxSizerFlags() %% @doc See external documentation. +-spec proportion(This, Proportion) -> wxSizerFlags() when + This::wxSizerFlags(), Proportion::integer(). proportion(#wx_ref{type=ThisT,ref=ThisRef},Proportion) when is_integer(Proportion) -> ?CLASS(ThisT,wxSizerFlags), wxe_util:call(?wxSizerFlags_Proportion, <>). -%% @spec (This::wxSizerFlags()) -> wxSizerFlags() %% @doc See external documentation. +-spec right(This) -> wxSizerFlags() when + This::wxSizerFlags(). right(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerFlags), wxe_util:call(?wxSizerFlags_Right, <>). -%% @spec (This::wxSizerFlags()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSizerFlags) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSizerFlags), wxe_util:destroy(?wxSizerFlags_destroy,Obj), diff --git a/lib/wx/src/gen/wxSizerItem.erl b/lib/wx/src/gen/wxSizerItem.erl index 41cb86eae2..e22befd1ad 100644 --- a/lib/wx/src/gen/wxSizerItem.erl +++ b/lib/wx/src/gen/wxSizerItem.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 @@ -35,17 +35,20 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxSizerItem/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSizerItem() +-type wxSizerItem() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxSizerItem(). new() -> wxe_util:construct(?wxSizerItem_new_0, <<>>). -%% @spec (Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Flags::wxSizerFlags:wxSizerFlags()) -> wxSizerItem() %% @doc See external documentation. +-spec new(Window, Flags) -> wxSizerItem() when + Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Flags::wxSizerFlags:wxSizerFlags(). new(#wx_ref{type=WindowT,ref=WindowRef},#wx_ref{type=FlagsT,ref=FlagsRef}) -> WindowOP = case ?CLASS_T(WindowT,wxWindow) of true -> @@ -58,16 +61,18 @@ new(#wx_ref{type=WindowT,ref=WindowRef},#wx_ref{type=FlagsT,ref=FlagsRef}) -> wxe_util:construct(WindowOP, <>). -%% @spec (Width::integer(), Height::integer(), Flags::wxSizerFlags:wxSizerFlags()) -> wxSizerItem() %% @doc See external documentation. +-spec new(Width, Height, Flags) -> wxSizerItem() when + Width::integer(), Height::integer(), Flags::wxSizerFlags:wxSizerFlags(). new(Width,Height,#wx_ref{type=FlagsT,ref=FlagsRef}) when is_integer(Width),is_integer(Height) -> ?CLASS(FlagsT,wxSizerFlags), wxe_util:construct(?wxSizerItem_new_3, <>). -%% @spec (Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Proportion::integer(), Flag::integer(), Border::integer(), UserData::wx:wx()) -> wxSizerItem() %% @doc See external documentation. +-spec new(Window, Proportion, Flag, Border, UserData) -> wxSizerItem() when + Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Proportion::integer(), Flag::integer(), Border::integer(), UserData::wx:wx(). new(#wx_ref{type=WindowT,ref=WindowRef},Proportion,Flag,Border,#wx_ref{type=UserDataT,ref=UserDataRef}) when is_integer(Proportion),is_integer(Flag),is_integer(Border) -> WindowOP = case ?CLASS_T(WindowT,wxWindow) of @@ -81,212 +86,235 @@ new(#wx_ref{type=WindowT,ref=WindowRef},Proportion,Flag,Border,#wx_ref{type=User wxe_util:construct(WindowOP, <>). -%% @spec (Width::integer(), Height::integer(), Proportion::integer(), Flag::integer(), Border::integer(), UserData::wx:wx()) -> wxSizerItem() %% @doc See external documentation. +-spec new(Width, Height, Proportion, Flag, Border, UserData) -> wxSizerItem() when + Width::integer(), Height::integer(), Proportion::integer(), Flag::integer(), Border::integer(), UserData::wx:wx(). new(Width,Height,Proportion,Flag,Border,#wx_ref{type=UserDataT,ref=UserDataRef}) when is_integer(Width),is_integer(Height),is_integer(Proportion),is_integer(Flag),is_integer(Border) -> ?CLASS(UserDataT,wx), wxe_util:construct(?wxSizerItem_new_6, <>). -%% @spec (This::wxSizerItem()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec calcMin(This) -> {W::integer(), H::integer()} when + This::wxSizerItem(). calcMin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_CalcMin, <>). -%% @spec (This::wxSizerItem()) -> ok %% @doc See external documentation. +-spec deleteWindows(This) -> ok when + This::wxSizerItem(). deleteWindows(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_DeleteWindows, <>). -%% @spec (This::wxSizerItem()) -> ok %% @doc See external documentation. +-spec detachSizer(This) -> ok when + This::wxSizerItem(). detachSizer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_DetachSizer, <>). -%% @spec (This::wxSizerItem()) -> integer() %% @doc See external documentation. +-spec getBorder(This) -> integer() when + This::wxSizerItem(). getBorder(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetBorder, <>). -%% @spec (This::wxSizerItem()) -> integer() %% @doc See external documentation. +-spec getFlag(This) -> integer() when + This::wxSizerItem(). getFlag(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetFlag, <>). -%% @spec (This::wxSizerItem()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getMinSize(This) -> {W::integer(), H::integer()} when + This::wxSizerItem(). getMinSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetMinSize, <>). -%% @spec (This::wxSizerItem()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxSizerItem(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetPosition, <>). -%% @spec (This::wxSizerItem()) -> integer() %% @doc See external documentation. +-spec getProportion(This) -> integer() when + This::wxSizerItem(). getProportion(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetProportion, <>). -%% @spec (This::wxSizerItem()) -> float() %% @doc See external documentation. +-spec getRatio(This) -> float() when + This::wxSizerItem(). getRatio(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetRatio, <>). -%% @spec (This::wxSizerItem()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxSizerItem(). getRect(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetRect, <>). -%% @spec (This::wxSizerItem()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getSize(This) -> {W::integer(), H::integer()} when + This::wxSizerItem(). getSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetSize, <>). -%% @spec (This::wxSizerItem()) -> wxSizer:wxSizer() %% @doc See external documentation. +-spec getSizer(This) -> wxSizer:wxSizer() when + This::wxSizerItem(). getSizer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetSizer, <>). -%% @spec (This::wxSizerItem()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getSpacer(This) -> {W::integer(), H::integer()} when + This::wxSizerItem(). getSpacer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetSpacer, <>). -%% @spec (This::wxSizerItem()) -> wx:wx() %% @doc See external documentation. +-spec getUserData(This) -> wx:wx() when + This::wxSizerItem(). getUserData(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetUserData, <>). -%% @spec (This::wxSizerItem()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getWindow(This) -> wxWindow:wxWindow() when + This::wxSizerItem(). getWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_GetWindow, <>). -%% @spec (This::wxSizerItem()) -> bool() %% @doc See external documentation. +-spec isSizer(This) -> boolean() when + This::wxSizerItem(). isSizer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_IsSizer, <>). -%% @spec (This::wxSizerItem()) -> bool() %% @doc See external documentation. +-spec isShown(This) -> boolean() when + This::wxSizerItem(). isShown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_IsShown, <>). -%% @spec (This::wxSizerItem()) -> bool() %% @doc See external documentation. +-spec isSpacer(This) -> boolean() when + This::wxSizerItem(). isSpacer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_IsSpacer, <>). -%% @spec (This::wxSizerItem()) -> bool() %% @doc See external documentation. +-spec isWindow(This) -> boolean() when + This::wxSizerItem(). isWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSizerItem), wxe_util:call(?wxSizerItem_IsWindow, <>). -%% @spec (This::wxSizerItem(), Border::integer()) -> ok %% @doc See external documentation. +-spec setBorder(This, Border) -> ok when + This::wxSizerItem(), Border::integer(). setBorder(#wx_ref{type=ThisT,ref=ThisRef},Border) when is_integer(Border) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetBorder, <>). -%% @spec (This::wxSizerItem(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setDimension(This, Pos, Size) -> ok when + This::wxSizerItem(), Pos::{X::integer(), Y::integer()}, Size::{W::integer(), H::integer()}. setDimension(#wx_ref{type=ThisT,ref=ThisRef},{PosX,PosY},{SizeW,SizeH}) when is_integer(PosX),is_integer(PosY),is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetDimension, <>). -%% @spec (This::wxSizerItem(), Flag::integer()) -> ok %% @doc See external documentation. +-spec setFlag(This, Flag) -> ok when + This::wxSizerItem(), Flag::integer(). setFlag(#wx_ref{type=ThisT,ref=ThisRef},Flag) when is_integer(Flag) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetFlag, <>). -%% @spec (This::wxSizerItem(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec setInitSize(This, X, Y) -> ok when + This::wxSizerItem(), X::integer(), Y::integer(). setInitSize(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetInitSize, <>). -%% @spec (This::wxSizerItem(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setMinSize(This, Size) -> ok when + This::wxSizerItem(), Size::{W::integer(), H::integer()}. setMinSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetMinSize_1, <>). -%% @spec (This::wxSizerItem(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec setMinSize(This, X, Y) -> ok when + This::wxSizerItem(), X::integer(), Y::integer(). setMinSize(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetMinSize_2, <>). -%% @spec (This::wxSizerItem(), Proportion::integer()) -> ok %% @doc See external documentation. +-spec setProportion(This, Proportion) -> ok when + This::wxSizerItem(), Proportion::integer(). setProportion(#wx_ref{type=ThisT,ref=ThisRef},Proportion) when is_integer(Proportion) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetProportion, <>). -%% @spec (This::wxSizerItem(),X::float()|term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setRatio(This::wxSizerItem(), Ratio::float()) -> ok -%%

-%%

-%% setRatio(This::wxSizerItem(), Size::{W::integer(), H::integer()}) -> ok -%%

+-spec setRatio(This, Ratio) -> ok when + This::wxSizerItem(), Ratio::float(); + (This, Size) -> ok when + This::wxSizerItem(), Size::{W::integer(), H::integer()}. setRatio(#wx_ref{type=ThisT,ref=ThisRef},Ratio) when is_float(Ratio) -> ?CLASS(ThisT,wxSizerItem), @@ -298,56 +326,62 @@ setRatio(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) wxe_util:cast(?wxSizerItem_SetRatio_1_1, <>). -%% @spec (This::wxSizerItem(), Width::integer(), Height::integer()) -> ok %% @doc See external documentation. +-spec setRatio(This, Width, Height) -> ok when + This::wxSizerItem(), Width::integer(), Height::integer(). setRatio(#wx_ref{type=ThisT,ref=ThisRef},Width,Height) when is_integer(Width),is_integer(Height) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetRatio_2, <>). -%% @spec (This::wxSizerItem(), Sizer::wxSizer:wxSizer()) -> ok %% @doc See external documentation. +-spec setSizer(This, Sizer) -> ok when + This::wxSizerItem(), Sizer::wxSizer:wxSizer(). setSizer(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SizerT,ref=SizerRef}) -> ?CLASS(ThisT,wxSizerItem), ?CLASS(SizerT,wxSizer), wxe_util:cast(?wxSizerItem_SetSizer, <>). -%% @spec (This::wxSizerItem(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setSpacer(This, Size) -> ok when + This::wxSizerItem(), Size::{W::integer(), H::integer()}. setSpacer(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetSpacer_1, <>). -%% @spec (This::wxSizerItem(), Width::integer(), Height::integer()) -> ok %% @doc See external documentation. +-spec setSpacer(This, Width, Height) -> ok when + This::wxSizerItem(), Width::integer(), Height::integer(). setSpacer(#wx_ref{type=ThisT,ref=ThisRef},Width,Height) when is_integer(Width),is_integer(Height) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_SetSpacer_2, <>). -%% @spec (This::wxSizerItem(), Window::wxWindow:wxWindow()) -> ok %% @doc See external documentation. +-spec setWindow(This, Window) -> ok when + This::wxSizerItem(), Window::wxWindow:wxWindow(). setWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(ThisT,wxSizerItem), ?CLASS(WindowT,wxWindow), wxe_util:cast(?wxSizerItem_SetWindow, <>). -%% @spec (This::wxSizerItem(), Show::bool()) -> ok %% @doc See external documentation. +-spec show(This, Show) -> ok when + This::wxSizerItem(), Show::boolean(). show(#wx_ref{type=ThisT,ref=ThisRef},Show) when is_boolean(Show) -> ?CLASS(ThisT,wxSizerItem), wxe_util:cast(?wxSizerItem_Show, <>). -%% @spec (This::wxSizerItem()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSizerItem) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSizerItem), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxSlider.erl b/lib/wx/src/gen/wxSlider.erl index c7a3d6f5c0..bd00e71476 100644 --- a/lib/wx/src/gen/wxSlider.erl +++ b/lib/wx/src/gen/wxSlider.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 @@ -71,27 +71,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxSlider/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSlider() +-type wxSlider() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxSlider(). new() -> wxe_util:construct(?wxSlider_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Value::integer(), MinValue::integer(), MaxValue::integer()) -> wxSlider() %% @equiv new(Parent,Id,Value,MinValue,MaxValue, []) +-spec new(Parent, Id, Value, MinValue, MaxValue) -> wxSlider() when + Parent::wxWindow:wxWindow(), Id::integer(), Value::integer(), MinValue::integer(), MaxValue::integer(). + new(Parent,Id,Value,MinValue,MaxValue) when is_record(Parent, wx_ref),is_integer(Id),is_integer(Value),is_integer(MinValue),is_integer(MaxValue) -> new(Parent,Id,Value,MinValue,MaxValue, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Value::integer(), MinValue::integer(), MaxValue::integer(), [Option]) -> wxSlider() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, Value, MinValue, MaxValue, [Option]) -> wxSlider() when + Parent::wxWindow:wxWindow(), Id::integer(), Value::integer(), MinValue::integer(), MaxValue::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Value,MinValue,MaxValue, Options) when is_integer(Id),is_integer(Value),is_integer(MinValue),is_integer(MaxValue),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -104,15 +112,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Value,MinValue,MaxValue, Options) wxe_util:construct(?wxSlider_new_6, <>). -%% @spec (This::wxSlider(), Parent::wxWindow:wxWindow(), Id::integer(), Value::integer(), MinValue::integer(), MaxValue::integer()) -> bool() %% @equiv create(This,Parent,Id,Value,MinValue,MaxValue, []) +-spec create(This, Parent, Id, Value, MinValue, MaxValue) -> boolean() when + This::wxSlider(), Parent::wxWindow:wxWindow(), Id::integer(), Value::integer(), MinValue::integer(), MaxValue::integer(). + create(This,Parent,Id,Value,MinValue,MaxValue) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_integer(Value),is_integer(MinValue),is_integer(MaxValue) -> create(This,Parent,Id,Value,MinValue,MaxValue, []). -%% @spec (This::wxSlider(), Parent::wxWindow:wxWindow(), Id::integer(), Value::integer(), MinValue::integer(), MaxValue::integer(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Value, MinValue, MaxValue, [Option]) -> boolean() when + This::wxSlider(), Parent::wxWindow:wxWindow(), Id::integer(), Value::integer(), MinValue::integer(), MaxValue::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Value,MinValue,MaxValue, Options) when is_integer(Id),is_integer(Value),is_integer(MinValue),is_integer(MaxValue),is_list(Options) -> ?CLASS(ThisT,wxSlider), @@ -126,90 +140,101 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Va wxe_util:call(?wxSlider_Create, <>). -%% @spec (This::wxSlider()) -> integer() %% @doc See external documentation. +-spec getLineSize(This) -> integer() when + This::wxSlider(). getLineSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSlider), wxe_util:call(?wxSlider_GetLineSize, <>). -%% @spec (This::wxSlider()) -> integer() %% @doc See external documentation. +-spec getMax(This) -> integer() when + This::wxSlider(). getMax(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSlider), wxe_util:call(?wxSlider_GetMax, <>). -%% @spec (This::wxSlider()) -> integer() %% @doc See external documentation. +-spec getMin(This) -> integer() when + This::wxSlider(). getMin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSlider), wxe_util:call(?wxSlider_GetMin, <>). -%% @spec (This::wxSlider()) -> integer() %% @doc See external documentation. +-spec getPageSize(This) -> integer() when + This::wxSlider(). getPageSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSlider), wxe_util:call(?wxSlider_GetPageSize, <>). -%% @spec (This::wxSlider()) -> integer() %% @doc See external documentation. +-spec getThumbLength(This) -> integer() when + This::wxSlider(). getThumbLength(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSlider), wxe_util:call(?wxSlider_GetThumbLength, <>). -%% @spec (This::wxSlider()) -> integer() %% @doc See external documentation. +-spec getValue(This) -> integer() when + This::wxSlider(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSlider), wxe_util:call(?wxSlider_GetValue, <>). -%% @spec (This::wxSlider(), LineSize::integer()) -> ok %% @doc See external documentation. +-spec setLineSize(This, LineSize) -> ok when + This::wxSlider(), LineSize::integer(). setLineSize(#wx_ref{type=ThisT,ref=ThisRef},LineSize) when is_integer(LineSize) -> ?CLASS(ThisT,wxSlider), wxe_util:cast(?wxSlider_SetLineSize, <>). -%% @spec (This::wxSlider(), PageSize::integer()) -> ok %% @doc See external documentation. +-spec setPageSize(This, PageSize) -> ok when + This::wxSlider(), PageSize::integer(). setPageSize(#wx_ref{type=ThisT,ref=ThisRef},PageSize) when is_integer(PageSize) -> ?CLASS(ThisT,wxSlider), wxe_util:cast(?wxSlider_SetPageSize, <>). -%% @spec (This::wxSlider(), MinValue::integer(), MaxValue::integer()) -> ok %% @doc See external documentation. +-spec setRange(This, MinValue, MaxValue) -> ok when + This::wxSlider(), MinValue::integer(), MaxValue::integer(). setRange(#wx_ref{type=ThisT,ref=ThisRef},MinValue,MaxValue) when is_integer(MinValue),is_integer(MaxValue) -> ?CLASS(ThisT,wxSlider), wxe_util:cast(?wxSlider_SetRange, <>). -%% @spec (This::wxSlider(), LenPixels::integer()) -> ok %% @doc See external documentation. +-spec setThumbLength(This, LenPixels) -> ok when + This::wxSlider(), LenPixels::integer(). setThumbLength(#wx_ref{type=ThisT,ref=ThisRef},LenPixels) when is_integer(LenPixels) -> ?CLASS(ThisT,wxSlider), wxe_util:cast(?wxSlider_SetThumbLength, <>). -%% @spec (This::wxSlider(), Value::integer()) -> ok %% @doc See external documentation. +-spec setValue(This, Value) -> ok when + This::wxSlider(), Value::integer(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Value) when is_integer(Value) -> ?CLASS(ThisT,wxSlider), wxe_util:cast(?wxSlider_SetValue, <>). -%% @spec (This::wxSlider()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSlider) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSlider), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxSpinButton.erl b/lib/wx/src/gen/wxSpinButton.erl index e269dbe329..0e987a0f09 100644 --- a/lib/wx/src/gen/wxSpinButton.erl +++ b/lib/wx/src/gen/wxSpinButton.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 @@ -70,27 +70,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxSpinButton/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSpinButton() +-type wxSpinButton() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxSpinButton(). new() -> wxe_util:construct(?wxSpinButton_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxSpinButton() %% @equiv new(Parent, []) +-spec new(Parent) -> wxSpinButton() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxSpinButton() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxSpinButton() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -103,15 +111,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxSpinButton_new_2, <>). -%% @spec (This::wxSpinButton(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxSpinButton(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxSpinButton(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxSpinButton(), Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {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}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSpinButton), @@ -125,45 +139,50 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxSpinButton_Create, <>). -%% @spec (This::wxSpinButton()) -> integer() %% @doc See external documentation. +-spec getMax(This) -> integer() when + This::wxSpinButton(). getMax(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSpinButton), wxe_util:call(?wxSpinButton_GetMax, <>). -%% @spec (This::wxSpinButton()) -> integer() %% @doc See external documentation. +-spec getMin(This) -> integer() when + This::wxSpinButton(). getMin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSpinButton), wxe_util:call(?wxSpinButton_GetMin, <>). -%% @spec (This::wxSpinButton()) -> integer() %% @doc See external documentation. +-spec getValue(This) -> integer() when + This::wxSpinButton(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSpinButton), wxe_util:call(?wxSpinButton_GetValue, <>). -%% @spec (This::wxSpinButton(), MinVal::integer(), MaxVal::integer()) -> ok %% @doc See external documentation. +-spec setRange(This, MinVal, MaxVal) -> ok when + This::wxSpinButton(), MinVal::integer(), MaxVal::integer(). setRange(#wx_ref{type=ThisT,ref=ThisRef},MinVal,MaxVal) when is_integer(MinVal),is_integer(MaxVal) -> ?CLASS(ThisT,wxSpinButton), wxe_util:cast(?wxSpinButton_SetRange, <>). -%% @spec (This::wxSpinButton(), Value::integer()) -> ok %% @doc See external documentation. +-spec setValue(This, Value) -> ok when + This::wxSpinButton(), Value::integer(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Value) when is_integer(Value) -> ?CLASS(ThisT,wxSpinButton), wxe_util:cast(?wxSpinButton_SetValue, <>). -%% @spec (This::wxSpinButton()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSpinButton) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSpinButton), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxSpinCtrl.erl b/lib/wx/src/gen/wxSpinCtrl.erl index c6e8ad2238..5de7619b34 100644 --- a/lib/wx/src/gen/wxSpinCtrl.erl +++ b/lib/wx/src/gen/wxSpinCtrl.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 @@ -70,27 +70,39 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxSpinCtrl/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSpinCtrl() +-type wxSpinCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxSpinCtrl(). new() -> wxe_util:construct(?wxSpinCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxSpinCtrl() %% @equiv new(Parent, []) +-spec new(Parent) -> wxSpinCtrl() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxSpinCtrl() -%% Option = {id, integer()} | {value, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {min, integer()} | {max, integer()} | {initial, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxSpinCtrl() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {value, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {min, integer()} + | {max, integer()} + | {initial, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -107,15 +119,25 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxSpinCtrl_new_2, <>). -%% @spec (This::wxSpinCtrl(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxSpinCtrl(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxSpinCtrl(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {id, integer()} | {value, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {min, integer()} | {max, integer()} | {initial, integer()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxSpinCtrl(), Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {value, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {min, integer()} + | {max, integer()} + | {initial, integer()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSpinCtrl), @@ -133,15 +155,11 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxSpinCtrl_Create, <>). -%% @spec (This::wxSpinCtrl(),X::integer()|string()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setValue(This::wxSpinCtrl(), Value::integer()) -> ok -%%

-%%

-%% setValue(This::wxSpinCtrl(), Text::string()) -> ok -%%

+-spec setValue(This, Value) -> ok when + This::wxSpinCtrl(), Value::integer(); + (This, Text) -> ok when + This::wxSpinCtrl(), Text::string(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Value) when is_integer(Value) -> ?CLASS(ThisT,wxSpinCtrl), @@ -154,45 +172,50 @@ setValue(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxSpinCtrl_SetValue_1_1, <>). -%% @spec (This::wxSpinCtrl()) -> integer() %% @doc See external documentation. +-spec getValue(This) -> integer() when + This::wxSpinCtrl(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSpinCtrl), wxe_util:call(?wxSpinCtrl_GetValue, <>). -%% @spec (This::wxSpinCtrl(), MinVal::integer(), MaxVal::integer()) -> ok %% @doc See external documentation. +-spec setRange(This, MinVal, MaxVal) -> ok when + This::wxSpinCtrl(), MinVal::integer(), MaxVal::integer(). setRange(#wx_ref{type=ThisT,ref=ThisRef},MinVal,MaxVal) when is_integer(MinVal),is_integer(MaxVal) -> ?CLASS(ThisT,wxSpinCtrl), wxe_util:cast(?wxSpinCtrl_SetRange, <>). -%% @spec (This::wxSpinCtrl(), From::integer(), To::integer()) -> ok %% @doc See external documentation. +-spec setSelection(This, From, To) -> ok when + This::wxSpinCtrl(), From::integer(), To::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},From,To) when is_integer(From),is_integer(To) -> ?CLASS(ThisT,wxSpinCtrl), wxe_util:cast(?wxSpinCtrl_SetSelection, <>). -%% @spec (This::wxSpinCtrl()) -> integer() %% @doc See external documentation. +-spec getMin(This) -> integer() when + This::wxSpinCtrl(). getMin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSpinCtrl), wxe_util:call(?wxSpinCtrl_GetMin, <>). -%% @spec (This::wxSpinCtrl()) -> integer() %% @doc See external documentation. +-spec getMax(This) -> integer() when + This::wxSpinCtrl(). getMax(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSpinCtrl), wxe_util:call(?wxSpinCtrl_GetMax, <>). -%% @spec (This::wxSpinCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSpinCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSpinCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxSpinEvent.erl b/lib/wx/src/gen/wxSpinEvent.erl index 82edc70983..ecbe557c7b 100644 --- a/lib/wx/src/gen/wxSpinEvent.erl +++ b/lib/wx/src/gen/wxSpinEvent.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -41,21 +41,25 @@ isSelection/1,parent_class/1,resumePropagation/2,setInt/2,setString/2, shouldPropagate/1,skip/1,skip/2,stopPropagation/1,veto/1]). +-export_type([wxSpinEvent/0]). %% @hidden parent_class(wxNotifyEvent) -> true; parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxSpinEvent()) -> integer() +-type wxSpinEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getPosition(This) -> integer() when + This::wxSpinEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSpinEvent), wxe_util:call(?wxSpinEvent_GetPosition, <>). -%% @spec (This::wxSpinEvent(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setPosition(This, Pos) -> ok when + This::wxSpinEvent(), Pos::integer(). setPosition(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxSpinEvent), diff --git a/lib/wx/src/gen/wxSplashScreen.erl b/lib/wx/src/gen/wxSplashScreen.erl index 79ef8e413a..e6755690e0 100644 --- a/lib/wx/src/gen/wxSplashScreen.erl +++ b/lib/wx/src/gen/wxSplashScreen.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 @@ -80,6 +80,7 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxSplashScreen/0]). %% @hidden parent_class(wxFrame) -> true; parent_class(wxTopLevelWindow) -> true; @@ -87,21 +88,27 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSplashScreen() +-type wxSplashScreen() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxSplashScreen(). new() -> wxe_util:construct(?wxSplashScreen_new_0, <<>>). -%% @spec (Bitmap::wxBitmap:wxBitmap(), SplashStyle::integer(), Milliseconds::integer(), Parent::wxWindow:wxWindow(), Id::integer()) -> wxSplashScreen() %% @equiv new(Bitmap,SplashStyle,Milliseconds,Parent,Id, []) +-spec new(Bitmap, SplashStyle, Milliseconds, Parent, Id) -> wxSplashScreen() when + Bitmap::wxBitmap:wxBitmap(), SplashStyle::integer(), Milliseconds::integer(), Parent::wxWindow:wxWindow(), Id::integer(). + new(Bitmap,SplashStyle,Milliseconds,Parent,Id) when is_record(Bitmap, wx_ref),is_integer(SplashStyle),is_integer(Milliseconds),is_record(Parent, wx_ref),is_integer(Id) -> new(Bitmap,SplashStyle,Milliseconds,Parent,Id, []). -%% @spec (Bitmap::wxBitmap:wxBitmap(), SplashStyle::integer(), Milliseconds::integer(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxSplashScreen() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Bitmap, SplashStyle, Milliseconds, Parent, Id, [Option]) -> wxSplashScreen() when + Bitmap::wxBitmap:wxBitmap(), SplashStyle::integer(), Milliseconds::integer(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=BitmapT,ref=BitmapRef},SplashStyle,Milliseconds,#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(SplashStyle),is_integer(Milliseconds),is_integer(Id),is_list(Options) -> ?CLASS(BitmapT,wxBitmap), @@ -114,22 +121,24 @@ new(#wx_ref{type=BitmapT,ref=BitmapRef},SplashStyle,Milliseconds,#wx_ref{type=Pa wxe_util:construct(?wxSplashScreen_new_6, <>). -%% @spec (This::wxSplashScreen()) -> integer() %% @doc See external documentation. +-spec getSplashStyle(This) -> integer() when + This::wxSplashScreen(). getSplashStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplashScreen), wxe_util:call(?wxSplashScreen_GetSplashStyle, <>). -%% @spec (This::wxSplashScreen()) -> integer() %% @doc See external documentation. +-spec getTimeout(This) -> integer() when + This::wxSplashScreen(). getTimeout(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplashScreen), wxe_util:call(?wxSplashScreen_GetTimeout, <>). -%% @spec (This::wxSplashScreen()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSplashScreen) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSplashScreen), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxSplitterEvent.erl b/lib/wx/src/gen/wxSplitterEvent.erl index 512f858284..bba9b13abd 100644 --- a/lib/wx/src/gen/wxSplitterEvent.erl +++ b/lib/wx/src/gen/wxSplitterEvent.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2010. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -41,42 +41,49 @@ isSelection/1,parent_class/1,resumePropagation/2,setInt/2,setString/2, shouldPropagate/1,skip/1,skip/2,stopPropagation/1,veto/1]). +-export_type([wxSplitterEvent/0]). %% @hidden parent_class(wxNotifyEvent) -> true; parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxSplitterEvent()) -> integer() +-type wxSplitterEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getSashPosition(This) -> integer() when + This::wxSplitterEvent(). getSashPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterEvent), wxe_util:call(?wxSplitterEvent_GetSashPosition, <>). -%% @spec (This::wxSplitterEvent()) -> integer() %% @doc See external documentation. +-spec getX(This) -> integer() when + This::wxSplitterEvent(). getX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterEvent), wxe_util:call(?wxSplitterEvent_GetX, <>). -%% @spec (This::wxSplitterEvent()) -> integer() %% @doc See external documentation. +-spec getY(This) -> integer() when + This::wxSplitterEvent(). getY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterEvent), wxe_util:call(?wxSplitterEvent_GetY, <>). -%% @spec (This::wxSplitterEvent()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getWindowBeingRemoved(This) -> wxWindow:wxWindow() when + This::wxSplitterEvent(). getWindowBeingRemoved(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterEvent), wxe_util:call(?wxSplitterEvent_GetWindowBeingRemoved, <>). -%% @spec (This::wxSplitterEvent(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setSashPosition(This, Pos) -> ok when + This::wxSplitterEvent(), Pos::integer(). setSashPosition(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxSplitterEvent), diff --git a/lib/wx/src/gen/wxSplitterWindow.erl b/lib/wx/src/gen/wxSplitterWindow.erl index b17fed3151..37ef11fc9c 100644 --- a/lib/wx/src/gen/wxSplitterWindow.erl +++ b/lib/wx/src/gen/wxSplitterWindow.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2011. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -73,26 +73,34 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxSplitterWindow/0]). %% @hidden parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxSplitterWindow() +-type wxSplitterWindow() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxSplitterWindow(). new() -> wxe_util:construct(?wxSplitterWindow_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxSplitterWindow() %% @equiv new(Parent, []) +-spec new(Parent) -> wxSplitterWindow() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxSplitterWindow() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxSplitterWindow() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -105,15 +113,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxSplitterWindow_new_2, <>). -%% @spec (This::wxSplitterWindow(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxSplitterWindow(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxSplitterWindow(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxSplitterWindow(), Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {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}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSplitterWindow), @@ -127,67 +141,75 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxSplitterWindow_Create, <>). -%% @spec (This::wxSplitterWindow()) -> integer() %% @doc See external documentation. +-spec getMinimumPaneSize(This) -> integer() when + This::wxSplitterWindow(). getMinimumPaneSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetMinimumPaneSize, <>). -%% @spec (This::wxSplitterWindow()) -> float() %% @doc See external documentation. +-spec getSashGravity(This) -> float() when + This::wxSplitterWindow(). getSashGravity(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetSashGravity, <>). -%% @spec (This::wxSplitterWindow()) -> integer() %% @doc See external documentation. +-spec getSashPosition(This) -> integer() when + This::wxSplitterWindow(). getSashPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetSashPosition, <>). -%% @spec (This::wxSplitterWindow()) -> WxSplitMode -%% WxSplitMode = integer() %% @doc See external documentation. -%%
WxSplitMode is one of ?wxSPLIT_HORIZONTAL | ?wxSPLIT_VERTICAL +%%
Res = ?wxSPLIT_HORIZONTAL | ?wxSPLIT_VERTICAL +-spec getSplitMode(This) -> wx:wx_enum() when + This::wxSplitterWindow(). getSplitMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetSplitMode, <>). -%% @spec (This::wxSplitterWindow()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getWindow1(This) -> wxWindow:wxWindow() when + This::wxSplitterWindow(). getWindow1(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetWindow1, <>). -%% @spec (This::wxSplitterWindow()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getWindow2(This) -> wxWindow:wxWindow() when + This::wxSplitterWindow(). getWindow2(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetWindow2, <>). -%% @spec (This::wxSplitterWindow(), Window::wxWindow:wxWindow()) -> ok %% @doc See external documentation. +-spec initialize(This, Window) -> ok when + This::wxSplitterWindow(), Window::wxWindow:wxWindow(). initialize(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(ThisT,wxSplitterWindow), ?CLASS(WindowT,wxWindow), wxe_util:cast(?wxSplitterWindow_Initialize, <>). -%% @spec (This::wxSplitterWindow()) -> bool() %% @doc See external documentation. +-spec isSplit(This) -> boolean() when + This::wxSplitterWindow(). isSplit(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_IsSplit, <>). -%% @spec (This::wxSplitterWindow(), WinOld::wxWindow:wxWindow(), WinNew::wxWindow:wxWindow()) -> bool() %% @doc See external documentation. +-spec replaceWindow(This, WinOld, WinNew) -> boolean() when + This::wxSplitterWindow(), WinOld::wxWindow:wxWindow(), WinNew::wxWindow:wxWindow(). replaceWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WinOldT,ref=WinOldRef},#wx_ref{type=WinNewT,ref=WinNewRef}) -> ?CLASS(ThisT,wxSplitterWindow), ?CLASS(WinOldT,wxWindow), @@ -195,23 +217,27 @@ replaceWindow(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WinOldT,ref=WinOldRef wxe_util:call(?wxSplitterWindow_ReplaceWindow, <>). -%% @spec (This::wxSplitterWindow(), Gravity::float()) -> ok %% @doc See external documentation. +-spec setSashGravity(This, Gravity) -> ok when + This::wxSplitterWindow(), Gravity::float(). setSashGravity(#wx_ref{type=ThisT,ref=ThisRef},Gravity) when is_float(Gravity) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:cast(?wxSplitterWindow_SetSashGravity, <>). -%% @spec (This::wxSplitterWindow(), Position::integer()) -> ok %% @equiv setSashPosition(This,Position, []) +-spec setSashPosition(This, Position) -> ok when + This::wxSplitterWindow(), Position::integer(). + setSashPosition(This,Position) when is_record(This, wx_ref),is_integer(Position) -> setSashPosition(This,Position, []). -%% @spec (This::wxSplitterWindow(), Position::integer(), [Option]) -> ok -%% Option = {redraw, bool()} %% @doc See external documentation. +-spec setSashPosition(This, Position, [Option]) -> ok when + This::wxSplitterWindow(), Position::integer(), + Option :: {redraw, boolean()}. setSashPosition(#wx_ref{type=ThisT,ref=ThisRef},Position, Options) when is_integer(Position),is_list(Options) -> ?CLASS(ThisT,wxSplitterWindow), @@ -221,39 +247,45 @@ setSashPosition(#wx_ref{type=ThisT,ref=ThisRef},Position, Options) wxe_util:cast(?wxSplitterWindow_SetSashPosition, <>). -%% @spec (This::wxSplitterWindow(), Width::integer()) -> ok %% @doc See external documentation. +-spec setSashSize(This, Width) -> ok when + This::wxSplitterWindow(), Width::integer(). setSashSize(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:cast(?wxSplitterWindow_SetSashSize, <>). -%% @spec (This::wxSplitterWindow(), Min::integer()) -> ok %% @doc See external documentation. +-spec setMinimumPaneSize(This, Min) -> ok when + This::wxSplitterWindow(), Min::integer(). setMinimumPaneSize(#wx_ref{type=ThisT,ref=ThisRef},Min) when is_integer(Min) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:cast(?wxSplitterWindow_SetMinimumPaneSize, <>). -%% @spec (This::wxSplitterWindow(), Mode::integer()) -> ok %% @doc See external documentation. +-spec setSplitMode(This, Mode) -> ok when + This::wxSplitterWindow(), Mode::integer(). setSplitMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) when is_integer(Mode) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:cast(?wxSplitterWindow_SetSplitMode, <>). -%% @spec (This::wxSplitterWindow(), Window1::wxWindow:wxWindow(), Window2::wxWindow:wxWindow()) -> bool() %% @equiv splitHorizontally(This,Window1,Window2, []) +-spec splitHorizontally(This, Window1, Window2) -> boolean() when + This::wxSplitterWindow(), Window1::wxWindow:wxWindow(), Window2::wxWindow:wxWindow(). + splitHorizontally(This,Window1,Window2) when is_record(This, wx_ref),is_record(Window1, wx_ref),is_record(Window2, wx_ref) -> splitHorizontally(This,Window1,Window2, []). -%% @spec (This::wxSplitterWindow(), Window1::wxWindow:wxWindow(), Window2::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {sashPosition, integer()} %% @doc See external documentation. +-spec splitHorizontally(This, Window1, Window2, [Option]) -> boolean() when + This::wxSplitterWindow(), Window1::wxWindow:wxWindow(), Window2::wxWindow:wxWindow(), + Option :: {sashPosition, integer()}. splitHorizontally(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=Window1T,ref=Window1Ref},#wx_ref{type=Window2T,ref=Window2Ref}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSplitterWindow), @@ -265,15 +297,18 @@ splitHorizontally(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=Window1T,ref=Wind wxe_util:call(?wxSplitterWindow_SplitHorizontally, <>). -%% @spec (This::wxSplitterWindow(), Window1::wxWindow:wxWindow(), Window2::wxWindow:wxWindow()) -> bool() %% @equiv splitVertically(This,Window1,Window2, []) +-spec splitVertically(This, Window1, Window2) -> boolean() when + This::wxSplitterWindow(), Window1::wxWindow:wxWindow(), Window2::wxWindow:wxWindow(). + splitVertically(This,Window1,Window2) when is_record(This, wx_ref),is_record(Window1, wx_ref),is_record(Window2, wx_ref) -> splitVertically(This,Window1,Window2, []). -%% @spec (This::wxSplitterWindow(), Window1::wxWindow:wxWindow(), Window2::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {sashPosition, integer()} %% @doc See external documentation. +-spec splitVertically(This, Window1, Window2, [Option]) -> boolean() when + This::wxSplitterWindow(), Window1::wxWindow:wxWindow(), Window2::wxWindow:wxWindow(), + Option :: {sashPosition, integer()}. splitVertically(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=Window1T,ref=Window1Ref},#wx_ref{type=Window2T,ref=Window2Ref}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSplitterWindow), @@ -285,15 +320,18 @@ splitVertically(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=Window1T,ref=Window wxe_util:call(?wxSplitterWindow_SplitVertically, <>). -%% @spec (This::wxSplitterWindow()) -> bool() %% @equiv unsplit(This, []) +-spec unsplit(This) -> boolean() when + This::wxSplitterWindow(). + unsplit(This) when is_record(This, wx_ref) -> unsplit(This, []). -%% @spec (This::wxSplitterWindow(), [Option]) -> bool() -%% Option = {toRemove, wxWindow:wxWindow()} %% @doc See external documentation. +-spec unsplit(This, [Option]) -> boolean() when + This::wxSplitterWindow(), + Option :: {toRemove, wxWindow:wxWindow()}. unsplit(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxSplitterWindow), @@ -303,15 +341,16 @@ unsplit(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxSplitterWindow_Unsplit, <>). -%% @spec (This::wxSplitterWindow()) -> ok %% @doc See external documentation. +-spec updateSize(This) -> ok when + This::wxSplitterWindow(). updateSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:cast(?wxSplitterWindow_UpdateSize, <>). -%% @spec (This::wxSplitterWindow()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxSplitterWindow) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxSplitterWindow), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxStaticBitmap.erl b/lib/wx/src/gen/wxStaticBitmap.erl index 31e39b3a6c..e16cd7ef21 100644 --- a/lib/wx/src/gen/wxStaticBitmap.erl +++ b/lib/wx/src/gen/wxStaticBitmap.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 @@ -69,27 +69,34 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxStaticBitmap/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxStaticBitmap() +-type wxStaticBitmap() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxStaticBitmap(). new() -> wxe_util:construct(?wxStaticBitmap_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::wxBitmap:wxBitmap()) -> wxStaticBitmap() %% @equiv new(Parent,Id,Label, []) +-spec new(Parent, Id, Label) -> wxStaticBitmap() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::wxBitmap:wxBitmap(). + new(Parent,Id,Label) when is_record(Parent, wx_ref),is_integer(Id),is_record(Label, wx_ref) -> new(Parent,Id,Label, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::wxBitmap:wxBitmap(), [Option]) -> wxStaticBitmap() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, Label, [Option]) -> wxStaticBitmap() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::wxBitmap:wxBitmap(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,#wx_ref{type=LabelT,ref=LabelRef}, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -102,15 +109,20 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,#wx_ref{type=LabelT,ref=LabelRef}, Op wxe_util:construct(?wxStaticBitmap_new_4, <>). -%% @spec (This::wxStaticBitmap(), Parent::wxWindow:wxWindow(), Id::integer(), Label::wxBitmap:wxBitmap()) -> bool() %% @equiv create(This,Parent,Id,Label, []) +-spec create(This, Parent, Id, Label) -> boolean() when + This::wxStaticBitmap(), Parent::wxWindow:wxWindow(), Id::integer(), Label::wxBitmap:wxBitmap(). + create(This,Parent,Id,Label) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_record(Label, wx_ref) -> create(This,Parent,Id,Label, []). -%% @spec (This::wxStaticBitmap(), Parent::wxWindow:wxWindow(), Id::integer(), Label::wxBitmap:wxBitmap(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, Label, [Option]) -> boolean() when + This::wxStaticBitmap(), Parent::wxWindow:wxWindow(), Id::integer(), Label::wxBitmap:wxBitmap(), + 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,#wx_ref{type=LabelT,ref=LabelRef}, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxStaticBitmap), @@ -124,23 +136,25 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,#w wxe_util:call(?wxStaticBitmap_Create, <>). -%% @spec (This::wxStaticBitmap()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec getBitmap(This) -> wxBitmap:wxBitmap() when + This::wxStaticBitmap(). getBitmap(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStaticBitmap), wxe_util:call(?wxStaticBitmap_GetBitmap, <>). -%% @spec (This::wxStaticBitmap(), Bitmap::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec setBitmap(This, Bitmap) -> ok when + This::wxStaticBitmap(), Bitmap::wxBitmap:wxBitmap(). setBitmap(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BitmapT,ref=BitmapRef}) -> ?CLASS(ThisT,wxStaticBitmap), ?CLASS(BitmapT,wxBitmap), wxe_util:cast(?wxStaticBitmap_SetBitmap, <>). -%% @spec (This::wxStaticBitmap()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxStaticBitmap) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxStaticBitmap), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxStaticBox.erl b/lib/wx/src/gen/wxStaticBox.erl index ec83ff5fd9..0b02cb43e4 100644 --- a/lib/wx/src/gen/wxStaticBox.erl +++ b/lib/wx/src/gen/wxStaticBox.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 @@ -69,27 +69,34 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxStaticBox/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxStaticBox() +-type wxStaticBox() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxStaticBox(). new() -> wxe_util:construct(?wxStaticBox_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> wxStaticBox() %% @equiv new(Parent,Id,Label, []) +-spec new(Parent, Id, Label) -> wxStaticBox() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + new(Parent,Id,Label) when is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> new(Parent,Id,Label, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> wxStaticBox() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, Label, [Option]) -> wxStaticBox() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -102,15 +109,20 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) wxe_util:construct(?wxStaticBox_new_4, <>). -%% @spec (This::wxStaticBox(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> bool() %% @equiv create(This,Parent,Id,Label, []) +-spec create(This, Parent, Id, Label) -> boolean() when + This::wxStaticBox(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + create(This,Parent,Id,Label) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> create(This,Parent,Id,Label, []). -%% @spec (This::wxStaticBox(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, Label, [Option]) -> boolean() when + This::wxStaticBox(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + 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,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ThisT,wxStaticBox), @@ -124,8 +136,8 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,La wxe_util:call(?wxStaticBox_Create, <>). -%% @spec (This::wxStaticBox()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxStaticBox) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxStaticBox), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxStaticBoxSizer.erl b/lib/wx/src/gen/wxStaticBoxSizer.erl index 2cf9f64325..c73563d4cf 100644 --- a/lib/wx/src/gen/wxStaticBoxSizer.erl +++ b/lib/wx/src/gen/wxStaticBoxSizer.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 @@ -41,19 +41,18 @@ setItemMinSize/4,setMinSize/2,setMinSize/3,setSizeHints/2,setVirtualSizeHints/2, show/2,show/3]). +-export_type([wxStaticBoxSizer/0]). %% @hidden parent_class(wxBoxSizer) -> true; parent_class(wxSizer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (X::integer()|term(),X::term()|integer()) -> wxStaticBoxSizer() +-type wxStaticBoxSizer() :: wx:wx_object(). %% @doc See external documentation. -%%
Alternatives: -%%

-%% new(Orient::integer(), Win::wxWindow:wxWindow()) -> new(Orient,Win, [])

-%%

-%% new(Box::wxStaticBox:wxStaticBox(), Orient::integer()) -> wxStaticBoxSizer() -%%

+-spec new(Orient, Win) -> wxStaticBoxSizer() when + Orient::integer(), Win::wxWindow:wxWindow(); + (Box, Orient) -> wxStaticBoxSizer() when + Box::wxStaticBox:wxStaticBox(), Orient::integer(). new(Orient,Win) when is_integer(Orient),is_record(Win, wx_ref) -> @@ -64,9 +63,10 @@ new(#wx_ref{type=BoxT,ref=BoxRef},Orient) wxe_util:construct(?wxStaticBoxSizer_new_2, <>). -%% @spec (Orient::integer(), Win::wxWindow:wxWindow(), [Option]) -> wxStaticBoxSizer() -%% Option = {label, string()} %% @doc See external documentation. +-spec new(Orient, Win, [Option]) -> wxStaticBoxSizer() when + Orient::integer(), Win::wxWindow:wxWindow(), + Option :: {label, string()}. new(Orient,#wx_ref{type=WinT,ref=WinRef}, Options) when is_integer(Orient),is_list(Options) -> ?CLASS(WinT,wxWindow), @@ -76,15 +76,16 @@ new(Orient,#wx_ref{type=WinT,ref=WinRef}, Options) wxe_util:construct(?wxStaticBoxSizer_new_3, <>). -%% @spec (This::wxStaticBoxSizer()) -> wxStaticBox:wxStaticBox() %% @doc See external documentation. +-spec getStaticBox(This) -> wxStaticBox:wxStaticBox() when + This::wxStaticBoxSizer(). getStaticBox(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStaticBoxSizer), wxe_util:call(?wxStaticBoxSizer_GetStaticBox, <>). -%% @spec (This::wxStaticBoxSizer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxStaticBoxSizer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxStaticBoxSizer), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxStaticLine.erl b/lib/wx/src/gen/wxStaticLine.erl index a850065ba0..6298f449d4 100644 --- a/lib/wx/src/gen/wxStaticLine.erl +++ b/lib/wx/src/gen/wxStaticLine.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 @@ -70,27 +70,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxStaticLine/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxStaticLine() +-type wxStaticLine() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxStaticLine(). new() -> wxe_util:construct(?wxStaticLine_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxStaticLine() %% @equiv new(Parent, []) +-spec new(Parent) -> wxStaticLine() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxStaticLine() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxStaticLine() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -103,15 +111,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxStaticLine_new_2, <>). -%% @spec (This::wxStaticLine(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxStaticLine(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxStaticLine(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxStaticLine(), Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {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}, Options) when is_list(Options) -> ?CLASS(ThisT,wxStaticLine), @@ -125,21 +139,22 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxStaticLine_Create, <>). -%% @spec (This::wxStaticLine()) -> bool() %% @doc See external documentation. +-spec isVertical(This) -> boolean() when + This::wxStaticLine(). isVertical(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStaticLine), wxe_util:call(?wxStaticLine_IsVertical, <>). -%% @spec () -> integer() %% @doc See external documentation. +-spec getDefaultSize() -> integer(). getDefaultSize() -> wxe_util:call(?wxStaticLine_GetDefaultSize, <<>>). -%% @spec (This::wxStaticLine()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxStaticLine) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxStaticLine), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxStaticText.erl b/lib/wx/src/gen/wxStaticText.erl index 301999d49a..5aa4b6a7e0 100644 --- a/lib/wx/src/gen/wxStaticText.erl +++ b/lib/wx/src/gen/wxStaticText.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 @@ -69,27 +69,34 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxStaticText/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxStaticText() +-type wxStaticText() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxStaticText(). new() -> wxe_util:construct(?wxStaticText_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> wxStaticText() %% @equiv new(Parent,Id,Label, []) +-spec new(Parent, Id, Label) -> wxStaticText() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + new(Parent,Id,Label) when is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> new(Parent,Id,Label, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> wxStaticText() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, Label, [Option]) -> wxStaticText() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -102,15 +109,20 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) wxe_util:construct(?wxStaticText_new_4, <>). -%% @spec (This::wxStaticText(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> bool() %% @equiv create(This,Parent,Id,Label, []) +-spec create(This, Parent, Id, Label) -> boolean() when + This::wxStaticText(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + create(This,Parent,Id,Label) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> create(This,Parent,Id,Label, []). -%% @spec (This::wxStaticText(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, Label, [Option]) -> boolean() when + This::wxStaticText(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + 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,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ThisT,wxStaticText), @@ -124,15 +136,17 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,La wxe_util:call(?wxStaticText_Create, <>). -%% @spec (This::wxStaticText()) -> string() %% @doc See external documentation. +-spec getLabel(This) -> string() when + This::wxStaticText(). getLabel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStaticText), wxe_util:call(?wxStaticText_GetLabel, <>). -%% @spec (This::wxStaticText(), Label::string()) -> ok %% @doc See external documentation. +-spec setLabel(This, Label) -> ok when + This::wxStaticText(), Label::string(). setLabel(#wx_ref{type=ThisT,ref=ThisRef},Label) when is_list(Label) -> ?CLASS(ThisT,wxStaticText), @@ -140,16 +154,17 @@ setLabel(#wx_ref{type=ThisT,ref=ThisRef},Label) wxe_util:cast(?wxStaticText_SetLabel, <>). -%% @spec (This::wxStaticText(), Width::integer()) -> ok %% @doc See external documentation. +-spec wrap(This, Width) -> ok when + This::wxStaticText(), Width::integer(). wrap(#wx_ref{type=ThisT,ref=ThisRef},Width) when is_integer(Width) -> ?CLASS(ThisT,wxStaticText), wxe_util:cast(?wxStaticText_Wrap, <>). -%% @spec (This::wxStaticText()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxStaticText) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxStaticText), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxStatusBar.erl b/lib/wx/src/gen/wxStatusBar.erl index 6e77761f1d..4b43a8e30b 100644 --- a/lib/wx/src/gen/wxStatusBar.erl +++ b/lib/wx/src/gen/wxStatusBar.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 @@ -71,26 +71,32 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxStatusBar/0]). %% @hidden parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxStatusBar() +-type wxStatusBar() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxStatusBar(). new() -> wxe_util:construct(?wxStatusBar_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxStatusBar() %% @equiv new(Parent, []) +-spec new(Parent) -> wxStatusBar() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxStatusBar() -%% Option = {winid, integer()} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxStatusBar() when + Parent::wxWindow:wxWindow(), + Option :: {winid, integer()} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -101,15 +107,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxStatusBar_new_2, <>). -%% @spec (This::wxStatusBar(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxStatusBar(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxStatusBar(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {winid, integer()} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxStatusBar(), Parent::wxWindow:wxWindow(), + Option :: {winid, integer()} + | {style, integer()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxStatusBar), @@ -121,30 +131,35 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxStatusBar_Create, <>). -%% @spec (This::wxStatusBar(), I::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool() %% @doc See external documentation. +-spec getFieldRect(This, I, Rect) -> boolean() when + This::wxStatusBar(), I::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. getFieldRect(#wx_ref{type=ThisT,ref=ThisRef},I,{RectX,RectY,RectW,RectH}) when is_integer(I),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> ?CLASS(ThisT,wxStatusBar), wxe_util:call(?wxStatusBar_GetFieldRect, <>). -%% @spec (This::wxStatusBar()) -> integer() %% @doc See external documentation. +-spec getFieldsCount(This) -> integer() when + This::wxStatusBar(). getFieldsCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStatusBar), wxe_util:call(?wxStatusBar_GetFieldsCount, <>). -%% @spec (This::wxStatusBar()) -> string() %% @equiv getStatusText(This, []) +-spec getStatusText(This) -> string() when + This::wxStatusBar(). + getStatusText(This) when is_record(This, wx_ref) -> getStatusText(This, []). -%% @spec (This::wxStatusBar(), [Option]) -> string() -%% Option = {number, integer()} %% @doc See external documentation. +-spec getStatusText(This, [Option]) -> string() when + This::wxStatusBar(), + Option :: {number, integer()}. getStatusText(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxStatusBar), @@ -154,15 +169,18 @@ getStatusText(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxStatusBar_GetStatusText, <>). -%% @spec (This::wxStatusBar()) -> ok %% @equiv popStatusText(This, []) +-spec popStatusText(This) -> ok when + This::wxStatusBar(). + popStatusText(This) when is_record(This, wx_ref) -> popStatusText(This, []). -%% @spec (This::wxStatusBar(), [Option]) -> ok -%% Option = {number, integer()} %% @doc See external documentation. +-spec popStatusText(This, [Option]) -> ok when + This::wxStatusBar(), + Option :: {number, integer()}. popStatusText(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxStatusBar), @@ -172,15 +190,18 @@ popStatusText(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxStatusBar_PopStatusText, <>). -%% @spec (This::wxStatusBar(), Text::string()) -> ok %% @equiv pushStatusText(This,Text, []) +-spec pushStatusText(This, Text) -> ok when + This::wxStatusBar(), Text::string(). + pushStatusText(This,Text) when is_record(This, wx_ref),is_list(Text) -> pushStatusText(This,Text, []). -%% @spec (This::wxStatusBar(), Text::string(), [Option]) -> ok -%% Option = {number, integer()} %% @doc See external documentation. +-spec pushStatusText(This, Text, [Option]) -> ok when + This::wxStatusBar(), Text::string(), + Option :: {number, integer()}. pushStatusText(#wx_ref{type=ThisT,ref=ThisRef},Text, Options) when is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxStatusBar), @@ -191,15 +212,18 @@ pushStatusText(#wx_ref{type=ThisT,ref=ThisRef},Text, Options) wxe_util:cast(?wxStatusBar_PushStatusText, <>). -%% @spec (This::wxStatusBar(), Number::integer()) -> ok %% @equiv setFieldsCount(This,Number, []) +-spec setFieldsCount(This, Number) -> ok when + This::wxStatusBar(), Number::integer(). + setFieldsCount(This,Number) when is_record(This, wx_ref),is_integer(Number) -> setFieldsCount(This,Number, []). -%% @spec (This::wxStatusBar(), Number::integer(), [Option]) -> ok -%% Option = {widths, [integer()]} %% @doc See external documentation. +-spec setFieldsCount(This, Number, [Option]) -> ok when + This::wxStatusBar(), Number::integer(), + Option :: {widths, [integer()]}. setFieldsCount(#wx_ref{type=ThisT,ref=ThisRef},Number, Options) when is_integer(Number),is_list(Options) -> ?CLASS(ThisT,wxStatusBar), @@ -210,23 +234,27 @@ setFieldsCount(#wx_ref{type=ThisT,ref=ThisRef},Number, Options) wxe_util:cast(?wxStatusBar_SetFieldsCount, <>). -%% @spec (This::wxStatusBar(), Height::integer()) -> ok %% @doc See external documentation. +-spec setMinHeight(This, Height) -> ok when + This::wxStatusBar(), Height::integer(). setMinHeight(#wx_ref{type=ThisT,ref=ThisRef},Height) when is_integer(Height) -> ?CLASS(ThisT,wxStatusBar), wxe_util:cast(?wxStatusBar_SetMinHeight, <>). -%% @spec (This::wxStatusBar(), Text::string()) -> ok %% @equiv setStatusText(This,Text, []) +-spec setStatusText(This, Text) -> ok when + This::wxStatusBar(), Text::string(). + setStatusText(This,Text) when is_record(This, wx_ref),is_list(Text) -> setStatusText(This,Text, []). -%% @spec (This::wxStatusBar(), Text::string(), [Option]) -> ok -%% Option = {number, integer()} %% @doc See external documentation. +-spec setStatusText(This, Text, [Option]) -> ok when + This::wxStatusBar(), Text::string(), + Option :: {number, integer()}. setStatusText(#wx_ref{type=ThisT,ref=ThisRef},Text, Options) when is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxStatusBar), @@ -237,8 +265,9 @@ setStatusText(#wx_ref{type=ThisT,ref=ThisRef},Text, Options) wxe_util:cast(?wxStatusBar_SetStatusText, <>). -%% @spec (This::wxStatusBar(), Widths_field::[integer()]) -> ok %% @doc See external documentation. +-spec setStatusWidths(This, Widths_field) -> ok when + This::wxStatusBar(), Widths_field::[integer()]. setStatusWidths(#wx_ref{type=ThisT,ref=ThisRef},Widths_field) when is_list(Widths_field) -> ?CLASS(ThisT,wxStatusBar), @@ -246,8 +275,9 @@ setStatusWidths(#wx_ref{type=ThisT,ref=ThisRef},Widths_field) <> || C <- Widths_field>>)/binary, 0:(((0+length(Widths_field)) rem 2)*32)>>). -%% @spec (This::wxStatusBar(), Styles::[integer()]) -> ok %% @doc See external documentation. +-spec setStatusStyles(This, Styles) -> ok when + This::wxStatusBar(), Styles::[integer()]. setStatusStyles(#wx_ref{type=ThisT,ref=ThisRef},Styles) when is_list(Styles) -> ?CLASS(ThisT,wxStatusBar), @@ -255,8 +285,8 @@ setStatusStyles(#wx_ref{type=ThisT,ref=ThisRef},Styles) <> || C <- Styles>>)/binary, 0:(((0+length(Styles)) rem 2)*32)>>). -%% @spec (This::wxStatusBar()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxStatusBar) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxStatusBar), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxStdDialogButtonSizer.erl b/lib/wx/src/gen/wxStdDialogButtonSizer.erl index 3d31907275..b8c17ab6ac 100644 --- a/lib/wx/src/gen/wxStdDialogButtonSizer.erl +++ b/lib/wx/src/gen/wxStdDialogButtonSizer.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 @@ -42,58 +42,65 @@ setItemMinSize/4,setMinSize/2,setMinSize/3,setSizeHints/2,setVirtualSizeHints/2, show/2,show/3]). +-export_type([wxStdDialogButtonSizer/0]). %% @hidden parent_class(wxBoxSizer) -> true; parent_class(wxSizer) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxStdDialogButtonSizer() +-type wxStdDialogButtonSizer() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxStdDialogButtonSizer(). new() -> wxe_util:construct(?wxStdDialogButtonSizer_new, <<>>). -%% @spec (This::wxStdDialogButtonSizer(), Button::wxButton:wxButton()) -> ok %% @doc See external documentation. +-spec addButton(This, Button) -> ok when + This::wxStdDialogButtonSizer(), Button::wxButton:wxButton(). addButton(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ButtonT,ref=ButtonRef}) -> ?CLASS(ThisT,wxStdDialogButtonSizer), ?CLASS(ButtonT,wxButton), wxe_util:cast(?wxStdDialogButtonSizer_AddButton, <>). -%% @spec (This::wxStdDialogButtonSizer()) -> ok %% @doc See external documentation. +-spec realize(This) -> ok when + This::wxStdDialogButtonSizer(). realize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStdDialogButtonSizer), wxe_util:cast(?wxStdDialogButtonSizer_Realize, <>). -%% @spec (This::wxStdDialogButtonSizer(), Button::wxButton:wxButton()) -> ok %% @doc See external documentation. +-spec setAffirmativeButton(This, Button) -> ok when + This::wxStdDialogButtonSizer(), Button::wxButton:wxButton(). setAffirmativeButton(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ButtonT,ref=ButtonRef}) -> ?CLASS(ThisT,wxStdDialogButtonSizer), ?CLASS(ButtonT,wxButton), wxe_util:cast(?wxStdDialogButtonSizer_SetAffirmativeButton, <>). -%% @spec (This::wxStdDialogButtonSizer(), Button::wxButton:wxButton()) -> ok %% @doc See external documentation. +-spec setCancelButton(This, Button) -> ok when + This::wxStdDialogButtonSizer(), Button::wxButton:wxButton(). setCancelButton(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ButtonT,ref=ButtonRef}) -> ?CLASS(ThisT,wxStdDialogButtonSizer), ?CLASS(ButtonT,wxButton), wxe_util:cast(?wxStdDialogButtonSizer_SetCancelButton, <>). -%% @spec (This::wxStdDialogButtonSizer(), Button::wxButton:wxButton()) -> ok %% @doc See external documentation. +-spec setNegativeButton(This, Button) -> ok when + This::wxStdDialogButtonSizer(), Button::wxButton:wxButton(). setNegativeButton(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ButtonT,ref=ButtonRef}) -> ?CLASS(ThisT,wxStdDialogButtonSizer), ?CLASS(ButtonT,wxButton), wxe_util:cast(?wxStdDialogButtonSizer_SetNegativeButton, <>). -%% @spec (This::wxStdDialogButtonSizer()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxStdDialogButtonSizer) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxStdDialogButtonSizer), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxStyledTextCtrl.erl b/lib/wx/src/gen/wxStyledTextCtrl.erl index 61f0e5afef..fdbe4faec0 100644 --- a/lib/wx/src/gen/wxStyledTextCtrl.erl +++ b/lib/wx/src/gen/wxStyledTextCtrl.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 @@ -171,27 +171,35 @@ transferDataToWindow/1,update/1,updateWindowUI/1,updateWindowUI/2, validate/1,warpPointer/3]). +-export_type([wxStyledTextCtrl/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxStyledTextCtrl() +-type wxStyledTextCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxStyledTextCtrl(). new() -> wxe_util:construct(?wxStyledTextCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxStyledTextCtrl() %% @equiv new(Parent, []) +-spec new(Parent) -> wxStyledTextCtrl() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxStyledTextCtrl() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxStyledTextCtrl() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -204,15 +212,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxStyledTextCtrl_new_2, <>). -%% @spec (This::wxStyledTextCtrl(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxStyledTextCtrl(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxStyledTextCtrl(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxStyledTextCtrl(), Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {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}, Options) when is_list(Options) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -226,8 +240,9 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxStyledTextCtrl_Create, <>). -%% @spec (This::wxStyledTextCtrl(), Text::string()) -> ok %% @doc See external documentation. +-spec addText(This, Text) -> ok when + This::wxStyledTextCtrl(), Text::string(). addText(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -235,16 +250,18 @@ addText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxStyledTextCtrl_AddText, <>). -%% @spec (This::wxStyledTextCtrl(), Data::wxMemoryBuffer:wxMemoryBuffer()) -> ok %% @doc See external documentation. +-spec addStyledText(This, Data) -> ok when + This::wxStyledTextCtrl(), Data::wxMemoryBuffer:wxMemoryBuffer(). addStyledText(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DataT,ref=DataRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), ?CLASS(DataT,wxMemoryBuffer), wxe_util:cast(?wxStyledTextCtrl_AddStyledText, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer(), Text::string()) -> ok %% @doc See external documentation. +-spec insertText(This, Pos, Text) -> ok when + This::wxStyledTextCtrl(), Pos::integer(), Text::string(). insertText(#wx_ref{type=ThisT,ref=ThisRef},Pos,Text) when is_integer(Pos),is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -252,279 +269,319 @@ insertText(#wx_ref{type=ThisT,ref=ThisRef},Pos,Text) wxe_util:cast(?wxStyledTextCtrl_InsertText, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec clearAll(This) -> ok when + This::wxStyledTextCtrl(). clearAll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ClearAll, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec clearDocumentStyle(This) -> ok when + This::wxStyledTextCtrl(). clearDocumentStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ClearDocumentStyle, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getLength(This) -> integer() when + This::wxStyledTextCtrl(). getLength(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLength, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> integer() %% @doc See external documentation. +-spec getCharAt(This, Pos) -> integer() when + This::wxStyledTextCtrl(), Pos::integer(). getCharAt(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCharAt, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getCurrentPos(This) -> integer() when + This::wxStyledTextCtrl(). getCurrentPos(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCurrentPos, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getAnchor(This) -> integer() when + This::wxStyledTextCtrl(). getAnchor(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetAnchor, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> integer() %% @doc See external documentation. +-spec getStyleAt(This, Pos) -> integer() when + This::wxStyledTextCtrl(), Pos::integer(). getStyleAt(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetStyleAt, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec redo(This) -> ok when + This::wxStyledTextCtrl(). redo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Redo, <>). -%% @spec (This::wxStyledTextCtrl(), CollectUndo::bool()) -> ok %% @doc See external documentation. +-spec setUndoCollection(This, CollectUndo) -> ok when + This::wxStyledTextCtrl(), CollectUndo::boolean(). setUndoCollection(#wx_ref{type=ThisT,ref=ThisRef},CollectUndo) when is_boolean(CollectUndo) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetUndoCollection, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec selectAll(This) -> ok when + This::wxStyledTextCtrl(). selectAll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SelectAll, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec setSavePoint(This) -> ok when + This::wxStyledTextCtrl(). setSavePoint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSavePoint, <>). -%% @spec (This::wxStyledTextCtrl(), StartPos::integer(), EndPos::integer()) -> wxMemoryBuffer:wxMemoryBuffer() %% @doc See external documentation. +-spec getStyledText(This, StartPos, EndPos) -> wxMemoryBuffer:wxMemoryBuffer() when + This::wxStyledTextCtrl(), StartPos::integer(), EndPos::integer(). getStyledText(#wx_ref{type=ThisT,ref=ThisRef},StartPos,EndPos) when is_integer(StartPos),is_integer(EndPos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetStyledText, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec canRedo(This) -> boolean() when + This::wxStyledTextCtrl(). canRedo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_CanRedo, <>). -%% @spec (This::wxStyledTextCtrl(), Handle::integer()) -> integer() %% @doc See external documentation. +-spec markerLineFromHandle(This, Handle) -> integer() when + This::wxStyledTextCtrl(), Handle::integer(). markerLineFromHandle(#wx_ref{type=ThisT,ref=ThisRef},Handle) when is_integer(Handle) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_MarkerLineFromHandle, <>). -%% @spec (This::wxStyledTextCtrl(), Handle::integer()) -> ok %% @doc See external documentation. +-spec markerDeleteHandle(This, Handle) -> ok when + This::wxStyledTextCtrl(), Handle::integer(). markerDeleteHandle(#wx_ref{type=ThisT,ref=ThisRef},Handle) when is_integer(Handle) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_MarkerDeleteHandle, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getUndoCollection(This) -> boolean() when + This::wxStyledTextCtrl(). getUndoCollection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetUndoCollection, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getViewWhiteSpace(This) -> integer() when + This::wxStyledTextCtrl(). getViewWhiteSpace(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetViewWhiteSpace, <>). -%% @spec (This::wxStyledTextCtrl(), ViewWS::integer()) -> ok %% @doc See external documentation. +-spec setViewWhiteSpace(This, ViewWS) -> ok when + This::wxStyledTextCtrl(), ViewWS::integer(). setViewWhiteSpace(#wx_ref{type=ThisT,ref=ThisRef},ViewWS) when is_integer(ViewWS) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetViewWhiteSpace, <>). -%% @spec (This::wxStyledTextCtrl(), Pt::{X::integer(), Y::integer()}) -> integer() %% @doc See external documentation. +-spec positionFromPoint(This, Pt) -> integer() when + This::wxStyledTextCtrl(), Pt::{X::integer(), Y::integer()}. positionFromPoint(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_PositionFromPoint, <>). -%% @spec (This::wxStyledTextCtrl(), X::integer(), Y::integer()) -> integer() %% @doc See external documentation. +-spec positionFromPointClose(This, X, Y) -> integer() when + This::wxStyledTextCtrl(), X::integer(), Y::integer(). positionFromPointClose(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_PositionFromPointClose, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> ok %% @doc See external documentation. +-spec gotoLine(This, Line) -> ok when + This::wxStyledTextCtrl(), Line::integer(). gotoLine(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_GotoLine, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> ok %% @doc See external documentation. +-spec gotoPos(This, Pos) -> ok when + This::wxStyledTextCtrl(), Pos::integer(). gotoPos(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_GotoPos, <>). -%% @spec (This::wxStyledTextCtrl(), PosAnchor::integer()) -> ok %% @doc See external documentation. +-spec setAnchor(This, PosAnchor) -> ok when + This::wxStyledTextCtrl(), PosAnchor::integer(). setAnchor(#wx_ref{type=ThisT,ref=ThisRef},PosAnchor) when is_integer(PosAnchor) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetAnchor, <>). -%% @spec (This::wxStyledTextCtrl()) -> {string(), LinePos::integer()} %% @doc See external documentation. +-spec getCurLine(This) -> Result when + Result ::{Res ::string(), LinePos::integer()}, + This::wxStyledTextCtrl(). getCurLine(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCurLine, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getEndStyled(This) -> integer() when + This::wxStyledTextCtrl(). getEndStyled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetEndStyled, <>). -%% @spec (This::wxStyledTextCtrl(), EolMode::integer()) -> ok %% @doc See external documentation. +-spec convertEOLs(This, EolMode) -> ok when + This::wxStyledTextCtrl(), EolMode::integer(). convertEOLs(#wx_ref{type=ThisT,ref=ThisRef},EolMode) when is_integer(EolMode) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ConvertEOLs, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getEOLMode(This) -> integer() when + This::wxStyledTextCtrl(). getEOLMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetEOLMode, <>). -%% @spec (This::wxStyledTextCtrl(), EolMode::integer()) -> ok %% @doc See external documentation. +-spec setEOLMode(This, EolMode) -> ok when + This::wxStyledTextCtrl(), EolMode::integer(). setEOLMode(#wx_ref{type=ThisT,ref=ThisRef},EolMode) when is_integer(EolMode) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetEOLMode, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer(), Mask::integer()) -> ok %% @doc See external documentation. +-spec startStyling(This, Pos, Mask) -> ok when + This::wxStyledTextCtrl(), Pos::integer(), Mask::integer(). startStyling(#wx_ref{type=ThisT,ref=ThisRef},Pos,Mask) when is_integer(Pos),is_integer(Mask) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StartStyling, <>). -%% @spec (This::wxStyledTextCtrl(), Length::integer(), Style::integer()) -> ok %% @doc See external documentation. +-spec setStyling(This, Length, Style) -> ok when + This::wxStyledTextCtrl(), Length::integer(), Style::integer(). setStyling(#wx_ref{type=ThisT,ref=ThisRef},Length,Style) when is_integer(Length),is_integer(Style) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetStyling, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getBufferedDraw(This) -> boolean() when + This::wxStyledTextCtrl(). getBufferedDraw(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetBufferedDraw, <>). -%% @spec (This::wxStyledTextCtrl(), Buffered::bool()) -> ok %% @doc See external documentation. +-spec setBufferedDraw(This, Buffered) -> ok when + This::wxStyledTextCtrl(), Buffered::boolean(). setBufferedDraw(#wx_ref{type=ThisT,ref=ThisRef},Buffered) when is_boolean(Buffered) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetBufferedDraw, <>). -%% @spec (This::wxStyledTextCtrl(), TabWidth::integer()) -> ok %% @doc See external documentation. +-spec setTabWidth(This, TabWidth) -> ok when + This::wxStyledTextCtrl(), TabWidth::integer(). setTabWidth(#wx_ref{type=ThisT,ref=ThisRef},TabWidth) when is_integer(TabWidth) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetTabWidth, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getTabWidth(This) -> integer() when + This::wxStyledTextCtrl(). getTabWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetTabWidth, <>). -%% @spec (This::wxStyledTextCtrl(), CodePage::integer()) -> ok %% @doc See external documentation. +-spec setCodePage(This, CodePage) -> ok when + This::wxStyledTextCtrl(), CodePage::integer(). setCodePage(#wx_ref{type=ThisT,ref=ThisRef},CodePage) when is_integer(CodePage) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCodePage, <>). -%% @spec (This::wxStyledTextCtrl(), MarkerNumber::integer(), MarkerSymbol::integer()) -> ok %% @equiv markerDefine(This,MarkerNumber,MarkerSymbol, []) +-spec markerDefine(This, MarkerNumber, MarkerSymbol) -> ok when + This::wxStyledTextCtrl(), MarkerNumber::integer(), MarkerSymbol::integer(). + markerDefine(This,MarkerNumber,MarkerSymbol) when is_record(This, wx_ref),is_integer(MarkerNumber),is_integer(MarkerSymbol) -> markerDefine(This,MarkerNumber,MarkerSymbol, []). -%% @spec (This::wxStyledTextCtrl(), MarkerNumber::integer(), MarkerSymbol::integer(), [Option]) -> ok -%% Option = {foreground, wx:colour()} | {background, wx:colour()} %% @doc See external documentation. +-spec markerDefine(This, MarkerNumber, MarkerSymbol, [Option]) -> ok when + This::wxStyledTextCtrl(), MarkerNumber::integer(), MarkerSymbol::integer(), + Option :: {foreground, wx:wx_colour()} + | {background, wx:wx_colour()}. markerDefine(#wx_ref{type=ThisT,ref=ThisRef},MarkerNumber,MarkerSymbol, Options) when is_integer(MarkerNumber),is_integer(MarkerSymbol),is_list(Options) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -535,72 +592,81 @@ markerDefine(#wx_ref{type=ThisT,ref=ThisRef},MarkerNumber,MarkerSymbol, Options) wxe_util:cast(?wxStyledTextCtrl_MarkerDefine, <>). -%% @spec (This::wxStyledTextCtrl(), MarkerNumber::integer(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec markerSetForeground(This, MarkerNumber, Fore) -> ok when + This::wxStyledTextCtrl(), MarkerNumber::integer(), Fore::wx:wx_colour(). markerSetForeground(#wx_ref{type=ThisT,ref=ThisRef},MarkerNumber,Fore) when is_integer(MarkerNumber),tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_MarkerSetForeground, <>). -%% @spec (This::wxStyledTextCtrl(), MarkerNumber::integer(), Back::wx:colour()) -> ok %% @doc See external documentation. +-spec markerSetBackground(This, MarkerNumber, Back) -> ok when + This::wxStyledTextCtrl(), MarkerNumber::integer(), Back::wx:wx_colour(). markerSetBackground(#wx_ref{type=ThisT,ref=ThisRef},MarkerNumber,Back) when is_integer(MarkerNumber),tuple_size(Back) =:= 3; tuple_size(Back) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_MarkerSetBackground, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer(), MarkerNumber::integer()) -> integer() %% @doc See external documentation. +-spec markerAdd(This, Line, MarkerNumber) -> integer() when + This::wxStyledTextCtrl(), Line::integer(), MarkerNumber::integer(). markerAdd(#wx_ref{type=ThisT,ref=ThisRef},Line,MarkerNumber) when is_integer(Line),is_integer(MarkerNumber) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_MarkerAdd, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer(), MarkerNumber::integer()) -> ok %% @doc See external documentation. +-spec markerDelete(This, Line, MarkerNumber) -> ok when + This::wxStyledTextCtrl(), Line::integer(), MarkerNumber::integer(). markerDelete(#wx_ref{type=ThisT,ref=ThisRef},Line,MarkerNumber) when is_integer(Line),is_integer(MarkerNumber) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_MarkerDelete, <>). -%% @spec (This::wxStyledTextCtrl(), MarkerNumber::integer()) -> ok %% @doc See external documentation. +-spec markerDeleteAll(This, MarkerNumber) -> ok when + This::wxStyledTextCtrl(), MarkerNumber::integer(). markerDeleteAll(#wx_ref{type=ThisT,ref=ThisRef},MarkerNumber) when is_integer(MarkerNumber) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_MarkerDeleteAll, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec markerGet(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). markerGet(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_MarkerGet, <>). -%% @spec (This::wxStyledTextCtrl(), LineStart::integer(), MarkerMask::integer()) -> integer() %% @doc See external documentation. +-spec markerNext(This, LineStart, MarkerMask) -> integer() when + This::wxStyledTextCtrl(), LineStart::integer(), MarkerMask::integer(). markerNext(#wx_ref{type=ThisT,ref=ThisRef},LineStart,MarkerMask) when is_integer(LineStart),is_integer(MarkerMask) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_MarkerNext, <>). -%% @spec (This::wxStyledTextCtrl(), LineStart::integer(), MarkerMask::integer()) -> integer() %% @doc See external documentation. +-spec markerPrevious(This, LineStart, MarkerMask) -> integer() when + This::wxStyledTextCtrl(), LineStart::integer(), MarkerMask::integer(). markerPrevious(#wx_ref{type=ThisT,ref=ThisRef},LineStart,MarkerMask) when is_integer(LineStart),is_integer(MarkerMask) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_MarkerPrevious, <>). -%% @spec (This::wxStyledTextCtrl(), MarkerNumber::integer(), Bmp::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec markerDefineBitmap(This, MarkerNumber, Bmp) -> ok when + This::wxStyledTextCtrl(), MarkerNumber::integer(), Bmp::wxBitmap:wxBitmap(). markerDefineBitmap(#wx_ref{type=ThisT,ref=ThisRef},MarkerNumber,#wx_ref{type=BmpT,ref=BmpRef}) when is_integer(MarkerNumber) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -608,135 +674,152 @@ markerDefineBitmap(#wx_ref{type=ThisT,ref=ThisRef},MarkerNumber,#wx_ref{type=Bmp wxe_util:cast(?wxStyledTextCtrl_MarkerDefineBitmap, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer(), Set::integer()) -> ok %% @doc See external documentation. +-spec markerAddSet(This, Line, Set) -> ok when + This::wxStyledTextCtrl(), Line::integer(), Set::integer(). markerAddSet(#wx_ref{type=ThisT,ref=ThisRef},Line,Set) when is_integer(Line),is_integer(Set) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_MarkerAddSet, <>). -%% @spec (This::wxStyledTextCtrl(), MarkerNumber::integer(), Alpha::integer()) -> ok %% @doc See external documentation. +-spec markerSetAlpha(This, MarkerNumber, Alpha) -> ok when + This::wxStyledTextCtrl(), MarkerNumber::integer(), Alpha::integer(). markerSetAlpha(#wx_ref{type=ThisT,ref=ThisRef},MarkerNumber,Alpha) when is_integer(MarkerNumber),is_integer(Alpha) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_MarkerSetAlpha, <>). -%% @spec (This::wxStyledTextCtrl(), Margin::integer(), MarginType::integer()) -> ok %% @doc See external documentation. +-spec setMarginType(This, Margin, MarginType) -> ok when + This::wxStyledTextCtrl(), Margin::integer(), MarginType::integer(). setMarginType(#wx_ref{type=ThisT,ref=ThisRef},Margin,MarginType) when is_integer(Margin),is_integer(MarginType) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetMarginType, <>). -%% @spec (This::wxStyledTextCtrl(), Margin::integer()) -> integer() %% @doc See external documentation. +-spec getMarginType(This, Margin) -> integer() when + This::wxStyledTextCtrl(), Margin::integer(). getMarginType(#wx_ref{type=ThisT,ref=ThisRef},Margin) when is_integer(Margin) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetMarginType, <>). -%% @spec (This::wxStyledTextCtrl(), Margin::integer(), PixelWidth::integer()) -> ok %% @doc See external documentation. +-spec setMarginWidth(This, Margin, PixelWidth) -> ok when + This::wxStyledTextCtrl(), Margin::integer(), PixelWidth::integer(). setMarginWidth(#wx_ref{type=ThisT,ref=ThisRef},Margin,PixelWidth) when is_integer(Margin),is_integer(PixelWidth) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetMarginWidth, <>). -%% @spec (This::wxStyledTextCtrl(), Margin::integer()) -> integer() %% @doc See external documentation. +-spec getMarginWidth(This, Margin) -> integer() when + This::wxStyledTextCtrl(), Margin::integer(). getMarginWidth(#wx_ref{type=ThisT,ref=ThisRef},Margin) when is_integer(Margin) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetMarginWidth, <>). -%% @spec (This::wxStyledTextCtrl(), Margin::integer(), Mask::integer()) -> ok %% @doc See external documentation. +-spec setMarginMask(This, Margin, Mask) -> ok when + This::wxStyledTextCtrl(), Margin::integer(), Mask::integer(). setMarginMask(#wx_ref{type=ThisT,ref=ThisRef},Margin,Mask) when is_integer(Margin),is_integer(Mask) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetMarginMask, <>). -%% @spec (This::wxStyledTextCtrl(), Margin::integer()) -> integer() %% @doc See external documentation. +-spec getMarginMask(This, Margin) -> integer() when + This::wxStyledTextCtrl(), Margin::integer(). getMarginMask(#wx_ref{type=ThisT,ref=ThisRef},Margin) when is_integer(Margin) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetMarginMask, <>). -%% @spec (This::wxStyledTextCtrl(), Margin::integer(), Sensitive::bool()) -> ok %% @doc See external documentation. +-spec setMarginSensitive(This, Margin, Sensitive) -> ok when + This::wxStyledTextCtrl(), Margin::integer(), Sensitive::boolean(). setMarginSensitive(#wx_ref{type=ThisT,ref=ThisRef},Margin,Sensitive) when is_integer(Margin),is_boolean(Sensitive) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetMarginSensitive, <>). -%% @spec (This::wxStyledTextCtrl(), Margin::integer()) -> bool() %% @doc See external documentation. +-spec getMarginSensitive(This, Margin) -> boolean() when + This::wxStyledTextCtrl(), Margin::integer(). getMarginSensitive(#wx_ref{type=ThisT,ref=ThisRef},Margin) when is_integer(Margin) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetMarginSensitive, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec styleClearAll(This) -> ok when + This::wxStyledTextCtrl(). styleClearAll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleClearAll, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec styleSetForeground(This, Style, Fore) -> ok when + This::wxStyledTextCtrl(), Style::integer(), Fore::wx:wx_colour(). styleSetForeground(#wx_ref{type=ThisT,ref=ThisRef},Style,Fore) when is_integer(Style),tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetForeground, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Back::wx:colour()) -> ok %% @doc See external documentation. +-spec styleSetBackground(This, Style, Back) -> ok when + This::wxStyledTextCtrl(), Style::integer(), Back::wx:wx_colour(). styleSetBackground(#wx_ref{type=ThisT,ref=ThisRef},Style,Back) when is_integer(Style),tuple_size(Back) =:= 3; tuple_size(Back) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetBackground, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Bold::bool()) -> ok %% @doc See external documentation. +-spec styleSetBold(This, Style, Bold) -> ok when + This::wxStyledTextCtrl(), Style::integer(), Bold::boolean(). styleSetBold(#wx_ref{type=ThisT,ref=ThisRef},Style,Bold) when is_integer(Style),is_boolean(Bold) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetBold, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Italic::bool()) -> ok %% @doc See external documentation. +-spec styleSetItalic(This, Style, Italic) -> ok when + This::wxStyledTextCtrl(), Style::integer(), Italic::boolean(). styleSetItalic(#wx_ref{type=ThisT,ref=ThisRef},Style,Italic) when is_integer(Style),is_boolean(Italic) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetItalic, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), SizePoints::integer()) -> ok %% @doc See external documentation. +-spec styleSetSize(This, Style, SizePoints) -> ok when + This::wxStyledTextCtrl(), Style::integer(), SizePoints::integer(). styleSetSize(#wx_ref{type=ThisT,ref=ThisRef},Style,SizePoints) when is_integer(Style),is_integer(SizePoints) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetSize, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), FontName::string()) -> ok %% @doc See external documentation. +-spec styleSetFaceName(This, Style, FontName) -> ok when + This::wxStyledTextCtrl(), Style::integer(), FontName::string(). styleSetFaceName(#wx_ref{type=ThisT,ref=ThisRef},Style,FontName) when is_integer(Style),is_list(FontName) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -744,140 +827,158 @@ styleSetFaceName(#wx_ref{type=ThisT,ref=ThisRef},Style,FontName) wxe_util:cast(?wxStyledTextCtrl_StyleSetFaceName, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Filled::bool()) -> ok %% @doc See external documentation. +-spec styleSetEOLFilled(This, Style, Filled) -> ok when + This::wxStyledTextCtrl(), Style::integer(), Filled::boolean(). styleSetEOLFilled(#wx_ref{type=ThisT,ref=ThisRef},Style,Filled) when is_integer(Style),is_boolean(Filled) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetEOLFilled, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec styleResetDefault(This) -> ok when + This::wxStyledTextCtrl(). styleResetDefault(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleResetDefault, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Underline::bool()) -> ok %% @doc See external documentation. +-spec styleSetUnderline(This, Style, Underline) -> ok when + This::wxStyledTextCtrl(), Style::integer(), Underline::boolean(). styleSetUnderline(#wx_ref{type=ThisT,ref=ThisRef},Style,Underline) when is_integer(Style),is_boolean(Underline) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetUnderline, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), CaseForce::integer()) -> ok %% @doc See external documentation. +-spec styleSetCase(This, Style, CaseForce) -> ok when + This::wxStyledTextCtrl(), Style::integer(), CaseForce::integer(). styleSetCase(#wx_ref{type=ThisT,ref=ThisRef},Style,CaseForce) when is_integer(Style),is_integer(CaseForce) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetCase, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Hotspot::bool()) -> ok %% @doc See external documentation. +-spec styleSetHotSpot(This, Style, Hotspot) -> ok when + This::wxStyledTextCtrl(), Style::integer(), Hotspot::boolean(). styleSetHotSpot(#wx_ref{type=ThisT,ref=ThisRef},Style,Hotspot) when is_integer(Style),is_boolean(Hotspot) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetHotSpot, <>). -%% @spec (This::wxStyledTextCtrl(), UseSetting::bool(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec setSelForeground(This, UseSetting, Fore) -> ok when + This::wxStyledTextCtrl(), UseSetting::boolean(), Fore::wx:wx_colour(). setSelForeground(#wx_ref{type=ThisT,ref=ThisRef},UseSetting,Fore) when is_boolean(UseSetting),tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSelForeground, <>). -%% @spec (This::wxStyledTextCtrl(), UseSetting::bool(), Back::wx:colour()) -> ok %% @doc See external documentation. +-spec setSelBackground(This, UseSetting, Back) -> ok when + This::wxStyledTextCtrl(), UseSetting::boolean(), Back::wx:wx_colour(). setSelBackground(#wx_ref{type=ThisT,ref=ThisRef},UseSetting,Back) when is_boolean(UseSetting),tuple_size(Back) =:= 3; tuple_size(Back) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSelBackground, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getSelAlpha(This) -> integer() when + This::wxStyledTextCtrl(). getSelAlpha(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSelAlpha, <>). -%% @spec (This::wxStyledTextCtrl(), Alpha::integer()) -> ok %% @doc See external documentation. +-spec setSelAlpha(This, Alpha) -> ok when + This::wxStyledTextCtrl(), Alpha::integer(). setSelAlpha(#wx_ref{type=ThisT,ref=ThisRef},Alpha) when is_integer(Alpha) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSelAlpha, <>). -%% @spec (This::wxStyledTextCtrl(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec setCaretForeground(This, Fore) -> ok when + This::wxStyledTextCtrl(), Fore::wx:wx_colour(). setCaretForeground(#wx_ref{type=ThisT,ref=ThisRef},Fore) when tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCaretForeground, <>). -%% @spec (This::wxStyledTextCtrl(), Key::integer(), Modifiers::integer(), Cmd::integer()) -> ok %% @doc See external documentation. +-spec cmdKeyAssign(This, Key, Modifiers, Cmd) -> ok when + This::wxStyledTextCtrl(), Key::integer(), Modifiers::integer(), Cmd::integer(). cmdKeyAssign(#wx_ref{type=ThisT,ref=ThisRef},Key,Modifiers,Cmd) when is_integer(Key),is_integer(Modifiers),is_integer(Cmd) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CmdKeyAssign, <>). -%% @spec (This::wxStyledTextCtrl(), Key::integer(), Modifiers::integer()) -> ok %% @doc See external documentation. +-spec cmdKeyClear(This, Key, Modifiers) -> ok when + This::wxStyledTextCtrl(), Key::integer(), Modifiers::integer(). cmdKeyClear(#wx_ref{type=ThisT,ref=ThisRef},Key,Modifiers) when is_integer(Key),is_integer(Modifiers) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CmdKeyClear, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec cmdKeyClearAll(This) -> ok when + This::wxStyledTextCtrl(). cmdKeyClearAll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CmdKeyClearAll, <>). -%% @spec (This::wxStyledTextCtrl(), Length::integer()) -> integer() %% @doc See external documentation. +-spec setStyleBytes(This, Length) -> integer() when + This::wxStyledTextCtrl(), Length::integer(). setStyleBytes(#wx_ref{type=ThisT,ref=ThisRef},Length) when is_integer(Length) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_SetStyleBytes, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Visible::bool()) -> ok %% @doc See external documentation. +-spec styleSetVisible(This, Style, Visible) -> ok when + This::wxStyledTextCtrl(), Style::integer(), Visible::boolean(). styleSetVisible(#wx_ref{type=ThisT,ref=ThisRef},Style,Visible) when is_integer(Style),is_boolean(Visible) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetVisible, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getCaretPeriod(This) -> integer() when + This::wxStyledTextCtrl(). getCaretPeriod(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCaretPeriod, <>). -%% @spec (This::wxStyledTextCtrl(), PeriodMilliseconds::integer()) -> ok %% @doc See external documentation. +-spec setCaretPeriod(This, PeriodMilliseconds) -> ok when + This::wxStyledTextCtrl(), PeriodMilliseconds::integer(). setCaretPeriod(#wx_ref{type=ThisT,ref=ThisRef},PeriodMilliseconds) when is_integer(PeriodMilliseconds) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCaretPeriod, <>). -%% @spec (This::wxStyledTextCtrl(), Characters::string()) -> ok %% @doc See external documentation. +-spec setWordChars(This, Characters) -> ok when + This::wxStyledTextCtrl(), Characters::string(). setWordChars(#wx_ref{type=ThisT,ref=ThisRef},Characters) when is_list(Characters) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -885,130 +986,147 @@ setWordChars(#wx_ref{type=ThisT,ref=ThisRef},Characters) wxe_util:cast(?wxStyledTextCtrl_SetWordChars, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec beginUndoAction(This) -> ok when + This::wxStyledTextCtrl(). beginUndoAction(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_BeginUndoAction, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec endUndoAction(This) -> ok when + This::wxStyledTextCtrl(). endUndoAction(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_EndUndoAction, <>). -%% @spec (This::wxStyledTextCtrl(), Indic::integer(), Style::integer()) -> ok %% @doc See external documentation. +-spec indicatorSetStyle(This, Indic, Style) -> ok when + This::wxStyledTextCtrl(), Indic::integer(), Style::integer(). indicatorSetStyle(#wx_ref{type=ThisT,ref=ThisRef},Indic,Style) when is_integer(Indic),is_integer(Style) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_IndicatorSetStyle, <>). -%% @spec (This::wxStyledTextCtrl(), Indic::integer()) -> integer() %% @doc See external documentation. +-spec indicatorGetStyle(This, Indic) -> integer() when + This::wxStyledTextCtrl(), Indic::integer(). indicatorGetStyle(#wx_ref{type=ThisT,ref=ThisRef},Indic) when is_integer(Indic) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_IndicatorGetStyle, <>). -%% @spec (This::wxStyledTextCtrl(), Indic::integer(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec indicatorSetForeground(This, Indic, Fore) -> ok when + This::wxStyledTextCtrl(), Indic::integer(), Fore::wx:wx_colour(). indicatorSetForeground(#wx_ref{type=ThisT,ref=ThisRef},Indic,Fore) when is_integer(Indic),tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_IndicatorSetForeground, <>). -%% @spec (This::wxStyledTextCtrl(), Indic::integer()) -> wx:colour() %% @doc See external documentation. +-spec indicatorGetForeground(This, Indic) -> wx:wx_colour() when + This::wxStyledTextCtrl(), Indic::integer(). indicatorGetForeground(#wx_ref{type=ThisT,ref=ThisRef},Indic) when is_integer(Indic) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_IndicatorGetForeground, <>). -%% @spec (This::wxStyledTextCtrl(), UseSetting::bool(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec setWhitespaceForeground(This, UseSetting, Fore) -> ok when + This::wxStyledTextCtrl(), UseSetting::boolean(), Fore::wx:wx_colour(). setWhitespaceForeground(#wx_ref{type=ThisT,ref=ThisRef},UseSetting,Fore) when is_boolean(UseSetting),tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetWhitespaceForeground, <>). -%% @spec (This::wxStyledTextCtrl(), UseSetting::bool(), Back::wx:colour()) -> ok %% @doc See external documentation. +-spec setWhitespaceBackground(This, UseSetting, Back) -> ok when + This::wxStyledTextCtrl(), UseSetting::boolean(), Back::wx:wx_colour(). setWhitespaceBackground(#wx_ref{type=ThisT,ref=ThisRef},UseSetting,Back) when is_boolean(UseSetting),tuple_size(Back) =:= 3; tuple_size(Back) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetWhitespaceBackground, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getStyleBits(This) -> integer() when + This::wxStyledTextCtrl(). getStyleBits(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetStyleBits, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer(), State::integer()) -> ok %% @doc See external documentation. +-spec setLineState(This, Line, State) -> ok when + This::wxStyledTextCtrl(), Line::integer(), State::integer(). setLineState(#wx_ref{type=ThisT,ref=ThisRef},Line,State) when is_integer(Line),is_integer(State) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetLineState, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec getLineState(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). getLineState(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLineState, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getMaxLineState(This) -> integer() when + This::wxStyledTextCtrl(). getMaxLineState(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetMaxLineState, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getCaretLineVisible(This) -> boolean() when + This::wxStyledTextCtrl(). getCaretLineVisible(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCaretLineVisible, <>). -%% @spec (This::wxStyledTextCtrl(), Show::bool()) -> ok %% @doc See external documentation. +-spec setCaretLineVisible(This, Show) -> ok when + This::wxStyledTextCtrl(), Show::boolean(). setCaretLineVisible(#wx_ref{type=ThisT,ref=ThisRef},Show) when is_boolean(Show) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCaretLineVisible, <>). -%% @spec (This::wxStyledTextCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getCaretLineBackground(This) -> wx:wx_colour() when + This::wxStyledTextCtrl(). getCaretLineBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCaretLineBackground, <>). -%% @spec (This::wxStyledTextCtrl(), Back::wx:colour()) -> ok %% @doc See external documentation. +-spec setCaretLineBackground(This, Back) -> ok when + This::wxStyledTextCtrl(), Back::wx:wx_colour(). setCaretLineBackground(#wx_ref{type=ThisT,ref=ThisRef},Back) when tuple_size(Back) =:= 3; tuple_size(Back) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCaretLineBackground, <>). -%% @spec (This::wxStyledTextCtrl(), LenEntered::integer(), ItemList::string()) -> ok %% @doc See external documentation. +-spec autoCompShow(This, LenEntered, ItemList) -> ok when + This::wxStyledTextCtrl(), LenEntered::integer(), ItemList::string(). autoCompShow(#wx_ref{type=ThisT,ref=ThisRef},LenEntered,ItemList) when is_integer(LenEntered),is_list(ItemList) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1016,36 +1134,41 @@ autoCompShow(#wx_ref{type=ThisT,ref=ThisRef},LenEntered,ItemList) wxe_util:cast(?wxStyledTextCtrl_AutoCompShow, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec autoCompCancel(This) -> ok when + This::wxStyledTextCtrl(). autoCompCancel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompCancel, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec autoCompActive(This) -> boolean() when + This::wxStyledTextCtrl(). autoCompActive(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompActive, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec autoCompPosStart(This) -> integer() when + This::wxStyledTextCtrl(). autoCompPosStart(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompPosStart, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec autoCompComplete(This) -> ok when + This::wxStyledTextCtrl(). autoCompComplete(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompComplete, <>). -%% @spec (This::wxStyledTextCtrl(), CharacterSet::string()) -> ok %% @doc See external documentation. +-spec autoCompStops(This, CharacterSet) -> ok when + This::wxStyledTextCtrl(), CharacterSet::string(). autoCompStops(#wx_ref{type=ThisT,ref=ThisRef},CharacterSet) when is_list(CharacterSet) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1053,23 +1176,26 @@ autoCompStops(#wx_ref{type=ThisT,ref=ThisRef},CharacterSet) wxe_util:cast(?wxStyledTextCtrl_AutoCompStops, <>). -%% @spec (This::wxStyledTextCtrl(), SeparatorCharacter::integer()) -> ok %% @doc See external documentation. +-spec autoCompSetSeparator(This, SeparatorCharacter) -> ok when + This::wxStyledTextCtrl(), SeparatorCharacter::integer(). autoCompSetSeparator(#wx_ref{type=ThisT,ref=ThisRef},SeparatorCharacter) when is_integer(SeparatorCharacter) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompSetSeparator, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec autoCompGetSeparator(This) -> integer() when + This::wxStyledTextCtrl(). autoCompGetSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetSeparator, <>). -%% @spec (This::wxStyledTextCtrl(), Text::string()) -> ok %% @doc See external documentation. +-spec autoCompSelect(This, Text) -> ok when + This::wxStyledTextCtrl(), Text::string(). autoCompSelect(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1077,23 +1203,26 @@ autoCompSelect(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxStyledTextCtrl_AutoCompSelect, <>). -%% @spec (This::wxStyledTextCtrl(), Cancel::bool()) -> ok %% @doc See external documentation. +-spec autoCompSetCancelAtStart(This, Cancel) -> ok when + This::wxStyledTextCtrl(), Cancel::boolean(). autoCompSetCancelAtStart(#wx_ref{type=ThisT,ref=ThisRef},Cancel) when is_boolean(Cancel) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompSetCancelAtStart, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec autoCompGetCancelAtStart(This) -> boolean() when + This::wxStyledTextCtrl(). autoCompGetCancelAtStart(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetCancelAtStart, <>). -%% @spec (This::wxStyledTextCtrl(), CharacterSet::string()) -> ok %% @doc See external documentation. +-spec autoCompSetFillUps(This, CharacterSet) -> ok when + This::wxStyledTextCtrl(), CharacterSet::string(). autoCompSetFillUps(#wx_ref{type=ThisT,ref=ThisRef},CharacterSet) when is_list(CharacterSet) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1101,38 +1230,43 @@ autoCompSetFillUps(#wx_ref{type=ThisT,ref=ThisRef},CharacterSet) wxe_util:cast(?wxStyledTextCtrl_AutoCompSetFillUps, <>). -%% @spec (This::wxStyledTextCtrl(), ChooseSingle::bool()) -> ok %% @doc See external documentation. +-spec autoCompSetChooseSingle(This, ChooseSingle) -> ok when + This::wxStyledTextCtrl(), ChooseSingle::boolean(). autoCompSetChooseSingle(#wx_ref{type=ThisT,ref=ThisRef},ChooseSingle) when is_boolean(ChooseSingle) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompSetChooseSingle, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec autoCompGetChooseSingle(This) -> boolean() when + This::wxStyledTextCtrl(). autoCompGetChooseSingle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetChooseSingle, <>). -%% @spec (This::wxStyledTextCtrl(), IgnoreCase::bool()) -> ok %% @doc See external documentation. +-spec autoCompSetIgnoreCase(This, IgnoreCase) -> ok when + This::wxStyledTextCtrl(), IgnoreCase::boolean(). autoCompSetIgnoreCase(#wx_ref{type=ThisT,ref=ThisRef},IgnoreCase) when is_boolean(IgnoreCase) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompSetIgnoreCase, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec autoCompGetIgnoreCase(This) -> boolean() when + This::wxStyledTextCtrl(). autoCompGetIgnoreCase(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetIgnoreCase, <>). -%% @spec (This::wxStyledTextCtrl(), ListType::integer(), ItemList::string()) -> ok %% @doc See external documentation. +-spec userListShow(This, ListType, ItemList) -> ok when + This::wxStyledTextCtrl(), ListType::integer(), ItemList::string(). userListShow(#wx_ref{type=ThisT,ref=ThisRef},ListType,ItemList) when is_integer(ListType),is_list(ItemList) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1140,38 +1274,43 @@ userListShow(#wx_ref{type=ThisT,ref=ThisRef},ListType,ItemList) wxe_util:cast(?wxStyledTextCtrl_UserListShow, <>). -%% @spec (This::wxStyledTextCtrl(), AutoHide::bool()) -> ok %% @doc See external documentation. +-spec autoCompSetAutoHide(This, AutoHide) -> ok when + This::wxStyledTextCtrl(), AutoHide::boolean(). autoCompSetAutoHide(#wx_ref{type=ThisT,ref=ThisRef},AutoHide) when is_boolean(AutoHide) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompSetAutoHide, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec autoCompGetAutoHide(This) -> boolean() when + This::wxStyledTextCtrl(). autoCompGetAutoHide(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetAutoHide, <>). -%% @spec (This::wxStyledTextCtrl(), DropRestOfWord::bool()) -> ok %% @doc See external documentation. +-spec autoCompSetDropRestOfWord(This, DropRestOfWord) -> ok when + This::wxStyledTextCtrl(), DropRestOfWord::boolean(). autoCompSetDropRestOfWord(#wx_ref{type=ThisT,ref=ThisRef},DropRestOfWord) when is_boolean(DropRestOfWord) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompSetDropRestOfWord, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec autoCompGetDropRestOfWord(This) -> boolean() when + This::wxStyledTextCtrl(). autoCompGetDropRestOfWord(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetDropRestOfWord, <>). -%% @spec (This::wxStyledTextCtrl(), Type::integer(), Bmp::wxBitmap:wxBitmap()) -> ok %% @doc See external documentation. +-spec registerImage(This, Type, Bmp) -> ok when + This::wxStyledTextCtrl(), Type::integer(), Bmp::wxBitmap:wxBitmap(). registerImage(#wx_ref{type=ThisT,ref=ThisRef},Type,#wx_ref{type=BmpT,ref=BmpRef}) when is_integer(Type) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1179,271 +1318,308 @@ registerImage(#wx_ref{type=ThisT,ref=ThisRef},Type,#wx_ref{type=BmpT,ref=BmpRef} wxe_util:cast(?wxStyledTextCtrl_RegisterImage, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec clearRegisteredImages(This) -> ok when + This::wxStyledTextCtrl(). clearRegisteredImages(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ClearRegisteredImages, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec autoCompGetTypeSeparator(This) -> integer() when + This::wxStyledTextCtrl(). autoCompGetTypeSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetTypeSeparator, <>). -%% @spec (This::wxStyledTextCtrl(), SeparatorCharacter::integer()) -> ok %% @doc See external documentation. +-spec autoCompSetTypeSeparator(This, SeparatorCharacter) -> ok when + This::wxStyledTextCtrl(), SeparatorCharacter::integer(). autoCompSetTypeSeparator(#wx_ref{type=ThisT,ref=ThisRef},SeparatorCharacter) when is_integer(SeparatorCharacter) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompSetTypeSeparator, <>). -%% @spec (This::wxStyledTextCtrl(), CharacterCount::integer()) -> ok %% @doc See external documentation. +-spec autoCompSetMaxWidth(This, CharacterCount) -> ok when + This::wxStyledTextCtrl(), CharacterCount::integer(). autoCompSetMaxWidth(#wx_ref{type=ThisT,ref=ThisRef},CharacterCount) when is_integer(CharacterCount) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompSetMaxWidth, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec autoCompGetMaxWidth(This) -> integer() when + This::wxStyledTextCtrl(). autoCompGetMaxWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetMaxWidth, <>). -%% @spec (This::wxStyledTextCtrl(), RowCount::integer()) -> ok %% @doc See external documentation. +-spec autoCompSetMaxHeight(This, RowCount) -> ok when + This::wxStyledTextCtrl(), RowCount::integer(). autoCompSetMaxHeight(#wx_ref{type=ThisT,ref=ThisRef},RowCount) when is_integer(RowCount) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_AutoCompSetMaxHeight, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec autoCompGetMaxHeight(This) -> integer() when + This::wxStyledTextCtrl(). autoCompGetMaxHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetMaxHeight, <>). -%% @spec (This::wxStyledTextCtrl(), IndentSize::integer()) -> ok %% @doc See external documentation. +-spec setIndent(This, IndentSize) -> ok when + This::wxStyledTextCtrl(), IndentSize::integer(). setIndent(#wx_ref{type=ThisT,ref=ThisRef},IndentSize) when is_integer(IndentSize) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetIndent, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getIndent(This) -> integer() when + This::wxStyledTextCtrl(). getIndent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetIndent, <>). -%% @spec (This::wxStyledTextCtrl(), UseTabs::bool()) -> ok %% @doc See external documentation. +-spec setUseTabs(This, UseTabs) -> ok when + This::wxStyledTextCtrl(), UseTabs::boolean(). setUseTabs(#wx_ref{type=ThisT,ref=ThisRef},UseTabs) when is_boolean(UseTabs) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetUseTabs, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getUseTabs(This) -> boolean() when + This::wxStyledTextCtrl(). getUseTabs(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetUseTabs, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer(), IndentSize::integer()) -> ok %% @doc See external documentation. +-spec setLineIndentation(This, Line, IndentSize) -> ok when + This::wxStyledTextCtrl(), Line::integer(), IndentSize::integer(). setLineIndentation(#wx_ref{type=ThisT,ref=ThisRef},Line,IndentSize) when is_integer(Line),is_integer(IndentSize) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetLineIndentation, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec getLineIndentation(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). getLineIndentation(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLineIndentation, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec getLineIndentPosition(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). getLineIndentPosition(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLineIndentPosition, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> integer() %% @doc See external documentation. +-spec getColumn(This, Pos) -> integer() when + This::wxStyledTextCtrl(), Pos::integer(). getColumn(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetColumn, <>). -%% @spec (This::wxStyledTextCtrl(), Show::bool()) -> ok %% @doc See external documentation. +-spec setUseHorizontalScrollBar(This, Show) -> ok when + This::wxStyledTextCtrl(), Show::boolean(). setUseHorizontalScrollBar(#wx_ref{type=ThisT,ref=ThisRef},Show) when is_boolean(Show) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetUseHorizontalScrollBar, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getUseHorizontalScrollBar(This) -> boolean() when + This::wxStyledTextCtrl(). getUseHorizontalScrollBar(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetUseHorizontalScrollBar, <>). -%% @spec (This::wxStyledTextCtrl(), Show::bool()) -> ok %% @doc See external documentation. +-spec setIndentationGuides(This, Show) -> ok when + This::wxStyledTextCtrl(), Show::boolean(). setIndentationGuides(#wx_ref{type=ThisT,ref=ThisRef},Show) when is_boolean(Show) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetIndentationGuides, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getIndentationGuides(This) -> boolean() when + This::wxStyledTextCtrl(). getIndentationGuides(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetIndentationGuides, <>). -%% @spec (This::wxStyledTextCtrl(), Column::integer()) -> ok %% @doc See external documentation. +-spec setHighlightGuide(This, Column) -> ok when + This::wxStyledTextCtrl(), Column::integer(). setHighlightGuide(#wx_ref{type=ThisT,ref=ThisRef},Column) when is_integer(Column) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetHighlightGuide, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getHighlightGuide(This) -> integer() when + This::wxStyledTextCtrl(). getHighlightGuide(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetHighlightGuide, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec getLineEndPosition(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). getLineEndPosition(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLineEndPosition, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getCodePage(This) -> integer() when + This::wxStyledTextCtrl(). getCodePage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCodePage, <>). -%% @spec (This::wxStyledTextCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getCaretForeground(This) -> wx:wx_colour() when + This::wxStyledTextCtrl(). getCaretForeground(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCaretForeground, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getReadOnly(This) -> boolean() when + This::wxStyledTextCtrl(). getReadOnly(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetReadOnly, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setCurrentPos(This, Pos) -> ok when + This::wxStyledTextCtrl(), Pos::integer(). setCurrentPos(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCurrentPos, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setSelectionStart(This, Pos) -> ok when + This::wxStyledTextCtrl(), Pos::integer(). setSelectionStart(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSelectionStart, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getSelectionStart(This) -> integer() when + This::wxStyledTextCtrl(). getSelectionStart(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSelectionStart, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setSelectionEnd(This, Pos) -> ok when + This::wxStyledTextCtrl(), Pos::integer(). setSelectionEnd(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSelectionEnd, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getSelectionEnd(This) -> integer() when + This::wxStyledTextCtrl(). getSelectionEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSelectionEnd, <>). -%% @spec (This::wxStyledTextCtrl(), Magnification::integer()) -> ok %% @doc See external documentation. +-spec setPrintMagnification(This, Magnification) -> ok when + This::wxStyledTextCtrl(), Magnification::integer(). setPrintMagnification(#wx_ref{type=ThisT,ref=ThisRef},Magnification) when is_integer(Magnification) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetPrintMagnification, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getPrintMagnification(This) -> integer() when + This::wxStyledTextCtrl(). getPrintMagnification(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetPrintMagnification, <>). -%% @spec (This::wxStyledTextCtrl(), Mode::integer()) -> ok %% @doc See external documentation. +-spec setPrintColourMode(This, Mode) -> ok when + This::wxStyledTextCtrl(), Mode::integer(). setPrintColourMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) when is_integer(Mode) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetPrintColourMode, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getPrintColourMode(This) -> integer() when + This::wxStyledTextCtrl(). getPrintColourMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetPrintColourMode, <>). -%% @spec (This::wxStyledTextCtrl(), MinPos::integer(), MaxPos::integer(), Text::string()) -> integer() %% @equiv findText(This,MinPos,MaxPos,Text, []) +-spec findText(This, MinPos, MaxPos, Text) -> integer() when + This::wxStyledTextCtrl(), MinPos::integer(), MaxPos::integer(), Text::string(). + findText(This,MinPos,MaxPos,Text) when is_record(This, wx_ref),is_integer(MinPos),is_integer(MaxPos),is_list(Text) -> findText(This,MinPos,MaxPos,Text, []). -%% @spec (This::wxStyledTextCtrl(), MinPos::integer(), MaxPos::integer(), Text::string(), [Option]) -> integer() -%% Option = {flags, integer()} %% @doc See external documentation. +-spec findText(This, MinPos, MaxPos, Text, [Option]) -> integer() when + This::wxStyledTextCtrl(), MinPos::integer(), MaxPos::integer(), Text::string(), + Option :: {flags, integer()}. findText(#wx_ref{type=ThisT,ref=ThisRef},MinPos,MaxPos,Text, Options) when is_integer(MinPos),is_integer(MaxPos),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1454,8 +1630,9 @@ findText(#wx_ref{type=ThisT,ref=ThisRef},MinPos,MaxPos,Text, Options) wxe_util:call(?wxStyledTextCtrl_FindText, <>). -%% @spec (This::wxStyledTextCtrl(), DoDraw::bool(), StartPos::integer(), EndPos::integer(), Draw::wxDC:wxDC(), Target::wxDC:wxDC(), RenderRect::{X::integer(), Y::integer(), W::integer(), H::integer()}, PageRect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> integer() %% @doc See external documentation. +-spec formatRange(This, DoDraw, StartPos, EndPos, Draw, Target, RenderRect, PageRect) -> integer() when + This::wxStyledTextCtrl(), DoDraw::boolean(), StartPos::integer(), EndPos::integer(), Draw::wxDC:wxDC(), Target::wxDC:wxDC(), RenderRect::{X::integer(), Y::integer(), W::integer(), H::integer()}, PageRect::{X::integer(), Y::integer(), W::integer(), H::integer()}. formatRange(#wx_ref{type=ThisT,ref=ThisRef},DoDraw,StartPos,EndPos,#wx_ref{type=DrawT,ref=DrawRef},#wx_ref{type=TargetT,ref=TargetRef},{RenderRectX,RenderRectY,RenderRectW,RenderRectH},{PageRectX,PageRectY,PageRectW,PageRectH}) when is_boolean(DoDraw),is_integer(StartPos),is_integer(EndPos),is_integer(RenderRectX),is_integer(RenderRectY),is_integer(RenderRectW),is_integer(RenderRectH),is_integer(PageRectX),is_integer(PageRectY),is_integer(PageRectW),is_integer(PageRectH) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1464,129 +1641,146 @@ formatRange(#wx_ref{type=ThisT,ref=ThisRef},DoDraw,StartPos,EndPos,#wx_ref{type= wxe_util:call(?wxStyledTextCtrl_FormatRange, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getFirstVisibleLine(This) -> integer() when + This::wxStyledTextCtrl(). getFirstVisibleLine(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetFirstVisibleLine, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> string() %% @doc See external documentation. +-spec getLine(This, Line) -> string() when + This::wxStyledTextCtrl(), Line::integer(). getLine(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLine, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getLineCount(This) -> integer() when + This::wxStyledTextCtrl(). getLineCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLineCount, <>). -%% @spec (This::wxStyledTextCtrl(), PixelWidth::integer()) -> ok %% @doc See external documentation. +-spec setMarginLeft(This, PixelWidth) -> ok when + This::wxStyledTextCtrl(), PixelWidth::integer(). setMarginLeft(#wx_ref{type=ThisT,ref=ThisRef},PixelWidth) when is_integer(PixelWidth) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetMarginLeft, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getMarginLeft(This) -> integer() when + This::wxStyledTextCtrl(). getMarginLeft(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetMarginLeft, <>). -%% @spec (This::wxStyledTextCtrl(), PixelWidth::integer()) -> ok %% @doc See external documentation. +-spec setMarginRight(This, PixelWidth) -> ok when + This::wxStyledTextCtrl(), PixelWidth::integer(). setMarginRight(#wx_ref{type=ThisT,ref=ThisRef},PixelWidth) when is_integer(PixelWidth) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetMarginRight, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getMarginRight(This) -> integer() when + This::wxStyledTextCtrl(). getMarginRight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetMarginRight, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getModify(This) -> boolean() when + This::wxStyledTextCtrl(). getModify(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetModify, <>). -%% @spec (This::wxStyledTextCtrl(), Start::integer(), End::integer()) -> ok %% @doc See external documentation. +-spec setSelection(This, Start, End) -> ok when + This::wxStyledTextCtrl(), Start::integer(), End::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},Start,End) when is_integer(Start),is_integer(End) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSelection, <>). -%% @spec (This::wxStyledTextCtrl()) -> string() %% @doc See external documentation. +-spec getSelectedText(This) -> string() when + This::wxStyledTextCtrl(). getSelectedText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSelectedText, <>). -%% @spec (This::wxStyledTextCtrl(), StartPos::integer(), EndPos::integer()) -> string() %% @doc See external documentation. +-spec getTextRange(This, StartPos, EndPos) -> string() when + This::wxStyledTextCtrl(), StartPos::integer(), EndPos::integer(). getTextRange(#wx_ref{type=ThisT,ref=ThisRef},StartPos,EndPos) when is_integer(StartPos),is_integer(EndPos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetTextRange, <>). -%% @spec (This::wxStyledTextCtrl(), Normal::bool()) -> ok %% @doc See external documentation. +-spec hideSelection(This, Normal) -> ok when + This::wxStyledTextCtrl(), Normal::boolean(). hideSelection(#wx_ref{type=ThisT,ref=ThisRef},Normal) when is_boolean(Normal) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_HideSelection, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> integer() %% @doc See external documentation. +-spec lineFromPosition(This, Pos) -> integer() when + This::wxStyledTextCtrl(), Pos::integer(). lineFromPosition(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_LineFromPosition, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec positionFromLine(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). positionFromLine(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_PositionFromLine, <>). -%% @spec (This::wxStyledTextCtrl(), Columns::integer(), Lines::integer()) -> ok %% @doc See external documentation. +-spec lineScroll(This, Columns, Lines) -> ok when + This::wxStyledTextCtrl(), Columns::integer(), Lines::integer(). lineScroll(#wx_ref{type=ThisT,ref=ThisRef},Columns,Lines) when is_integer(Columns),is_integer(Lines) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineScroll, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec ensureCaretVisible(This) -> ok when + This::wxStyledTextCtrl(). ensureCaretVisible(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_EnsureCaretVisible, <>). -%% @spec (This::wxStyledTextCtrl(), Text::string()) -> ok %% @doc See external documentation. +-spec replaceSelection(This, Text) -> ok when + This::wxStyledTextCtrl(), Text::string(). replaceSelection(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1594,72 +1788,82 @@ replaceSelection(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxStyledTextCtrl_ReplaceSelection, <>). -%% @spec (This::wxStyledTextCtrl(), ReadOnly::bool()) -> ok %% @doc See external documentation. +-spec setReadOnly(This, ReadOnly) -> ok when + This::wxStyledTextCtrl(), ReadOnly::boolean(). setReadOnly(#wx_ref{type=ThisT,ref=ThisRef},ReadOnly) when is_boolean(ReadOnly) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetReadOnly, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec canPaste(This) -> boolean() when + This::wxStyledTextCtrl(). canPaste(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_CanPaste, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec canUndo(This) -> boolean() when + This::wxStyledTextCtrl(). canUndo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_CanUndo, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec emptyUndoBuffer(This) -> ok when + This::wxStyledTextCtrl(). emptyUndoBuffer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_EmptyUndoBuffer, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec undo(This) -> ok when + This::wxStyledTextCtrl(). undo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Undo, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec cut(This) -> ok when + This::wxStyledTextCtrl(). cut(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Cut, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec copy(This) -> ok when + This::wxStyledTextCtrl(). copy(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Copy, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec paste(This) -> ok when + This::wxStyledTextCtrl(). paste(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Paste, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec clear(This) -> ok when + This::wxStyledTextCtrl(). clear(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Clear, <>). -%% @spec (This::wxStyledTextCtrl(), Text::string()) -> ok %% @doc See external documentation. +-spec setText(This, Text) -> ok when + This::wxStyledTextCtrl(), Text::string(). setText(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1667,74 +1871,84 @@ setText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxStyledTextCtrl_SetText, <>). -%% @spec (This::wxStyledTextCtrl()) -> string() %% @doc See external documentation. +-spec getText(This) -> string() when + This::wxStyledTextCtrl(). getText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetText, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getTextLength(This) -> integer() when + This::wxStyledTextCtrl(). getTextLength(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetTextLength, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getOvertype(This) -> boolean() when + This::wxStyledTextCtrl(). getOvertype(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetOvertype, <>). -%% @spec (This::wxStyledTextCtrl(), PixelWidth::integer()) -> ok %% @doc See external documentation. +-spec setCaretWidth(This, PixelWidth) -> ok when + This::wxStyledTextCtrl(), PixelWidth::integer(). setCaretWidth(#wx_ref{type=ThisT,ref=ThisRef},PixelWidth) when is_integer(PixelWidth) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCaretWidth, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getCaretWidth(This) -> integer() when + This::wxStyledTextCtrl(). getCaretWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCaretWidth, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setTargetStart(This, Pos) -> ok when + This::wxStyledTextCtrl(), Pos::integer(). setTargetStart(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetTargetStart, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getTargetStart(This) -> integer() when + This::wxStyledTextCtrl(). getTargetStart(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetTargetStart, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setTargetEnd(This, Pos) -> ok when + This::wxStyledTextCtrl(), Pos::integer(). setTargetEnd(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetTargetEnd, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getTargetEnd(This) -> integer() when + This::wxStyledTextCtrl(). getTargetEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetTargetEnd, <>). -%% @spec (This::wxStyledTextCtrl(), Text::string()) -> integer() %% @doc See external documentation. +-spec replaceTarget(This, Text) -> integer() when + This::wxStyledTextCtrl(), Text::string(). replaceTarget(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1742,8 +1956,9 @@ replaceTarget(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:call(?wxStyledTextCtrl_ReplaceTarget, <>). -%% @spec (This::wxStyledTextCtrl(), Text::string()) -> integer() %% @doc See external documentation. +-spec searchInTarget(This, Text) -> integer() when + This::wxStyledTextCtrl(), Text::string(). searchInTarget(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1751,23 +1966,26 @@ searchInTarget(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:call(?wxStyledTextCtrl_SearchInTarget, <>). -%% @spec (This::wxStyledTextCtrl(), Flags::integer()) -> ok %% @doc See external documentation. +-spec setSearchFlags(This, Flags) -> ok when + This::wxStyledTextCtrl(), Flags::integer(). setSearchFlags(#wx_ref{type=ThisT,ref=ThisRef},Flags) when is_integer(Flags) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSearchFlags, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getSearchFlags(This) -> integer() when + This::wxStyledTextCtrl(). getSearchFlags(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSearchFlags, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer(), Definition::string()) -> ok %% @doc See external documentation. +-spec callTipShow(This, Pos, Definition) -> ok when + This::wxStyledTextCtrl(), Pos::integer(), Definition::string(). callTipShow(#wx_ref{type=ThisT,ref=ThisRef},Pos,Definition) when is_integer(Pos),is_list(Definition) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -1775,348 +1993,393 @@ callTipShow(#wx_ref{type=ThisT,ref=ThisRef},Pos,Definition) wxe_util:cast(?wxStyledTextCtrl_CallTipShow, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec callTipCancel(This) -> ok when + This::wxStyledTextCtrl(). callTipCancel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CallTipCancel, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec callTipActive(This) -> boolean() when + This::wxStyledTextCtrl(). callTipActive(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_CallTipActive, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec callTipPosAtStart(This) -> integer() when + This::wxStyledTextCtrl(). callTipPosAtStart(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_CallTipPosAtStart, <>). -%% @spec (This::wxStyledTextCtrl(), Start::integer(), End::integer()) -> ok %% @doc See external documentation. +-spec callTipSetHighlight(This, Start, End) -> ok when + This::wxStyledTextCtrl(), Start::integer(), End::integer(). callTipSetHighlight(#wx_ref{type=ThisT,ref=ThisRef},Start,End) when is_integer(Start),is_integer(End) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CallTipSetHighlight, <>). -%% @spec (This::wxStyledTextCtrl(), Back::wx:colour()) -> ok %% @doc See external documentation. +-spec callTipSetBackground(This, Back) -> ok when + This::wxStyledTextCtrl(), Back::wx:wx_colour(). callTipSetBackground(#wx_ref{type=ThisT,ref=ThisRef},Back) when tuple_size(Back) =:= 3; tuple_size(Back) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CallTipSetBackground, <>). -%% @spec (This::wxStyledTextCtrl(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec callTipSetForeground(This, Fore) -> ok when + This::wxStyledTextCtrl(), Fore::wx:wx_colour(). callTipSetForeground(#wx_ref{type=ThisT,ref=ThisRef},Fore) when tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CallTipSetForeground, <>). -%% @spec (This::wxStyledTextCtrl(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec callTipSetForegroundHighlight(This, Fore) -> ok when + This::wxStyledTextCtrl(), Fore::wx:wx_colour(). callTipSetForegroundHighlight(#wx_ref{type=ThisT,ref=ThisRef},Fore) when tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CallTipSetForegroundHighlight, <>). -%% @spec (This::wxStyledTextCtrl(), TabSize::integer()) -> ok %% @doc See external documentation. +-spec callTipUseStyle(This, TabSize) -> ok when + This::wxStyledTextCtrl(), TabSize::integer(). callTipUseStyle(#wx_ref{type=ThisT,ref=ThisRef},TabSize) when is_integer(TabSize) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CallTipUseStyle, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec visibleFromDocLine(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). visibleFromDocLine(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_VisibleFromDocLine, <>). -%% @spec (This::wxStyledTextCtrl(), LineDisplay::integer()) -> integer() %% @doc See external documentation. +-spec docLineFromVisible(This, LineDisplay) -> integer() when + This::wxStyledTextCtrl(), LineDisplay::integer(). docLineFromVisible(#wx_ref{type=ThisT,ref=ThisRef},LineDisplay) when is_integer(LineDisplay) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_DocLineFromVisible, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec wrapCount(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). wrapCount(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_WrapCount, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer(), Level::integer()) -> ok %% @doc See external documentation. +-spec setFoldLevel(This, Line, Level) -> ok when + This::wxStyledTextCtrl(), Line::integer(), Level::integer(). setFoldLevel(#wx_ref{type=ThisT,ref=ThisRef},Line,Level) when is_integer(Line),is_integer(Level) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetFoldLevel, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec getFoldLevel(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). getFoldLevel(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetFoldLevel, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer(), Level::integer()) -> integer() %% @doc See external documentation. +-spec getLastChild(This, Line, Level) -> integer() when + This::wxStyledTextCtrl(), Line::integer(), Level::integer(). getLastChild(#wx_ref{type=ThisT,ref=ThisRef},Line,Level) when is_integer(Line),is_integer(Level) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLastChild, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec getFoldParent(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). getFoldParent(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetFoldParent, <>). -%% @spec (This::wxStyledTextCtrl(), LineStart::integer(), LineEnd::integer()) -> ok %% @doc See external documentation. +-spec showLines(This, LineStart, LineEnd) -> ok when + This::wxStyledTextCtrl(), LineStart::integer(), LineEnd::integer(). showLines(#wx_ref{type=ThisT,ref=ThisRef},LineStart,LineEnd) when is_integer(LineStart),is_integer(LineEnd) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ShowLines, <>). -%% @spec (This::wxStyledTextCtrl(), LineStart::integer(), LineEnd::integer()) -> ok %% @doc See external documentation. +-spec hideLines(This, LineStart, LineEnd) -> ok when + This::wxStyledTextCtrl(), LineStart::integer(), LineEnd::integer(). hideLines(#wx_ref{type=ThisT,ref=ThisRef},LineStart,LineEnd) when is_integer(LineStart),is_integer(LineEnd) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_HideLines, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> bool() %% @doc See external documentation. +-spec getLineVisible(This, Line) -> boolean() when + This::wxStyledTextCtrl(), Line::integer(). getLineVisible(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLineVisible, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer(), Expanded::bool()) -> ok %% @doc See external documentation. +-spec setFoldExpanded(This, Line, Expanded) -> ok when + This::wxStyledTextCtrl(), Line::integer(), Expanded::boolean(). setFoldExpanded(#wx_ref{type=ThisT,ref=ThisRef},Line,Expanded) when is_integer(Line),is_boolean(Expanded) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetFoldExpanded, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> bool() %% @doc See external documentation. +-spec getFoldExpanded(This, Line) -> boolean() when + This::wxStyledTextCtrl(), Line::integer(). getFoldExpanded(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetFoldExpanded, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> ok %% @doc See external documentation. +-spec toggleFold(This, Line) -> ok when + This::wxStyledTextCtrl(), Line::integer(). toggleFold(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ToggleFold, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> ok %% @doc See external documentation. +-spec ensureVisible(This, Line) -> ok when + This::wxStyledTextCtrl(), Line::integer(). ensureVisible(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_EnsureVisible, <>). -%% @spec (This::wxStyledTextCtrl(), Flags::integer()) -> ok %% @doc See external documentation. +-spec setFoldFlags(This, Flags) -> ok when + This::wxStyledTextCtrl(), Flags::integer(). setFoldFlags(#wx_ref{type=ThisT,ref=ThisRef},Flags) when is_integer(Flags) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetFoldFlags, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> ok %% @doc See external documentation. +-spec ensureVisibleEnforcePolicy(This, Line) -> ok when + This::wxStyledTextCtrl(), Line::integer(). ensureVisibleEnforcePolicy(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_EnsureVisibleEnforcePolicy, <>). -%% @spec (This::wxStyledTextCtrl(), TabIndents::bool()) -> ok %% @doc See external documentation. +-spec setTabIndents(This, TabIndents) -> ok when + This::wxStyledTextCtrl(), TabIndents::boolean(). setTabIndents(#wx_ref{type=ThisT,ref=ThisRef},TabIndents) when is_boolean(TabIndents) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetTabIndents, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getTabIndents(This) -> boolean() when + This::wxStyledTextCtrl(). getTabIndents(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetTabIndents, <>). -%% @spec (This::wxStyledTextCtrl(), BsUnIndents::bool()) -> ok %% @doc See external documentation. +-spec setBackSpaceUnIndents(This, BsUnIndents) -> ok when + This::wxStyledTextCtrl(), BsUnIndents::boolean(). setBackSpaceUnIndents(#wx_ref{type=ThisT,ref=ThisRef},BsUnIndents) when is_boolean(BsUnIndents) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetBackSpaceUnIndents, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getBackSpaceUnIndents(This) -> boolean() when + This::wxStyledTextCtrl(). getBackSpaceUnIndents(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetBackSpaceUnIndents, <>). -%% @spec (This::wxStyledTextCtrl(), PeriodMilliseconds::integer()) -> ok %% @doc See external documentation. +-spec setMouseDwellTime(This, PeriodMilliseconds) -> ok when + This::wxStyledTextCtrl(), PeriodMilliseconds::integer(). setMouseDwellTime(#wx_ref{type=ThisT,ref=ThisRef},PeriodMilliseconds) when is_integer(PeriodMilliseconds) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetMouseDwellTime, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getMouseDwellTime(This) -> integer() when + This::wxStyledTextCtrl(). getMouseDwellTime(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetMouseDwellTime, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer(), OnlyWordCharacters::bool()) -> integer() %% @doc See external documentation. +-spec wordStartPosition(This, Pos, OnlyWordCharacters) -> integer() when + This::wxStyledTextCtrl(), Pos::integer(), OnlyWordCharacters::boolean(). wordStartPosition(#wx_ref{type=ThisT,ref=ThisRef},Pos,OnlyWordCharacters) when is_integer(Pos),is_boolean(OnlyWordCharacters) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_WordStartPosition, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer(), OnlyWordCharacters::bool()) -> integer() %% @doc See external documentation. +-spec wordEndPosition(This, Pos, OnlyWordCharacters) -> integer() when + This::wxStyledTextCtrl(), Pos::integer(), OnlyWordCharacters::boolean(). wordEndPosition(#wx_ref{type=ThisT,ref=ThisRef},Pos,OnlyWordCharacters) when is_integer(Pos),is_boolean(OnlyWordCharacters) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_WordEndPosition, <>). -%% @spec (This::wxStyledTextCtrl(), Mode::integer()) -> ok %% @doc See external documentation. +-spec setWrapMode(This, Mode) -> ok when + This::wxStyledTextCtrl(), Mode::integer(). setWrapMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) when is_integer(Mode) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetWrapMode, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getWrapMode(This) -> integer() when + This::wxStyledTextCtrl(). getWrapMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetWrapMode, <>). -%% @spec (This::wxStyledTextCtrl(), WrapVisualFlags::integer()) -> ok %% @doc See external documentation. +-spec setWrapVisualFlags(This, WrapVisualFlags) -> ok when + This::wxStyledTextCtrl(), WrapVisualFlags::integer(). setWrapVisualFlags(#wx_ref{type=ThisT,ref=ThisRef},WrapVisualFlags) when is_integer(WrapVisualFlags) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetWrapVisualFlags, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getWrapVisualFlags(This) -> integer() when + This::wxStyledTextCtrl(). getWrapVisualFlags(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetWrapVisualFlags, <>). -%% @spec (This::wxStyledTextCtrl(), WrapVisualFlagsLocation::integer()) -> ok %% @doc See external documentation. +-spec setWrapVisualFlagsLocation(This, WrapVisualFlagsLocation) -> ok when + This::wxStyledTextCtrl(), WrapVisualFlagsLocation::integer(). setWrapVisualFlagsLocation(#wx_ref{type=ThisT,ref=ThisRef},WrapVisualFlagsLocation) when is_integer(WrapVisualFlagsLocation) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetWrapVisualFlagsLocation, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getWrapVisualFlagsLocation(This) -> integer() when + This::wxStyledTextCtrl(). getWrapVisualFlagsLocation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetWrapVisualFlagsLocation, <>). -%% @spec (This::wxStyledTextCtrl(), Indent::integer()) -> ok %% @doc See external documentation. +-spec setWrapStartIndent(This, Indent) -> ok when + This::wxStyledTextCtrl(), Indent::integer(). setWrapStartIndent(#wx_ref{type=ThisT,ref=ThisRef},Indent) when is_integer(Indent) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetWrapStartIndent, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getWrapStartIndent(This) -> integer() when + This::wxStyledTextCtrl(). getWrapStartIndent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetWrapStartIndent, <>). -%% @spec (This::wxStyledTextCtrl(), Mode::integer()) -> ok %% @doc See external documentation. +-spec setLayoutCache(This, Mode) -> ok when + This::wxStyledTextCtrl(), Mode::integer(). setLayoutCache(#wx_ref{type=ThisT,ref=ThisRef},Mode) when is_integer(Mode) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetLayoutCache, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getLayoutCache(This) -> integer() when + This::wxStyledTextCtrl(). getLayoutCache(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLayoutCache, <>). -%% @spec (This::wxStyledTextCtrl(), PixelWidth::integer()) -> ok %% @doc See external documentation. +-spec setScrollWidth(This, PixelWidth) -> ok when + This::wxStyledTextCtrl(), PixelWidth::integer(). setScrollWidth(#wx_ref{type=ThisT,ref=ThisRef},PixelWidth) when is_integer(PixelWidth) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetScrollWidth, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getScrollWidth(This) -> integer() when + This::wxStyledTextCtrl(). getScrollWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetScrollWidth, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Text::string()) -> integer() %% @doc See external documentation. +-spec textWidth(This, Style, Text) -> integer() when + This::wxStyledTextCtrl(), Style::integer(), Text::string(). textWidth(#wx_ref{type=ThisT,ref=ThisRef},Style,Text) when is_integer(Style),is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -2124,38 +2387,43 @@ textWidth(#wx_ref{type=ThisT,ref=ThisRef},Style,Text) wxe_util:call(?wxStyledTextCtrl_TextWidth, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getEndAtLastLine(This) -> boolean() when + This::wxStyledTextCtrl(). getEndAtLastLine(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetEndAtLastLine, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec textHeight(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). textHeight(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_TextHeight, <>). -%% @spec (This::wxStyledTextCtrl(), Show::bool()) -> ok %% @doc See external documentation. +-spec setUseVerticalScrollBar(This, Show) -> ok when + This::wxStyledTextCtrl(), Show::boolean(). setUseVerticalScrollBar(#wx_ref{type=ThisT,ref=ThisRef},Show) when is_boolean(Show) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetUseVerticalScrollBar, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getUseVerticalScrollBar(This) -> boolean() when + This::wxStyledTextCtrl(). getUseVerticalScrollBar(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetUseVerticalScrollBar, <>). -%% @spec (This::wxStyledTextCtrl(), Text::string()) -> ok %% @doc See external documentation. +-spec appendText(This, Text) -> ok when + This::wxStyledTextCtrl(), Text::string(). appendText(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -2163,559 +2431,637 @@ appendText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxStyledTextCtrl_AppendText, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getTwoPhaseDraw(This) -> boolean() when + This::wxStyledTextCtrl(). getTwoPhaseDraw(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetTwoPhaseDraw, <>). -%% @spec (This::wxStyledTextCtrl(), TwoPhase::bool()) -> ok %% @doc See external documentation. +-spec setTwoPhaseDraw(This, TwoPhase) -> ok when + This::wxStyledTextCtrl(), TwoPhase::boolean(). setTwoPhaseDraw(#wx_ref{type=ThisT,ref=ThisRef},TwoPhase) when is_boolean(TwoPhase) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetTwoPhaseDraw, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec targetFromSelection(This) -> ok when + This::wxStyledTextCtrl(). targetFromSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_TargetFromSelection, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec linesJoin(This) -> ok when + This::wxStyledTextCtrl(). linesJoin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LinesJoin, <>). -%% @spec (This::wxStyledTextCtrl(), PixelWidth::integer()) -> ok %% @doc See external documentation. +-spec linesSplit(This, PixelWidth) -> ok when + This::wxStyledTextCtrl(), PixelWidth::integer(). linesSplit(#wx_ref{type=ThisT,ref=ThisRef},PixelWidth) when is_integer(PixelWidth) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LinesSplit, <>). -%% @spec (This::wxStyledTextCtrl(), UseSetting::bool(), Back::wx:colour()) -> ok %% @doc See external documentation. +-spec setFoldMarginColour(This, UseSetting, Back) -> ok when + This::wxStyledTextCtrl(), UseSetting::boolean(), Back::wx:wx_colour(). setFoldMarginColour(#wx_ref{type=ThisT,ref=ThisRef},UseSetting,Back) when is_boolean(UseSetting),tuple_size(Back) =:= 3; tuple_size(Back) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetFoldMarginColour, <>). -%% @spec (This::wxStyledTextCtrl(), UseSetting::bool(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec setFoldMarginHiColour(This, UseSetting, Fore) -> ok when + This::wxStyledTextCtrl(), UseSetting::boolean(), Fore::wx:wx_colour(). setFoldMarginHiColour(#wx_ref{type=ThisT,ref=ThisRef},UseSetting,Fore) when is_boolean(UseSetting),tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetFoldMarginHiColour, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineDown(This) -> ok when + This::wxStyledTextCtrl(). lineDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineDown, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineDownExtend(This) -> ok when + This::wxStyledTextCtrl(). lineDownExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineDownExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineUp(This) -> ok when + This::wxStyledTextCtrl(). lineUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineUp, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineUpExtend(This) -> ok when + This::wxStyledTextCtrl(). lineUpExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineUpExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec charLeft(This) -> ok when + This::wxStyledTextCtrl(). charLeft(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CharLeft, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec charLeftExtend(This) -> ok when + This::wxStyledTextCtrl(). charLeftExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CharLeftExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec charRight(This) -> ok when + This::wxStyledTextCtrl(). charRight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CharRight, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec charRightExtend(This) -> ok when + This::wxStyledTextCtrl(). charRightExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CharRightExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordLeft(This) -> ok when + This::wxStyledTextCtrl(). wordLeft(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordLeft, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordLeftExtend(This) -> ok when + This::wxStyledTextCtrl(). wordLeftExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordLeftExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordRight(This) -> ok when + This::wxStyledTextCtrl(). wordRight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordRight, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordRightExtend(This) -> ok when + This::wxStyledTextCtrl(). wordRightExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordRightExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec home(This) -> ok when + This::wxStyledTextCtrl(). home(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Home, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec homeExtend(This) -> ok when + This::wxStyledTextCtrl(). homeExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_HomeExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineEnd(This) -> ok when + This::wxStyledTextCtrl(). lineEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineEnd, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineEndExtend(This) -> ok when + This::wxStyledTextCtrl(). lineEndExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineEndExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec documentStart(This) -> ok when + This::wxStyledTextCtrl(). documentStart(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DocumentStart, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec documentStartExtend(This) -> ok when + This::wxStyledTextCtrl(). documentStartExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DocumentStartExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec documentEnd(This) -> ok when + This::wxStyledTextCtrl(). documentEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DocumentEnd, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec documentEndExtend(This) -> ok when + This::wxStyledTextCtrl(). documentEndExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DocumentEndExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec pageUp(This) -> ok when + This::wxStyledTextCtrl(). pageUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_PageUp, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec pageUpExtend(This) -> ok when + This::wxStyledTextCtrl(). pageUpExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_PageUpExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec pageDown(This) -> ok when + This::wxStyledTextCtrl(). pageDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_PageDown, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec pageDownExtend(This) -> ok when + This::wxStyledTextCtrl(). pageDownExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_PageDownExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec editToggleOvertype(This) -> ok when + This::wxStyledTextCtrl(). editToggleOvertype(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_EditToggleOvertype, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec cancel(This) -> ok when + This::wxStyledTextCtrl(). cancel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Cancel, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec deleteBack(This) -> ok when + This::wxStyledTextCtrl(). deleteBack(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DeleteBack, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec tab(This) -> ok when + This::wxStyledTextCtrl(). tab(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Tab, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec backTab(This) -> ok when + This::wxStyledTextCtrl(). backTab(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_BackTab, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec newLine(This) -> ok when + This::wxStyledTextCtrl(). newLine(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_NewLine, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec formFeed(This) -> ok when + This::wxStyledTextCtrl(). formFeed(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_FormFeed, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec vCHome(This) -> ok when + This::wxStyledTextCtrl(). vCHome(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_VCHome, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec vCHomeExtend(This) -> ok when + This::wxStyledTextCtrl(). vCHomeExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_VCHomeExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec zoomIn(This) -> ok when + This::wxStyledTextCtrl(). zoomIn(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ZoomIn, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec zoomOut(This) -> ok when + This::wxStyledTextCtrl(). zoomOut(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ZoomOut, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec delWordLeft(This) -> ok when + This::wxStyledTextCtrl(). delWordLeft(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DelWordLeft, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec delWordRight(This) -> ok when + This::wxStyledTextCtrl(). delWordRight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DelWordRight, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineCut(This) -> ok when + This::wxStyledTextCtrl(). lineCut(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineCut, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineDelete(This) -> ok when + This::wxStyledTextCtrl(). lineDelete(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineDelete, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineTranspose(This) -> ok when + This::wxStyledTextCtrl(). lineTranspose(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineTranspose, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineDuplicate(This) -> ok when + This::wxStyledTextCtrl(). lineDuplicate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineDuplicate, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lowerCase(This) -> ok when + This::wxStyledTextCtrl(). lowerCase(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LowerCase, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec upperCase(This) -> ok when + This::wxStyledTextCtrl(). upperCase(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_UpperCase, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineScrollDown(This) -> ok when + This::wxStyledTextCtrl(). lineScrollDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineScrollDown, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineScrollUp(This) -> ok when + This::wxStyledTextCtrl(). lineScrollUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineScrollUp, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec deleteBackNotLine(This) -> ok when + This::wxStyledTextCtrl(). deleteBackNotLine(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DeleteBackNotLine, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec homeDisplay(This) -> ok when + This::wxStyledTextCtrl(). homeDisplay(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_HomeDisplay, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec homeDisplayExtend(This) -> ok when + This::wxStyledTextCtrl(). homeDisplayExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_HomeDisplayExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineEndDisplay(This) -> ok when + This::wxStyledTextCtrl(). lineEndDisplay(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineEndDisplay, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineEndDisplayExtend(This) -> ok when + This::wxStyledTextCtrl(). lineEndDisplayExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineEndDisplayExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec homeWrapExtend(This) -> ok when + This::wxStyledTextCtrl(). homeWrapExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_HomeWrapExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineEndWrap(This) -> ok when + This::wxStyledTextCtrl(). lineEndWrap(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineEndWrap, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineEndWrapExtend(This) -> ok when + This::wxStyledTextCtrl(). lineEndWrapExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineEndWrapExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec vCHomeWrap(This) -> ok when + This::wxStyledTextCtrl(). vCHomeWrap(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_VCHomeWrap, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec vCHomeWrapExtend(This) -> ok when + This::wxStyledTextCtrl(). vCHomeWrapExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_VCHomeWrapExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineCopy(This) -> ok when + This::wxStyledTextCtrl(). lineCopy(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineCopy, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec moveCaretInsideView(This) -> ok when + This::wxStyledTextCtrl(). moveCaretInsideView(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_MoveCaretInsideView, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> integer() %% @doc See external documentation. +-spec lineLength(This, Line) -> integer() when + This::wxStyledTextCtrl(), Line::integer(). lineLength(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_LineLength, <>). -%% @spec (This::wxStyledTextCtrl(), Pos1::integer(), Pos2::integer()) -> ok %% @doc See external documentation. +-spec braceHighlight(This, Pos1, Pos2) -> ok when + This::wxStyledTextCtrl(), Pos1::integer(), Pos2::integer(). braceHighlight(#wx_ref{type=ThisT,ref=ThisRef},Pos1,Pos2) when is_integer(Pos1),is_integer(Pos2) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_BraceHighlight, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> ok %% @doc See external documentation. +-spec braceBadLight(This, Pos) -> ok when + This::wxStyledTextCtrl(), Pos::integer(). braceBadLight(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_BraceBadLight, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> integer() %% @doc See external documentation. +-spec braceMatch(This, Pos) -> integer() when + This::wxStyledTextCtrl(), Pos::integer(). braceMatch(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_BraceMatch, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getViewEOL(This) -> boolean() when + This::wxStyledTextCtrl(). getViewEOL(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetViewEOL, <>). -%% @spec (This::wxStyledTextCtrl(), Visible::bool()) -> ok %% @doc See external documentation. +-spec setViewEOL(This, Visible) -> ok when + This::wxStyledTextCtrl(), Visible::boolean(). setViewEOL(#wx_ref{type=ThisT,ref=ThisRef},Visible) when is_boolean(Visible) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetViewEOL, <>). -%% @spec (This::wxStyledTextCtrl(), Mask::integer()) -> ok %% @doc See external documentation. +-spec setModEventMask(This, Mask) -> ok when + This::wxStyledTextCtrl(), Mask::integer(). setModEventMask(#wx_ref{type=ThisT,ref=ThisRef},Mask) when is_integer(Mask) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetModEventMask, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getEdgeColumn(This) -> integer() when + This::wxStyledTextCtrl(). getEdgeColumn(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetEdgeColumn, <>). -%% @spec (This::wxStyledTextCtrl(), Column::integer()) -> ok %% @doc See external documentation. +-spec setEdgeColumn(This, Column) -> ok when + This::wxStyledTextCtrl(), Column::integer(). setEdgeColumn(#wx_ref{type=ThisT,ref=ThisRef},Column) when is_integer(Column) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetEdgeColumn, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getEdgeMode(This) -> integer() when + This::wxStyledTextCtrl(). getEdgeMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetEdgeMode, <>). -%% @spec (This::wxStyledTextCtrl()) -> wx:colour() %% @doc See external documentation. +-spec getEdgeColour(This) -> wx:wx_colour() when + This::wxStyledTextCtrl(). getEdgeColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetEdgeColour, <>). -%% @spec (This::wxStyledTextCtrl(), EdgeColour::wx:colour()) -> ok %% @doc See external documentation. +-spec setEdgeColour(This, EdgeColour) -> ok when + This::wxStyledTextCtrl(), EdgeColour::wx:wx_colour(). setEdgeColour(#wx_ref{type=ThisT,ref=ThisRef},EdgeColour) when tuple_size(EdgeColour) =:= 3; tuple_size(EdgeColour) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetEdgeColour, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec searchAnchor(This) -> ok when + This::wxStyledTextCtrl(). searchAnchor(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SearchAnchor, <>). -%% @spec (This::wxStyledTextCtrl(), Flags::integer(), Text::string()) -> integer() %% @doc See external documentation. +-spec searchNext(This, Flags, Text) -> integer() when + This::wxStyledTextCtrl(), Flags::integer(), Text::string(). searchNext(#wx_ref{type=ThisT,ref=ThisRef},Flags,Text) when is_integer(Flags),is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -2723,8 +3069,9 @@ searchNext(#wx_ref{type=ThisT,ref=ThisRef},Flags,Text) wxe_util:call(?wxStyledTextCtrl_SearchNext, <>). -%% @spec (This::wxStyledTextCtrl(), Flags::integer(), Text::string()) -> integer() %% @doc See external documentation. +-spec searchPrev(This, Flags, Text) -> integer() when + This::wxStyledTextCtrl(), Flags::integer(), Text::string(). searchPrev(#wx_ref{type=ThisT,ref=ThisRef},Flags,Text) when is_integer(Flags),is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -2732,291 +3079,330 @@ searchPrev(#wx_ref{type=ThisT,ref=ThisRef},Flags,Text) wxe_util:call(?wxStyledTextCtrl_SearchPrev, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec linesOnScreen(This) -> integer() when + This::wxStyledTextCtrl(). linesOnScreen(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_LinesOnScreen, <>). -%% @spec (This::wxStyledTextCtrl(), AllowPopUp::bool()) -> ok %% @doc See external documentation. +-spec usePopUp(This, AllowPopUp) -> ok when + This::wxStyledTextCtrl(), AllowPopUp::boolean(). usePopUp(#wx_ref{type=ThisT,ref=ThisRef},AllowPopUp) when is_boolean(AllowPopUp) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_UsePopUp, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec selectionIsRectangle(This) -> boolean() when + This::wxStyledTextCtrl(). selectionIsRectangle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_SelectionIsRectangle, <>). -%% @spec (This::wxStyledTextCtrl(), Zoom::integer()) -> ok %% @doc See external documentation. +-spec setZoom(This, Zoom) -> ok when + This::wxStyledTextCtrl(), Zoom::integer(). setZoom(#wx_ref{type=ThisT,ref=ThisRef},Zoom) when is_integer(Zoom) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetZoom, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getZoom(This) -> integer() when + This::wxStyledTextCtrl(). getZoom(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetZoom, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getModEventMask(This) -> integer() when + This::wxStyledTextCtrl(). getModEventMask(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetModEventMask, <>). -%% @spec (This::wxStyledTextCtrl(), Focus::bool()) -> ok %% @doc See external documentation. +-spec setSTCFocus(This, Focus) -> ok when + This::wxStyledTextCtrl(), Focus::boolean(). setSTCFocus(#wx_ref{type=ThisT,ref=ThisRef},Focus) when is_boolean(Focus) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSTCFocus, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getSTCFocus(This) -> boolean() when + This::wxStyledTextCtrl(). getSTCFocus(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSTCFocus, <>). -%% @spec (This::wxStyledTextCtrl(), StatusCode::integer()) -> ok %% @doc See external documentation. +-spec setStatus(This, StatusCode) -> ok when + This::wxStyledTextCtrl(), StatusCode::integer(). setStatus(#wx_ref{type=ThisT,ref=ThisRef},StatusCode) when is_integer(StatusCode) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetStatus, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getStatus(This) -> integer() when + This::wxStyledTextCtrl(). getStatus(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetStatus, <>). -%% @spec (This::wxStyledTextCtrl(), Captures::bool()) -> ok %% @doc See external documentation. +-spec setMouseDownCaptures(This, Captures) -> ok when + This::wxStyledTextCtrl(), Captures::boolean(). setMouseDownCaptures(#wx_ref{type=ThisT,ref=ThisRef},Captures) when is_boolean(Captures) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetMouseDownCaptures, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getMouseDownCaptures(This) -> boolean() when + This::wxStyledTextCtrl(). getMouseDownCaptures(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetMouseDownCaptures, <>). -%% @spec (This::wxStyledTextCtrl(), CursorType::integer()) -> ok %% @doc See external documentation. +-spec setSTCCursor(This, CursorType) -> ok when + This::wxStyledTextCtrl(), CursorType::integer(). setSTCCursor(#wx_ref{type=ThisT,ref=ThisRef},CursorType) when is_integer(CursorType) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSTCCursor, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getSTCCursor(This) -> integer() when + This::wxStyledTextCtrl(). getSTCCursor(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSTCCursor, <>). -%% @spec (This::wxStyledTextCtrl(), Symbol::integer()) -> ok %% @doc See external documentation. +-spec setControlCharSymbol(This, Symbol) -> ok when + This::wxStyledTextCtrl(), Symbol::integer(). setControlCharSymbol(#wx_ref{type=ThisT,ref=ThisRef},Symbol) when is_integer(Symbol) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetControlCharSymbol, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getControlCharSymbol(This) -> integer() when + This::wxStyledTextCtrl(). getControlCharSymbol(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetControlCharSymbol, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordPartLeft(This) -> ok when + This::wxStyledTextCtrl(). wordPartLeft(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordPartLeft, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordPartLeftExtend(This) -> ok when + This::wxStyledTextCtrl(). wordPartLeftExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordPartLeftExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordPartRight(This) -> ok when + This::wxStyledTextCtrl(). wordPartRight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordPartRight, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordPartRightExtend(This) -> ok when + This::wxStyledTextCtrl(). wordPartRightExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordPartRightExtend, <>). -%% @spec (This::wxStyledTextCtrl(), VisiblePolicy::integer(), VisibleSlop::integer()) -> ok %% @doc See external documentation. +-spec setVisiblePolicy(This, VisiblePolicy, VisibleSlop) -> ok when + This::wxStyledTextCtrl(), VisiblePolicy::integer(), VisibleSlop::integer(). setVisiblePolicy(#wx_ref{type=ThisT,ref=ThisRef},VisiblePolicy,VisibleSlop) when is_integer(VisiblePolicy),is_integer(VisibleSlop) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetVisiblePolicy, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec delLineLeft(This) -> ok when + This::wxStyledTextCtrl(). delLineLeft(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DelLineLeft, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec delLineRight(This) -> ok when + This::wxStyledTextCtrl(). delLineRight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_DelLineRight, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getXOffset(This) -> integer() when + This::wxStyledTextCtrl(). getXOffset(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetXOffset, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec chooseCaretX(This) -> ok when + This::wxStyledTextCtrl(). chooseCaretX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ChooseCaretX, <>). -%% @spec (This::wxStyledTextCtrl(), CaretPolicy::integer(), CaretSlop::integer()) -> ok %% @doc See external documentation. +-spec setXCaretPolicy(This, CaretPolicy, CaretSlop) -> ok when + This::wxStyledTextCtrl(), CaretPolicy::integer(), CaretSlop::integer(). setXCaretPolicy(#wx_ref{type=ThisT,ref=ThisRef},CaretPolicy,CaretSlop) when is_integer(CaretPolicy),is_integer(CaretSlop) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetXCaretPolicy, <>). -%% @spec (This::wxStyledTextCtrl(), CaretPolicy::integer(), CaretSlop::integer()) -> ok %% @doc See external documentation. +-spec setYCaretPolicy(This, CaretPolicy, CaretSlop) -> ok when + This::wxStyledTextCtrl(), CaretPolicy::integer(), CaretSlop::integer(). setYCaretPolicy(#wx_ref{type=ThisT,ref=ThisRef},CaretPolicy,CaretSlop) when is_integer(CaretPolicy),is_integer(CaretSlop) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetYCaretPolicy, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getPrintWrapMode(This) -> integer() when + This::wxStyledTextCtrl(). getPrintWrapMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetPrintWrapMode, <>). -%% @spec (This::wxStyledTextCtrl(), UseSetting::bool(), Fore::wx:colour()) -> ok %% @doc See external documentation. +-spec setHotspotActiveForeground(This, UseSetting, Fore) -> ok when + This::wxStyledTextCtrl(), UseSetting::boolean(), Fore::wx:wx_colour(). setHotspotActiveForeground(#wx_ref{type=ThisT,ref=ThisRef},UseSetting,Fore) when is_boolean(UseSetting),tuple_size(Fore) =:= 3; tuple_size(Fore) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetHotspotActiveForeground, <>). -%% @spec (This::wxStyledTextCtrl(), UseSetting::bool(), Back::wx:colour()) -> ok %% @doc See external documentation. +-spec setHotspotActiveBackground(This, UseSetting, Back) -> ok when + This::wxStyledTextCtrl(), UseSetting::boolean(), Back::wx:wx_colour(). setHotspotActiveBackground(#wx_ref{type=ThisT,ref=ThisRef},UseSetting,Back) when is_boolean(UseSetting),tuple_size(Back) =:= 3; tuple_size(Back) =:= 4 -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetHotspotActiveBackground, <>). -%% @spec (This::wxStyledTextCtrl(), Underline::bool()) -> ok %% @doc See external documentation. +-spec setHotspotActiveUnderline(This, Underline) -> ok when + This::wxStyledTextCtrl(), Underline::boolean(). setHotspotActiveUnderline(#wx_ref{type=ThisT,ref=ThisRef},Underline) when is_boolean(Underline) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetHotspotActiveUnderline, <>). -%% @spec (This::wxStyledTextCtrl(), SingleLine::bool()) -> ok %% @doc See external documentation. +-spec setHotspotSingleLine(This, SingleLine) -> ok when + This::wxStyledTextCtrl(), SingleLine::boolean(). setHotspotSingleLine(#wx_ref{type=ThisT,ref=ThisRef},SingleLine) when is_boolean(SingleLine) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetHotspotSingleLine, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec paraDownExtend(This) -> ok when + This::wxStyledTextCtrl(). paraDownExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ParaDownExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec paraUp(This) -> ok when + This::wxStyledTextCtrl(). paraUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ParaUp, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec paraUpExtend(This) -> ok when + This::wxStyledTextCtrl(). paraUpExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ParaUpExtend, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> integer() %% @doc See external documentation. +-spec positionBefore(This, Pos) -> integer() when + This::wxStyledTextCtrl(), Pos::integer(). positionBefore(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_PositionBefore, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> integer() %% @doc See external documentation. +-spec positionAfter(This, Pos) -> integer() when + This::wxStyledTextCtrl(), Pos::integer(). positionAfter(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_PositionAfter, <>). -%% @spec (This::wxStyledTextCtrl(), Start::integer(), End::integer()) -> ok %% @doc See external documentation. +-spec copyRange(This, Start, End) -> ok when + This::wxStyledTextCtrl(), Start::integer(), End::integer(). copyRange(#wx_ref{type=ThisT,ref=ThisRef},Start,End) when is_integer(Start),is_integer(End) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CopyRange, <>). -%% @spec (This::wxStyledTextCtrl(), Length::integer(), Text::string()) -> ok %% @doc See external documentation. +-spec copyText(This, Length, Text) -> ok when + This::wxStyledTextCtrl(), Length::integer(), Text::string(). copyText(#wx_ref{type=ThisT,ref=ThisRef},Length,Text) when is_integer(Length),is_list(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3024,142 +3410,162 @@ copyText(#wx_ref{type=ThisT,ref=ThisRef},Length,Text) wxe_util:cast(?wxStyledTextCtrl_CopyText, <>). -%% @spec (This::wxStyledTextCtrl(), Mode::integer()) -> ok %% @doc See external documentation. +-spec setSelectionMode(This, Mode) -> ok when + This::wxStyledTextCtrl(), Mode::integer(). setSelectionMode(#wx_ref{type=ThisT,ref=ThisRef},Mode) when is_integer(Mode) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetSelectionMode, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getSelectionMode(This) -> integer() when + This::wxStyledTextCtrl(). getSelectionMode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSelectionMode, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineDownRectExtend(This) -> ok when + This::wxStyledTextCtrl(). lineDownRectExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineDownRectExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineUpRectExtend(This) -> ok when + This::wxStyledTextCtrl(). lineUpRectExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineUpRectExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec charLeftRectExtend(This) -> ok when + This::wxStyledTextCtrl(). charLeftRectExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CharLeftRectExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec charRightRectExtend(This) -> ok when + This::wxStyledTextCtrl(). charRightRectExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CharRightRectExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec homeRectExtend(This) -> ok when + This::wxStyledTextCtrl(). homeRectExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_HomeRectExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec vCHomeRectExtend(This) -> ok when + This::wxStyledTextCtrl(). vCHomeRectExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_VCHomeRectExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec lineEndRectExtend(This) -> ok when + This::wxStyledTextCtrl(). lineEndRectExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_LineEndRectExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec pageUpRectExtend(This) -> ok when + This::wxStyledTextCtrl(). pageUpRectExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_PageUpRectExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec pageDownRectExtend(This) -> ok when + This::wxStyledTextCtrl(). pageDownRectExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_PageDownRectExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec stutteredPageUp(This) -> ok when + This::wxStyledTextCtrl(). stutteredPageUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StutteredPageUp, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec stutteredPageUpExtend(This) -> ok when + This::wxStyledTextCtrl(). stutteredPageUpExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StutteredPageUpExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec stutteredPageDown(This) -> ok when + This::wxStyledTextCtrl(). stutteredPageDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StutteredPageDown, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec stutteredPageDownExtend(This) -> ok when + This::wxStyledTextCtrl(). stutteredPageDownExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StutteredPageDownExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordLeftEnd(This) -> ok when + This::wxStyledTextCtrl(). wordLeftEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordLeftEnd, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordLeftEndExtend(This) -> ok when + This::wxStyledTextCtrl(). wordLeftEndExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordLeftEndExtend, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordRightEnd(This) -> ok when + This::wxStyledTextCtrl(). wordRightEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordRightEnd, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec wordRightEndExtend(This) -> ok when + This::wxStyledTextCtrl(). wordRightEndExtend(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_WordRightEndExtend, <>). -%% @spec (This::wxStyledTextCtrl(), Characters::string()) -> ok %% @doc See external documentation. +-spec setWhitespaceChars(This, Characters) -> ok when + This::wxStyledTextCtrl(), Characters::string(). setWhitespaceChars(#wx_ref{type=ThisT,ref=ThisRef},Characters) when is_list(Characters) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3167,134 +3573,152 @@ setWhitespaceChars(#wx_ref{type=ThisT,ref=ThisRef},Characters) wxe_util:cast(?wxStyledTextCtrl_SetWhitespaceChars, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec setCharsDefault(This) -> ok when + This::wxStyledTextCtrl(). setCharsDefault(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCharsDefault, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec autoCompGetCurrent(This) -> integer() when + This::wxStyledTextCtrl(). autoCompGetCurrent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_AutoCompGetCurrent, <>). -%% @spec (This::wxStyledTextCtrl(), Bytes::integer()) -> ok %% @doc See external documentation. +-spec allocate(This, Bytes) -> ok when + This::wxStyledTextCtrl(), Bytes::integer(). allocate(#wx_ref{type=ThisT,ref=ThisRef},Bytes) when is_integer(Bytes) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Allocate, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer(), Column::integer()) -> integer() %% @doc See external documentation. +-spec findColumn(This, Line, Column) -> integer() when + This::wxStyledTextCtrl(), Line::integer(), Column::integer(). findColumn(#wx_ref{type=ThisT,ref=ThisRef},Line,Column) when is_integer(Line),is_integer(Column) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_FindColumn, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getCaretSticky(This) -> boolean() when + This::wxStyledTextCtrl(). getCaretSticky(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCaretSticky, <>). -%% @spec (This::wxStyledTextCtrl(), UseCaretStickyBehaviour::bool()) -> ok %% @doc See external documentation. +-spec setCaretSticky(This, UseCaretStickyBehaviour) -> ok when + This::wxStyledTextCtrl(), UseCaretStickyBehaviour::boolean(). setCaretSticky(#wx_ref{type=ThisT,ref=ThisRef},UseCaretStickyBehaviour) when is_boolean(UseCaretStickyBehaviour) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCaretSticky, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec toggleCaretSticky(This) -> ok when + This::wxStyledTextCtrl(). toggleCaretSticky(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ToggleCaretSticky, <>). -%% @spec (This::wxStyledTextCtrl(), Convert::bool()) -> ok %% @doc See external documentation. +-spec setPasteConvertEndings(This, Convert) -> ok when + This::wxStyledTextCtrl(), Convert::boolean(). setPasteConvertEndings(#wx_ref{type=ThisT,ref=ThisRef},Convert) when is_boolean(Convert) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetPasteConvertEndings, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getPasteConvertEndings(This) -> boolean() when + This::wxStyledTextCtrl(). getPasteConvertEndings(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetPasteConvertEndings, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec selectionDuplicate(This) -> ok when + This::wxStyledTextCtrl(). selectionDuplicate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SelectionDuplicate, <>). -%% @spec (This::wxStyledTextCtrl(), Alpha::integer()) -> ok %% @doc See external documentation. +-spec setCaretLineBackAlpha(This, Alpha) -> ok when + This::wxStyledTextCtrl(), Alpha::integer(). setCaretLineBackAlpha(#wx_ref{type=ThisT,ref=ThisRef},Alpha) when is_integer(Alpha) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetCaretLineBackAlpha, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getCaretLineBackAlpha(This) -> integer() when + This::wxStyledTextCtrl(). getCaretLineBackAlpha(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCaretLineBackAlpha, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec startRecord(This) -> ok when + This::wxStyledTextCtrl(). startRecord(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StartRecord, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc See external documentation. +-spec stopRecord(This) -> ok when + This::wxStyledTextCtrl(). stopRecord(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StopRecord, <>). -%% @spec (This::wxStyledTextCtrl(), Lexer::integer()) -> ok %% @doc See external documentation. +-spec setLexer(This, Lexer) -> ok when + This::wxStyledTextCtrl(), Lexer::integer(). setLexer(#wx_ref{type=ThisT,ref=ThisRef},Lexer) when is_integer(Lexer) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetLexer, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getLexer(This) -> integer() when + This::wxStyledTextCtrl(). getLexer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLexer, <>). -%% @spec (This::wxStyledTextCtrl(), Start::integer(), End::integer()) -> ok %% @doc See external documentation. +-spec colourise(This, Start, End) -> ok when + This::wxStyledTextCtrl(), Start::integer(), End::integer(). colourise(#wx_ref{type=ThisT,ref=ThisRef},Start,End) when is_integer(Start),is_integer(End) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_Colourise, <>). -%% @spec (This::wxStyledTextCtrl(), Key::string(), Value::string()) -> ok %% @doc See external documentation. +-spec setProperty(This, Key, Value) -> ok when + This::wxStyledTextCtrl(), Key::string(), Value::string(). setProperty(#wx_ref{type=ThisT,ref=ThisRef},Key,Value) when is_list(Key),is_list(Value) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3303,8 +3727,9 @@ setProperty(#wx_ref{type=ThisT,ref=ThisRef},Key,Value) wxe_util:cast(?wxStyledTextCtrl_SetProperty, <>). -%% @spec (This::wxStyledTextCtrl(), KeywordSet::integer(), KeyWords::string()) -> ok %% @doc See external documentation. +-spec setKeyWords(This, KeywordSet, KeyWords) -> ok when + This::wxStyledTextCtrl(), KeywordSet::integer(), KeyWords::string(). setKeyWords(#wx_ref{type=ThisT,ref=ThisRef},KeywordSet,KeyWords) when is_integer(KeywordSet),is_list(KeyWords) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3312,8 +3737,9 @@ setKeyWords(#wx_ref{type=ThisT,ref=ThisRef},KeywordSet,KeyWords) wxe_util:cast(?wxStyledTextCtrl_SetKeyWords, <>). -%% @spec (This::wxStyledTextCtrl(), Language::string()) -> ok %% @doc See external documentation. +-spec setLexerLanguage(This, Language) -> ok when + This::wxStyledTextCtrl(), Language::string(). setLexerLanguage(#wx_ref{type=ThisT,ref=ThisRef},Language) when is_list(Language) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3321,8 +3747,9 @@ setLexerLanguage(#wx_ref{type=ThisT,ref=ThisRef},Language) wxe_util:cast(?wxStyledTextCtrl_SetLexerLanguage, <>). -%% @spec (This::wxStyledTextCtrl(), Key::string()) -> string() %% @doc See external documentation. +-spec getProperty(This, Key) -> string() when + This::wxStyledTextCtrl(), Key::string(). getProperty(#wx_ref{type=ThisT,ref=ThisRef},Key) when is_list(Key) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3330,22 +3757,25 @@ getProperty(#wx_ref{type=ThisT,ref=ThisRef},Key) wxe_util:call(?wxStyledTextCtrl_GetProperty, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getStyleBitsNeeded(This) -> integer() when + This::wxStyledTextCtrl(). getStyleBitsNeeded(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetStyleBitsNeeded, <>). -%% @spec (This::wxStyledTextCtrl()) -> integer() %% @doc See external documentation. +-spec getCurrentLine(This) -> integer() when + This::wxStyledTextCtrl(). getCurrentLine(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCurrentLine, <>). -%% @spec (This::wxStyledTextCtrl(), StyleNum::integer(), Spec::string()) -> ok %% @doc See external documentation. +-spec styleSetSpec(This, StyleNum, Spec) -> ok when + This::wxStyledTextCtrl(), StyleNum::integer(), Spec::string(). styleSetSpec(#wx_ref{type=ThisT,ref=ThisRef},StyleNum,Spec) when is_integer(StyleNum),is_list(Spec) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3353,8 +3783,9 @@ styleSetSpec(#wx_ref{type=ThisT,ref=ThisRef},StyleNum,Spec) wxe_util:cast(?wxStyledTextCtrl_StyleSetSpec, <>). -%% @spec (This::wxStyledTextCtrl(), StyleNum::integer(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec styleSetFont(This, StyleNum, Font) -> ok when + This::wxStyledTextCtrl(), StyleNum::integer(), Font::wxFont:wxFont(). styleSetFont(#wx_ref{type=ThisT,ref=ThisRef},StyleNum,#wx_ref{type=FontT,ref=FontRef}) when is_integer(StyleNum) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3362,17 +3793,19 @@ styleSetFont(#wx_ref{type=ThisT,ref=ThisRef},StyleNum,#wx_ref{type=FontT,ref=Fon wxe_util:cast(?wxStyledTextCtrl_StyleSetFont, <>). -%% @spec (This::wxStyledTextCtrl(), StyleNum::integer(), Size::integer(), FaceName::string(), Bold::bool(), Italic::bool(), Underline::bool()) -> ok %% @equiv styleSetFontAttr(This,StyleNum,Size,FaceName,Bold,Italic,Underline, []) +-spec styleSetFontAttr(This, StyleNum, Size, FaceName, Bold, Italic, Underline) -> ok when + This::wxStyledTextCtrl(), StyleNum::integer(), Size::integer(), FaceName::string(), Bold::boolean(), Italic::boolean(), Underline::boolean(). + styleSetFontAttr(This,StyleNum,Size,FaceName,Bold,Italic,Underline) when is_record(This, wx_ref),is_integer(StyleNum),is_integer(Size),is_list(FaceName),is_boolean(Bold),is_boolean(Italic),is_boolean(Underline) -> styleSetFontAttr(This,StyleNum,Size,FaceName,Bold,Italic,Underline, []). -%% @spec (This::wxStyledTextCtrl(), StyleNum::integer(), Size::integer(), FaceName::string(), Bold::bool(), Italic::bool(), Underline::bool(), [Option]) -> ok -%% Option = {encoding, WxFontEncoding} -%% WxFontEncoding = integer() %% @doc See external documentation. -%%
WxFontEncoding is one of ?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 +%%
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 styleSetFontAttr(This, StyleNum, Size, FaceName, Bold, Italic, Underline, [Option]) -> ok when + This::wxStyledTextCtrl(), StyleNum::integer(), Size::integer(), FaceName::string(), Bold::boolean(), Italic::boolean(), Underline::boolean(), + Option :: {encoding, wx:wx_enum()}. styleSetFontAttr(#wx_ref{type=ThisT,ref=ThisRef},StyleNum,Size,FaceName,Bold,Italic,Underline, Options) when is_integer(StyleNum),is_integer(Size),is_list(FaceName),is_boolean(Bold),is_boolean(Italic),is_boolean(Underline),is_list(Options) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3383,80 +3816,91 @@ styleSetFontAttr(#wx_ref{type=ThisT,ref=ThisRef},StyleNum,Size,FaceName,Bold,Ita wxe_util:cast(?wxStyledTextCtrl_StyleSetFontAttr, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), CharacterSet::integer()) -> ok %% @doc See external documentation. +-spec styleSetCharacterSet(This, Style, CharacterSet) -> ok when + This::wxStyledTextCtrl(), Style::integer(), CharacterSet::integer(). styleSetCharacterSet(#wx_ref{type=ThisT,ref=ThisRef},Style,CharacterSet) when is_integer(Style),is_integer(CharacterSet) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetCharacterSet, <>). -%% @spec (This::wxStyledTextCtrl(), Style::integer(), Encoding::WxFontEncoding) -> ok -%% WxFontEncoding = integer() %% @doc See external documentation. -%%
WxFontEncoding is one of ?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 +%%
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 styleSetFontEncoding(This, Style, Encoding) -> ok when + This::wxStyledTextCtrl(), Style::integer(), Encoding::wx:wx_enum(). styleSetFontEncoding(#wx_ref{type=ThisT,ref=ThisRef},Style,Encoding) when is_integer(Style),is_integer(Encoding) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_StyleSetFontEncoding, <>). -%% @spec (This::wxStyledTextCtrl(), Cmd::integer()) -> ok %% @doc See external documentation. +-spec cmdKeyExecute(This, Cmd) -> ok when + This::wxStyledTextCtrl(), Cmd::integer(). cmdKeyExecute(#wx_ref{type=ThisT,ref=ThisRef},Cmd) when is_integer(Cmd) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_CmdKeyExecute, <>). -%% @spec (This::wxStyledTextCtrl(), Left::integer(), Right::integer()) -> ok %% @doc See external documentation. +-spec setMargins(This, Left, Right) -> ok when + This::wxStyledTextCtrl(), Left::integer(), Right::integer(). setMargins(#wx_ref{type=ThisT,ref=ThisRef},Left,Right) when is_integer(Left),is_integer(Right) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetMargins, <>). -%% @spec (This::wxStyledTextCtrl()) -> {StartPos::integer(), EndPos::integer()} %% @doc See external documentation. +-spec getSelection(This) -> {StartPos::integer(), EndPos::integer()} when + This::wxStyledTextCtrl(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSelection, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec pointFromPosition(This, Pos) -> {X::integer(), Y::integer()} when + This::wxStyledTextCtrl(), Pos::integer(). pointFromPosition(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_PointFromPosition, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> ok %% @doc See external documentation. +-spec scrollToLine(This, Line) -> ok when + This::wxStyledTextCtrl(), Line::integer(). scrollToLine(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ScrollToLine, <>). -%% @spec (This::wxStyledTextCtrl(), Column::integer()) -> ok %% @doc See external documentation. +-spec scrollToColumn(This, Column) -> ok when + This::wxStyledTextCtrl(), Column::integer(). scrollToColumn(#wx_ref{type=ThisT,ref=ThisRef},Column) when is_integer(Column) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_ScrollToColumn, <>). -%% @spec (This::wxStyledTextCtrl(), Msg::integer()) -> integer() %% @equiv sendMsg(This,Msg, []) +-spec sendMsg(This, Msg) -> integer() when + This::wxStyledTextCtrl(), Msg::integer(). + sendMsg(This,Msg) when is_record(This, wx_ref),is_integer(Msg) -> sendMsg(This,Msg, []). -%% @spec (This::wxStyledTextCtrl(), Msg::integer(), [Option]) -> integer() -%% Option = {wp, integer()} | {lp, integer()} %% @doc See external documentation. +-spec sendMsg(This, Msg, [Option]) -> integer() when + This::wxStyledTextCtrl(), Msg::integer(), + Option :: {wp, integer()} + | {lp, integer()}. sendMsg(#wx_ref{type=ThisT,ref=ThisRef},Msg, Options) when is_integer(Msg),is_list(Options) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3467,39 +3911,44 @@ sendMsg(#wx_ref{type=ThisT,ref=ThisRef},Msg, Options) wxe_util:call(?wxStyledTextCtrl_SendMsg, <>). -%% @spec (This::wxStyledTextCtrl(), Bar::wxScrollBar:wxScrollBar()) -> ok %% @doc See external documentation. +-spec setVScrollBar(This, Bar) -> ok when + This::wxStyledTextCtrl(), Bar::wxScrollBar:wxScrollBar(). setVScrollBar(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BarT,ref=BarRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), ?CLASS(BarT,wxScrollBar), wxe_util:cast(?wxStyledTextCtrl_SetVScrollBar, <>). -%% @spec (This::wxStyledTextCtrl(), Bar::wxScrollBar:wxScrollBar()) -> ok %% @doc See external documentation. +-spec setHScrollBar(This, Bar) -> ok when + This::wxStyledTextCtrl(), Bar::wxScrollBar:wxScrollBar(). setHScrollBar(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=BarT,ref=BarRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), ?CLASS(BarT,wxScrollBar), wxe_util:cast(?wxStyledTextCtrl_SetHScrollBar, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getLastKeydownProcessed(This) -> boolean() when + This::wxStyledTextCtrl(). getLastKeydownProcessed(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLastKeydownProcessed, <>). -%% @spec (This::wxStyledTextCtrl(), Val::bool()) -> ok %% @doc See external documentation. +-spec setLastKeydownProcessed(This, Val) -> ok when + This::wxStyledTextCtrl(), Val::boolean(). setLastKeydownProcessed(#wx_ref{type=ThisT,ref=ThisRef},Val) when is_boolean(Val) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:cast(?wxStyledTextCtrl_SetLastKeydownProcessed, <>). -%% @spec (This::wxStyledTextCtrl(), Filename::string()) -> bool() %% @doc See external documentation. +-spec saveFile(This, Filename) -> boolean() when + This::wxStyledTextCtrl(), Filename::string(). saveFile(#wx_ref{type=ThisT,ref=ThisRef},Filename) when is_list(Filename) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3507,8 +3956,9 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef},Filename) wxe_util:call(?wxStyledTextCtrl_SaveFile, <>). -%% @spec (This::wxStyledTextCtrl(), Filename::string()) -> bool() %% @doc See external documentation. +-spec loadFile(This, Filename) -> boolean() when + This::wxStyledTextCtrl(), Filename::string(). loadFile(#wx_ref{type=ThisT,ref=ThisRef},Filename) when is_list(Filename) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3516,20 +3966,20 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},Filename) wxe_util:call(?wxStyledTextCtrl_LoadFile, <>). -%% @spec (This::wxStyledTextCtrl(), X::integer(), Y::integer(), Def::WxDragResult) -> WxDragResult -%% WxDragResult = integer() -%% WxDragResult = integer() %% @doc See external documentation. -%%
WxDragResult is one of ?wxDragError | ?wxDragNone | ?wxDragCopy | ?wxDragMove | ?wxDragLink | ?wxDragCancel -%%
WxDragResult is one of ?wxDragError | ?wxDragNone | ?wxDragCopy | ?wxDragMove | ?wxDragLink | ?wxDragCancel +%%
Res = ?wxDragError | ?wxDragNone | ?wxDragCopy | ?wxDragMove | ?wxDragLink | ?wxDragCancel +%%
Def = ?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) when is_integer(X),is_integer(Y),is_integer(Def) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_DoDragOver, <>). -%% @spec (This::wxStyledTextCtrl(), X::integer(), Y::integer(), Data::string()) -> bool() %% @doc See external documentation. +-spec doDropText(This, X, Y, Data) -> boolean() when + This::wxStyledTextCtrl(), X::integer(), Y::integer(), Data::string(). doDropText(#wx_ref{type=ThisT,ref=ThisRef},X,Y,Data) when is_integer(X),is_integer(Y),is_list(Data) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3537,15 +3987,17 @@ doDropText(#wx_ref{type=ThisT,ref=ThisRef},X,Y,Data) wxe_util:call(?wxStyledTextCtrl_DoDropText, <>). -%% @spec (This::wxStyledTextCtrl()) -> bool() %% @doc See external documentation. +-spec getUseAntiAliasing(This) -> boolean() when + This::wxStyledTextCtrl(). getUseAntiAliasing(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetUseAntiAliasing, <>). -%% @spec (This::wxStyledTextCtrl(), Text::binary()) -> ok %% @doc See external documentation. +-spec addTextRaw(This, Text) -> ok when + This::wxStyledTextCtrl(), Text::binary(). addTextRaw(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_binary(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3553,8 +4005,9 @@ addTextRaw(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxStyledTextCtrl_AddTextRaw, <>). -%% @spec (This::wxStyledTextCtrl(), Pos::integer(), Text::binary()) -> ok %% @doc See external documentation. +-spec insertTextRaw(This, Pos, Text) -> ok when + This::wxStyledTextCtrl(), Pos::integer(), Text::binary(). insertTextRaw(#wx_ref{type=ThisT,ref=ThisRef},Pos,Text) when is_integer(Pos),is_binary(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3562,38 +4015,44 @@ insertTextRaw(#wx_ref{type=ThisT,ref=ThisRef},Pos,Text) wxe_util:cast(?wxStyledTextCtrl_InsertTextRaw, <>). -%% @spec (This::wxStyledTextCtrl()) -> {binary(), LinePos::integer()} %% @doc See external documentation. +-spec getCurLineRaw(This) -> Result when + Result ::{Res ::binary(), LinePos::integer()}, + This::wxStyledTextCtrl(). getCurLineRaw(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetCurLineRaw, <>). -%% @spec (This::wxStyledTextCtrl(), Line::integer()) -> binary() %% @doc See external documentation. +-spec getLineRaw(This, Line) -> binary() when + This::wxStyledTextCtrl(), Line::integer(). getLineRaw(#wx_ref{type=ThisT,ref=ThisRef},Line) when is_integer(Line) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetLineRaw, <>). -%% @spec (This::wxStyledTextCtrl()) -> binary() %% @doc See external documentation. +-spec getSelectedTextRaw(This) -> binary() when + This::wxStyledTextCtrl(). getSelectedTextRaw(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetSelectedTextRaw, <>). -%% @spec (This::wxStyledTextCtrl(), StartPos::integer(), EndPos::integer()) -> binary() %% @doc See external documentation. +-spec getTextRangeRaw(This, StartPos, EndPos) -> binary() when + This::wxStyledTextCtrl(), StartPos::integer(), EndPos::integer(). getTextRangeRaw(#wx_ref{type=ThisT,ref=ThisRef},StartPos,EndPos) when is_integer(StartPos),is_integer(EndPos) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetTextRangeRaw, <>). -%% @spec (This::wxStyledTextCtrl(), Text::binary()) -> ok %% @doc See external documentation. +-spec setTextRaw(This, Text) -> ok when + This::wxStyledTextCtrl(), Text::binary(). setTextRaw(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_binary(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3601,15 +4060,17 @@ setTextRaw(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxStyledTextCtrl_SetTextRaw, <>). -%% @spec (This::wxStyledTextCtrl()) -> binary() %% @doc See external documentation. +-spec getTextRaw(This) -> binary() when + This::wxStyledTextCtrl(). getTextRaw(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextCtrl), wxe_util:call(?wxStyledTextCtrl_GetTextRaw, <>). -%% @spec (This::wxStyledTextCtrl(), Text::binary()) -> ok %% @doc See external documentation. +-spec appendTextRaw(This, Text) -> ok when + This::wxStyledTextCtrl(), Text::binary(). appendTextRaw(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_binary(Text) -> ?CLASS(ThisT,wxStyledTextCtrl), @@ -3617,8 +4078,8 @@ appendTextRaw(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxStyledTextCtrl_AppendTextRaw, <>). -%% @spec (This::wxStyledTextCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxStyledTextCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxStyledTextCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxStyledTextEvent.erl b/lib/wx/src/gen/wxStyledTextEvent.erl index 5d98ae585d..9c1343ef85 100644 --- a/lib/wx/src/gen/wxStyledTextEvent.erl +++ b/lib/wx/src/gen/wxStyledTextEvent.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 @@ -44,169 +44,193 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxStyledTextEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxStyledTextEvent()) -> integer() +-type wxStyledTextEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getPosition(This) -> integer() when + This::wxStyledTextEvent(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetPosition, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getKey(This) -> integer() when + This::wxStyledTextEvent(). getKey(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetKey, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getModifiers(This) -> integer() when + This::wxStyledTextEvent(). getModifiers(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetModifiers, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getModificationType(This) -> integer() when + This::wxStyledTextEvent(). getModificationType(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetModificationType, <>). -%% @spec (This::wxStyledTextEvent()) -> string() %% @doc See external documentation. +-spec getText(This) -> string() when + This::wxStyledTextEvent(). getText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetText, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getLength(This) -> integer() when + This::wxStyledTextEvent(). getLength(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetLength, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getLinesAdded(This) -> integer() when + This::wxStyledTextEvent(). getLinesAdded(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetLinesAdded, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getLine(This) -> integer() when + This::wxStyledTextEvent(). getLine(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetLine, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getFoldLevelNow(This) -> integer() when + This::wxStyledTextEvent(). getFoldLevelNow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetFoldLevelNow, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getFoldLevelPrev(This) -> integer() when + This::wxStyledTextEvent(). getFoldLevelPrev(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetFoldLevelPrev, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getMargin(This) -> integer() when + This::wxStyledTextEvent(). getMargin(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetMargin, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getMessage(This) -> integer() when + This::wxStyledTextEvent(). getMessage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetMessage, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getWParam(This) -> integer() when + This::wxStyledTextEvent(). getWParam(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetWParam, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getLParam(This) -> integer() when + This::wxStyledTextEvent(). getLParam(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetLParam, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getListType(This) -> integer() when + This::wxStyledTextEvent(). getListType(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetListType, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getX(This) -> integer() when + This::wxStyledTextEvent(). getX(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetX, <>). -%% @spec (This::wxStyledTextEvent()) -> integer() %% @doc See external documentation. +-spec getY(This) -> integer() when + This::wxStyledTextEvent(). getY(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetY, <>). -%% @spec (This::wxStyledTextEvent()) -> string() %% @doc See external documentation. +-spec getDragText(This) -> string() when + This::wxStyledTextEvent(). getDragText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetDragText, <>). -%% @spec (This::wxStyledTextEvent()) -> bool() %% @doc See external documentation. +-spec getDragAllowMove(This) -> boolean() when + This::wxStyledTextEvent(). getDragAllowMove(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetDragAllowMove, <>). -%% @spec (This::wxStyledTextEvent()) -> WxDragResult -%% WxDragResult = integer() %% @doc See external documentation. -%%
WxDragResult is one of ?wxDragError | ?wxDragNone | ?wxDragCopy | ?wxDragMove | ?wxDragLink | ?wxDragCancel +%%
Res = ?wxDragError | ?wxDragNone | ?wxDragCopy | ?wxDragMove | ?wxDragLink | ?wxDragCancel +-spec getDragResult(This) -> wx:wx_enum() when + This::wxStyledTextEvent(). getDragResult(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetDragResult, <>). -%% @spec (This::wxStyledTextEvent()) -> bool() %% @doc See external documentation. +-spec getShift(This) -> boolean() when + This::wxStyledTextEvent(). getShift(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetShift, <>). -%% @spec (This::wxStyledTextEvent()) -> bool() %% @doc See external documentation. +-spec getControl(This) -> boolean() when + This::wxStyledTextEvent(). getControl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetControl, <>). -%% @spec (This::wxStyledTextEvent()) -> bool() %% @doc See external documentation. +-spec getAlt(This) -> boolean() when + This::wxStyledTextEvent(). getAlt(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxStyledTextEvent), wxe_util:call(?wxStyledTextEvent_GetAlt, diff --git a/lib/wx/src/gen/wxSysColourChangedEvent.erl b/lib/wx/src/gen/wxSysColourChangedEvent.erl index 0d86edcf5b..94777748d2 100644 --- a/lib/wx/src/gen/wxSysColourChangedEvent.erl +++ b/lib/wx/src/gen/wxSysColourChangedEvent.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 @@ -37,10 +37,12 @@ -export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1, resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]). +-export_type([wxSysColourChangedEvent/0]). %% @hidden parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxSysColourChangedEvent() :: wx:wx_object(). %% From wxEvent %% @hidden stopPropagation(This) -> wxEvent:stopPropagation(This). diff --git a/lib/wx/src/gen/wxSystemOptions.erl b/lib/wx/src/gen/wxSystemOptions.erl index d5e504632b..a94b74136f 100644 --- a/lib/wx/src/gen/wxSystemOptions.erl +++ b/lib/wx/src/gen/wxSystemOptions.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 @@ -29,50 +29,52 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxSystemOptions/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Name::string()) -> string() +-type wxSystemOptions() :: wx:wx_object(). %% @doc See external documentation. +-spec getOption(Name) -> string() when + Name::string(). getOption(Name) when is_list(Name) -> Name_UC = unicode:characters_to_binary([Name,0]), wxe_util:call(?wxSystemOptions_GetOption, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (Name::string()) -> integer() %% @doc See external documentation. +-spec getOptionInt(Name) -> integer() when + Name::string(). getOptionInt(Name) when is_list(Name) -> Name_UC = unicode:characters_to_binary([Name,0]), wxe_util:call(?wxSystemOptions_GetOptionInt, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (Name::string()) -> bool() %% @doc See external documentation. +-spec hasOption(Name) -> boolean() when + Name::string(). hasOption(Name) when is_list(Name) -> Name_UC = unicode:characters_to_binary([Name,0]), wxe_util:call(?wxSystemOptions_HasOption, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (Name::string()) -> bool() %% @doc See external documentation. +-spec isFalse(Name) -> boolean() when + Name::string(). isFalse(Name) when is_list(Name) -> Name_UC = unicode:characters_to_binary([Name,0]), wxe_util:call(?wxSystemOptions_IsFalse, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (Name::string(),X::integer()|string()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setOption(Name::string(), Value::integer()) -> ok -%%

-%%

-%% setOption(Name::string(), Value::string()) -> ok -%%

+-spec setOption(Name, Value) -> ok when + Name::string(), Value::integer(); + (Name, Value) -> ok when + Name::string(), Value::string(). setOption(Name,Value) when is_list(Name),is_integer(Value) -> Name_UC = unicode:characters_to_binary([Name,0]), diff --git a/lib/wx/src/gen/wxSystemSettings.erl b/lib/wx/src/gen/wxSystemSettings.erl index 3f7e0a1ad6..fce9572ae9 100644 --- a/lib/wx/src/gen/wxSystemSettings.erl +++ b/lib/wx/src/gen/wxSystemSettings.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 @@ -29,38 +29,42 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxSystemSettings/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Index::WxSystemColour) -> wx:colour() -%% WxSystemColour = integer() +-type wxSystemSettings() :: wx:wx_object(). %% @doc See external documentation. -%%
WxSystemColour is one of ?wxSYS_COLOUR_SCROLLBAR | ?wxSYS_COLOUR_BACKGROUND | ?wxSYS_COLOUR_DESKTOP | ?wxSYS_COLOUR_ACTIVECAPTION | ?wxSYS_COLOUR_INACTIVECAPTION | ?wxSYS_COLOUR_MENU | ?wxSYS_COLOUR_WINDOW | ?wxSYS_COLOUR_WINDOWFRAME | ?wxSYS_COLOUR_MENUTEXT | ?wxSYS_COLOUR_WINDOWTEXT | ?wxSYS_COLOUR_CAPTIONTEXT | ?wxSYS_COLOUR_ACTIVEBORDER | ?wxSYS_COLOUR_INACTIVEBORDER | ?wxSYS_COLOUR_APPWORKSPACE | ?wxSYS_COLOUR_HIGHLIGHT | ?wxSYS_COLOUR_HIGHLIGHTTEXT | ?wxSYS_COLOUR_BTNFACE | ?wxSYS_COLOUR_3DFACE | ?wxSYS_COLOUR_BTNSHADOW | ?wxSYS_COLOUR_3DSHADOW | ?wxSYS_COLOUR_GRAYTEXT | ?wxSYS_COLOUR_BTNTEXT | ?wxSYS_COLOUR_INACTIVECAPTIONTEXT | ?wxSYS_COLOUR_BTNHIGHLIGHT | ?wxSYS_COLOUR_BTNHILIGHT | ?wxSYS_COLOUR_3DHIGHLIGHT | ?wxSYS_COLOUR_3DHILIGHT | ?wxSYS_COLOUR_3DDKSHADOW | ?wxSYS_COLOUR_3DLIGHT | ?wxSYS_COLOUR_INFOTEXT | ?wxSYS_COLOUR_INFOBK | ?wxSYS_COLOUR_LISTBOX | ?wxSYS_COLOUR_HOTLIGHT | ?wxSYS_COLOUR_GRADIENTACTIVECAPTION | ?wxSYS_COLOUR_GRADIENTINACTIVECAPTION | ?wxSYS_COLOUR_MENUHILIGHT | ?wxSYS_COLOUR_MENUBAR | ?wxSYS_COLOUR_LISTBOXTEXT | ?wxSYS_COLOUR_MAX +%%
Index = ?wxSYS_COLOUR_SCROLLBAR | ?wxSYS_COLOUR_BACKGROUND | ?wxSYS_COLOUR_DESKTOP | ?wxSYS_COLOUR_ACTIVECAPTION | ?wxSYS_COLOUR_INACTIVECAPTION | ?wxSYS_COLOUR_MENU | ?wxSYS_COLOUR_WINDOW | ?wxSYS_COLOUR_WINDOWFRAME | ?wxSYS_COLOUR_MENUTEXT | ?wxSYS_COLOUR_WINDOWTEXT | ?wxSYS_COLOUR_CAPTIONTEXT | ?wxSYS_COLOUR_ACTIVEBORDER | ?wxSYS_COLOUR_INACTIVEBORDER | ?wxSYS_COLOUR_APPWORKSPACE | ?wxSYS_COLOUR_HIGHLIGHT | ?wxSYS_COLOUR_HIGHLIGHTTEXT | ?wxSYS_COLOUR_BTNFACE | ?wxSYS_COLOUR_3DFACE | ?wxSYS_COLOUR_BTNSHADOW | ?wxSYS_COLOUR_3DSHADOW | ?wxSYS_COLOUR_GRAYTEXT | ?wxSYS_COLOUR_BTNTEXT | ?wxSYS_COLOUR_INACTIVECAPTIONTEXT | ?wxSYS_COLOUR_BTNHIGHLIGHT | ?wxSYS_COLOUR_BTNHILIGHT | ?wxSYS_COLOUR_3DHIGHLIGHT | ?wxSYS_COLOUR_3DHILIGHT | ?wxSYS_COLOUR_3DDKSHADOW | ?wxSYS_COLOUR_3DLIGHT | ?wxSYS_COLOUR_INFOTEXT | ?wxSYS_COLOUR_INFOBK | ?wxSYS_COLOUR_LISTBOX | ?wxSYS_COLOUR_HOTLIGHT | ?wxSYS_COLOUR_GRADIENTACTIVECAPTION | ?wxSYS_COLOUR_GRADIENTINACTIVECAPTION | ?wxSYS_COLOUR_MENUHILIGHT | ?wxSYS_COLOUR_MENUBAR | ?wxSYS_COLOUR_LISTBOXTEXT | ?wxSYS_COLOUR_MAX +-spec getColour(Index) -> wx:wx_colour() when + Index::wx:wx_enum(). getColour(Index) when is_integer(Index) -> wxe_util:call(?wxSystemSettings_GetColour, <>). -%% @spec (Index::WxSystemFont) -> wxFont:wxFont() -%% WxSystemFont = integer() %% @doc See external documentation. -%%
WxSystemFont is one of ?wxSYS_OEM_FIXED_FONT | ?wxSYS_ANSI_FIXED_FONT | ?wxSYS_ANSI_VAR_FONT | ?wxSYS_SYSTEM_FONT | ?wxSYS_DEVICE_DEFAULT_FONT | ?wxSYS_DEFAULT_PALETTE | ?wxSYS_SYSTEM_FIXED_FONT | ?wxSYS_DEFAULT_GUI_FONT | ?wxSYS_ICONTITLE_FONT +%%
Index = ?wxSYS_OEM_FIXED_FONT | ?wxSYS_ANSI_FIXED_FONT | ?wxSYS_ANSI_VAR_FONT | ?wxSYS_SYSTEM_FONT | ?wxSYS_DEVICE_DEFAULT_FONT | ?wxSYS_DEFAULT_PALETTE | ?wxSYS_SYSTEM_FIXED_FONT | ?wxSYS_DEFAULT_GUI_FONT | ?wxSYS_ICONTITLE_FONT +-spec getFont(Index) -> wxFont:wxFont() when + Index::wx:wx_enum(). getFont(Index) when is_integer(Index) -> wxe_util:call(?wxSystemSettings_GetFont, <>). -%% @spec (Index::WxSystemMetric) -> integer() %% @equiv getMetric(Index, []) +-spec getMetric(Index) -> integer() when + Index::wx:wx_enum(). + getMetric(Index) when is_integer(Index) -> getMetric(Index, []). -%% @spec (Index::WxSystemMetric, [Option]) -> integer() -%% Option = {win, wxWindow:wxWindow()} -%% WxSystemMetric = integer() %% @doc See external documentation. -%%
WxSystemMetric is one of ?wxSYS_MOUSE_BUTTONS | ?wxSYS_BORDER_X | ?wxSYS_BORDER_Y | ?wxSYS_CURSOR_X | ?wxSYS_CURSOR_Y | ?wxSYS_DCLICK_X | ?wxSYS_DCLICK_Y | ?wxSYS_DRAG_X | ?wxSYS_DRAG_Y | ?wxSYS_EDGE_X | ?wxSYS_EDGE_Y | ?wxSYS_HSCROLL_ARROW_X | ?wxSYS_HSCROLL_ARROW_Y | ?wxSYS_HTHUMB_X | ?wxSYS_ICON_X | ?wxSYS_ICON_Y | ?wxSYS_ICONSPACING_X | ?wxSYS_ICONSPACING_Y | ?wxSYS_WINDOWMIN_X | ?wxSYS_WINDOWMIN_Y | ?wxSYS_SCREEN_X | ?wxSYS_SCREEN_Y | ?wxSYS_FRAMESIZE_X | ?wxSYS_FRAMESIZE_Y | ?wxSYS_SMALLICON_X | ?wxSYS_SMALLICON_Y | ?wxSYS_HSCROLL_Y | ?wxSYS_VSCROLL_X | ?wxSYS_VSCROLL_ARROW_X | ?wxSYS_VSCROLL_ARROW_Y | ?wxSYS_VTHUMB_Y | ?wxSYS_CAPTION_Y | ?wxSYS_MENU_Y | ?wxSYS_NETWORK_PRESENT | ?wxSYS_PENWINDOWS_PRESENT | ?wxSYS_SHOW_SOUNDS | ?wxSYS_SWAP_BUTTONS +%%
Index = ?wxSYS_MOUSE_BUTTONS | ?wxSYS_BORDER_X | ?wxSYS_BORDER_Y | ?wxSYS_CURSOR_X | ?wxSYS_CURSOR_Y | ?wxSYS_DCLICK_X | ?wxSYS_DCLICK_Y | ?wxSYS_DRAG_X | ?wxSYS_DRAG_Y | ?wxSYS_EDGE_X | ?wxSYS_EDGE_Y | ?wxSYS_HSCROLL_ARROW_X | ?wxSYS_HSCROLL_ARROW_Y | ?wxSYS_HTHUMB_X | ?wxSYS_ICON_X | ?wxSYS_ICON_Y | ?wxSYS_ICONSPACING_X | ?wxSYS_ICONSPACING_Y | ?wxSYS_WINDOWMIN_X | ?wxSYS_WINDOWMIN_Y | ?wxSYS_SCREEN_X | ?wxSYS_SCREEN_Y | ?wxSYS_FRAMESIZE_X | ?wxSYS_FRAMESIZE_Y | ?wxSYS_SMALLICON_X | ?wxSYS_SMALLICON_Y | ?wxSYS_HSCROLL_Y | ?wxSYS_VSCROLL_X | ?wxSYS_VSCROLL_ARROW_X | ?wxSYS_VSCROLL_ARROW_Y | ?wxSYS_VTHUMB_Y | ?wxSYS_CAPTION_Y | ?wxSYS_MENU_Y | ?wxSYS_NETWORK_PRESENT | ?wxSYS_PENWINDOWS_PRESENT | ?wxSYS_SHOW_SOUNDS | ?wxSYS_SWAP_BUTTONS +-spec getMetric(Index, [Option]) -> integer() when + Index::wx:wx_enum(), + Option :: {win, wxWindow:wxWindow()}. getMetric(Index, Options) when is_integer(Index),is_list(Options) -> MOpts = fun({win, #wx_ref{type=WinT,ref=WinRef}}, Acc) -> ?CLASS(WinT,wxWindow),[<<1:32/?UI,WinRef:32/?UI>>|Acc]; @@ -69,10 +73,9 @@ getMetric(Index, Options) wxe_util:call(?wxSystemSettings_GetMetric, <>). -%% @spec () -> WxSystemScreenType -%% WxSystemScreenType = integer() %% @doc See external documentation. -%%
WxSystemScreenType is one of ?wxSYS_SCREEN_NONE | ?wxSYS_SCREEN_TINY | ?wxSYS_SCREEN_PDA | ?wxSYS_SCREEN_SMALL | ?wxSYS_SCREEN_DESKTOP +%%
Res = ?wxSYS_SCREEN_NONE | ?wxSYS_SCREEN_TINY | ?wxSYS_SCREEN_PDA | ?wxSYS_SCREEN_SMALL | ?wxSYS_SCREEN_DESKTOP +-spec getScreenType() -> wx:wx_enum(). getScreenType() -> wxe_util:call(?wxSystemSettings_GetScreenType, <<>>). diff --git a/lib/wx/src/gen/wxTextAttr.erl b/lib/wx/src/gen/wxTextAttr.erl index 056dc59161..1e3872421b 100644 --- a/lib/wx/src/gen/wxTextAttr.erl +++ b/lib/wx/src/gen/wxTextAttr.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 @@ -34,26 +34,32 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxTextAttr/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxTextAttr() +-type wxTextAttr() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxTextAttr(). new() -> wxe_util:construct(?wxTextAttr_new_0, <<>>). -%% @spec (ColText::wx:colour()) -> wxTextAttr() %% @equiv new(ColText, []) +-spec new(ColText) -> wxTextAttr() when + ColText::wx:wx_colour(). + new(ColText) when tuple_size(ColText) =:= 3; tuple_size(ColText) =:= 4 -> new(ColText, []). -%% @spec (ColText::wx:colour(), [Option]) -> wxTextAttr() -%% Option = {colBack, wx:colour()} | {font, wxFont:wxFont()} | {alignment, WxTextAttrAlignment} -%% WxTextAttrAlignment = integer() %% @doc See external documentation. -%%
WxTextAttrAlignment is one of ?wxTEXT_ALIGNMENT_DEFAULT | ?wxTEXT_ALIGNMENT_LEFT | ?wxTEXT_ALIGNMENT_CENTRE | ?wxTEXT_ALIGNMENT_CENTER | ?wxTEXT_ALIGNMENT_RIGHT | ?wxTEXT_ALIGNMENT_JUSTIFIED +%%
Alignment = ?wxTEXT_ALIGNMENT_DEFAULT | ?wxTEXT_ALIGNMENT_LEFT | ?wxTEXT_ALIGNMENT_CENTRE | ?wxTEXT_ALIGNMENT_CENTER | ?wxTEXT_ALIGNMENT_RIGHT | ?wxTEXT_ALIGNMENT_JUSTIFIED +-spec new(ColText, [Option]) -> wxTextAttr() when + ColText::wx:wx_colour(), + Option :: {colBack, wx:wx_colour()} + | {font, wxFont:wxFont()} + | {alignment, wx:wx_enum()}. new(ColText, Options) when tuple_size(ColText) =:= 3; tuple_size(ColText) =:= 4,is_list(Options) -> MOpts = fun({colBack, ColBack}, Acc) -> [<<1:32/?UI,(wxe_util:colour_bin(ColBack)):16/binary,0:32>>|Acc]; @@ -64,134 +70,151 @@ new(ColText, Options) wxe_util:construct(?wxTextAttr_new_2, <<(wxe_util:colour_bin(ColText)):16/binary, BinOpt/binary>>). -%% @spec (This::wxTextAttr()) -> WxTextAttrAlignment -%% WxTextAttrAlignment = integer() %% @doc See external documentation. -%%
WxTextAttrAlignment is one of ?wxTEXT_ALIGNMENT_DEFAULT | ?wxTEXT_ALIGNMENT_LEFT | ?wxTEXT_ALIGNMENT_CENTRE | ?wxTEXT_ALIGNMENT_CENTER | ?wxTEXT_ALIGNMENT_RIGHT | ?wxTEXT_ALIGNMENT_JUSTIFIED +%%
Res = ?wxTEXT_ALIGNMENT_DEFAULT | ?wxTEXT_ALIGNMENT_LEFT | ?wxTEXT_ALIGNMENT_CENTRE | ?wxTEXT_ALIGNMENT_CENTER | ?wxTEXT_ALIGNMENT_RIGHT | ?wxTEXT_ALIGNMENT_JUSTIFIED +-spec getAlignment(This) -> wx:wx_enum() when + This::wxTextAttr(). getAlignment(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_GetAlignment, <>). -%% @spec (This::wxTextAttr()) -> wx:colour() %% @doc See external documentation. +-spec getBackgroundColour(This) -> wx:wx_colour() when + This::wxTextAttr(). getBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_GetBackgroundColour, <>). -%% @spec (This::wxTextAttr()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getFont(This) -> wxFont:wxFont() when + This::wxTextAttr(). getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_GetFont, <>). -%% @spec (This::wxTextAttr()) -> integer() %% @doc See external documentation. +-spec getLeftIndent(This) -> integer() when + This::wxTextAttr(). getLeftIndent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_GetLeftIndent, <>). -%% @spec (This::wxTextAttr()) -> integer() %% @doc See external documentation. +-spec getLeftSubIndent(This) -> integer() when + This::wxTextAttr(). getLeftSubIndent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_GetLeftSubIndent, <>). -%% @spec (This::wxTextAttr()) -> integer() %% @doc See external documentation. +-spec getRightIndent(This) -> integer() when + This::wxTextAttr(). getRightIndent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_GetRightIndent, <>). -%% @spec (This::wxTextAttr()) -> [integer()] %% @doc See external documentation. +-spec getTabs(This) -> [integer()] when + This::wxTextAttr(). getTabs(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_GetTabs, <>). -%% @spec (This::wxTextAttr()) -> wx:colour() %% @doc See external documentation. +-spec getTextColour(This) -> wx:wx_colour() when + This::wxTextAttr(). getTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_GetTextColour, <>). -%% @spec (This::wxTextAttr()) -> bool() %% @doc See external documentation. +-spec hasBackgroundColour(This) -> boolean() when + This::wxTextAttr(). hasBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_HasBackgroundColour, <>). -%% @spec (This::wxTextAttr()) -> bool() %% @doc See external documentation. +-spec hasFont(This) -> boolean() when + This::wxTextAttr(). hasFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_HasFont, <>). -%% @spec (This::wxTextAttr()) -> bool() %% @doc See external documentation. +-spec hasTextColour(This) -> boolean() when + This::wxTextAttr(). hasTextColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_HasTextColour, <>). -%% @spec (This::wxTextAttr()) -> integer() %% @doc See external documentation. +-spec getFlags(This) -> integer() when + This::wxTextAttr(). getFlags(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_GetFlags, <>). -%% @spec (This::wxTextAttr()) -> bool() %% @doc See external documentation. +-spec isDefault(This) -> boolean() when + This::wxTextAttr(). isDefault(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextAttr), wxe_util:call(?wxTextAttr_IsDefault, <>). -%% @spec (This::wxTextAttr(), Alignment::WxTextAttrAlignment) -> ok -%% WxTextAttrAlignment = integer() %% @doc See external documentation. -%%
WxTextAttrAlignment is one of ?wxTEXT_ALIGNMENT_DEFAULT | ?wxTEXT_ALIGNMENT_LEFT | ?wxTEXT_ALIGNMENT_CENTRE | ?wxTEXT_ALIGNMENT_CENTER | ?wxTEXT_ALIGNMENT_RIGHT | ?wxTEXT_ALIGNMENT_JUSTIFIED +%%
Alignment = ?wxTEXT_ALIGNMENT_DEFAULT | ?wxTEXT_ALIGNMENT_LEFT | ?wxTEXT_ALIGNMENT_CENTRE | ?wxTEXT_ALIGNMENT_CENTER | ?wxTEXT_ALIGNMENT_RIGHT | ?wxTEXT_ALIGNMENT_JUSTIFIED +-spec setAlignment(This, Alignment) -> ok when + This::wxTextAttr(), Alignment::wx:wx_enum(). setAlignment(#wx_ref{type=ThisT,ref=ThisRef},Alignment) when is_integer(Alignment) -> ?CLASS(ThisT,wxTextAttr), wxe_util:cast(?wxTextAttr_SetAlignment, <>). -%% @spec (This::wxTextAttr(), ColBack::wx:colour()) -> ok %% @doc See external documentation. +-spec setBackgroundColour(This, ColBack) -> ok when + This::wxTextAttr(), ColBack::wx:wx_colour(). setBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},ColBack) when tuple_size(ColBack) =:= 3; tuple_size(ColBack) =:= 4 -> ?CLASS(ThisT,wxTextAttr), wxe_util:cast(?wxTextAttr_SetBackgroundColour, <>). -%% @spec (This::wxTextAttr(), Flags::integer()) -> ok %% @doc See external documentation. +-spec setFlags(This, Flags) -> ok when + This::wxTextAttr(), Flags::integer(). setFlags(#wx_ref{type=ThisT,ref=ThisRef},Flags) when is_integer(Flags) -> ?CLASS(ThisT,wxTextAttr), wxe_util:cast(?wxTextAttr_SetFlags, <>). -%% @spec (This::wxTextAttr(), Font::wxFont:wxFont()) -> ok %% @equiv setFont(This,Font, []) +-spec setFont(This, Font) -> ok when + This::wxTextAttr(), Font::wxFont:wxFont(). + setFont(This,Font) when is_record(This, wx_ref),is_record(Font, wx_ref) -> setFont(This,Font, []). -%% @spec (This::wxTextAttr(), Font::wxFont:wxFont(), [Option]) -> ok -%% Option = {flags, integer()} %% @doc See external documentation. +-spec setFont(This, Font, [Option]) -> ok when + This::wxTextAttr(), Font::wxFont:wxFont(), + Option :: {flags, integer()}. setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxTextAttr), @@ -202,15 +225,18 @@ setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}, Options wxe_util:cast(?wxTextAttr_SetFont, <>). -%% @spec (This::wxTextAttr(), Indent::integer()) -> ok %% @equiv setLeftIndent(This,Indent, []) +-spec setLeftIndent(This, Indent) -> ok when + This::wxTextAttr(), Indent::integer(). + setLeftIndent(This,Indent) when is_record(This, wx_ref),is_integer(Indent) -> setLeftIndent(This,Indent, []). -%% @spec (This::wxTextAttr(), Indent::integer(), [Option]) -> ok -%% Option = {subIndent, integer()} %% @doc See external documentation. +-spec setLeftIndent(This, Indent, [Option]) -> ok when + This::wxTextAttr(), Indent::integer(), + Option :: {subIndent, integer()}. setLeftIndent(#wx_ref{type=ThisT,ref=ThisRef},Indent, Options) when is_integer(Indent),is_list(Options) -> ?CLASS(ThisT,wxTextAttr), @@ -220,16 +246,18 @@ setLeftIndent(#wx_ref{type=ThisT,ref=ThisRef},Indent, Options) wxe_util:cast(?wxTextAttr_SetLeftIndent, <>). -%% @spec (This::wxTextAttr(), Indent::integer()) -> ok %% @doc See external documentation. +-spec setRightIndent(This, Indent) -> ok when + This::wxTextAttr(), Indent::integer(). setRightIndent(#wx_ref{type=ThisT,ref=ThisRef},Indent) when is_integer(Indent) -> ?CLASS(ThisT,wxTextAttr), wxe_util:cast(?wxTextAttr_SetRightIndent, <>). -%% @spec (This::wxTextAttr(), Tabs::[integer()]) -> ok %% @doc See external documentation. +-spec setTabs(This, Tabs) -> ok when + This::wxTextAttr(), Tabs::[integer()]. setTabs(#wx_ref{type=ThisT,ref=ThisRef},Tabs) when is_list(Tabs) -> ?CLASS(ThisT,wxTextAttr), @@ -237,16 +265,17 @@ setTabs(#wx_ref{type=ThisT,ref=ThisRef},Tabs) <> || C <- Tabs>>)/binary, 0:(((0+length(Tabs)) rem 2)*32)>>). -%% @spec (This::wxTextAttr(), ColText::wx:colour()) -> ok %% @doc See external documentation. +-spec setTextColour(This, ColText) -> ok when + This::wxTextAttr(), ColText::wx:wx_colour(). setTextColour(#wx_ref{type=ThisT,ref=ThisRef},ColText) when tuple_size(ColText) =:= 3; tuple_size(ColText) =:= 4 -> ?CLASS(ThisT,wxTextAttr), wxe_util:cast(?wxTextAttr_SetTextColour, <>). -%% @spec (This::wxTextAttr()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxTextAttr) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxTextAttr), wxe_util:destroy(?wxTextAttr_destroy,Obj), diff --git a/lib/wx/src/gen/wxTextCtrl.erl b/lib/wx/src/gen/wxTextCtrl.erl index b32f45b83b..fa83913a6f 100644 --- a/lib/wx/src/gen/wxTextCtrl.erl +++ b/lib/wx/src/gen/wxTextCtrl.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 @@ -77,27 +77,36 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxTextCtrl/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxTextCtrl() +-type wxTextCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxTextCtrl(). new() -> wxe_util:construct(?wxTextCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxTextCtrl() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxTextCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxTextCtrl() -%% Option = {value, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxTextCtrl() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {value, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -111,8 +120,9 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxTextCtrl_new_3, <>). -%% @spec (This::wxTextCtrl(), Text::string()) -> ok %% @doc See external documentation. +-spec appendText(This, Text) -> ok when + This::wxTextCtrl(), Text::string(). appendText(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxTextCtrl), @@ -120,64 +130,78 @@ appendText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxTextCtrl_AppendText, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @doc See external documentation. +-spec canCopy(This) -> boolean() when + This::wxTextCtrl(). canCopy(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_CanCopy, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @doc See external documentation. +-spec canCut(This) -> boolean() when + This::wxTextCtrl(). canCut(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_CanCut, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @doc See external documentation. +-spec canPaste(This) -> boolean() when + This::wxTextCtrl(). canPaste(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_CanPaste, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @doc See external documentation. +-spec canRedo(This) -> boolean() when + This::wxTextCtrl(). canRedo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_CanRedo, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @doc See external documentation. +-spec canUndo(This) -> boolean() when + This::wxTextCtrl(). canUndo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_CanUndo, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc See external documentation. +-spec clear(This) -> ok when + This::wxTextCtrl(). clear(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_Clear, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc See external documentation. +-spec copy(This) -> ok when + This::wxTextCtrl(). copy(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_Copy, <>). -%% @spec (This::wxTextCtrl(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxTextCtrl(), 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::wxTextCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {value, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxTextCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {value, string()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ThisT,wxTextCtrl), @@ -192,96 +216,109 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxTextCtrl_Create, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc See external documentation. +-spec cut(This) -> ok when + This::wxTextCtrl(). cut(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_Cut, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc See external documentation. +-spec discardEdits(This) -> ok when + This::wxTextCtrl(). discardEdits(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_DiscardEdits, <>). -%% @spec (This::wxTextCtrl(), Event::wxKeyEvent:wxKeyEvent()) -> bool() %% @doc See external documentation. +-spec emulateKeyPress(This, Event) -> boolean() when + This::wxTextCtrl(), Event::wxKeyEvent:wxKeyEvent(). emulateKeyPress(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=EventT,ref=EventRef}) -> ?CLASS(ThisT,wxTextCtrl), ?CLASS(EventT,wxKeyEvent), wxe_util:call(?wxTextCtrl_EmulateKeyPress, <>). -%% @spec (This::wxTextCtrl()) -> wxTextAttr:wxTextAttr() %% @doc See external documentation. +-spec getDefaultStyle(This) -> wxTextAttr:wxTextAttr() when + This::wxTextCtrl(). getDefaultStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetDefaultStyle, <>). -%% @spec (This::wxTextCtrl()) -> integer() %% @doc See external documentation. +-spec getInsertionPoint(This) -> integer() when + This::wxTextCtrl(). getInsertionPoint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetInsertionPoint, <>). -%% @spec (This::wxTextCtrl()) -> integer() %% @doc See external documentation. +-spec getLastPosition(This) -> integer() when + This::wxTextCtrl(). getLastPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetLastPosition, <>). -%% @spec (This::wxTextCtrl(), LineNo::integer()) -> integer() %% @doc See external documentation. +-spec getLineLength(This, LineNo) -> integer() when + This::wxTextCtrl(), LineNo::integer(). getLineLength(#wx_ref{type=ThisT,ref=ThisRef},LineNo) when is_integer(LineNo) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetLineLength, <>). -%% @spec (This::wxTextCtrl(), LineNo::integer()) -> string() %% @doc See external documentation. +-spec getLineText(This, LineNo) -> string() when + This::wxTextCtrl(), LineNo::integer(). getLineText(#wx_ref{type=ThisT,ref=ThisRef},LineNo) when is_integer(LineNo) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetLineText, <>). -%% @spec (This::wxTextCtrl()) -> integer() %% @doc See external documentation. +-spec getNumberOfLines(This) -> integer() when + This::wxTextCtrl(). getNumberOfLines(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetNumberOfLines, <>). -%% @spec (This::wxTextCtrl(), From::integer(), To::integer()) -> string() %% @doc See external documentation. +-spec getRange(This, From, To) -> string() when + This::wxTextCtrl(), From::integer(), To::integer(). getRange(#wx_ref{type=ThisT,ref=ThisRef},From,To) when is_integer(From),is_integer(To) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetRange, <>). -%% @spec (This::wxTextCtrl()) -> {From::integer(), To::integer()} %% @doc See external documentation. +-spec getSelection(This) -> {From::integer(), To::integer()} when + This::wxTextCtrl(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetSelection, <>). -%% @spec (This::wxTextCtrl()) -> string() %% @doc See external documentation. +-spec getStringSelection(This) -> string() when + This::wxTextCtrl(). getStringSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetStringSelection, <>). -%% @spec (This::wxTextCtrl(), Position::integer(), Style::wxTextAttr:wxTextAttr()) -> bool() %% @doc See external documentation. +-spec getStyle(This, Position, Style) -> boolean() when + This::wxTextCtrl(), Position::integer(), Style::wxTextAttr:wxTextAttr(). getStyle(#wx_ref{type=ThisT,ref=ThisRef},Position,#wx_ref{type=StyleT,ref=StyleRef}) when is_integer(Position) -> ?CLASS(ThisT,wxTextCtrl), @@ -289,50 +326,58 @@ getStyle(#wx_ref{type=ThisT,ref=ThisRef},Position,#wx_ref{type=StyleT,ref=StyleR wxe_util:call(?wxTextCtrl_GetStyle, <>). -%% @spec (This::wxTextCtrl()) -> string() %% @doc See external documentation. +-spec getValue(This) -> string() when + This::wxTextCtrl(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_GetValue, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @doc See external documentation. +-spec isEditable(This) -> boolean() when + This::wxTextCtrl(). isEditable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_IsEditable, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @doc See external documentation. +-spec isModified(This) -> boolean() when + This::wxTextCtrl(). isModified(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_IsModified, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @doc See external documentation. +-spec isMultiLine(This) -> boolean() when + This::wxTextCtrl(). isMultiLine(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_IsMultiLine, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @doc See external documentation. +-spec isSingleLine(This) -> boolean() when + This::wxTextCtrl(). isSingleLine(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_IsSingleLine, <>). -%% @spec (This::wxTextCtrl(), File::string()) -> bool() %% @equiv loadFile(This,File, []) +-spec loadFile(This, File) -> boolean() when + This::wxTextCtrl(), File::string(). + loadFile(This,File) when is_record(This, wx_ref),is_list(File) -> loadFile(This,File, []). -%% @spec (This::wxTextCtrl(), File::string(), [Option]) -> bool() -%% Option = {fileType, integer()} %% @doc See external documentation. +-spec loadFile(This, File, [Option]) -> boolean() when + This::wxTextCtrl(), File::string(), + Option :: {fileType, integer()}. loadFile(#wx_ref{type=ThisT,ref=ThisRef},File, Options) when is_list(File),is_list(Options) -> ?CLASS(ThisT,wxTextCtrl), @@ -343,45 +388,52 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},File, Options) wxe_util:call(?wxTextCtrl_LoadFile, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc See external documentation. +-spec markDirty(This) -> ok when + This::wxTextCtrl(). markDirty(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_MarkDirty, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc See external documentation. +-spec paste(This) -> ok when + This::wxTextCtrl(). paste(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_Paste, <>). -%% @spec (This::wxTextCtrl(), Pos::integer()) -> {bool(), X::integer(), Y::integer()} %% @doc See external documentation. +-spec positionToXY(This, Pos) -> Result when + Result ::{Res ::boolean(), X::integer(), Y::integer()}, + This::wxTextCtrl(), Pos::integer(). positionToXY(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_PositionToXY, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc See external documentation. +-spec redo(This) -> ok when + This::wxTextCtrl(). redo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_Redo, <>). -%% @spec (This::wxTextCtrl(), From::integer(), To::integer()) -> ok %% @doc See external documentation. +-spec remove(This, From, To) -> ok when + This::wxTextCtrl(), From::integer(), To::integer(). remove(#wx_ref{type=ThisT,ref=ThisRef},From,To) when is_integer(From),is_integer(To) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_Remove, <>). -%% @spec (This::wxTextCtrl(), From::integer(), To::integer(), Value::string()) -> ok %% @doc See external documentation. +-spec replace(This, From, To, Value) -> ok when + This::wxTextCtrl(), From::integer(), To::integer(), Value::string(). replace(#wx_ref{type=ThisT,ref=ThisRef},From,To,Value) when is_integer(From),is_integer(To),is_list(Value) -> ?CLASS(ThisT,wxTextCtrl), @@ -389,15 +441,19 @@ replace(#wx_ref{type=ThisT,ref=ThisRef},From,To,Value) wxe_util:cast(?wxTextCtrl_Replace, <>). -%% @spec (This::wxTextCtrl()) -> bool() %% @equiv saveFile(This, []) +-spec saveFile(This) -> boolean() when + This::wxTextCtrl(). + saveFile(This) when is_record(This, wx_ref) -> saveFile(This, []). -%% @spec (This::wxTextCtrl(), [Option]) -> bool() -%% Option = {file, string()} | {fileType, integer()} %% @doc See external documentation. +-spec saveFile(This, [Option]) -> boolean() when + This::wxTextCtrl(), + Option :: {file, string()} + | {fileType, integer()}. saveFile(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxTextCtrl), @@ -408,55 +464,62 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxTextCtrl_SaveFile, <>). -%% @spec (This::wxTextCtrl(), Style::wxTextAttr:wxTextAttr()) -> bool() %% @doc See external documentation. +-spec setDefaultStyle(This, Style) -> boolean() when + This::wxTextCtrl(), Style::wxTextAttr:wxTextAttr(). setDefaultStyle(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=StyleT,ref=StyleRef}) -> ?CLASS(ThisT,wxTextCtrl), ?CLASS(StyleT,wxTextAttr), wxe_util:call(?wxTextCtrl_SetDefaultStyle, <>). -%% @spec (This::wxTextCtrl(), Editable::bool()) -> ok %% @doc See external documentation. +-spec setEditable(This, Editable) -> ok when + This::wxTextCtrl(), Editable::boolean(). setEditable(#wx_ref{type=ThisT,ref=ThisRef},Editable) when is_boolean(Editable) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_SetEditable, <>). -%% @spec (This::wxTextCtrl(), Pos::integer()) -> ok %% @doc See external documentation. +-spec setInsertionPoint(This, Pos) -> ok when + This::wxTextCtrl(), Pos::integer(). setInsertionPoint(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_SetInsertionPoint, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc See external documentation. +-spec setInsertionPointEnd(This) -> ok when + This::wxTextCtrl(). setInsertionPointEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_SetInsertionPointEnd, <>). -%% @spec (This::wxTextCtrl(), Len::integer()) -> ok %% @doc See external documentation. +-spec setMaxLength(This, Len) -> ok when + This::wxTextCtrl(), Len::integer(). setMaxLength(#wx_ref{type=ThisT,ref=ThisRef},Len) when is_integer(Len) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_SetMaxLength, <>). -%% @spec (This::wxTextCtrl(), From::integer(), To::integer()) -> ok %% @doc See external documentation. +-spec setSelection(This, From, To) -> ok when + This::wxTextCtrl(), From::integer(), To::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},From,To) when is_integer(From),is_integer(To) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_SetSelection, <>). -%% @spec (This::wxTextCtrl(), Start::integer(), End::integer(), Style::wxTextAttr:wxTextAttr()) -> bool() %% @doc See external documentation. +-spec setStyle(This, Start, End, Style) -> boolean() when + This::wxTextCtrl(), Start::integer(), End::integer(), Style::wxTextAttr:wxTextAttr(). setStyle(#wx_ref{type=ThisT,ref=ThisRef},Start,End,#wx_ref{type=StyleT,ref=StyleRef}) when is_integer(Start),is_integer(End) -> ?CLASS(ThisT,wxTextCtrl), @@ -464,8 +527,9 @@ setStyle(#wx_ref{type=ThisT,ref=ThisRef},Start,End,#wx_ref{type=StyleT,ref=Style wxe_util:call(?wxTextCtrl_SetStyle, <>). -%% @spec (This::wxTextCtrl(), Value::string()) -> ok %% @doc See external documentation. +-spec setValue(This, Value) -> ok when + This::wxTextCtrl(), Value::string(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Value) when is_list(Value) -> ?CLASS(ThisT,wxTextCtrl), @@ -473,23 +537,26 @@ setValue(#wx_ref{type=ThisT,ref=ThisRef},Value) wxe_util:cast(?wxTextCtrl_SetValue, <>). -%% @spec (This::wxTextCtrl(), Pos::integer()) -> ok %% @doc See external documentation. +-spec showPosition(This, Pos) -> ok when + This::wxTextCtrl(), Pos::integer(). showPosition(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_ShowPosition, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc See external documentation. +-spec undo(This) -> ok when + This::wxTextCtrl(). undo(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:cast(?wxTextCtrl_Undo, <>). -%% @spec (This::wxTextCtrl(), Text::string()) -> ok %% @doc See external documentation. +-spec writeText(This, Text) -> ok when + This::wxTextCtrl(), Text::string(). writeText(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxTextCtrl), @@ -497,16 +564,17 @@ writeText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxTextCtrl_WriteText, <>). -%% @spec (This::wxTextCtrl(), X::integer(), Y::integer()) -> integer() %% @doc See external documentation. +-spec xYToPosition(This, X, Y) -> integer() when + This::wxTextCtrl(), X::integer(), Y::integer(). xYToPosition(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxTextCtrl), wxe_util:call(?wxTextCtrl_XYToPosition, <>). -%% @spec (This::wxTextCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxTextCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxTextCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxTextDataObject.erl b/lib/wx/src/gen/wxTextDataObject.erl index f4fe3b5e0c..ab4d5378e1 100644 --- a/lib/wx/src/gen/wxTextDataObject.erl +++ b/lib/wx/src/gen/wxTextDataObject.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 @@ -32,18 +32,21 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxTextDataObject/0]). %% @hidden parent_class(wxDataObject) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxTextDataObject() +-type wxTextDataObject() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxTextDataObject(). + new() -> new([]). -%% @spec ([Option]) -> wxTextDataObject() -%% Option = {text, string()} %% @doc See external documentation. +-spec new([Option]) -> wxTextDataObject() when + Option :: {text, string()}. new(Options) when is_list(Options) -> MOpts = fun({text, Text}, Acc) -> Text_UC = unicode:characters_to_binary([Text,0]),[<<1: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>>|Acc]; @@ -52,22 +55,25 @@ new(Options) wxe_util:construct(?wxTextDataObject_new, <>). -%% @spec (This::wxTextDataObject()) -> integer() %% @doc See external documentation. +-spec getTextLength(This) -> integer() when + This::wxTextDataObject(). getTextLength(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextDataObject), wxe_util:call(?wxTextDataObject_GetTextLength, <>). -%% @spec (This::wxTextDataObject()) -> string() %% @doc See external documentation. +-spec getText(This) -> string() when + This::wxTextDataObject(). getText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextDataObject), wxe_util:call(?wxTextDataObject_GetText, <>). -%% @spec (This::wxTextDataObject(), Text::string()) -> ok %% @doc See external documentation. +-spec setText(This, Text) -> ok when + This::wxTextDataObject(), Text::string(). setText(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxTextDataObject), @@ -75,8 +81,8 @@ setText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxTextDataObject_SetText, <>). -%% @spec (This::wxTextDataObject()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxTextDataObject) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxTextDataObject), wxe_util:destroy(?wxTextDataObject_destroy,Obj), diff --git a/lib/wx/src/gen/wxTextEntryDialog.erl b/lib/wx/src/gen/wxTextEntryDialog.erl index 53694a47e6..c26a1a57b5 100644 --- a/lib/wx/src/gen/wxTextEntryDialog.erl +++ b/lib/wx/src/gen/wxTextEntryDialog.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 @@ -77,6 +77,7 @@ transferDataFromWindow/1,transferDataToWindow/1,update/1,updateWindowUI/1, updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxTextEntryDialog/0]). %% @hidden parent_class(wxDialog) -> true; parent_class(wxTopLevelWindow) -> true; @@ -84,15 +85,22 @@ parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Parent::wxWindow:wxWindow(), Message::string()) -> wxTextEntryDialog() +-type wxTextEntryDialog() :: wx:wx_object(). %% @equiv new(Parent,Message, []) +-spec new(Parent, Message) -> wxTextEntryDialog() when + Parent::wxWindow:wxWindow(), Message::string(). + new(Parent,Message) when is_record(Parent, wx_ref),is_list(Message) -> new(Parent,Message, []). -%% @spec (Parent::wxWindow:wxWindow(), Message::string(), [Option]) -> wxTextEntryDialog() -%% Option = {caption, string()} | {value, string()} | {style, integer()} | {pos, {X::integer(), Y::integer()}} %% @doc See external documentation. +-spec new(Parent, Message, [Option]) -> wxTextEntryDialog() when + Parent::wxWindow:wxWindow(), Message::string(), + Option :: {caption, string()} + | {value, string()} + | {style, integer()} + | {pos, {X::integer(), Y::integer()}}. new(#wx_ref{type=ParentT,ref=ParentRef},Message, Options) when is_list(Message),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -106,15 +114,17 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Message, Options) wxe_util:construct(?wxTextEntryDialog_new, <>). -%% @spec (This::wxTextEntryDialog()) -> string() %% @doc See external documentation. +-spec getValue(This) -> string() when + This::wxTextEntryDialog(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTextEntryDialog), wxe_util:call(?wxTextEntryDialog_GetValue, <>). -%% @spec (This::wxTextEntryDialog(), Val::string()) -> ok %% @doc See external documentation. +-spec setValue(This, Val) -> ok when + This::wxTextEntryDialog(), Val::string(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Val) when is_list(Val) -> ?CLASS(ThisT,wxTextEntryDialog), @@ -122,8 +132,8 @@ setValue(#wx_ref{type=ThisT,ref=ThisRef},Val) wxe_util:cast(?wxTextEntryDialog_SetValue, <>). -%% @spec (This::wxTextEntryDialog()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxTextEntryDialog) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxTextEntryDialog), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxToggleButton.erl b/lib/wx/src/gen/wxToggleButton.erl index d7755cc50b..23a2987a27 100644 --- a/lib/wx/src/gen/wxToggleButton.erl +++ b/lib/wx/src/gen/wxToggleButton.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 @@ -69,27 +69,35 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxToggleButton/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxToggleButton() +-type wxToggleButton() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxToggleButton(). new() -> wxe_util:construct(?wxToggleButton_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> wxToggleButton() %% @equiv new(Parent,Id,Label, []) +-spec new(Parent, Id, Label) -> wxToggleButton() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + new(Parent,Id,Label) when is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> new(Parent,Id,Label, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> wxToggleButton() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, Id, Label, [Option]) -> wxToggleButton() when + Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -103,15 +111,21 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) wxe_util:construct(?wxToggleButton_new_4, <>). -%% @spec (This::wxToggleButton(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string()) -> bool() %% @equiv create(This,Parent,Id,Label, []) +-spec create(This, Parent, Id, Label) -> boolean() when + This::wxToggleButton(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(). + create(This,Parent,Id,Label) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id),is_list(Label) -> create(This,Parent,Id,Label, []). -%% @spec (This::wxToggleButton(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, Id, Label, [Option]) -> boolean() when + This::wxToggleButton(), Parent::wxWindow:wxWindow(), Id::integer(), Label::string(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,Label, Options) when is_integer(Id),is_list(Label),is_list(Options) -> ?CLASS(ThisT,wxToggleButton), @@ -126,23 +140,25 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id,La wxe_util:call(?wxToggleButton_Create, <>). -%% @spec (This::wxToggleButton()) -> bool() %% @doc See external documentation. +-spec getValue(This) -> boolean() when + This::wxToggleButton(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToggleButton), wxe_util:call(?wxToggleButton_GetValue, <>). -%% @spec (This::wxToggleButton(), State::bool()) -> ok %% @doc See external documentation. +-spec setValue(This, State) -> ok when + This::wxToggleButton(), State::boolean(). setValue(#wx_ref{type=ThisT,ref=ThisRef},State) when is_boolean(State) -> ?CLASS(ThisT,wxToggleButton), wxe_util:cast(?wxToggleButton_SetValue, <>). -%% @spec (This::wxToggleButton()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxToggleButton) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxToggleButton), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxToolBar.erl b/lib/wx/src/gen/wxToolBar.erl index 59369368f0..8fc200d6ba 100644 --- a/lib/wx/src/gen/wxToolBar.erl +++ b/lib/wx/src/gen/wxToolBar.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 @@ -77,52 +77,57 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxToolBar/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxToolBar(), Control::wxControl:wxControl()) -> wx:wx() +-type wxToolBar() :: wx:wx_object(). %% @doc See external documentation. +-spec addControl(This, Control) -> wx:wx() when + This::wxToolBar(), Control::wxControl:wxControl(). addControl(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ControlT,ref=ControlRef}) -> ?CLASS(ThisT,wxToolBar), ?CLASS(ControlT,wxControl), wxe_util:call(?wxToolBar_AddControl, <>). -%% @spec (This::wxToolBar()) -> wx:wx() %% @doc See external documentation. +-spec addSeparator(This) -> wx:wx() when + This::wxToolBar(). addSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_AddSeparator, <>). -%% @spec (This::wxToolBar(), Tool::wx:wx()) -> wx:wx() %% @doc See external documentation. +-spec addTool(This, Tool) -> wx:wx() when + This::wxToolBar(), Tool::wx:wx(). addTool(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ToolT,ref=ToolRef}) -> ?CLASS(ThisT,wxToolBar), ?CLASS(ToolT,wx), wxe_util:call(?wxToolBar_AddTool_1, <>). -%% @spec (This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap()) -> wx:wx() %% @equiv addTool(This,Toolid,Bitmap, []) +-spec addTool(This, Toolid, Bitmap) -> wx:wx() when + This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(). + addTool(This,Toolid,Bitmap) when is_record(This, wx_ref),is_integer(Toolid),is_record(Bitmap, wx_ref) -> addTool(This,Toolid,Bitmap, []). -%% @spec (This::wxToolBar(),Toolid::integer(),X::string()|term(),X::term()) -> wx:wx() %% @doc See external documentation. -%%
Alternatives: -%%

-%% addTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap()) -> addTool(This,Toolid,Label,Bitmap, [])

-%%

-%% addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap()) -> addTool(This,Toolid,Bitmap,BmpDisabled, [])

-%%

-%% addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wx:wx() -%%
Option = {shortHelpString, string()} | {longHelpString, string()} -%%

+-spec addTool(This, Toolid, Label, Bitmap) -> wx:wx() when + This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(); + (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, string()} + | {longHelpString, string()}. addTool(This,Toolid,Label,Bitmap) when is_record(This, wx_ref),is_integer(Toolid),is_list(Label),is_record(Bitmap, wx_ref) -> @@ -142,21 +147,19 @@ addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,#wx_ref{type=BitmapT,ref=BitmapRe wxe_util:call(?wxToolBar_AddTool_3, <>). -%% @spec (This::wxToolBar(),Toolid::integer(),X::string()|term(),X::term(),X::term()) -> wx:wx() %% @doc See external documentation. -%%
Alternatives: -%%

-%% addTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap()) -> addTool(This,Toolid,Label,Bitmap,BmpDisabled, [])

-%%

-%% addTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wx:wx() -%%
Option = {shortHelp, string()} | {kind, WxItemKind} -%%
WxItemKind = integer() -%%
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -%%

-%%

-%% addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), [Option]) -> wx:wx() -%%
Option = {toggle, bool()} | {clientData, wx:wx()} | {shortHelpString, string()} | {longHelpString, string()} -%%

+-spec addTool(This, Toolid, Label, Bitmap, BmpDisabled) -> wx:wx() when + This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(); + (This, Toolid, Label, Bitmap, [Option]) -> wx:wx() when + This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), + Option :: {shortHelp, string()} + | {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, string()} + | {longHelpString, string()}. addTool(This,Toolid,Label,Bitmap,BmpDisabled) when is_record(This, wx_ref),is_integer(Toolid),is_list(Label),is_record(Bitmap, wx_ref),is_record(BmpDisabled, wx_ref) -> @@ -186,17 +189,15 @@ addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,#wx_ref{type=BitmapT,ref=BitmapRe wxe_util:call(?wxToolBar_AddTool_4_1, <>). -%% @spec (This::wxToolBar(),Toolid::integer(),X::term()|string(),X::term(),X::bool()|term(),X::integer()|term()) -> wx:wx() %% @doc See external documentation. -%%
Alternatives: -%%

-%% addTool(This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), Toggle::bool(), XPos::integer()) -> addTool(This,Toolid,Bitmap,BmpDisabled,Toggle,XPos, [])

-%%

-%% addTool(This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), [Option]) -> wx:wx() -%%
Option = {kind, WxItemKind} | {shortHelp, string()} | {longHelp, string()} | {data, wx:wx()} -%%
WxItemKind = integer() -%%
WxItemKind is one of ?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 + This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), + Option :: {kind, wx:wx_enum()} + | {shortHelp, string()} + | {longHelp, string()} + | {data, wx:wx()}. addTool(This,Toolid,Bitmap,BmpDisabled,Toggle,XPos) when is_record(This, wx_ref),is_integer(Toolid),is_record(Bitmap, wx_ref),is_record(BmpDisabled, wx_ref),is_boolean(Toggle),is_integer(XPos) -> @@ -216,9 +217,13 @@ addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Label,#wx_ref{type=BitmapT,ref=Bi wxe_util:call(?wxToolBar_AddTool_5, <>). -%% @spec (This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), Toggle::bool(), XPos::integer(), [Option]) -> wx:wx() -%% Option = {yPos, integer()} | {clientData, wx:wx()} | {shortHelp, string()} | {longHelp, string()} %% @doc See external documentation. +-spec addTool(This, Toolid, Bitmap, BmpDisabled, Toggle, XPos, [Option]) -> wx:wx() when + This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), Toggle::boolean(), XPos::integer(), + Option :: {yPos, integer()} + | {clientData, wx:wx()} + | {shortHelp, string()} + | {longHelp, string()}. addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,#wx_ref{type=BitmapT,ref=BitmapRef},#wx_ref{type=BmpDisabledT,ref=BmpDisabledRef},Toggle,XPos, Options) when is_integer(Toolid),is_boolean(Toggle),is_integer(XPos),is_list(Options) -> ?CLASS(ThisT,wxToolBar), @@ -233,15 +238,21 @@ addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,#wx_ref{type=BitmapT,ref=BitmapRe wxe_util:call(?wxToolBar_AddTool_6, <>). -%% @spec (This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap()) -> wx:wx() %% @equiv addCheckTool(This,Toolid,Label,Bitmap, []) +-spec addCheckTool(This, Toolid, Label, Bitmap) -> wx:wx() when + This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(). + addCheckTool(This,Toolid,Label,Bitmap) when is_record(This, wx_ref),is_integer(Toolid),is_list(Label),is_record(Bitmap, wx_ref) -> addCheckTool(This,Toolid,Label,Bitmap, []). -%% @spec (This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wx:wx() -%% Option = {bmpDisabled, wxBitmap:wxBitmap()} | {shortHelp, string()} | {longHelp, string()} | {data, wx:wx()} %% @doc See external documentation. +-spec addCheckTool(This, Toolid, Label, Bitmap, [Option]) -> wx:wx() when + This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), + Option :: {bmpDisabled, wxBitmap:wxBitmap()} + | {shortHelp, string()} + | {longHelp, string()} + | {data, wx:wx()}. addCheckTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Label,#wx_ref{type=BitmapT,ref=BitmapRef}, Options) when is_integer(Toolid),is_list(Label),is_list(Options) -> ?CLASS(ThisT,wxToolBar), @@ -256,15 +267,21 @@ addCheckTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Label,#wx_ref{type=BitmapT,r wxe_util:call(?wxToolBar_AddCheckTool, <>). -%% @spec (This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap()) -> wx:wx() %% @equiv addRadioTool(This,Toolid,Label,Bitmap, []) +-spec addRadioTool(This, Toolid, Label, Bitmap) -> wx:wx() when + This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(). + addRadioTool(This,Toolid,Label,Bitmap) when is_record(This, wx_ref),is_integer(Toolid),is_list(Label),is_record(Bitmap, wx_ref) -> addRadioTool(This,Toolid,Label,Bitmap, []). -%% @spec (This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wx:wx() -%% Option = {bmpDisabled, wxBitmap:wxBitmap()} | {shortHelp, string()} | {longHelp, string()} | {data, wx:wx()} %% @doc See external documentation. +-spec addRadioTool(This, Toolid, Label, Bitmap, [Option]) -> wx:wx() when + This::wxToolBar(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), + Option :: {bmpDisabled, wxBitmap:wxBitmap()} + | {shortHelp, string()} + | {longHelp, string()} + | {data, wx:wx()}. addRadioTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Label,#wx_ref{type=BitmapT,ref=BitmapRef}, Options) when is_integer(Toolid),is_list(Label),is_list(Options) -> ?CLASS(ThisT,wxToolBar), @@ -279,131 +296,148 @@ addRadioTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Label,#wx_ref{type=BitmapT,r wxe_util:call(?wxToolBar_AddRadioTool, <>). -%% @spec (This::wxToolBar(), Toolid::integer()) -> bool() %% @doc See external documentation. +-spec deleteTool(This, Toolid) -> boolean() when + This::wxToolBar(), Toolid::integer(). deleteTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid) when is_integer(Toolid) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_DeleteTool, <>). -%% @spec (This::wxToolBar(), Pos::integer()) -> bool() %% @doc See external documentation. +-spec deleteToolByPos(This, Pos) -> boolean() when + This::wxToolBar(), Pos::integer(). deleteToolByPos(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_DeleteToolByPos, <>). -%% @spec (This::wxToolBar(), Toolid::integer(), Enable::bool()) -> ok %% @doc See external documentation. +-spec enableTool(This, Toolid, Enable) -> ok when + This::wxToolBar(), Toolid::integer(), Enable::boolean(). enableTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Enable) when is_integer(Toolid),is_boolean(Enable) -> ?CLASS(ThisT,wxToolBar), wxe_util:cast(?wxToolBar_EnableTool, <>). -%% @spec (This::wxToolBar(), Toolid::integer()) -> wx:wx() %% @doc See external documentation. +-spec findById(This, Toolid) -> wx:wx() when + This::wxToolBar(), Toolid::integer(). findById(#wx_ref{type=ThisT,ref=ThisRef},Toolid) when is_integer(Toolid) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_FindById, <>). -%% @spec (This::wxToolBar(), Toolid::integer()) -> wxControl:wxControl() %% @doc See external documentation. +-spec findControl(This, Toolid) -> wxControl:wxControl() when + This::wxToolBar(), Toolid::integer(). findControl(#wx_ref{type=ThisT,ref=ThisRef},Toolid) when is_integer(Toolid) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_FindControl, <>). -%% @spec (This::wxToolBar(), X::integer(), Y::integer()) -> wx:wx() %% @doc See external documentation. +-spec findToolForPosition(This, X, Y) -> wx:wx() when + This::wxToolBar(), X::integer(), Y::integer(). findToolForPosition(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_FindToolForPosition, <>). -%% @spec (This::wxToolBar()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getToolSize(This) -> {W::integer(), H::integer()} when + This::wxToolBar(). getToolSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetToolSize, <>). -%% @spec (This::wxToolBar()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getToolBitmapSize(This) -> {W::integer(), H::integer()} when + This::wxToolBar(). getToolBitmapSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetToolBitmapSize, <>). -%% @spec (This::wxToolBar()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getMargins(This) -> {W::integer(), H::integer()} when + This::wxToolBar(). getMargins(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetMargins, <>). -%% @spec (This::wxToolBar(), Toolid::integer()) -> bool() %% @doc See external documentation. +-spec getToolEnabled(This, Toolid) -> boolean() when + This::wxToolBar(), Toolid::integer(). getToolEnabled(#wx_ref{type=ThisT,ref=ThisRef},Toolid) when is_integer(Toolid) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetToolEnabled, <>). -%% @spec (This::wxToolBar(), Toolid::integer()) -> string() %% @doc See external documentation. +-spec getToolLongHelp(This, Toolid) -> string() when + This::wxToolBar(), Toolid::integer(). getToolLongHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid) when is_integer(Toolid) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetToolLongHelp, <>). -%% @spec (This::wxToolBar()) -> integer() %% @doc See external documentation. +-spec getToolPacking(This) -> integer() when + This::wxToolBar(). getToolPacking(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetToolPacking, <>). -%% @spec (This::wxToolBar(), Id::integer()) -> integer() %% @doc See external documentation. +-spec getToolPos(This, Id) -> integer() when + This::wxToolBar(), Id::integer(). getToolPos(#wx_ref{type=ThisT,ref=ThisRef},Id) when is_integer(Id) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetToolPos, <>). -%% @spec (This::wxToolBar()) -> integer() %% @doc See external documentation. +-spec getToolSeparation(This) -> integer() when + This::wxToolBar(). getToolSeparation(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetToolSeparation, <>). -%% @spec (This::wxToolBar(), Toolid::integer()) -> string() %% @doc See external documentation. +-spec getToolShortHelp(This, Toolid) -> string() when + This::wxToolBar(), Toolid::integer(). getToolShortHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid) when is_integer(Toolid) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetToolShortHelp, <>). -%% @spec (This::wxToolBar(), Toolid::integer()) -> bool() %% @doc See external documentation. +-spec getToolState(This, Toolid) -> boolean() when + This::wxToolBar(), Toolid::integer(). getToolState(#wx_ref{type=ThisT,ref=ThisRef},Toolid) when is_integer(Toolid) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_GetToolState, <>). -%% @spec (This::wxToolBar(), Pos::integer(), Control::wxControl:wxControl()) -> wx:wx() %% @doc See external documentation. +-spec insertControl(This, Pos, Control) -> wx:wx() when + This::wxToolBar(), Pos::integer(), Control::wxControl:wxControl(). insertControl(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=ControlT,ref=ControlRef}) when is_integer(Pos) -> ?CLASS(ThisT,wxToolBar), @@ -411,16 +445,18 @@ insertControl(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=ControlT,ref=Cont wxe_util:call(?wxToolBar_InsertControl, <>). -%% @spec (This::wxToolBar(), Pos::integer()) -> wx:wx() %% @doc See external documentation. +-spec insertSeparator(This, Pos) -> wx:wx() when + This::wxToolBar(), Pos::integer(). insertSeparator(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_InsertSeparator, <>). -%% @spec (This::wxToolBar(), Pos::integer(), Tool::wx:wx()) -> wx:wx() %% @doc See external documentation. +-spec insertTool(This, Pos, Tool) -> wx:wx() when + This::wxToolBar(), Pos::integer(), Tool::wx:wx(). insertTool(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=ToolT,ref=ToolRef}) when is_integer(Pos) -> ?CLASS(ThisT,wxToolBar), @@ -428,21 +464,24 @@ insertTool(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=ToolT,ref=ToolRef}) wxe_util:call(?wxToolBar_InsertTool_2, <>). -%% @spec (This::wxToolBar(), Pos::integer(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap()) -> wx:wx() %% @equiv insertTool(This,Pos,Toolid,Bitmap, []) +-spec insertTool(This, Pos, Toolid, Bitmap) -> wx:wx() when + This::wxToolBar(), Pos::integer(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(). + insertTool(This,Pos,Toolid,Bitmap) when is_record(This, wx_ref),is_integer(Pos),is_integer(Toolid),is_record(Bitmap, wx_ref) -> insertTool(This,Pos,Toolid,Bitmap, []). -%% @spec (This::wxToolBar(),Pos::integer(),Toolid::integer(),X::string()|term(),X::term()) -> wx:wx() %% @doc See external documentation. -%%
Alternatives: -%%

-%% insertTool(This::wxToolBar(), Pos::integer(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap()) -> insertTool(This,Pos,Toolid,Label,Bitmap, [])

-%%

-%% insertTool(This::wxToolBar(), Pos::integer(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wx:wx() -%%
Option = {bmpDisabled, wxBitmap:wxBitmap()} | {toggle, bool()} | {clientData, wx:wx()} | {shortHelp, string()} | {longHelp, string()} -%%

+-spec insertTool(This, Pos, Toolid, Label, Bitmap) -> wx:wx() when + This::wxToolBar(), Pos::integer(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(); + (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, string()} + | {longHelp, string()}. insertTool(This,Pos,Toolid,Label,Bitmap) when is_record(This, wx_ref),is_integer(Pos),is_integer(Toolid),is_list(Label),is_record(Bitmap, wx_ref) -> @@ -461,11 +500,15 @@ insertTool(#wx_ref{type=ThisT,ref=ThisRef},Pos,Toolid,#wx_ref{type=BitmapT,ref=B wxe_util:call(?wxToolBar_InsertTool_4, <>). -%% @spec (This::wxToolBar(), Pos::integer(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), [Option]) -> wx:wx() -%% Option = {bmpDisabled, wxBitmap:wxBitmap()} | {kind, WxItemKind} | {shortHelp, string()} | {longHelp, string()} | {clientData, wx:wx()} -%% WxItemKind = integer() %% @doc See external documentation. -%%
WxItemKind is one of ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +%%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX +-spec insertTool(This, Pos, Toolid, Label, Bitmap, [Option]) -> wx:wx() when + This::wxToolBar(), Pos::integer(), Toolid::integer(), Label::string(), Bitmap::wxBitmap:wxBitmap(), + Option :: {bmpDisabled, wxBitmap:wxBitmap()} + | {kind, wx:wx_enum()} + | {shortHelp, string()} + | {longHelp, string()} + | {clientData, wx:wx()}. insertTool(#wx_ref{type=ThisT,ref=ThisRef},Pos,Toolid,Label,#wx_ref{type=BitmapT,ref=BitmapRef}, Options) when is_integer(Pos),is_integer(Toolid),is_list(Label),is_list(Options) -> ?CLASS(ThisT,wxToolBar), @@ -481,39 +524,44 @@ insertTool(#wx_ref{type=ThisT,ref=ThisRef},Pos,Toolid,Label,#wx_ref{type=BitmapT wxe_util:call(?wxToolBar_InsertTool_5, <>). -%% @spec (This::wxToolBar()) -> bool() %% @doc See external documentation. +-spec realize(This) -> boolean() when + This::wxToolBar(). realize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_Realize, <>). -%% @spec (This::wxToolBar(), Toolid::integer()) -> wx:wx() %% @doc See external documentation. +-spec removeTool(This, Toolid) -> wx:wx() when + This::wxToolBar(), Toolid::integer(). removeTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid) when is_integer(Toolid) -> ?CLASS(ThisT,wxToolBar), wxe_util:call(?wxToolBar_RemoveTool, <>). -%% @spec (This::wxToolBar(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec setMargins(This, X, Y) -> ok when + This::wxToolBar(), X::integer(), Y::integer(). setMargins(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxToolBar), wxe_util:cast(?wxToolBar_SetMargins, <>). -%% @spec (This::wxToolBar(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setToolBitmapSize(This, Size) -> ok when + This::wxToolBar(), Size::{W::integer(), H::integer()}. setToolBitmapSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxToolBar), wxe_util:cast(?wxToolBar_SetToolBitmapSize, <>). -%% @spec (This::wxToolBar(), Toolid::integer(), HelpString::string()) -> ok %% @doc See external documentation. +-spec setToolLongHelp(This, Toolid, HelpString) -> ok when + This::wxToolBar(), Toolid::integer(), HelpString::string(). setToolLongHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid,HelpString) when is_integer(Toolid),is_list(HelpString) -> ?CLASS(ThisT,wxToolBar), @@ -521,16 +569,18 @@ setToolLongHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid,HelpString) wxe_util:cast(?wxToolBar_SetToolLongHelp, <>). -%% @spec (This::wxToolBar(), Packing::integer()) -> ok %% @doc See external documentation. +-spec setToolPacking(This, Packing) -> ok when + This::wxToolBar(), Packing::integer(). setToolPacking(#wx_ref{type=ThisT,ref=ThisRef},Packing) when is_integer(Packing) -> ?CLASS(ThisT,wxToolBar), wxe_util:cast(?wxToolBar_SetToolPacking, <>). -%% @spec (This::wxToolBar(), Id::integer(), HelpString::string()) -> ok %% @doc See external documentation. +-spec setToolShortHelp(This, Id, HelpString) -> ok when + This::wxToolBar(), Id::integer(), HelpString::string(). setToolShortHelp(#wx_ref{type=ThisT,ref=ThisRef},Id,HelpString) when is_integer(Id),is_list(HelpString) -> ?CLASS(ThisT,wxToolBar), @@ -538,16 +588,18 @@ setToolShortHelp(#wx_ref{type=ThisT,ref=ThisRef},Id,HelpString) wxe_util:cast(?wxToolBar_SetToolShortHelp, <>). -%% @spec (This::wxToolBar(), Separation::integer()) -> ok %% @doc See external documentation. +-spec setToolSeparation(This, Separation) -> ok when + This::wxToolBar(), Separation::integer(). setToolSeparation(#wx_ref{type=ThisT,ref=ThisRef},Separation) when is_integer(Separation) -> ?CLASS(ThisT,wxToolBar), wxe_util:cast(?wxToolBar_SetToolSeparation, <>). -%% @spec (This::wxToolBar(), Toolid::integer(), Toggle::bool()) -> ok %% @doc See external documentation. +-spec toggleTool(This, Toolid, Toggle) -> ok when + This::wxToolBar(), Toolid::integer(), Toggle::boolean(). toggleTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Toggle) when is_integer(Toolid),is_boolean(Toggle) -> ?CLASS(ThisT,wxToolBar), diff --git a/lib/wx/src/gen/wxToolTip.erl b/lib/wx/src/gen/wxToolTip.erl index b0749c851a..c604fc4af9 100644 --- a/lib/wx/src/gen/wxToolTip.erl +++ b/lib/wx/src/gen/wxToolTip.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 @@ -29,33 +29,39 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxToolTip/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Flag::bool()) -> ok +-type wxToolTip() :: wx:wx_object(). %% @doc See external documentation. +-spec enable(Flag) -> ok when + Flag::boolean(). enable(Flag) when is_boolean(Flag) -> wxe_util:cast(?wxToolTip_Enable, <<(wxe_util:from_bool(Flag)):32/?UI>>). -%% @spec (Msecs::integer()) -> ok %% @doc See external documentation. +-spec setDelay(Msecs) -> ok when + Msecs::integer(). setDelay(Msecs) when is_integer(Msecs) -> wxe_util:cast(?wxToolTip_SetDelay, <>). -%% @spec (Tip::string()) -> wxToolTip() %% @doc See external documentation. +-spec new(Tip) -> wxToolTip() when + Tip::string(). new(Tip) when is_list(Tip) -> Tip_UC = unicode:characters_to_binary([Tip,0]), wxe_util:construct(?wxToolTip_new, <<(byte_size(Tip_UC)):32/?UI,(Tip_UC)/binary, 0:(((8- ((4+byte_size(Tip_UC)) band 16#7)) band 16#7))/unit:8>>). -%% @spec (This::wxToolTip(), Tip::string()) -> ok %% @doc See external documentation. +-spec setTip(This, Tip) -> ok when + This::wxToolTip(), Tip::string(). setTip(#wx_ref{type=ThisT,ref=ThisRef},Tip) when is_list(Tip) -> ?CLASS(ThisT,wxToolTip), @@ -63,22 +69,24 @@ setTip(#wx_ref{type=ThisT,ref=ThisRef},Tip) wxe_util:cast(?wxToolTip_SetTip, <>). -%% @spec (This::wxToolTip()) -> string() %% @doc See external documentation. +-spec getTip(This) -> string() when + This::wxToolTip(). getTip(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolTip), wxe_util:call(?wxToolTip_GetTip, <>). -%% @spec (This::wxToolTip()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getWindow(This) -> wxWindow:wxWindow() when + This::wxToolTip(). getWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolTip), wxe_util:call(?wxToolTip_GetWindow, <>). -%% @spec (This::wxToolTip()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxToolTip) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxToolTip), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxToolbook.erl b/lib/wx/src/gen/wxToolbook.erl index 764f66c2e5..f568a11d6a 100644 --- a/lib/wx/src/gen/wxToolbook.erl +++ b/lib/wx/src/gen/wxToolbook.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2011. All Rights Reserved. +%% Copyright Ericsson AB 2009-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([wxToolbook/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxToolbook() +-type wxToolbook() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxToolbook(). new() -> wxe_util:construct(?wxToolbook_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxToolbook() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxToolbook() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxToolbook() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxToolbook() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -106,15 +113,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxToolbook_new_3, <>). -%% @spec (This::wxToolbook(), Page::wxWindow:wxWindow(), Text::string()) -> bool() %% @equiv addPage(This,Page,Text, []) +-spec addPage(This, Page, Text) -> boolean() when + This::wxToolbook(), 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::wxToolbook(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool() -%% Option = {bSelect, bool()} | {imageId, integer()} %% @doc See external documentation. +-spec addPage(This, Page, Text, [Option]) -> boolean() when + This::wxToolbook(), 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,wxToolbook), @@ -127,15 +138,18 @@ addPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageT,ref=PageRef},Text, Op wxe_util:call(?wxToolbook_AddPage, <>). -%% @spec (This::wxToolbook()) -> ok %% @equiv advanceSelection(This, []) +-spec advanceSelection(This) -> ok when + This::wxToolbook(). + advanceSelection(This) when is_record(This, wx_ref) -> advanceSelection(This, []). -%% @spec (This::wxToolbook(), [Option]) -> ok -%% Option = {forward, bool()} %% @doc See external documentation. +-spec advanceSelection(This, [Option]) -> ok when + This::wxToolbook(), + Option :: {forward, boolean()}. advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxToolbook), @@ -145,23 +159,29 @@ advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxToolbook_AdvanceSelection, <>). -%% @spec (This::wxToolbook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec assignImageList(This, ImageList) -> ok when + This::wxToolbook(), ImageList::wxImageList:wxImageList(). assignImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxToolbook), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxToolbook_AssignImageList, <>). -%% @spec (This::wxToolbook(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxToolbook(), 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::wxToolbook(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxToolbook(), 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,wxToolbook), @@ -174,98 +194,114 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxToolbook_Create, <>). -%% @spec (This::wxToolbook()) -> bool() %% @doc See external documentation. +-spec deleteAllPages(This) -> boolean() when + This::wxToolbook(). deleteAllPages(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_DeleteAllPages, <>). -%% @spec (This::wxToolbook(), N::integer()) -> bool() %% @doc See external documentation. +-spec deletePage(This, N) -> boolean() when + This::wxToolbook(), N::integer(). deletePage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_DeletePage, <>). -%% @spec (This::wxToolbook(), N::integer()) -> bool() %% @doc See external documentation. +-spec removePage(This, N) -> boolean() when + This::wxToolbook(), N::integer(). removePage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_RemovePage, <>). -%% @spec (This::wxToolbook()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getCurrentPage(This) -> wxWindow:wxWindow() when + This::wxToolbook(). getCurrentPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_GetCurrentPage, <>). -%% @spec (This::wxToolbook()) -> wxImageList:wxImageList() %% @doc See external documentation. +-spec getImageList(This) -> wxImageList:wxImageList() when + This::wxToolbook(). getImageList(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_GetImageList, <>). -%% @spec (This::wxToolbook(), N::integer()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getPage(This, N) -> wxWindow:wxWindow() when + This::wxToolbook(), N::integer(). getPage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_GetPage, <>). -%% @spec (This::wxToolbook()) -> integer() %% @doc See external documentation. +-spec getPageCount(This) -> integer() when + This::wxToolbook(). getPageCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_GetPageCount, <>). -%% @spec (This::wxToolbook(), N::integer()) -> integer() %% @doc See external documentation. +-spec getPageImage(This, N) -> integer() when + This::wxToolbook(), N::integer(). getPageImage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_GetPageImage, <>). -%% @spec (This::wxToolbook(), N::integer()) -> string() %% @doc See external documentation. +-spec getPageText(This, N) -> string() when + This::wxToolbook(), N::integer(). getPageText(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_GetPageText, <>). -%% @spec (This::wxToolbook()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxToolbook(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_GetSelection, <>). -%% @spec (This::wxToolbook(), Pt::{X::integer(), Y::integer()}) -> {integer(), Flags::integer()} %% @doc See external documentation. +-spec hitTest(This, Pt) -> Result when + Result ::{Res ::integer(), Flags::integer()}, + This::wxToolbook(), Pt::{X::integer(), Y::integer()}. hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_HitTest, <>). -%% @spec (This::wxToolbook(), N::integer(), Page::wxWindow:wxWindow(), Text::string()) -> bool() %% @equiv insertPage(This,N,Page,Text, []) +-spec insertPage(This, N, Page, Text) -> boolean() when + This::wxToolbook(), N::integer(), Page::wxWindow:wxWindow(), Text::string(). + insertPage(This,N,Page,Text) when is_record(This, wx_ref),is_integer(N),is_record(Page, wx_ref),is_list(Text) -> insertPage(This,N,Page,Text, []). -%% @spec (This::wxToolbook(), N::integer(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool() -%% Option = {bSelect, bool()} | {imageId, integer()} %% @doc See external documentation. +-spec insertPage(This, N, Page, Text, [Option]) -> boolean() when + This::wxToolbook(), N::integer(), Page::wxWindow:wxWindow(), Text::string(), + Option :: {bSelect, boolean()} + | {imageId, integer()}. insertPage(#wx_ref{type=ThisT,ref=ThisRef},N,#wx_ref{type=PageT,ref=PageRef},Text, Options) when is_integer(N),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxToolbook), @@ -278,32 +314,36 @@ insertPage(#wx_ref{type=ThisT,ref=ThisRef},N,#wx_ref{type=PageT,ref=PageRef},Tex wxe_util:call(?wxToolbook_InsertPage, <>). -%% @spec (This::wxToolbook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec setImageList(This, ImageList) -> ok when + This::wxToolbook(), ImageList::wxImageList:wxImageList(). setImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxToolbook), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxToolbook_SetImageList, <>). -%% @spec (This::wxToolbook(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setPageSize(This, Size) -> ok when + This::wxToolbook(), Size::{W::integer(), H::integer()}. setPageSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxToolbook), wxe_util:cast(?wxToolbook_SetPageSize, <>). -%% @spec (This::wxToolbook(), N::integer(), ImageId::integer()) -> bool() %% @doc See external documentation. +-spec setPageImage(This, N, ImageId) -> boolean() when + This::wxToolbook(), N::integer(), ImageId::integer(). setPageImage(#wx_ref{type=ThisT,ref=ThisRef},N,ImageId) when is_integer(N),is_integer(ImageId) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_SetPageImage, <>). -%% @spec (This::wxToolbook(), N::integer(), StrText::string()) -> bool() %% @doc See external documentation. +-spec setPageText(This, N, StrText) -> boolean() when + This::wxToolbook(), N::integer(), StrText::string(). setPageText(#wx_ref{type=ThisT,ref=ThisRef},N,StrText) when is_integer(N),is_list(StrText) -> ?CLASS(ThisT,wxToolbook), @@ -311,24 +351,26 @@ setPageText(#wx_ref{type=ThisT,ref=ThisRef},N,StrText) wxe_util:call(?wxToolbook_SetPageText, <>). -%% @spec (This::wxToolbook(), N::integer()) -> integer() %% @doc See external documentation. +-spec setSelection(This, N) -> integer() when + This::wxToolbook(), N::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_SetSelection, <>). -%% @spec (This::wxToolbook(), N::integer()) -> integer() %% @doc See external documentation. +-spec changeSelection(This, N) -> integer() when + This::wxToolbook(), N::integer(). changeSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxToolbook), wxe_util:call(?wxToolbook_ChangeSelection, <>). -%% @spec (This::wxToolbook()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxToolbook) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxToolbook), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxTopLevelWindow.erl b/lib/wx/src/gen/wxTopLevelWindow.erl index e0551b480f..b315429bb6 100644 --- a/lib/wx/src/gen/wxTopLevelWindow.erl +++ b/lib/wx/src/gen/wxTopLevelWindow.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 @@ -72,48 +72,57 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxTopLevelWindow/0]). %% @hidden parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxTopLevelWindow()) -> wxIcon:wxIcon() +-type wxTopLevelWindow() :: wx:wx_object(). %% @doc See external documentation. +-spec getIcon(This) -> wxIcon:wxIcon() when + This::wxTopLevelWindow(). getIcon(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTopLevelWindow), wxe_util:call(?wxTopLevelWindow_GetIcon, <>). -%% @spec (This::wxTopLevelWindow()) -> wxIconBundle:wxIconBundle() %% @doc See external documentation. +-spec getIcons(This) -> wxIconBundle:wxIconBundle() when + This::wxTopLevelWindow(). getIcons(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTopLevelWindow), wxe_util:call(?wxTopLevelWindow_GetIcons, <>). -%% @spec (This::wxTopLevelWindow()) -> string() %% @doc See external documentation. +-spec getTitle(This) -> string() when + This::wxTopLevelWindow(). getTitle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTopLevelWindow), wxe_util:call(?wxTopLevelWindow_GetTitle, <>). -%% @spec (This::wxTopLevelWindow()) -> bool() %% @doc See external documentation. +-spec isActive(This) -> boolean() when + This::wxTopLevelWindow(). isActive(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTopLevelWindow), wxe_util:call(?wxTopLevelWindow_IsActive, <>). -%% @spec (This::wxTopLevelWindow()) -> ok %% @equiv iconize(This, []) +-spec iconize(This) -> ok when + This::wxTopLevelWindow(). + iconize(This) when is_record(This, wx_ref) -> iconize(This, []). -%% @spec (This::wxTopLevelWindow(), [Option]) -> ok -%% Option = {iconize, bool()} %% @doc See external documentation. +-spec iconize(This, [Option]) -> ok when + This::wxTopLevelWindow(), + Option :: {iconize, boolean()}. iconize(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxTopLevelWindow), @@ -123,36 +132,42 @@ iconize(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxTopLevelWindow_Iconize, <>). -%% @spec (This::wxTopLevelWindow()) -> bool() %% @doc See external documentation. +-spec isFullScreen(This) -> boolean() when + This::wxTopLevelWindow(). isFullScreen(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTopLevelWindow), wxe_util:call(?wxTopLevelWindow_IsFullScreen, <>). -%% @spec (This::wxTopLevelWindow()) -> bool() %% @doc See external documentation. +-spec isIconized(This) -> boolean() when + This::wxTopLevelWindow(). isIconized(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTopLevelWindow), wxe_util:call(?wxTopLevelWindow_IsIconized, <>). -%% @spec (This::wxTopLevelWindow()) -> bool() %% @doc See external documentation. +-spec isMaximized(This) -> boolean() when + This::wxTopLevelWindow(). isMaximized(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTopLevelWindow), wxe_util:call(?wxTopLevelWindow_IsMaximized, <>). -%% @spec (This::wxTopLevelWindow()) -> ok %% @equiv maximize(This, []) +-spec maximize(This) -> ok when + This::wxTopLevelWindow(). + maximize(This) when is_record(This, wx_ref) -> maximize(This, []). -%% @spec (This::wxTopLevelWindow(), [Option]) -> ok -%% Option = {maximize, bool()} %% @doc See external documentation. +-spec maximize(This, [Option]) -> ok when + This::wxTopLevelWindow(), + Option :: {maximize, boolean()}. maximize(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxTopLevelWindow), @@ -162,15 +177,18 @@ maximize(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxTopLevelWindow_Maximize, <>). -%% @spec (This::wxTopLevelWindow()) -> ok %% @equiv requestUserAttention(This, []) +-spec requestUserAttention(This) -> ok when + This::wxTopLevelWindow(). + requestUserAttention(This) when is_record(This, wx_ref) -> requestUserAttention(This, []). -%% @spec (This::wxTopLevelWindow(), [Option]) -> ok -%% Option = {flags, integer()} %% @doc See external documentation. +-spec requestUserAttention(This, [Option]) -> ok when + This::wxTopLevelWindow(), + Option :: {flags, integer()}. requestUserAttention(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxTopLevelWindow), @@ -180,31 +198,36 @@ requestUserAttention(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxTopLevelWindow_RequestUserAttention, <>). -%% @spec (This::wxTopLevelWindow(), Icon::wxIcon:wxIcon()) -> ok %% @doc See external documentation. +-spec setIcon(This, Icon) -> ok when + This::wxTopLevelWindow(), Icon::wxIcon:wxIcon(). setIcon(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconT,ref=IconRef}) -> ?CLASS(ThisT,wxTopLevelWindow), ?CLASS(IconT,wxIcon), wxe_util:cast(?wxTopLevelWindow_SetIcon, <>). -%% @spec (This::wxTopLevelWindow(), Icons::wxIconBundle:wxIconBundle()) -> ok %% @doc See external documentation. +-spec setIcons(This, Icons) -> ok when + This::wxTopLevelWindow(), Icons::wxIconBundle:wxIconBundle(). setIcons(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=IconsT,ref=IconsRef}) -> ?CLASS(ThisT,wxTopLevelWindow), ?CLASS(IconsT,wxIconBundle), wxe_util:cast(?wxTopLevelWindow_SetIcons, <>). -%% @spec (This::wxTopLevelWindow()) -> ok %% @equiv centerOnScreen(This, []) +-spec centerOnScreen(This) -> ok when + This::wxTopLevelWindow(). + centerOnScreen(This) when is_record(This, wx_ref) -> centerOnScreen(This, []). -%% @spec (This::wxTopLevelWindow(), [Option]) -> ok -%% Option = {dir, integer()} %% @doc See external documentation. +-spec centerOnScreen(This, [Option]) -> ok when + This::wxTopLevelWindow(), + Option :: {dir, integer()}. centerOnScreen(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxTopLevelWindow), @@ -214,15 +237,18 @@ centerOnScreen(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxTopLevelWindow_CenterOnScreen, <>). -%% @spec (This::wxTopLevelWindow()) -> ok %% @equiv centreOnScreen(This, []) +-spec centreOnScreen(This) -> ok when + This::wxTopLevelWindow(). + centreOnScreen(This) when is_record(This, wx_ref) -> centreOnScreen(This, []). -%% @spec (This::wxTopLevelWindow(), [Option]) -> ok -%% Option = {dir, integer()} %% @doc See external documentation. +-spec centreOnScreen(This, [Option]) -> ok when + This::wxTopLevelWindow(), + Option :: {dir, integer()}. centreOnScreen(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxTopLevelWindow), @@ -232,16 +258,18 @@ centreOnScreen(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxTopLevelWindow_CentreOnScreen, <>). -%% @spec (This::wxTopLevelWindow(), Region::wxRegion:wxRegion()) -> bool() %% @doc See external documentation. +-spec setShape(This, Region) -> boolean() when + This::wxTopLevelWindow(), Region::wxRegion:wxRegion(). setShape(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=RegionT,ref=RegionRef}) -> ?CLASS(ThisT,wxTopLevelWindow), ?CLASS(RegionT,wxRegion), wxe_util:call(?wxTopLevelWindow_SetShape, <>). -%% @spec (This::wxTopLevelWindow(), Title::string()) -> ok %% @doc See external documentation. +-spec setTitle(This, Title) -> ok when + This::wxTopLevelWindow(), Title::string(). setTitle(#wx_ref{type=ThisT,ref=ThisRef},Title) when is_list(Title) -> ?CLASS(ThisT,wxTopLevelWindow), @@ -249,15 +277,18 @@ setTitle(#wx_ref{type=ThisT,ref=ThisRef},Title) wxe_util:cast(?wxTopLevelWindow_SetTitle, <>). -%% @spec (This::wxTopLevelWindow(), Show::bool()) -> bool() %% @equiv showFullScreen(This,Show, []) +-spec showFullScreen(This, Show) -> boolean() when + This::wxTopLevelWindow(), Show::boolean(). + showFullScreen(This,Show) when is_record(This, wx_ref),is_boolean(Show) -> showFullScreen(This,Show, []). -%% @spec (This::wxTopLevelWindow(), Show::bool(), [Option]) -> bool() -%% Option = {style, integer()} %% @doc See external documentation. +-spec showFullScreen(This, Show, [Option]) -> boolean() when + This::wxTopLevelWindow(), Show::boolean(), + Option :: {style, integer()}. showFullScreen(#wx_ref{type=ThisT,ref=ThisRef},Show, Options) when is_boolean(Show),is_list(Options) -> ?CLASS(ThisT,wxTopLevelWindow), diff --git a/lib/wx/src/gen/wxTreeCtrl.erl b/lib/wx/src/gen/wxTreeCtrl.erl index 77705ec76e..ba9052b5f3 100644 --- a/lib/wx/src/gen/wxTreeCtrl.erl +++ b/lib/wx/src/gen/wxTreeCtrl.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 @@ -89,27 +89,36 @@ show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1,update/1, updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxTreeCtrl/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxTreeCtrl() +-type wxTreeCtrl() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxTreeCtrl(). new() -> wxe_util:construct(?wxTreeCtrl_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow()) -> wxTreeCtrl() %% @equiv new(Parent, []) +-spec new(Parent) -> wxTreeCtrl() when + Parent::wxWindow:wxWindow(). + new(Parent) when is_record(Parent, wx_ref) -> new(Parent, []). -%% @spec (Parent::wxWindow:wxWindow(), [Option]) -> wxTreeCtrl() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec new(Parent, [Option]) -> wxTreeCtrl() when + Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. new(#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -123,15 +132,20 @@ new(#wx_ref{type=ParentT,ref=ParentRef}, Options) wxe_util:construct(?wxTreeCtrl_new_2, <>). -%% @spec (This::wxTreeCtrl(), Text::string()) -> integer() %% @equiv addRoot(This,Text, []) +-spec addRoot(This, Text) -> integer() when + This::wxTreeCtrl(), Text::string(). + addRoot(This,Text) when is_record(This, wx_ref),is_list(Text) -> addRoot(This,Text, []). -%% @spec (This::wxTreeCtrl(), Text::string(), [Option]) -> integer() -%% Option = {image, integer()} | {selectedImage, integer()} | {data, term()} %% @doc See external documentation. +-spec addRoot(This, Text, [Option]) -> integer() when + This::wxTreeCtrl(), Text::string(), + Option :: {image, integer()} + | {selectedImage, integer()} + | {data, term()}. addRoot(#wx_ref{type=ThisT,ref=ThisRef},Text, Options) when is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -144,15 +158,20 @@ addRoot(#wx_ref{type=ThisT,ref=ThisRef},Text, Options) wxe_util:call(?wxTreeCtrl_AddRoot, <>). -%% @spec (This::wxTreeCtrl(), Parent::integer(), Text::string()) -> integer() %% @equiv appendItem(This,Parent,Text, []) +-spec appendItem(This, Parent, Text) -> integer() when + This::wxTreeCtrl(), Parent::integer(), Text::string(). + appendItem(This,Parent,Text) when is_record(This, wx_ref),is_integer(Parent),is_list(Text) -> appendItem(This,Parent,Text, []). -%% @spec (This::wxTreeCtrl(), Parent::integer(), Text::string(), [Option]) -> integer() -%% Option = {image, integer()} | {selectedImage, integer()} | {data, term()} %% @doc See external documentation. +-spec appendItem(This, Parent, Text, [Option]) -> integer() when + This::wxTreeCtrl(), Parent::integer(), Text::string(), + Option :: {image, integer()} + | {selectedImage, integer()} + | {data, term()}. appendItem(#wx_ref{type=ThisT,ref=ThisRef},Parent,Text, Options) when is_integer(Parent),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -165,47 +184,58 @@ appendItem(#wx_ref{type=ThisT,ref=ThisRef},Parent,Text, Options) wxe_util:call(?wxTreeCtrl_AppendItem, <>). -%% @spec (This::wxTreeCtrl(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec assignImageList(This, ImageList) -> ok when + This::wxTreeCtrl(), ImageList::wxImageList:wxImageList(). assignImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxTreeCtrl), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxTreeCtrl_AssignImageList, <>). -%% @spec (This::wxTreeCtrl(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec assignStateImageList(This, ImageList) -> ok when + This::wxTreeCtrl(), ImageList::wxImageList:wxImageList(). assignStateImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxTreeCtrl), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxTreeCtrl_AssignStateImageList, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec collapse(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). collapse(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_Collapse, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec collapseAndReset(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). collapseAndReset(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_CollapseAndReset, <>). -%% @spec (This::wxTreeCtrl(), Parent::wxWindow:wxWindow()) -> bool() %% @equiv create(This,Parent, []) +-spec create(This, Parent) -> boolean() when + This::wxTreeCtrl(), Parent::wxWindow:wxWindow(). + create(This,Parent) when is_record(This, wx_ref),is_record(Parent, wx_ref) -> create(This,Parent, []). -%% @spec (This::wxTreeCtrl(), Parent::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx()} %% @doc See external documentation. +-spec create(This, Parent, [Option]) -> boolean() when + This::wxTreeCtrl(), Parent::wxWindow:wxWindow(), + Option :: {id, integer()} + | {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()} + | {validator, wx:wx()}. create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -220,62 +250,71 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, Opti wxe_util:call(?wxTreeCtrl_Create, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec delete(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). delete(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_Delete, <>). -%% @spec (This::wxTreeCtrl()) -> ok %% @doc See external documentation. +-spec deleteAllItems(This) -> ok when + This::wxTreeCtrl(). deleteAllItems(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_DeleteAllItems, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec deleteChildren(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). deleteChildren(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_DeleteChildren, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> wxTextCtrl:wxTextCtrl() %% @doc See external documentation. +-spec editLabel(This, Item) -> wxTextCtrl:wxTextCtrl() when + This::wxTreeCtrl(), Item::integer(). editLabel(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_EditLabel, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec ensureVisible(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). ensureVisible(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_EnsureVisible, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec expand(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). expand(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_Expand, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool() %% @equiv getBoundingRect(This,Item,Rect, []) +-spec getBoundingRect(This, Item, Rect) -> boolean() when + This::wxTreeCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. + getBoundingRect(This,Item,Rect={RectX,RectY,RectW,RectH}) when is_record(This, wx_ref),is_integer(Item),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> getBoundingRect(This,Item,Rect, []). -%% @spec (This::wxTreeCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, [Option]) -> bool() -%% Option = {textOnly, bool()} %% @doc See external documentation. +-spec getBoundingRect(This, Item, Rect, [Option]) -> boolean() when + This::wxTreeCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, + Option :: {textOnly, boolean()}. getBoundingRect(#wx_ref{type=ThisT,ref=ThisRef},Item,{RectX,RectY,RectW,RectH}, Options) when is_integer(Item),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -285,15 +324,18 @@ getBoundingRect(#wx_ref{type=ThisT,ref=ThisRef},Item,{RectX,RectY,RectW,RectH}, wxe_util:call(?wxTreeCtrl_GetBoundingRect, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> integer() %% @equiv getChildrenCount(This,Item, []) +-spec getChildrenCount(This, Item) -> integer() when + This::wxTreeCtrl(), Item::integer(). + getChildrenCount(This,Item) when is_record(This, wx_ref),is_integer(Item) -> getChildrenCount(This,Item, []). -%% @spec (This::wxTreeCtrl(), Item::integer(), [Option]) -> integer() -%% Option = {recursively, bool()} %% @doc See external documentation. +-spec getChildrenCount(This, Item, [Option]) -> integer() when + This::wxTreeCtrl(), Item::integer(), + Option :: {recursively, boolean()}. getChildrenCount(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) when is_integer(Item),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -303,94 +345,107 @@ getChildrenCount(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) wxe_util:call(?wxTreeCtrl_GetChildrenCount, <>). -%% @spec (This::wxTreeCtrl()) -> integer() %% @doc See external documentation. +-spec getCount(This) -> integer() when + This::wxTreeCtrl(). getCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetCount, <>). -%% @spec (This::wxTreeCtrl()) -> wxTextCtrl:wxTextCtrl() %% @doc See external documentation. +-spec getEditControl(This) -> wxTextCtrl:wxTextCtrl() when + This::wxTreeCtrl(). getEditControl(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetEditControl, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> {integer(), Cookie::integer()} %% @doc See external documentation. +-spec getFirstChild(This, Item) -> Result when + Result ::{Res ::integer(), Cookie::integer()}, + This::wxTreeCtrl(), Item::integer(). getFirstChild(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetFirstChild, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), Cookie::integer()) -> {integer(), Cookie::integer()} %% @doc See external documentation. +-spec getNextChild(This, Item, Cookie) -> Result when + Result ::{Res ::integer(), Cookie::integer()}, + This::wxTreeCtrl(), Item::integer(), Cookie::integer(). getNextChild(#wx_ref{type=ThisT,ref=ThisRef},Item,Cookie) when is_integer(Item),is_integer(Cookie) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetNextChild, <>). -%% @spec (This::wxTreeCtrl()) -> integer() %% @doc See external documentation. +-spec getFirstVisibleItem(This) -> integer() when + This::wxTreeCtrl(). getFirstVisibleItem(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetFirstVisibleItem, <>). -%% @spec (This::wxTreeCtrl()) -> wxImageList:wxImageList() %% @doc See external documentation. +-spec getImageList(This) -> wxImageList:wxImageList() when + This::wxTreeCtrl(). getImageList(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetImageList, <>). -%% @spec (This::wxTreeCtrl()) -> integer() %% @doc See external documentation. +-spec getIndent(This) -> integer() when + This::wxTreeCtrl(). getIndent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetIndent, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> wx:colour() %% @doc See external documentation. +-spec getItemBackgroundColour(This, Item) -> wx:wx_colour() when + This::wxTreeCtrl(), Item::integer(). getItemBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetItemBackgroundColour, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> term() %% @doc See external documentation. +-spec getItemData(This, Item) -> term() when + This::wxTreeCtrl(), Item::integer(). getItemData(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetItemData, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getItemFont(This, Item) -> wxFont:wxFont() when + This::wxTreeCtrl(), Item::integer(). getItemFont(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetItemFont, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> integer() %% @doc See external documentation. +-spec getItemImage(This, Item) -> integer() when + This::wxTreeCtrl(), Item::integer(). getItemImage(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetItemImage_1, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), [Option]) -> integer() -%% Option = {which, WxTreeItemIcon} -%% WxTreeItemIcon = integer() %% @doc See external documentation. -%%
WxTreeItemIcon is one of ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wxTreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wxTreeItemIcon_Max +%%
Which = ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wxTreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wxTreeItemIcon_Max +-spec getItemImage(This, Item, [Option]) -> integer() when + This::wxTreeCtrl(), Item::integer(), + Option :: {which, wx:wx_enum()}. getItemImage(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) when is_integer(Item),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -400,115 +455,134 @@ getItemImage(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) wxe_util:call(?wxTreeCtrl_GetItemImage_2, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> string() %% @doc See external documentation. +-spec getItemText(This, Item) -> string() when + This::wxTreeCtrl(), Item::integer(). getItemText(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetItemText, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> wx:colour() %% @doc See external documentation. +-spec getItemTextColour(This, Item) -> wx:wx_colour() when + This::wxTreeCtrl(), Item::integer(). getItemTextColour(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetItemTextColour, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> integer() %% @doc See external documentation. +-spec getLastChild(This, Item) -> integer() when + This::wxTreeCtrl(), Item::integer(). getLastChild(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetLastChild, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> integer() %% @doc See external documentation. +-spec getNextSibling(This, Item) -> integer() when + This::wxTreeCtrl(), Item::integer(). getNextSibling(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetNextSibling, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> integer() %% @doc See external documentation. +-spec getNextVisible(This, Item) -> integer() when + This::wxTreeCtrl(), Item::integer(). getNextVisible(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetNextVisible, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> integer() %% @doc See external documentation. +-spec getItemParent(This, Item) -> integer() when + This::wxTreeCtrl(), Item::integer(). getItemParent(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetItemParent, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> integer() %% @doc See external documentation. +-spec getPrevSibling(This, Item) -> integer() when + This::wxTreeCtrl(), Item::integer(). getPrevSibling(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetPrevSibling, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> integer() %% @doc See external documentation. +-spec getPrevVisible(This, Item) -> integer() when + This::wxTreeCtrl(), Item::integer(). getPrevVisible(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetPrevVisible, <>). -%% @spec (This::wxTreeCtrl()) -> integer() %% @doc See external documentation. +-spec getRootItem(This) -> integer() when + This::wxTreeCtrl(). getRootItem(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetRootItem, <>). -%% @spec (This::wxTreeCtrl()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxTreeCtrl(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetSelection, <>). -%% @spec (This::wxTreeCtrl()) -> {integer(), Val::[integer()]} %% @doc See external documentation. +-spec getSelections(This) -> Result when + Result ::{Res ::integer(), Val::[integer()]}, + This::wxTreeCtrl(). getSelections(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetSelections, <>). -%% @spec (This::wxTreeCtrl()) -> wxImageList:wxImageList() %% @doc See external documentation. +-spec getStateImageList(This) -> wxImageList:wxImageList() when + This::wxTreeCtrl(). getStateImageList(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_GetStateImageList, <>). -%% @spec (This::wxTreeCtrl(), Point::{X::integer(), Y::integer()}) -> integer() %% @doc See external documentation. +-spec hitTest(This, Point) -> integer() when + This::wxTreeCtrl(), Point::{X::integer(), Y::integer()}. hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PointX,PointY}) when is_integer(PointX),is_integer(PointY) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_HitTest, <>). -%% @spec (This::wxTreeCtrl(), Parent::integer(), Pos::integer(), Text::string()) -> integer() %% @equiv insertItem(This,Parent,Pos,Text, []) +-spec insertItem(This, Parent, Pos, Text) -> integer() when + This::wxTreeCtrl(), Parent::integer(), Pos::integer(), Text::string(). + insertItem(This,Parent,Pos,Text) when is_record(This, wx_ref),is_integer(Parent),is_integer(Pos),is_list(Text) -> insertItem(This,Parent,Pos,Text, []). -%% @spec (This::wxTreeCtrl(), Parent::integer(), Pos::integer(), Text::string(), [Option]) -> integer() -%% Option = {image, integer()} | {selImage, integer()} | {data, term()} %% @doc See external documentation. +-spec insertItem(This, Parent, Pos, Text, [Option]) -> integer() when + This::wxTreeCtrl(), Parent::integer(), Pos::integer(), Text::string(), + Option :: {image, integer()} + | {selImage, integer()} + | {data, term()}. insertItem(#wx_ref{type=ThisT,ref=ThisRef},Parent,Pos,Text, Options) when is_integer(Parent),is_integer(Pos),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -521,55 +595,65 @@ insertItem(#wx_ref{type=ThisT,ref=ThisRef},Parent,Pos,Text, Options) wxe_util:call(?wxTreeCtrl_InsertItem, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> bool() %% @doc See external documentation. +-spec isBold(This, Item) -> boolean() when + This::wxTreeCtrl(), Item::integer(). isBold(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_IsBold, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> bool() %% @doc See external documentation. +-spec isExpanded(This, Item) -> boolean() when + This::wxTreeCtrl(), Item::integer(). isExpanded(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_IsExpanded, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> bool() %% @doc See external documentation. +-spec isSelected(This, Item) -> boolean() when + This::wxTreeCtrl(), Item::integer(). isSelected(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_IsSelected, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> bool() %% @doc See external documentation. +-spec isVisible(This, Item) -> boolean() when + This::wxTreeCtrl(), Item::integer(). isVisible(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_IsVisible, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> bool() %% @doc See external documentation. +-spec itemHasChildren(This, Item) -> boolean() when + This::wxTreeCtrl(), Item::integer(). itemHasChildren(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:call(?wxTreeCtrl_ItemHasChildren, <>). -%% @spec (This::wxTreeCtrl(), Parent::integer(), Text::string()) -> integer() %% @equiv prependItem(This,Parent,Text, []) +-spec prependItem(This, Parent, Text) -> integer() when + This::wxTreeCtrl(), Parent::integer(), Text::string(). + prependItem(This,Parent,Text) when is_record(This, wx_ref),is_integer(Parent),is_list(Text) -> prependItem(This,Parent,Text, []). -%% @spec (This::wxTreeCtrl(), Parent::integer(), Text::string(), [Option]) -> integer() -%% Option = {image, integer()} | {selectedImage, integer()} | {data, term()} %% @doc See external documentation. +-spec prependItem(This, Parent, Text, [Option]) -> integer() when + This::wxTreeCtrl(), Parent::integer(), Text::string(), + Option :: {image, integer()} + | {selectedImage, integer()} + | {data, term()}. prependItem(#wx_ref{type=ThisT,ref=ThisRef},Parent,Text, Options) when is_integer(Parent),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -582,25 +666,28 @@ prependItem(#wx_ref{type=ThisT,ref=ThisRef},Parent,Text, Options) wxe_util:call(?wxTreeCtrl_PrependItem, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec scrollTo(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). scrollTo(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_ScrollTo, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec selectItem(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). selectItem(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_SelectItem_1, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), [Option]) -> ok -%% Option = {select, bool()} %% @doc See external documentation. +-spec selectItem(This, Item, [Option]) -> ok when + This::wxTreeCtrl(), Item::integer(), + Option :: {select, boolean()}. selectItem(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) when is_integer(Item),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -610,39 +697,45 @@ selectItem(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) wxe_util:cast(?wxTreeCtrl_SelectItem_2, <>). -%% @spec (This::wxTreeCtrl(), Indent::integer()) -> ok %% @doc See external documentation. +-spec setIndent(This, Indent) -> ok when + This::wxTreeCtrl(), Indent::integer(). setIndent(#wx_ref{type=ThisT,ref=ThisRef},Indent) when is_integer(Indent) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_SetIndent, <>). -%% @spec (This::wxTreeCtrl(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec setImageList(This, ImageList) -> ok when + This::wxTreeCtrl(), ImageList::wxImageList:wxImageList(). setImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxTreeCtrl), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxTreeCtrl_SetImageList, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), Col::wx:colour()) -> ok %% @doc See external documentation. +-spec setItemBackgroundColour(This, Item, Col) -> ok when + This::wxTreeCtrl(), Item::integer(), Col::wx:wx_colour(). setItemBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Item,Col) when is_integer(Item),tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_SetItemBackgroundColour, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @equiv setItemBold(This,Item, []) +-spec setItemBold(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). + setItemBold(This,Item) when is_record(This, wx_ref),is_integer(Item) -> setItemBold(This,Item, []). -%% @spec (This::wxTreeCtrl(), Item::integer(), [Option]) -> ok -%% Option = {bold, bool()} %% @doc See external documentation. +-spec setItemBold(This, Item, [Option]) -> ok when + This::wxTreeCtrl(), Item::integer(), + Option :: {bold, boolean()}. setItemBold(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) when is_integer(Item),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -652,8 +745,9 @@ setItemBold(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) wxe_util:cast(?wxTreeCtrl_SetItemBold, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), Data::term()) -> ok %% @doc See external documentation. +-spec setItemData(This, Item, Data) -> ok when + This::wxTreeCtrl(), Item::integer(), Data::term(). setItemData(#wx_ref{type=ThisT,ref=ThisRef},Item,Data) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), @@ -661,15 +755,18 @@ setItemData(#wx_ref{type=ThisT,ref=ThisRef},Item,Data) wxe_util:cast(?wxTreeCtrl_SetItemData, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @equiv setItemDropHighlight(This,Item, []) +-spec setItemDropHighlight(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). + setItemDropHighlight(This,Item) when is_record(This, wx_ref),is_integer(Item) -> setItemDropHighlight(This,Item, []). -%% @spec (This::wxTreeCtrl(), Item::integer(), [Option]) -> ok -%% Option = {highlight, bool()} %% @doc See external documentation. +-spec setItemDropHighlight(This, Item, [Option]) -> ok when + This::wxTreeCtrl(), Item::integer(), + Option :: {highlight, boolean()}. setItemDropHighlight(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) when is_integer(Item),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -679,8 +776,9 @@ setItemDropHighlight(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) wxe_util:cast(?wxTreeCtrl_SetItemDropHighlight, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setItemFont(This, Item, Font) -> ok when + This::wxTreeCtrl(), Item::integer(), Font::wxFont:wxFont(). setItemFont(#wx_ref{type=ThisT,ref=ThisRef},Item,#wx_ref{type=FontT,ref=FontRef}) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), @@ -688,15 +786,18 @@ setItemFont(#wx_ref{type=ThisT,ref=ThisRef},Item,#wx_ref{type=FontT,ref=FontRef} wxe_util:cast(?wxTreeCtrl_SetItemFont, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @equiv setItemHasChildren(This,Item, []) +-spec setItemHasChildren(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). + setItemHasChildren(This,Item) when is_record(This, wx_ref),is_integer(Item) -> setItemHasChildren(This,Item, []). -%% @spec (This::wxTreeCtrl(), Item::integer(), [Option]) -> ok -%% Option = {has, bool()} %% @doc See external documentation. +-spec setItemHasChildren(This, Item, [Option]) -> ok when + This::wxTreeCtrl(), Item::integer(), + Option :: {has, boolean()}. setItemHasChildren(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) when is_integer(Item),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -706,19 +807,20 @@ setItemHasChildren(#wx_ref{type=ThisT,ref=ThisRef},Item, Options) wxe_util:cast(?wxTreeCtrl_SetItemHasChildren, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), Image::integer()) -> ok %% @doc See external documentation. +-spec setItemImage(This, Item, Image) -> ok when + This::wxTreeCtrl(), Item::integer(), Image::integer(). setItemImage(#wx_ref{type=ThisT,ref=ThisRef},Item,Image) when is_integer(Item),is_integer(Image) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_SetItemImage_2, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), Image::integer(), [Option]) -> ok -%% Option = {which, WxTreeItemIcon} -%% WxTreeItemIcon = integer() %% @doc See external documentation. -%%
WxTreeItemIcon is one of ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wxTreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wxTreeItemIcon_Max +%%
Which = ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wxTreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wxTreeItemIcon_Max +-spec setItemImage(This, Item, Image, [Option]) -> ok when + This::wxTreeCtrl(), Item::integer(), Image::integer(), + Option :: {which, wx:wx_enum()}. setItemImage(#wx_ref{type=ThisT,ref=ThisRef},Item,Image, Options) when is_integer(Item),is_integer(Image),is_list(Options) -> ?CLASS(ThisT,wxTreeCtrl), @@ -728,8 +830,9 @@ setItemImage(#wx_ref{type=ThisT,ref=ThisRef},Item,Image, Options) wxe_util:cast(?wxTreeCtrl_SetItemImage_3, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), Text::string()) -> ok %% @doc See external documentation. +-spec setItemText(This, Item, Text) -> ok when + This::wxTreeCtrl(), Item::integer(), Text::string(). setItemText(#wx_ref{type=ThisT,ref=ThisRef},Item,Text) when is_integer(Item),is_list(Text) -> ?CLASS(ThisT,wxTreeCtrl), @@ -737,78 +840,87 @@ setItemText(#wx_ref{type=ThisT,ref=ThisRef},Item,Text) wxe_util:cast(?wxTreeCtrl_SetItemText, <>). -%% @spec (This::wxTreeCtrl(), Item::integer(), Col::wx:colour()) -> ok %% @doc See external documentation. +-spec setItemTextColour(This, Item, Col) -> ok when + This::wxTreeCtrl(), Item::integer(), Col::wx:wx_colour(). setItemTextColour(#wx_ref{type=ThisT,ref=ThisRef},Item,Col) when is_integer(Item),tuple_size(Col) =:= 3; tuple_size(Col) =:= 4 -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_SetItemTextColour, <>). -%% @spec (This::wxTreeCtrl(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec setStateImageList(This, ImageList) -> ok when + This::wxTreeCtrl(), ImageList::wxImageList:wxImageList(). setStateImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxTreeCtrl), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxTreeCtrl_SetStateImageList, <>). -%% @spec (This::wxTreeCtrl(), Styles::integer()) -> ok %% @doc See external documentation. +-spec setWindowStyle(This, Styles) -> ok when + This::wxTreeCtrl(), Styles::integer(). setWindowStyle(#wx_ref{type=ThisT,ref=ThisRef},Styles) when is_integer(Styles) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_SetWindowStyle, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec sortChildren(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). sortChildren(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_SortChildren, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec toggle(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). toggle(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_Toggle, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec toggleItemSelection(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). toggleItemSelection(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_ToggleItemSelection, <>). -%% @spec (This::wxTreeCtrl()) -> ok %% @doc See external documentation. +-spec unselect(This) -> ok when + This::wxTreeCtrl(). unselect(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_Unselect, <>). -%% @spec (This::wxTreeCtrl()) -> ok %% @doc See external documentation. +-spec unselectAll(This) -> ok when + This::wxTreeCtrl(). unselectAll(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_UnselectAll, <>). -%% @spec (This::wxTreeCtrl(), Item::integer()) -> ok %% @doc See external documentation. +-spec unselectItem(This, Item) -> ok when + This::wxTreeCtrl(), Item::integer(). unselectItem(#wx_ref{type=ThisT,ref=ThisRef},Item) when is_integer(Item) -> ?CLASS(ThisT,wxTreeCtrl), wxe_util:cast(?wxTreeCtrl_UnselectItem, <>). -%% @spec (This::wxTreeCtrl()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxTreeCtrl) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxTreeCtrl), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxTreeEvent.erl b/lib/wx/src/gen/wxTreeEvent.erl index 0264d43568..8c91d73dbd 100644 --- a/lib/wx/src/gen/wxTreeEvent.erl +++ b/lib/wx/src/gen/wxTreeEvent.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 @@ -42,63 +42,73 @@ isSelection/1,parent_class/1,resumePropagation/2,setInt/2,setString/2, shouldPropagate/1,skip/1,skip/2,stopPropagation/1,veto/1]). +-export_type([wxTreeEvent/0]). %% @hidden parent_class(wxNotifyEvent) -> true; parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (This::wxTreeEvent()) -> integer() +-type wxTreeEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec getKeyCode(This) -> integer() when + This::wxTreeEvent(). getKeyCode(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeEvent), wxe_util:call(?wxTreeEvent_GetKeyCode, <>). -%% @spec (This::wxTreeEvent()) -> integer() %% @doc See external documentation. +-spec getItem(This) -> integer() when + This::wxTreeEvent(). getItem(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeEvent), wxe_util:call(?wxTreeEvent_GetItem, <>). -%% @spec (This::wxTreeEvent()) -> wxKeyEvent:wxKeyEvent() %% @doc See external documentation. +-spec getKeyEvent(This) -> wxKeyEvent:wxKeyEvent() when + This::wxTreeEvent(). getKeyEvent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeEvent), wxe_util:call(?wxTreeEvent_GetKeyEvent, <>). -%% @spec (This::wxTreeEvent()) -> string() %% @doc See external documentation. +-spec getLabel(This) -> string() when + This::wxTreeEvent(). getLabel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeEvent), wxe_util:call(?wxTreeEvent_GetLabel, <>). -%% @spec (This::wxTreeEvent()) -> integer() %% @doc See external documentation. +-spec getOldItem(This) -> integer() when + This::wxTreeEvent(). getOldItem(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeEvent), wxe_util:call(?wxTreeEvent_GetOldItem, <>). -%% @spec (This::wxTreeEvent()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPoint(This) -> {X::integer(), Y::integer()} when + This::wxTreeEvent(). getPoint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeEvent), wxe_util:call(?wxTreeEvent_GetPoint, <>). -%% @spec (This::wxTreeEvent()) -> bool() %% @doc See external documentation. +-spec isEditCancelled(This) -> boolean() when + This::wxTreeEvent(). isEditCancelled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreeEvent), wxe_util:call(?wxTreeEvent_IsEditCancelled, <>). -%% @spec (This::wxTreeEvent(), ToolTip::string()) -> ok %% @doc See external documentation. +-spec setToolTip(This, ToolTip) -> ok when + This::wxTreeEvent(), ToolTip::string(). setToolTip(#wx_ref{type=ThisT,ref=ThisRef},ToolTip) when is_list(ToolTip) -> ?CLASS(ThisT,wxTreeEvent), diff --git a/lib/wx/src/gen/wxTreebook.erl b/lib/wx/src/gen/wxTreebook.erl index 24f5d72c43..945cfb62e1 100644 --- a/lib/wx/src/gen/wxTreebook.erl +++ b/lib/wx/src/gen/wxTreebook.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2009-2011. All Rights Reserved. +%% Copyright Ericsson AB 2009-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 @@ -75,27 +75,34 @@ show/1,show/2,thaw/1,transferDataFromWindow/1,transferDataToWindow/1, update/1,updateWindowUI/1,updateWindowUI/2,validate/1,warpPointer/3]). +-export_type([wxTreebook/0]). %% @hidden parent_class(wxControl) -> true; parent_class(wxWindow) -> true; parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxTreebook() +-type wxTreebook() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxTreebook(). new() -> wxe_util:construct(?wxTreebook_new_0, <<>>). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer()) -> wxTreebook() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxTreebook() when + Parent::wxWindow:wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxTreebook() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxTreebook() when + Parent::wxWindow:wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -107,15 +114,19 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxTreebook_new_3, <>). -%% @spec (This::wxTreebook(), Page::wxWindow:wxWindow(), Text::string()) -> bool() %% @equiv addPage(This,Page,Text, []) +-spec addPage(This, Page, Text) -> boolean() when + This::wxTreebook(), 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::wxTreebook(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool() -%% Option = {bSelect, bool()} | {imageId, integer()} %% @doc See external documentation. +-spec addPage(This, Page, Text, [Option]) -> boolean() when + This::wxTreebook(), 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,wxTreebook), @@ -128,15 +139,18 @@ addPage(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PageT,ref=PageRef},Text, Op wxe_util:call(?wxTreebook_AddPage, <>). -%% @spec (This::wxTreebook()) -> ok %% @equiv advanceSelection(This, []) +-spec advanceSelection(This) -> ok when + This::wxTreebook(). + advanceSelection(This) when is_record(This, wx_ref) -> advanceSelection(This, []). -%% @spec (This::wxTreebook(), [Option]) -> ok -%% Option = {forward, bool()} %% @doc See external documentation. +-spec advanceSelection(This, [Option]) -> ok when + This::wxTreebook(), + Option :: {forward, boolean()}. advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxTreebook), @@ -146,23 +160,29 @@ advanceSelection(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxTreebook_AdvanceSelection, <>). -%% @spec (This::wxTreebook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec assignImageList(This, ImageList) -> ok when + This::wxTreebook(), ImageList::wxImageList:wxImageList(). assignImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxTreebook), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxTreebook_AssignImageList, <>). -%% @spec (This::wxTreebook(), Parent::wxWindow:wxWindow(), Id::integer()) -> bool() %% @equiv create(This,Parent,Id, []) +-spec create(This, Parent, Id) -> boolean() when + This::wxTreebook(), 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::wxTreebook(), Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec create(This, Parent, Id, [Option]) -> boolean() when + This::wxTreebook(), 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,wxTreebook), @@ -175,90 +195,103 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxTreebook_Create, <>). -%% @spec (This::wxTreebook()) -> bool() %% @doc See external documentation. +-spec deleteAllPages(This) -> boolean() when + This::wxTreebook(). deleteAllPages(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_DeleteAllPages, <>). -%% @spec (This::wxTreebook(), Pos::integer()) -> bool() %% @doc See external documentation. +-spec deletePage(This, Pos) -> boolean() when + This::wxTreebook(), Pos::integer(). deletePage(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_DeletePage, <>). -%% @spec (This::wxTreebook(), N::integer()) -> bool() %% @doc See external documentation. +-spec removePage(This, N) -> boolean() when + This::wxTreebook(), N::integer(). removePage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_RemovePage, <>). -%% @spec (This::wxTreebook()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getCurrentPage(This) -> wxWindow:wxWindow() when + This::wxTreebook(). getCurrentPage(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_GetCurrentPage, <>). -%% @spec (This::wxTreebook()) -> wxImageList:wxImageList() %% @doc See external documentation. +-spec getImageList(This) -> wxImageList:wxImageList() when + This::wxTreebook(). getImageList(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_GetImageList, <>). -%% @spec (This::wxTreebook(), N::integer()) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec getPage(This, N) -> wxWindow:wxWindow() when + This::wxTreebook(), N::integer(). getPage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_GetPage, <>). -%% @spec (This::wxTreebook()) -> integer() %% @doc See external documentation. +-spec getPageCount(This) -> integer() when + This::wxTreebook(). getPageCount(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_GetPageCount, <>). -%% @spec (This::wxTreebook(), N::integer()) -> integer() %% @doc See external documentation. +-spec getPageImage(This, N) -> integer() when + This::wxTreebook(), N::integer(). getPageImage(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_GetPageImage, <>). -%% @spec (This::wxTreebook(), N::integer()) -> string() %% @doc See external documentation. +-spec getPageText(This, N) -> string() when + This::wxTreebook(), N::integer(). getPageText(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_GetPageText, <>). -%% @spec (This::wxTreebook()) -> integer() %% @doc See external documentation. +-spec getSelection(This) -> integer() when + This::wxTreebook(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_GetSelection, <>). -%% @spec (This::wxTreebook(), Pos::integer()) -> bool() %% @equiv expandNode(This,Pos, []) +-spec expandNode(This, Pos) -> boolean() when + This::wxTreebook(), Pos::integer(). + expandNode(This,Pos) when is_record(This, wx_ref),is_integer(Pos) -> expandNode(This,Pos, []). -%% @spec (This::wxTreebook(), Pos::integer(), [Option]) -> bool() -%% Option = {expand, bool()} %% @doc See external documentation. +-spec expandNode(This, Pos, [Option]) -> boolean() when + This::wxTreebook(), Pos::integer(), + Option :: {expand, boolean()}. expandNode(#wx_ref{type=ThisT,ref=ThisRef},Pos, Options) when is_integer(Pos),is_list(Options) -> ?CLASS(ThisT,wxTreebook), @@ -268,31 +301,38 @@ expandNode(#wx_ref{type=ThisT,ref=ThisRef},Pos, Options) wxe_util:call(?wxTreebook_ExpandNode, <>). -%% @spec (This::wxTreebook(), Pos::integer()) -> bool() %% @doc See external documentation. +-spec isNodeExpanded(This, Pos) -> boolean() when + This::wxTreebook(), Pos::integer(). isNodeExpanded(#wx_ref{type=ThisT,ref=ThisRef},Pos) when is_integer(Pos) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_IsNodeExpanded, <>). -%% @spec (This::wxTreebook(), Pt::{X::integer(), Y::integer()}) -> {integer(), Flags::integer()} %% @doc See external documentation. +-spec hitTest(This, Pt) -> Result when + Result ::{Res ::integer(), Flags::integer()}, + This::wxTreebook(), Pt::{X::integer(), Y::integer()}. hitTest(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_HitTest, <>). -%% @spec (This::wxTreebook(), Pos::integer(), Page::wxWindow:wxWindow(), Text::string()) -> bool() %% @equiv insertPage(This,Pos,Page,Text, []) +-spec insertPage(This, Pos, Page, Text) -> boolean() when + This::wxTreebook(), Pos::integer(), Page::wxWindow:wxWindow(), Text::string(). + insertPage(This,Pos,Page,Text) when is_record(This, wx_ref),is_integer(Pos),is_record(Page, wx_ref),is_list(Text) -> insertPage(This,Pos,Page,Text, []). -%% @spec (This::wxTreebook(), Pos::integer(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool() -%% Option = {bSelect, bool()} | {imageId, integer()} %% @doc See external documentation. +-spec insertPage(This, Pos, Page, Text, [Option]) -> boolean() when + This::wxTreebook(), Pos::integer(), Page::wxWindow:wxWindow(), Text::string(), + Option :: {bSelect, boolean()} + | {imageId, integer()}. insertPage(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=PageT,ref=PageRef},Text, Options) when is_integer(Pos),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxTreebook), @@ -305,15 +345,19 @@ insertPage(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=PageT,ref=PageRef},T wxe_util:call(?wxTreebook_InsertPage, <>). -%% @spec (This::wxTreebook(), Pos::integer(), Page::wxWindow:wxWindow(), Text::string()) -> bool() %% @equiv insertSubPage(This,Pos,Page,Text, []) +-spec insertSubPage(This, Pos, Page, Text) -> boolean() when + This::wxTreebook(), Pos::integer(), Page::wxWindow:wxWindow(), Text::string(). + insertSubPage(This,Pos,Page,Text) when is_record(This, wx_ref),is_integer(Pos),is_record(Page, wx_ref),is_list(Text) -> insertSubPage(This,Pos,Page,Text, []). -%% @spec (This::wxTreebook(), Pos::integer(), Page::wxWindow:wxWindow(), Text::string(), [Option]) -> bool() -%% Option = {bSelect, bool()} | {imageId, integer()} %% @doc See external documentation. +-spec insertSubPage(This, Pos, Page, Text, [Option]) -> boolean() when + This::wxTreebook(), Pos::integer(), Page::wxWindow:wxWindow(), Text::string(), + Option :: {bSelect, boolean()} + | {imageId, integer()}. insertSubPage(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=PageT,ref=PageRef},Text, Options) when is_integer(Pos),is_list(Text),is_list(Options) -> ?CLASS(ThisT,wxTreebook), @@ -326,32 +370,36 @@ insertSubPage(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=PageT,ref=PageRef wxe_util:call(?wxTreebook_InsertSubPage, <>). -%% @spec (This::wxTreebook(), ImageList::wxImageList:wxImageList()) -> ok %% @doc See external documentation. +-spec setImageList(This, ImageList) -> ok when + This::wxTreebook(), ImageList::wxImageList:wxImageList(). setImageList(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ImageListT,ref=ImageListRef}) -> ?CLASS(ThisT,wxTreebook), ?CLASS(ImageListT,wxImageList), wxe_util:cast(?wxTreebook_SetImageList, <>). -%% @spec (This::wxTreebook(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setPageSize(This, Size) -> ok when + This::wxTreebook(), Size::{W::integer(), H::integer()}. setPageSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxTreebook), wxe_util:cast(?wxTreebook_SetPageSize, <>). -%% @spec (This::wxTreebook(), N::integer(), ImageId::integer()) -> bool() %% @doc See external documentation. +-spec setPageImage(This, N, ImageId) -> boolean() when + This::wxTreebook(), N::integer(), ImageId::integer(). setPageImage(#wx_ref{type=ThisT,ref=ThisRef},N,ImageId) when is_integer(N),is_integer(ImageId) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_SetPageImage, <>). -%% @spec (This::wxTreebook(), N::integer(), StrText::string()) -> bool() %% @doc See external documentation. +-spec setPageText(This, N, StrText) -> boolean() when + This::wxTreebook(), N::integer(), StrText::string(). setPageText(#wx_ref{type=ThisT,ref=ThisRef},N,StrText) when is_integer(N),is_list(StrText) -> ?CLASS(ThisT,wxTreebook), @@ -359,24 +407,26 @@ setPageText(#wx_ref{type=ThisT,ref=ThisRef},N,StrText) wxe_util:call(?wxTreebook_SetPageText, <>). -%% @spec (This::wxTreebook(), N::integer()) -> integer() %% @doc See external documentation. +-spec setSelection(This, N) -> integer() when + This::wxTreebook(), N::integer(). setSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_SetSelection, <>). -%% @spec (This::wxTreebook(), N::integer()) -> integer() %% @doc See external documentation. +-spec changeSelection(This, N) -> integer() when + This::wxTreebook(), N::integer(). changeSelection(#wx_ref{type=ThisT,ref=ThisRef},N) when is_integer(N) -> ?CLASS(ThisT,wxTreebook), wxe_util:call(?wxTreebook_ChangeSelection, <>). -%% @spec (This::wxTreebook()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxTreebook) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxTreebook), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxUpdateUIEvent.erl b/lib/wx/src/gen/wxUpdateUIEvent.erl index baf9fc8b52..26cf81f72d 100644 --- a/lib/wx/src/gen/wxUpdateUIEvent.erl +++ b/lib/wx/src/gen/wxUpdateUIEvent.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 @@ -42,129 +42,143 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxUpdateUIEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec (Win::wxWindow:wxWindow()) -> bool() +-type wxUpdateUIEvent() :: wx:wx_object(). %% @doc See external documentation. +-spec canUpdate(Win) -> boolean() when + Win::wxWindow:wxWindow(). canUpdate(#wx_ref{type=WinT,ref=WinRef}) -> ?CLASS(WinT,wxWindow), wxe_util:call(?wxUpdateUIEvent_CanUpdate, <>). -%% @spec (This::wxUpdateUIEvent(), Check::bool()) -> ok %% @doc See external documentation. +-spec check(This, Check) -> ok when + This::wxUpdateUIEvent(), Check::boolean(). check(#wx_ref{type=ThisT,ref=ThisRef},Check) when is_boolean(Check) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:cast(?wxUpdateUIEvent_Check, <>). -%% @spec (This::wxUpdateUIEvent(), Enable::bool()) -> ok %% @doc See external documentation. +-spec enable(This, Enable) -> ok when + This::wxUpdateUIEvent(), Enable::boolean(). enable(#wx_ref{type=ThisT,ref=ThisRef},Enable) when is_boolean(Enable) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:cast(?wxUpdateUIEvent_Enable, <>). -%% @spec (This::wxUpdateUIEvent(), Show::bool()) -> ok %% @doc See external documentation. +-spec show(This, Show) -> ok when + This::wxUpdateUIEvent(), Show::boolean(). show(#wx_ref{type=ThisT,ref=ThisRef},Show) when is_boolean(Show) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:cast(?wxUpdateUIEvent_Show, <>). -%% @spec (This::wxUpdateUIEvent()) -> bool() %% @doc See external documentation. +-spec getChecked(This) -> boolean() when + This::wxUpdateUIEvent(). getChecked(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:call(?wxUpdateUIEvent_GetChecked, <>). -%% @spec (This::wxUpdateUIEvent()) -> bool() %% @doc See external documentation. +-spec getEnabled(This) -> boolean() when + This::wxUpdateUIEvent(). getEnabled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:call(?wxUpdateUIEvent_GetEnabled, <>). -%% @spec (This::wxUpdateUIEvent()) -> bool() %% @doc See external documentation. +-spec getShown(This) -> boolean() when + This::wxUpdateUIEvent(). getShown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:call(?wxUpdateUIEvent_GetShown, <>). -%% @spec (This::wxUpdateUIEvent()) -> bool() %% @doc See external documentation. +-spec getSetChecked(This) -> boolean() when + This::wxUpdateUIEvent(). getSetChecked(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:call(?wxUpdateUIEvent_GetSetChecked, <>). -%% @spec (This::wxUpdateUIEvent()) -> bool() %% @doc See external documentation. +-spec getSetEnabled(This) -> boolean() when + This::wxUpdateUIEvent(). getSetEnabled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:call(?wxUpdateUIEvent_GetSetEnabled, <>). -%% @spec (This::wxUpdateUIEvent()) -> bool() %% @doc See external documentation. +-spec getSetShown(This) -> boolean() when + This::wxUpdateUIEvent(). getSetShown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:call(?wxUpdateUIEvent_GetSetShown, <>). -%% @spec (This::wxUpdateUIEvent()) -> bool() %% @doc See external documentation. +-spec getSetText(This) -> boolean() when + This::wxUpdateUIEvent(). getSetText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:call(?wxUpdateUIEvent_GetSetText, <>). -%% @spec (This::wxUpdateUIEvent()) -> string() %% @doc See external documentation. +-spec getText(This) -> string() when + This::wxUpdateUIEvent(). getText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxUpdateUIEvent), wxe_util:call(?wxUpdateUIEvent_GetText, <>). -%% @spec () -> WxUpdateUIMode -%% WxUpdateUIMode = integer() %% @doc See external documentation. -%%
WxUpdateUIMode is one of ?wxUPDATE_UI_PROCESS_ALL | ?wxUPDATE_UI_PROCESS_SPECIFIED +%%
Res = ?wxUPDATE_UI_PROCESS_ALL | ?wxUPDATE_UI_PROCESS_SPECIFIED +-spec getMode() -> wx:wx_enum(). getMode() -> wxe_util:call(?wxUpdateUIEvent_GetMode, <<>>). -%% @spec () -> integer() %% @doc See external documentation. +-spec getUpdateInterval() -> integer(). getUpdateInterval() -> wxe_util:call(?wxUpdateUIEvent_GetUpdateInterval, <<>>). -%% @spec () -> ok %% @doc See external documentation. +-spec resetUpdateTime() -> ok. resetUpdateTime() -> wxe_util:cast(?wxUpdateUIEvent_ResetUpdateTime, <<>>). -%% @spec (Mode::WxUpdateUIMode) -> ok -%% WxUpdateUIMode = integer() %% @doc See external documentation. -%%
WxUpdateUIMode is one of ?wxUPDATE_UI_PROCESS_ALL | ?wxUPDATE_UI_PROCESS_SPECIFIED +%%
Mode = ?wxUPDATE_UI_PROCESS_ALL | ?wxUPDATE_UI_PROCESS_SPECIFIED +-spec setMode(Mode) -> ok when + Mode::wx:wx_enum(). setMode(Mode) when is_integer(Mode) -> wxe_util:cast(?wxUpdateUIEvent_SetMode, <>). -%% @spec (This::wxUpdateUIEvent(), Text::string()) -> ok %% @doc See external documentation. +-spec setText(This, Text) -> ok when + This::wxUpdateUIEvent(), Text::string(). setText(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxUpdateUIEvent), @@ -172,8 +186,9 @@ setText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxUpdateUIEvent_SetText, <>). -%% @spec (UpdateInterval::integer()) -> ok %% @doc See external documentation. +-spec setUpdateInterval(UpdateInterval) -> ok when + UpdateInterval::integer(). setUpdateInterval(UpdateInterval) when is_integer(UpdateInterval) -> wxe_util:cast(?wxUpdateUIEvent_SetUpdateInterval, diff --git a/lib/wx/src/gen/wxWindow.erl b/lib/wx/src/gen/wxWindow.erl index 6b57cf508e..9c4d3596fe 100644 --- a/lib/wx/src/gen/wxWindow.erl +++ b/lib/wx/src/gen/wxWindow.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 @@ -69,25 +69,32 @@ %% inherited exports -export([connect/2,connect/3,disconnect/1,disconnect/2,disconnect/3,parent_class/1]). +-export_type([wxWindow/0]). %% @hidden parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxWindow() +-type wxWindow() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxWindow(). new() -> wxe_util:construct(?wxWindow_new_0, <<>>). -%% @spec (Parent::wxWindow(), Id::integer()) -> wxWindow() %% @equiv new(Parent,Id, []) +-spec new(Parent, Id) -> wxWindow() when + Parent::wxWindow(), Id::integer(). + new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @spec (Parent::wxWindow(), Id::integer(), [Option]) -> wxWindow() -%% Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} %% @doc See external documentation. +-spec new(Parent, Id, [Option]) -> wxWindow() when + Parent::wxWindow(), Id::integer(), + Option :: {pos, {X::integer(), Y::integer()}} + | {size, {W::integer(), H::integer()}} + | {style, integer()}. new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) when is_integer(Id),is_list(Options) -> ?CLASS(ParentT,wxWindow), @@ -99,30 +106,35 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxWindow_new_3, <>). -%% @spec (This::wxWindow(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec cacheBestSize(This, Size) -> ok when + This::wxWindow(), Size::{W::integer(), H::integer()}. cacheBestSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_CacheBestSize, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec captureMouse(This) -> ok when + This::wxWindow(). captureMouse(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_CaptureMouse, <>). -%% @spec (This::wxWindow()) -> ok %% @equiv center(This, []) +-spec center(This) -> ok when + This::wxWindow(). + center(This) when is_record(This, wx_ref) -> center(This, []). -%% @spec (This::wxWindow(), [Option]) -> ok -%% Option = {dir, integer()} %% @doc See external documentation. +-spec center(This, [Option]) -> ok when + This::wxWindow(), + Option :: {dir, integer()}. center(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -132,15 +144,18 @@ center(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxWindow_Center, <>). -%% @spec (This::wxWindow()) -> ok %% @equiv centerOnParent(This, []) +-spec centerOnParent(This) -> ok when + This::wxWindow(). + centerOnParent(This) when is_record(This, wx_ref) -> centerOnParent(This, []). -%% @spec (This::wxWindow(), [Option]) -> ok -%% Option = {dir, integer()} %% @doc See external documentation. +-spec centerOnParent(This, [Option]) -> ok when + This::wxWindow(), + Option :: {dir, integer()}. centerOnParent(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -150,15 +165,18 @@ centerOnParent(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxWindow_CenterOnParent, <>). -%% @spec (This::wxWindow()) -> ok %% @equiv centre(This, []) +-spec centre(This) -> ok when + This::wxWindow(). + centre(This) when is_record(This, wx_ref) -> centre(This, []). -%% @spec (This::wxWindow(), [Option]) -> ok -%% Option = {dir, integer()} %% @doc See external documentation. +-spec centre(This, [Option]) -> ok when + This::wxWindow(), + Option :: {dir, integer()}. centre(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -168,15 +186,18 @@ centre(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxWindow_Centre, <>). -%% @spec (This::wxWindow()) -> ok %% @equiv centreOnParent(This, []) +-spec centreOnParent(This) -> ok when + This::wxWindow(). + centreOnParent(This) when is_record(This, wx_ref) -> centreOnParent(This, []). -%% @spec (This::wxWindow(), [Option]) -> ok -%% Option = {dir, integer()} %% @doc See external documentation. +-spec centreOnParent(This, [Option]) -> ok when + This::wxWindow(), + Option :: {dir, integer()}. centreOnParent(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -186,38 +207,44 @@ centreOnParent(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxWindow_CentreOnParent, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec clearBackground(This) -> ok when + This::wxWindow(). clearBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_ClearBackground, <>). -%% @spec (This::wxWindow(), Pt::{X::integer(), Y::integer()}) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec clientToScreen(This, Pt) -> {X::integer(), Y::integer()} when + This::wxWindow(), Pt::{X::integer(), Y::integer()}. clientToScreen(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_ClientToScreen_1, <>). -%% @spec (This::wxWindow(), X::integer(), Y::integer()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec clientToScreen(This, X, Y) -> {X::integer(), Y::integer()} when + This::wxWindow(), X::integer(), Y::integer(). clientToScreen(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_ClientToScreen_2, <>). -%% @spec (This::wxWindow()) -> bool() %% @equiv close(This, []) +-spec close(This) -> boolean() when + This::wxWindow(). + close(This) when is_record(This, wx_ref) -> close(This, []). -%% @spec (This::wxWindow(), [Option]) -> bool() -%% Option = {force, bool()} %% @doc See external documentation. +-spec close(This, [Option]) -> boolean() when + This::wxWindow(), + Option :: {force, boolean()}. close(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -227,52 +254,60 @@ close(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxWindow_Close, <>). -%% @spec (This::wxWindow(), Sz::{W::integer(), H::integer()}) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec convertDialogToPixels(This, Sz) -> {W::integer(), H::integer()} when + This::wxWindow(), Sz::{W::integer(), H::integer()}. convertDialogToPixels(#wx_ref{type=ThisT,ref=ThisRef},{SzW,SzH}) when is_integer(SzW),is_integer(SzH) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_ConvertDialogToPixels, <>). -%% @spec (This::wxWindow(), Sz::{W::integer(), H::integer()}) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec convertPixelsToDialog(This, Sz) -> {W::integer(), H::integer()} when + This::wxWindow(), Sz::{W::integer(), H::integer()}. convertPixelsToDialog(#wx_ref{type=ThisT,ref=ThisRef},{SzW,SzH}) when is_integer(SzW),is_integer(SzH) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_ConvertPixelsToDialog, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec 'Destroy'(This) -> boolean() when + This::wxWindow(). 'Destroy'(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_Destroy, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec destroyChildren(This) -> boolean() when + This::wxWindow(). destroyChildren(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_DestroyChildren, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec disable(This) -> boolean() when + This::wxWindow(). disable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_Disable, <>). -%% @spec (This::wxWindow()) -> bool() %% @equiv enable(This, []) +-spec enable(This) -> boolean() when + This::wxWindow(). + enable(This) when is_record(This, wx_ref) -> enable(This, []). -%% @spec (This::wxWindow(), [Option]) -> bool() -%% Option = {enable, bool()} %% @doc See external documentation. +-spec enable(This, [Option]) -> boolean() when + This::wxWindow(), + Option :: {enable, boolean()}. enable(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -282,21 +317,17 @@ enable(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxWindow_Enable, <>). -%% @spec () -> wxWindow() %% @doc See external documentation. +-spec findFocus() -> wxWindow(). findFocus() -> wxe_util:call(?wxWindow_FindFocus, <<>>). -%% @spec (This::wxWindow(),X::integer()|string()) -> wxWindow() %% @doc See external documentation. -%%
Alternatives: -%%

-%% findWindow(This::wxWindow(), Winid::integer()) -> wxWindow() -%%

-%%

-%% findWindow(This::wxWindow(), Name::string()) -> wxWindow() -%%

+-spec findWindow(This, Winid) -> wxWindow() when + This::wxWindow(), Winid::integer(); + (This, Name) -> wxWindow() when + This::wxWindow(), Name::string(). findWindow(#wx_ref{type=ThisT,ref=ThisRef},Winid) when is_integer(Winid) -> ?CLASS(ThisT,wxWindow), @@ -309,15 +340,18 @@ findWindow(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxWindow_FindWindow_1_1, <>). -%% @spec (Winid::integer()) -> wxWindow() %% @equiv findWindowById(Winid, []) +-spec findWindowById(Winid) -> wxWindow() when + Winid::integer(). + findWindowById(Winid) when is_integer(Winid) -> findWindowById(Winid, []). -%% @spec (Winid::integer(), [Option]) -> wxWindow() -%% Option = {parent, wxWindow()} %% @doc See external documentation. +-spec findWindowById(Winid, [Option]) -> wxWindow() when + Winid::integer(), + Option :: {parent, wxWindow()}. findWindowById(Winid, Options) when is_integer(Winid),is_list(Options) -> MOpts = fun({parent, #wx_ref{type=ParentT,ref=ParentRef}}, Acc) -> ?CLASS(ParentT,wxWindow),[<<1:32/?UI,ParentRef:32/?UI>>|Acc]; @@ -326,15 +360,18 @@ findWindowById(Winid, Options) wxe_util:call(?wxWindow_FindWindowById, <>). -%% @spec (Name::string()) -> wxWindow() %% @equiv findWindowByName(Name, []) +-spec findWindowByName(Name) -> wxWindow() when + Name::string(). + findWindowByName(Name) when is_list(Name) -> findWindowByName(Name, []). -%% @spec (Name::string(), [Option]) -> wxWindow() -%% Option = {parent, wxWindow()} %% @doc See external documentation. +-spec findWindowByName(Name, [Option]) -> wxWindow() when + Name::string(), + Option :: {parent, wxWindow()}. findWindowByName(Name, Options) when is_list(Name),is_list(Options) -> Name_UC = unicode:characters_to_binary([Name,0]), @@ -344,15 +381,18 @@ findWindowByName(Name, Options) wxe_util:call(?wxWindow_FindWindowByName, <<(byte_size(Name_UC)):32/?UI,(Name_UC)/binary, 0:(((8- ((4+byte_size(Name_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (Label::string()) -> wxWindow() %% @equiv findWindowByLabel(Label, []) +-spec findWindowByLabel(Label) -> wxWindow() when + Label::string(). + findWindowByLabel(Label) when is_list(Label) -> findWindowByLabel(Label, []). -%% @spec (Label::string(), [Option]) -> wxWindow() -%% Option = {parent, wxWindow()} %% @doc See external documentation. +-spec findWindowByLabel(Label, [Option]) -> wxWindow() when + Label::string(), + Option :: {parent, wxWindow()}. findWindowByLabel(Label, Options) when is_list(Label),is_list(Options) -> Label_UC = unicode:characters_to_binary([Label,0]), @@ -362,285 +402,326 @@ findWindowByLabel(Label, Options) wxe_util:call(?wxWindow_FindWindowByLabel, <<(byte_size(Label_UC)):32/?UI,(Label_UC)/binary, 0:(((8- ((4+byte_size(Label_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec fit(This) -> ok when + This::wxWindow(). fit(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_Fit, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec fitInside(This) -> ok when + This::wxWindow(). fitInside(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_FitInside, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec freeze(This) -> ok when + This::wxWindow(). freeze(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_Freeze, <>). -%% @spec (This::wxWindow()) -> wxAcceleratorTable:wxAcceleratorTable() %% @doc See external documentation. +-spec getAcceleratorTable(This) -> wxAcceleratorTable:wxAcceleratorTable() when + This::wxWindow(). getAcceleratorTable(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetAcceleratorTable, <>). -%% @spec (This::wxWindow()) -> wx:colour() %% @doc See external documentation. +-spec getBackgroundColour(This) -> wx:wx_colour() when + This::wxWindow(). getBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetBackgroundColour, <>). -%% @spec (This::wxWindow()) -> WxBackgroundStyle -%% WxBackgroundStyle = integer() %% @doc See external documentation. -%%
WxBackgroundStyle is one of ?wxBG_STYLE_SYSTEM | ?wxBG_STYLE_COLOUR | ?wxBG_STYLE_CUSTOM +%%
Res = ?wxBG_STYLE_SYSTEM | ?wxBG_STYLE_COLOUR | ?wxBG_STYLE_CUSTOM +-spec getBackgroundStyle(This) -> wx:wx_enum() when + This::wxWindow(). getBackgroundStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetBackgroundStyle, <>). -%% @spec (This::wxWindow()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getBestSize(This) -> {W::integer(), H::integer()} when + This::wxWindow(). getBestSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetBestSize, <>). -%% @spec (This::wxWindow()) -> wxCaret:wxCaret() %% @doc See external documentation. +-spec getCaret(This) -> wxCaret:wxCaret() when + This::wxWindow(). getCaret(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetCaret, <>). -%% @spec () -> wxWindow() %% @doc See external documentation. +-spec getCapture() -> wxWindow(). getCapture() -> wxe_util:call(?wxWindow_GetCapture, <<>>). -%% @spec (This::wxWindow()) -> integer() %% @doc See external documentation. +-spec getCharHeight(This) -> integer() when + This::wxWindow(). getCharHeight(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetCharHeight, <>). -%% @spec (This::wxWindow()) -> integer() %% @doc See external documentation. +-spec getCharWidth(This) -> integer() when + This::wxWindow(). getCharWidth(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetCharWidth, <>). -%% @spec (This::wxWindow()) -> [wxWindow()] %% @doc See external documentation. +-spec getChildren(This) -> [wxWindow()] when + This::wxWindow(). getChildren(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetChildren, <>). -%% @spec (This::wxWindow()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getClientSize(This) -> {W::integer(), H::integer()} when + This::wxWindow(). getClientSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetClientSize, <>). -%% @spec (This::wxWindow()) -> wxSizer:wxSizer() %% @doc See external documentation. +-spec getContainingSizer(This) -> wxSizer:wxSizer() when + This::wxWindow(). getContainingSizer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetContainingSizer, <>). -%% @spec (This::wxWindow()) -> wxCursor:wxCursor() %% @doc See external documentation. +-spec getCursor(This) -> wxCursor:wxCursor() when + This::wxWindow(). getCursor(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetCursor, <>). -%% @spec (This::wxWindow()) -> wxDropTarget:wxDropTarget() %% @doc See external documentation. +-spec getDropTarget(This) -> wxDropTarget:wxDropTarget() when + This::wxWindow(). getDropTarget(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetDropTarget, <>). -%% @spec (This::wxWindow()) -> wxEvtHandler:wxEvtHandler() %% @doc See external documentation. +-spec getEventHandler(This) -> wxEvtHandler:wxEvtHandler() when + This::wxWindow(). getEventHandler(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetEventHandler, <>). -%% @spec (This::wxWindow()) -> integer() %% @doc See external documentation. +-spec getExtraStyle(This) -> integer() when + This::wxWindow(). getExtraStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetExtraStyle, <>). -%% @spec (This::wxWindow()) -> wxFont:wxFont() %% @doc See external documentation. +-spec getFont(This) -> wxFont:wxFont() when + This::wxWindow(). getFont(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetFont, <>). -%% @spec (This::wxWindow()) -> wx:colour() %% @doc See external documentation. +-spec getForegroundColour(This) -> wx:wx_colour() when + This::wxWindow(). getForegroundColour(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetForegroundColour, <>). -%% @spec (This::wxWindow()) -> wxWindow() %% @doc See external documentation. +-spec getGrandParent(This) -> wxWindow() when + This::wxWindow(). getGrandParent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetGrandParent, <>). -%% @spec (This::wxWindow()) -> integer() %% @doc See external documentation. +-spec getHandle(This) -> integer() when + This::wxWindow(). getHandle(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetHandle, <>). -%% @spec (This::wxWindow()) -> string() %% @doc See external documentation. +-spec getHelpText(This) -> string() when + This::wxWindow(). getHelpText(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetHelpText, <>). -%% @spec (This::wxWindow()) -> integer() %% @doc See external documentation. +-spec getId(This) -> integer() when + This::wxWindow(). getId(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetId, <>). -%% @spec (This::wxWindow()) -> string() %% @doc See external documentation. +-spec getLabel(This) -> string() when + This::wxWindow(). getLabel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetLabel, <>). -%% @spec (This::wxWindow()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getMaxSize(This) -> {W::integer(), H::integer()} when + This::wxWindow(). getMaxSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetMaxSize, <>). -%% @spec (This::wxWindow()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getMinSize(This) -> {W::integer(), H::integer()} when + This::wxWindow(). getMinSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetMinSize, <>). -%% @spec (This::wxWindow()) -> string() %% @doc See external documentation. +-spec getName(This) -> string() when + This::wxWindow(). getName(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetName, <>). -%% @spec (This::wxWindow()) -> wxWindow() %% @doc See external documentation. +-spec getParent(This) -> wxWindow() when + This::wxWindow(). getParent(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetParent, <>). -%% @spec (This::wxWindow()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getPosition(This) -> {X::integer(), Y::integer()} when + This::wxWindow(). getPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetPosition, <>). -%% @spec (This::wxWindow()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxWindow(). getRect(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetRect, <>). -%% @spec (This::wxWindow()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getScreenPosition(This) -> {X::integer(), Y::integer()} when + This::wxWindow(). getScreenPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetScreenPosition, <>). -%% @spec (This::wxWindow()) -> {X::integer(), Y::integer(), W::integer(), H::integer()} %% @doc See external documentation. +-spec getScreenRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} when + This::wxWindow(). getScreenRect(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetScreenRect, <>). -%% @spec (This::wxWindow(), Orient::integer()) -> integer() %% @doc See external documentation. +-spec getScrollPos(This, Orient) -> integer() when + This::wxWindow(), Orient::integer(). getScrollPos(#wx_ref{type=ThisT,ref=ThisRef},Orient) when is_integer(Orient) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetScrollPos, <>). -%% @spec (This::wxWindow(), Orient::integer()) -> integer() %% @doc See external documentation. +-spec getScrollRange(This, Orient) -> integer() when + This::wxWindow(), Orient::integer(). getScrollRange(#wx_ref{type=ThisT,ref=ThisRef},Orient) when is_integer(Orient) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetScrollRange, <>). -%% @spec (This::wxWindow(), Orient::integer()) -> integer() %% @doc See external documentation. +-spec getScrollThumb(This, Orient) -> integer() when + This::wxWindow(), Orient::integer(). getScrollThumb(#wx_ref{type=ThisT,ref=ThisRef},Orient) when is_integer(Orient) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetScrollThumb, <>). -%% @spec (This::wxWindow()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getSize(This) -> {W::integer(), H::integer()} when + This::wxWindow(). getSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetSize, <>). -%% @spec (This::wxWindow()) -> wxSizer:wxSizer() %% @doc See external documentation. +-spec getSizer(This) -> wxSizer:wxSizer() when + This::wxWindow(). getSizer(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetSizer, <>). -%% @spec (This::wxWindow(), String::string()) -> {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()} %% @equiv getTextExtent(This,String, []) +-spec getTextExtent(This, String) -> Result when + Result ::{X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}, + This::wxWindow(), String::string(). + getTextExtent(This,String) when is_record(This, wx_ref),is_list(String) -> getTextExtent(This,String, []). -%% @spec (This::wxWindow(), String::string(), [Option]) -> {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()} -%% Option = {theFont, wxFont:wxFont()} %% @doc See external documentation. +-spec getTextExtent(This, String, [Option]) -> Result when + Result :: {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}, + This::wxWindow(), String::string(), + Option :: {theFont, wxFont:wxFont()}. getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String, Options) when is_list(String),is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -651,109 +732,117 @@ getTextExtent(#wx_ref{type=ThisT,ref=ThisRef},String, Options) wxe_util:call(?wxWindow_GetTextExtent, <>). -%% @spec (This::wxWindow()) -> wxToolTip:wxToolTip() %% @doc See external documentation. +-spec getToolTip(This) -> wxToolTip:wxToolTip() when + This::wxWindow(). getToolTip(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetToolTip, <>). -%% @spec (This::wxWindow()) -> wxRegion:wxRegion() %% @doc See external documentation. +-spec getUpdateRegion(This) -> wxRegion:wxRegion() when + This::wxWindow(). getUpdateRegion(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetUpdateRegion, <>). -%% @spec (This::wxWindow()) -> {W::integer(), H::integer()} %% @doc See external documentation. +-spec getVirtualSize(This) -> {W::integer(), H::integer()} when + This::wxWindow(). getVirtualSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetVirtualSize, <>). -%% @spec (This::wxWindow()) -> integer() %% @doc See external documentation. +-spec getWindowStyleFlag(This) -> integer() when + This::wxWindow(). getWindowStyleFlag(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetWindowStyleFlag, <>). -%% @spec (This::wxWindow()) -> WxWindowVariant -%% WxWindowVariant = integer() %% @doc See external documentation. -%%
WxWindowVariant is one of ?wxWINDOW_VARIANT_NORMAL | ?wxWINDOW_VARIANT_SMALL | ?wxWINDOW_VARIANT_MINI | ?wxWINDOW_VARIANT_LARGE | ?wxWINDOW_VARIANT_MAX +%%
Res = ?wxWINDOW_VARIANT_NORMAL | ?wxWINDOW_VARIANT_SMALL | ?wxWINDOW_VARIANT_MINI | ?wxWINDOW_VARIANT_LARGE | ?wxWINDOW_VARIANT_MAX +-spec getWindowVariant(This) -> wx:wx_enum() when + This::wxWindow(). getWindowVariant(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_GetWindowVariant, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec hasCapture(This) -> boolean() when + This::wxWindow(). hasCapture(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_HasCapture, <>). -%% @spec (This::wxWindow(), Orient::integer()) -> bool() %% @doc See external documentation. +-spec hasScrollbar(This, Orient) -> boolean() when + This::wxWindow(), Orient::integer(). hasScrollbar(#wx_ref{type=ThisT,ref=ThisRef},Orient) when is_integer(Orient) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_HasScrollbar, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec hasTransparentBackground(This) -> boolean() when + This::wxWindow(). hasTransparentBackground(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_HasTransparentBackground, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec hide(This) -> boolean() when + This::wxWindow(). hide(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_Hide, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec inheritAttributes(This) -> ok when + This::wxWindow(). inheritAttributes(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_InheritAttributes, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec initDialog(This) -> ok when + This::wxWindow(). initDialog(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_InitDialog, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec invalidateBestSize(This) -> ok when + This::wxWindow(). invalidateBestSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_InvalidateBestSize, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec isEnabled(This) -> boolean() when + This::wxWindow(). isEnabled(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_IsEnabled, <>). -%% @spec (This::wxWindow(),X::term()) -> bool() %% @doc See external documentation. -%%
Alternatives: -%%

-%% isExposed(This::wxWindow(), Pt::{X::integer(), Y::integer()}) -> bool() -%%

-%%

-%% isExposed(This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool() -%%

+-spec isExposed(This, Pt) -> boolean() when + This::wxWindow(), Pt::{X::integer(), Y::integer()}; + (This, Rect) -> boolean() when + This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. isExposed(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxWindow), @@ -765,80 +854,92 @@ isExposed(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:call(?wxWindow_IsExposed_1_1, <>). -%% @spec (This::wxWindow(), X::integer(), Y::integer()) -> bool() %% @doc See external documentation. +-spec isExposed(This, X, Y) -> boolean() when + This::wxWindow(), X::integer(), Y::integer(). isExposed(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_IsExposed_2, <>). -%% @spec (This::wxWindow(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool() %% @doc See external documentation. +-spec isExposed(This, X, Y, W, H) -> boolean() when + This::wxWindow(), X::integer(), Y::integer(), W::integer(), H::integer(). isExposed(#wx_ref{type=ThisT,ref=ThisRef},X,Y,W,H) when is_integer(X),is_integer(Y),is_integer(W),is_integer(H) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_IsExposed_4, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec isRetained(This) -> boolean() when + This::wxWindow(). isRetained(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_IsRetained, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec isShown(This) -> boolean() when + This::wxWindow(). isShown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_IsShown, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec isTopLevel(This) -> boolean() when + This::wxWindow(). isTopLevel(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_IsTopLevel, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec layout(This) -> boolean() when + This::wxWindow(). layout(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_Layout, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec lineDown(This) -> boolean() when + This::wxWindow(). lineDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_LineDown, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec lineUp(This) -> boolean() when + This::wxWindow(). lineUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_LineUp, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec lower(This) -> ok when + This::wxWindow(). lower(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_Lower, <>). -%% @spec (This::wxWindow()) -> ok %% @equiv makeModal(This, []) +-spec makeModal(This) -> ok when + This::wxWindow(). + makeModal(This) when is_record(This, wx_ref) -> makeModal(This, []). -%% @spec (This::wxWindow(), [Option]) -> ok -%% Option = {modal, bool()} %% @doc See external documentation. +-spec makeModal(This, [Option]) -> ok when + This::wxWindow(), + Option :: {modal, boolean()}. makeModal(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -848,21 +949,20 @@ makeModal(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxWindow_MakeModal, <>). -%% @spec (This::wxWindow(), Pt::{X::integer(), Y::integer()}) -> ok %% @equiv move(This,Pt, []) +-spec move(This, Pt) -> ok when + This::wxWindow(), Pt::{X::integer(), Y::integer()}. + move(This,Pt={PtX,PtY}) when is_record(This, wx_ref),is_integer(PtX),is_integer(PtY) -> move(This,Pt, []). -%% @spec (This::wxWindow(),X::integer()|term(),X::integer()|term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% move(This::wxWindow(), X::integer(), Y::integer()) -> move(This,X,Y, [])

-%%

-%% move(This::wxWindow(), Pt::{X::integer(), Y::integer()}, [Option]) -> ok -%%
Option = {flags, integer()} -%%

+-spec move(This, X, Y) -> ok when + This::wxWindow(), X::integer(), Y::integer(); + (This, Pt, [Option]) -> ok when + This::wxWindow(), Pt::{X::integer(), Y::integer()}, + Option :: {flags, integer()}. move(This,X,Y) when is_record(This, wx_ref),is_integer(X),is_integer(Y) -> @@ -876,9 +976,10 @@ move(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}, Options) wxe_util:cast(?wxWindow_Move_2, <>). -%% @spec (This::wxWindow(), X::integer(), Y::integer(), [Option]) -> ok -%% Option = {flags, integer()} %% @doc See external documentation. +-spec move(This, X, Y, [Option]) -> ok when + This::wxWindow(), X::integer(), Y::integer(), + Option :: {flags, integer()}. move(#wx_ref{type=ThisT,ref=ThisRef},X,Y, Options) when is_integer(X),is_integer(Y),is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -888,31 +989,36 @@ move(#wx_ref{type=ThisT,ref=ThisRef},X,Y, Options) wxe_util:cast(?wxWindow_Move_3, <>). -%% @spec (This::wxWindow(), Win::wxWindow()) -> ok %% @doc See external documentation. +-spec moveAfterInTabOrder(This, Win) -> ok when + This::wxWindow(), Win::wxWindow(). moveAfterInTabOrder(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WinT,ref=WinRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(WinT,wxWindow), wxe_util:cast(?wxWindow_MoveAfterInTabOrder, <>). -%% @spec (This::wxWindow(), Win::wxWindow()) -> ok %% @doc See external documentation. +-spec moveBeforeInTabOrder(This, Win) -> ok when + This::wxWindow(), Win::wxWindow(). moveBeforeInTabOrder(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=WinT,ref=WinRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(WinT,wxWindow), wxe_util:cast(?wxWindow_MoveBeforeInTabOrder, <>). -%% @spec (This::wxWindow()) -> bool() %% @equiv navigate(This, []) +-spec navigate(This) -> boolean() when + This::wxWindow(). + navigate(This) when is_record(This, wx_ref) -> navigate(This, []). -%% @spec (This::wxWindow(), [Option]) -> bool() -%% Option = {flags, integer()} %% @doc See external documentation. +-spec navigate(This, [Option]) -> boolean() when + This::wxWindow(), + Option :: {flags, integer()}. navigate(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -922,29 +1028,34 @@ navigate(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxWindow_Navigate, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec pageDown(This) -> boolean() when + This::wxWindow(). pageDown(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_PageDown, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec pageUp(This) -> boolean() when + This::wxWindow(). pageUp(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_PageUp, <>). -%% @spec (This::wxWindow()) -> wxEvtHandler:wxEvtHandler() %% @equiv popEventHandler(This, []) +-spec popEventHandler(This) -> wxEvtHandler:wxEvtHandler() when + This::wxWindow(). + popEventHandler(This) when is_record(This, wx_ref) -> popEventHandler(This, []). -%% @spec (This::wxWindow(), [Option]) -> wxEvtHandler:wxEvtHandler() -%% Option = {deleteHandler, bool()} %% @doc See external documentation. +-spec popEventHandler(This, [Option]) -> wxEvtHandler:wxEvtHandler() when + This::wxWindow(), + Option :: {deleteHandler, boolean()}. popEventHandler(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -954,15 +1065,18 @@ popEventHandler(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxWindow_PopEventHandler, <>). -%% @spec (This::wxWindow(), Menu::wxMenu:wxMenu()) -> bool() %% @equiv popupMenu(This,Menu, []) +-spec popupMenu(This, Menu) -> boolean() when + This::wxWindow(), Menu::wxMenu:wxMenu(). + popupMenu(This,Menu) when is_record(This, wx_ref),is_record(Menu, wx_ref) -> popupMenu(This,Menu, []). -%% @spec (This::wxWindow(), Menu::wxMenu:wxMenu(), [Option]) -> bool() -%% Option = {pos, {X::integer(), Y::integer()}} %% @doc See external documentation. +-spec popupMenu(This, Menu, [Option]) -> boolean() when + This::wxWindow(), Menu::wxMenu:wxMenu(), + Option :: {pos, {X::integer(), Y::integer()}}. popupMenu(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MenuT,ref=MenuRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -973,8 +1087,9 @@ popupMenu(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MenuT,ref=MenuRef}, Optio wxe_util:call(?wxWindow_PopupMenu_2, <>). -%% @spec (This::wxWindow(), Menu::wxMenu:wxMenu(), X::integer(), Y::integer()) -> bool() %% @doc See external documentation. +-spec popupMenu(This, Menu, X, Y) -> boolean() when + This::wxWindow(), Menu::wxMenu:wxMenu(), X::integer(), Y::integer(). popupMenu(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MenuT,ref=MenuRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxWindow), @@ -982,22 +1097,27 @@ popupMenu(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=MenuT,ref=MenuRef},X,Y) wxe_util:call(?wxWindow_PopupMenu_3, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec raise(This) -> ok when + This::wxWindow(). raise(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_Raise, <>). -%% @spec (This::wxWindow()) -> ok %% @equiv refresh(This, []) +-spec refresh(This) -> ok when + This::wxWindow(). + refresh(This) when is_record(This, wx_ref) -> refresh(This, []). -%% @spec (This::wxWindow(), [Option]) -> ok -%% Option = {eraseBackground, bool()} | {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}} %% @doc See external documentation. +-spec refresh(This, [Option]) -> ok when + This::wxWindow(), + Option :: {eraseBackground, boolean()} + | {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}}. refresh(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1008,15 +1128,18 @@ refresh(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxWindow_Refresh, <>). -%% @spec (This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok %% @equiv refreshRect(This,Rect, []) +-spec refreshRect(This, Rect) -> ok when + This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. + refreshRect(This,Rect={RectX,RectY,RectW,RectH}) when is_record(This, wx_ref),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> refreshRect(This,Rect, []). -%% @spec (This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, [Option]) -> ok -%% Option = {eraseBackground, bool()} %% @doc See external documentation. +-spec refreshRect(This, Rect, [Option]) -> ok when + This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, + Option :: {eraseBackground, boolean()}. refreshRect(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}, Options) when is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH),is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1026,69 +1149,79 @@ refreshRect(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}, Options) wxe_util:cast(?wxWindow_RefreshRect, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec releaseMouse(This) -> ok when + This::wxWindow(). releaseMouse(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_ReleaseMouse, <>). -%% @spec (This::wxWindow(), Child::wxWindow()) -> ok %% @doc See external documentation. +-spec removeChild(This, Child) -> ok when + This::wxWindow(), Child::wxWindow(). removeChild(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ChildT,ref=ChildRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(ChildT,wxWindow), wxe_util:cast(?wxWindow_RemoveChild, <>). -%% @spec (This::wxWindow(), NewParent::wxWindow()) -> bool() %% @doc See external documentation. +-spec reparent(This, NewParent) -> boolean() when + This::wxWindow(), NewParent::wxWindow(). reparent(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=NewParentT,ref=NewParentRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(NewParentT,wxWindow), wxe_util:call(?wxWindow_Reparent, <>). -%% @spec (This::wxWindow()) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec screenToClient(This) -> {X::integer(), Y::integer()} when + This::wxWindow(). screenToClient(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_ScreenToClient_2, <>). -%% @spec (This::wxWindow(), Pt::{X::integer(), Y::integer()}) -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec screenToClient(This, Pt) -> {X::integer(), Y::integer()} when + This::wxWindow(), Pt::{X::integer(), Y::integer()}. screenToClient(#wx_ref{type=ThisT,ref=ThisRef},{PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_ScreenToClient_1, <>). -%% @spec (This::wxWindow(), Lines::integer()) -> bool() %% @doc See external documentation. +-spec scrollLines(This, Lines) -> boolean() when + This::wxWindow(), Lines::integer(). scrollLines(#wx_ref{type=ThisT,ref=ThisRef},Lines) when is_integer(Lines) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_ScrollLines, <>). -%% @spec (This::wxWindow(), Pages::integer()) -> bool() %% @doc See external documentation. +-spec scrollPages(This, Pages) -> boolean() when + This::wxWindow(), Pages::integer(). scrollPages(#wx_ref{type=ThisT,ref=ThisRef},Pages) when is_integer(Pages) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_ScrollPages, <>). -%% @spec (This::wxWindow(), Dx::integer(), Dy::integer()) -> ok %% @equiv scrollWindow(This,Dx,Dy, []) +-spec scrollWindow(This, Dx, Dy) -> ok when + This::wxWindow(), Dx::integer(), Dy::integer(). + scrollWindow(This,Dx,Dy) when is_record(This, wx_ref),is_integer(Dx),is_integer(Dy) -> scrollWindow(This,Dx,Dy, []). -%% @spec (This::wxWindow(), Dx::integer(), Dy::integer(), [Option]) -> ok -%% Option = {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}} %% @doc See external documentation. +-spec scrollWindow(This, Dx, Dy, [Option]) -> ok when + This::wxWindow(), Dx::integer(), Dy::integer(), + Option :: {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}}. scrollWindow(#wx_ref{type=ThisT,ref=ThisRef},Dx,Dy, Options) when is_integer(Dx),is_integer(Dy),is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1098,57 +1231,57 @@ scrollWindow(#wx_ref{type=ThisT,ref=ThisRef},Dx,Dy, Options) wxe_util:cast(?wxWindow_ScrollWindow, <>). -%% @spec (This::wxWindow(), Accel::wxAcceleratorTable:wxAcceleratorTable()) -> ok %% @doc See external documentation. +-spec setAcceleratorTable(This, Accel) -> ok when + This::wxWindow(), Accel::wxAcceleratorTable:wxAcceleratorTable(). setAcceleratorTable(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=AccelT,ref=AccelRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(AccelT,wxAcceleratorTable), wxe_util:cast(?wxWindow_SetAcceleratorTable, <>). -%% @spec (This::wxWindow(), AutoLayout::bool()) -> ok %% @doc See external documentation. +-spec setAutoLayout(This, AutoLayout) -> ok when + This::wxWindow(), AutoLayout::boolean(). setAutoLayout(#wx_ref{type=ThisT,ref=ThisRef},AutoLayout) when is_boolean(AutoLayout) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetAutoLayout, <>). -%% @spec (This::wxWindow(), Colour::wx:colour()) -> bool() %% @doc See external documentation. +-spec setBackgroundColour(This, Colour) -> boolean() when + This::wxWindow(), Colour::wx:wx_colour(). setBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_SetBackgroundColour, <>). -%% @spec (This::wxWindow(), Style::WxBackgroundStyle) -> bool() -%% WxBackgroundStyle = integer() %% @doc See external documentation. -%%
WxBackgroundStyle is one of ?wxBG_STYLE_SYSTEM | ?wxBG_STYLE_COLOUR | ?wxBG_STYLE_CUSTOM +%%
Style = ?wxBG_STYLE_SYSTEM | ?wxBG_STYLE_COLOUR | ?wxBG_STYLE_CUSTOM +-spec setBackgroundStyle(This, Style) -> boolean() when + This::wxWindow(), Style::wx:wx_enum(). setBackgroundStyle(#wx_ref{type=ThisT,ref=ThisRef},Style) when is_integer(Style) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_SetBackgroundStyle, <>). -%% @spec (This::wxWindow(), Caret::wxCaret:wxCaret()) -> ok %% @doc See external documentation. +-spec setCaret(This, Caret) -> ok when + This::wxWindow(), Caret::wxCaret:wxCaret(). setCaret(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CaretT,ref=CaretRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(CaretT,wxCaret), wxe_util:cast(?wxWindow_SetCaret, <>). -%% @spec (This::wxWindow(),X::term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setClientSize(This::wxWindow(), Size::{W::integer(), H::integer()}) -> ok -%%

-%%

-%% setClientSize(This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok -%%

+-spec setClientSize(This, Size) -> ok when + This::wxWindow(), Size::{W::integer(), H::integer()}; + (This, Rect) -> ok when + This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}. setClientSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxWindow), @@ -1160,118 +1293,133 @@ setClientSize(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}) wxe_util:cast(?wxWindow_SetClientSize_1_1, <>). -%% @spec (This::wxWindow(), Width::integer(), Height::integer()) -> ok %% @doc See external documentation. +-spec setClientSize(This, Width, Height) -> ok when + This::wxWindow(), Width::integer(), Height::integer(). setClientSize(#wx_ref{type=ThisT,ref=ThisRef},Width,Height) when is_integer(Width),is_integer(Height) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetClientSize_2, <>). -%% @spec (This::wxWindow(), Sizer::wxSizer:wxSizer()) -> ok %% @doc See external documentation. +-spec setContainingSizer(This, Sizer) -> ok when + This::wxWindow(), Sizer::wxSizer:wxSizer(). setContainingSizer(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SizerT,ref=SizerRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(SizerT,wxSizer), wxe_util:cast(?wxWindow_SetContainingSizer, <>). -%% @spec (This::wxWindow(), Cursor::wxCursor:wxCursor()) -> bool() %% @doc See external documentation. +-spec setCursor(This, Cursor) -> boolean() when + This::wxWindow(), Cursor::wxCursor:wxCursor(). setCursor(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=CursorT,ref=CursorRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(CursorT,wxCursor), wxe_util:call(?wxWindow_SetCursor, <>). -%% @spec (This::wxWindow(), MaxSize::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setMaxSize(This, MaxSize) -> ok when + This::wxWindow(), MaxSize::{W::integer(), H::integer()}. setMaxSize(#wx_ref{type=ThisT,ref=ThisRef},{MaxSizeW,MaxSizeH}) when is_integer(MaxSizeW),is_integer(MaxSizeH) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetMaxSize, <>). -%% @spec (This::wxWindow(), MinSize::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setMinSize(This, MinSize) -> ok when + This::wxWindow(), MinSize::{W::integer(), H::integer()}. setMinSize(#wx_ref{type=ThisT,ref=ThisRef},{MinSizeW,MinSizeH}) when is_integer(MinSizeW),is_integer(MinSizeH) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetMinSize, <>). -%% @spec (This::wxWindow(), Colour::wx:colour()) -> ok %% @doc See external documentation. +-spec setOwnBackgroundColour(This, Colour) -> ok when + This::wxWindow(), Colour::wx:wx_colour(). setOwnBackgroundColour(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetOwnBackgroundColour, <>). -%% @spec (This::wxWindow(), Font::wxFont:wxFont()) -> ok %% @doc See external documentation. +-spec setOwnFont(This, Font) -> ok when + This::wxWindow(), Font::wxFont:wxFont(). setOwnFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(FontT,wxFont), wxe_util:cast(?wxWindow_SetOwnFont, <>). -%% @spec (This::wxWindow(), Colour::wx:colour()) -> ok %% @doc See external documentation. +-spec setOwnForegroundColour(This, Colour) -> ok when + This::wxWindow(), Colour::wx:wx_colour(). setOwnForegroundColour(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetOwnForegroundColour, <>). -%% @spec (This::wxWindow(), DropTarget::wxDropTarget:wxDropTarget()) -> ok %% @doc See external documentation. +-spec setDropTarget(This, DropTarget) -> ok when + This::wxWindow(), DropTarget::wxDropTarget:wxDropTarget(). setDropTarget(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DropTargetT,ref=DropTargetRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(DropTargetT,wxDropTarget), wxe_util:cast(?wxWindow_SetDropTarget, <>). -%% @spec (This::wxWindow(), ExStyle::integer()) -> ok %% @doc See external documentation. +-spec setExtraStyle(This, ExStyle) -> ok when + This::wxWindow(), ExStyle::integer(). setExtraStyle(#wx_ref{type=ThisT,ref=ThisRef},ExStyle) when is_integer(ExStyle) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetExtraStyle, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec setFocus(This) -> ok when + This::wxWindow(). setFocus(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetFocus, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec setFocusFromKbd(This) -> ok when + This::wxWindow(). setFocusFromKbd(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetFocusFromKbd, <>). -%% @spec (This::wxWindow(), Font::wxFont:wxFont()) -> bool() %% @doc See external documentation. +-spec setFont(This, Font) -> boolean() when + This::wxWindow(), Font::wxFont:wxFont(). setFont(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FontT,ref=FontRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(FontT,wxFont), wxe_util:call(?wxWindow_SetFont, <>). -%% @spec (This::wxWindow(), Colour::wx:colour()) -> bool() %% @doc See external documentation. +-spec setForegroundColour(This, Colour) -> boolean() when + This::wxWindow(), Colour::wx:wx_colour(). setForegroundColour(#wx_ref{type=ThisT,ref=ThisRef},Colour) when tuple_size(Colour) =:= 3; tuple_size(Colour) =:= 4 -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_SetForegroundColour, <>). -%% @spec (This::wxWindow(), Text::string()) -> ok %% @doc See external documentation. +-spec setHelpText(This, Text) -> ok when + This::wxWindow(), Text::string(). setHelpText(#wx_ref{type=ThisT,ref=ThisRef},Text) when is_list(Text) -> ?CLASS(ThisT,wxWindow), @@ -1279,16 +1427,18 @@ setHelpText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxWindow_SetHelpText, <>). -%% @spec (This::wxWindow(), Winid::integer()) -> ok %% @doc See external documentation. +-spec setId(This, Winid) -> ok when + This::wxWindow(), Winid::integer(). setId(#wx_ref{type=ThisT,ref=ThisRef},Winid) when is_integer(Winid) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetId, <>). -%% @spec (This::wxWindow(), Label::string()) -> ok %% @doc See external documentation. +-spec setLabel(This, Label) -> ok when + This::wxWindow(), Label::string(). setLabel(#wx_ref{type=ThisT,ref=ThisRef},Label) when is_list(Label) -> ?CLASS(ThisT,wxWindow), @@ -1296,8 +1446,9 @@ setLabel(#wx_ref{type=ThisT,ref=ThisRef},Label) wxe_util:cast(?wxWindow_SetLabel, <>). -%% @spec (This::wxWindow(), Name::string()) -> ok %% @doc See external documentation. +-spec setName(This, Name) -> ok when + This::wxWindow(), Name::string(). setName(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxWindow), @@ -1305,23 +1456,27 @@ setName(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:cast(?wxWindow_SetName, <>). -%% @spec (This::wxWindow(), Pal::wxPalette:wxPalette()) -> ok %% @doc See external documentation. +-spec setPalette(This, Pal) -> ok when + This::wxWindow(), Pal::wxPalette:wxPalette(). setPalette(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PalT,ref=PalRef}) -> ?CLASS(ThisT,wxWindow), ?CLASS(PalT,wxPalette), wxe_util:cast(?wxWindow_SetPalette, <>). -%% @spec (This::wxWindow(), Orient::integer(), Pos::integer(), ThumbVisible::integer(), Range::integer()) -> ok %% @equiv setScrollbar(This,Orient,Pos,ThumbVisible,Range, []) +-spec setScrollbar(This, Orient, Pos, ThumbVisible, Range) -> ok when + This::wxWindow(), Orient::integer(), Pos::integer(), ThumbVisible::integer(), Range::integer(). + setScrollbar(This,Orient,Pos,ThumbVisible,Range) when is_record(This, wx_ref),is_integer(Orient),is_integer(Pos),is_integer(ThumbVisible),is_integer(Range) -> setScrollbar(This,Orient,Pos,ThumbVisible,Range, []). -%% @spec (This::wxWindow(), Orient::integer(), Pos::integer(), ThumbVisible::integer(), Range::integer(), [Option]) -> ok -%% Option = {refresh, bool()} %% @doc See external documentation. +-spec setScrollbar(This, Orient, Pos, ThumbVisible, Range, [Option]) -> ok when + This::wxWindow(), Orient::integer(), Pos::integer(), ThumbVisible::integer(), Range::integer(), + Option :: {refresh, boolean()}. setScrollbar(#wx_ref{type=ThisT,ref=ThisRef},Orient,Pos,ThumbVisible,Range, Options) when is_integer(Orient),is_integer(Pos),is_integer(ThumbVisible),is_integer(Range),is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1331,15 +1486,18 @@ setScrollbar(#wx_ref{type=ThisT,ref=ThisRef},Orient,Pos,ThumbVisible,Range, Opti wxe_util:cast(?wxWindow_SetScrollbar, <>). -%% @spec (This::wxWindow(), Orient::integer(), Pos::integer()) -> ok %% @equiv setScrollPos(This,Orient,Pos, []) +-spec setScrollPos(This, Orient, Pos) -> ok when + This::wxWindow(), Orient::integer(), Pos::integer(). + setScrollPos(This,Orient,Pos) when is_record(This, wx_ref),is_integer(Orient),is_integer(Pos) -> setScrollPos(This,Orient,Pos, []). -%% @spec (This::wxWindow(), Orient::integer(), Pos::integer(), [Option]) -> ok -%% Option = {refresh, bool()} %% @doc See external documentation. +-spec setScrollPos(This, Orient, Pos, [Option]) -> ok when + This::wxWindow(), Orient::integer(), Pos::integer(), + Option :: {refresh, boolean()}. setScrollPos(#wx_ref{type=ThisT,ref=ThisRef},Orient,Pos, Options) when is_integer(Orient),is_integer(Pos),is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1349,14 +1507,11 @@ setScrollPos(#wx_ref{type=ThisT,ref=ThisRef},Orient,Pos, Options) wxe_util:cast(?wxWindow_SetScrollPos, <>). -%% @spec (This::wxWindow(),X::term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setSize(This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> setSize(This,Rect, [])

-%%

-%% setSize(This::wxWindow(), Size::{W::integer(), H::integer()}) -> ok -%%

+-spec setSize(This, Rect) -> ok when + This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}; + (This, Size) -> ok when + This::wxWindow(), Size::{W::integer(), H::integer()}. setSize(This,Rect={RectX,RectY,RectW,RectH}) when is_record(This, wx_ref),is_integer(RectX),is_integer(RectY),is_integer(RectW),is_integer(RectH) -> @@ -1367,16 +1522,12 @@ setSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) wxe_util:cast(?wxWindow_SetSize_1, <>). -%% @spec (This::wxWindow(),X::integer()|term(),X::integer()|term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setSize(This::wxWindow(), Width::integer(), Height::integer()) -> ok -%%

-%%

-%% setSize(This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, [Option]) -> ok -%%
Option = {sizeFlags, integer()} -%%

+-spec setSize(This, Width, Height) -> ok when + This::wxWindow(), Width::integer(), Height::integer(); + (This, Rect, [Option]) -> ok when + This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, + Option :: {sizeFlags, integer()}. setSize(#wx_ref{type=ThisT,ref=ThisRef},Width,Height) when is_integer(Width),is_integer(Height) -> ?CLASS(ThisT,wxWindow), @@ -1391,15 +1542,18 @@ setSize(#wx_ref{type=ThisT,ref=ThisRef},{RectX,RectY,RectW,RectH}, Options) wxe_util:cast(?wxWindow_SetSize_2_1, <>). -%% @spec (This::wxWindow(), X::integer(), Y::integer(), Width::integer(), Height::integer()) -> ok %% @equiv setSize(This,X,Y,Width,Height, []) +-spec setSize(This, X, Y, Width, Height) -> ok when + This::wxWindow(), X::integer(), Y::integer(), Width::integer(), Height::integer(). + setSize(This,X,Y,Width,Height) when is_record(This, wx_ref),is_integer(X),is_integer(Y),is_integer(Width),is_integer(Height) -> setSize(This,X,Y,Width,Height, []). -%% @spec (This::wxWindow(), X::integer(), Y::integer(), Width::integer(), Height::integer(), [Option]) -> ok -%% Option = {sizeFlags, integer()} %% @doc See external documentation. +-spec setSize(This, X, Y, Width, Height, [Option]) -> ok when + This::wxWindow(), X::integer(), Y::integer(), Width::integer(), Height::integer(), + Option :: {sizeFlags, integer()}. setSize(#wx_ref{type=ThisT,ref=ThisRef},X,Y,Width,Height, Options) when is_integer(X),is_integer(Y),is_integer(Width),is_integer(Height),is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1409,21 +1563,21 @@ setSize(#wx_ref{type=ThisT,ref=ThisRef},X,Y,Width,Height, Options) wxe_util:cast(?wxWindow_SetSize_5, <>). -%% @spec (This::wxWindow(), MinSize::{W::integer(), H::integer()}) -> ok %% @equiv setSizeHints(This,MinSize, []) +-spec setSizeHints(This, MinSize) -> ok when + This::wxWindow(), MinSize::{W::integer(), H::integer()}. + setSizeHints(This,MinSize={MinSizeW,MinSizeH}) when is_record(This, wx_ref),is_integer(MinSizeW),is_integer(MinSizeH) -> setSizeHints(This,MinSize, []). -%% @spec (This::wxWindow(),X::integer()|term(),X::integer()|term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setSizeHints(This::wxWindow(), MinW::integer(), MinH::integer()) -> setSizeHints(This,MinW,MinH, [])

-%%

-%% setSizeHints(This::wxWindow(), MinSize::{W::integer(), H::integer()}, [Option]) -> ok -%%
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 + This::wxWindow(), MinSize::{W::integer(), H::integer()}, + Option :: {maxSize, {W::integer(), H::integer()}} + | {incSize, {W::integer(), H::integer()}}. setSizeHints(This,MinW,MinH) when is_record(This, wx_ref),is_integer(MinW),is_integer(MinH) -> @@ -1438,9 +1592,13 @@ setSizeHints(#wx_ref{type=ThisT,ref=ThisRef},{MinSizeW,MinSizeH}, Options) wxe_util:cast(?wxWindow_SetSizeHints_2, <>). -%% @spec (This::wxWindow(), MinW::integer(), MinH::integer(), [Option]) -> ok -%% Option = {maxW, integer()} | {maxH, integer()} | {incW, integer()} | {incH, integer()} %% @doc See external documentation. +-spec setSizeHints(This, MinW, MinH, [Option]) -> ok when + This::wxWindow(), MinW::integer(), MinH::integer(), + Option :: {maxW, integer()} + | {maxH, integer()} + | {incW, integer()} + | {incH, integer()}. setSizeHints(#wx_ref{type=ThisT,ref=ThisRef},MinW,MinH, Options) when is_integer(MinW),is_integer(MinH),is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1453,15 +1611,18 @@ setSizeHints(#wx_ref{type=ThisT,ref=ThisRef},MinW,MinH, Options) wxe_util:cast(?wxWindow_SetSizeHints_3, <>). -%% @spec (This::wxWindow(), Sizer::wxSizer:wxSizer()) -> ok %% @equiv setSizer(This,Sizer, []) +-spec setSizer(This, Sizer) -> ok when + This::wxWindow(), Sizer::wxSizer:wxSizer(). + setSizer(This,Sizer) when is_record(This, wx_ref),is_record(Sizer, wx_ref) -> setSizer(This,Sizer, []). -%% @spec (This::wxWindow(), Sizer::wxSizer:wxSizer(), [Option]) -> ok -%% Option = {deleteOld, bool()} %% @doc See external documentation. +-spec setSizer(This, Sizer, [Option]) -> ok when + This::wxWindow(), Sizer::wxSizer:wxSizer(), + Option :: {deleteOld, boolean()}. setSizer(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SizerT,ref=SizerRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1472,15 +1633,18 @@ setSizer(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SizerT,ref=SizerRef}, Opti wxe_util:cast(?wxWindow_SetSizer, <>). -%% @spec (This::wxWindow(), Sizer::wxSizer:wxSizer()) -> ok %% @equiv setSizerAndFit(This,Sizer, []) +-spec setSizerAndFit(This, Sizer) -> ok when + This::wxWindow(), Sizer::wxSizer:wxSizer(). + setSizerAndFit(This,Sizer) when is_record(This, wx_ref),is_record(Sizer, wx_ref) -> setSizerAndFit(This,Sizer, []). -%% @spec (This::wxWindow(), Sizer::wxSizer:wxSizer(), [Option]) -> ok -%% Option = {deleteOld, bool()} %% @doc See external documentation. +-spec setSizerAndFit(This, Sizer, [Option]) -> ok when + This::wxWindow(), Sizer::wxSizer:wxSizer(), + Option :: {deleteOld, boolean()}. setSizerAndFit(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SizerT,ref=SizerRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1491,23 +1655,20 @@ setSizerAndFit(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=SizerT,ref=SizerRef} wxe_util:cast(?wxWindow_SetSizerAndFit, <>). -%% @spec (This::wxWindow(), EnableTheme::bool()) -> ok %% @doc See external documentation. +-spec setThemeEnabled(This, EnableTheme) -> ok when + This::wxWindow(), EnableTheme::boolean(). setThemeEnabled(#wx_ref{type=ThisT,ref=ThisRef},EnableTheme) when is_boolean(EnableTheme) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetThemeEnabled, <>). -%% @spec (This::wxWindow(),X::string()|term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setToolTip(This::wxWindow(), Tip::string()) -> ok -%%

-%%

-%% setToolTip(This::wxWindow(), Tip::wxToolTip:wxToolTip()) -> ok -%%

+-spec setToolTip(This, Tip) -> ok when + This::wxWindow(), Tip::string(); + (This, Tip) -> ok when + This::wxWindow(), Tip::wxToolTip:wxToolTip(). setToolTip(#wx_ref{type=ThisT,ref=ThisRef},Tip) when is_list(Tip) -> ?CLASS(ThisT,wxWindow), @@ -1520,37 +1681,38 @@ setToolTip(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=TipT,ref=TipRef}) -> wxe_util:cast(?wxWindow_SetToolTip_1_1, <>). -%% @spec (This::wxWindow(), Size::{W::integer(), H::integer()}) -> ok %% @doc See external documentation. +-spec setVirtualSize(This, Size) -> ok when + This::wxWindow(), Size::{W::integer(), H::integer()}. setVirtualSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) when is_integer(SizeW),is_integer(SizeH) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetVirtualSize_1, <>). -%% @spec (This::wxWindow(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec setVirtualSize(This, X, Y) -> ok when + This::wxWindow(), X::integer(), Y::integer(). setVirtualSize(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetVirtualSize_2, <>). -%% @spec (This::wxWindow(), MinSize::{W::integer(), H::integer()}) -> ok %% @equiv setVirtualSizeHints(This,MinSize, []) +-spec setVirtualSizeHints(This, MinSize) -> ok when + This::wxWindow(), MinSize::{W::integer(), H::integer()}. + setVirtualSizeHints(This,MinSize={MinSizeW,MinSizeH}) when is_record(This, wx_ref),is_integer(MinSizeW),is_integer(MinSizeH) -> setVirtualSizeHints(This,MinSize, []). -%% @spec (This::wxWindow(),X::integer()|term(),X::integer()|term()) -> ok %% @doc See external documentation. -%%
Alternatives: -%%

-%% setVirtualSizeHints(This::wxWindow(), MinW::integer(), MinH::integer()) -> setVirtualSizeHints(This,MinW,MinH, [])

-%%

-%% setVirtualSizeHints(This::wxWindow(), MinSize::{W::integer(), H::integer()}, [Option]) -> ok -%%
Option = {maxSize, {W::integer(), H::integer()}} -%%

+-spec setVirtualSizeHints(This, MinW, MinH) -> ok when + This::wxWindow(), MinW::integer(), MinH::integer(); + (This, MinSize, [Option]) -> ok when + This::wxWindow(), MinSize::{W::integer(), H::integer()}, + Option :: {maxSize, {W::integer(), H::integer()}}. setVirtualSizeHints(This,MinW,MinH) when is_record(This, wx_ref),is_integer(MinW),is_integer(MinH) -> @@ -1564,9 +1726,11 @@ setVirtualSizeHints(#wx_ref{type=ThisT,ref=ThisRef},{MinSizeW,MinSizeH}, Options wxe_util:cast(?wxWindow_SetVirtualSizeHints_2, <>). -%% @spec (This::wxWindow(), MinW::integer(), MinH::integer(), [Option]) -> ok -%% Option = {maxW, integer()} | {maxH, integer()} %% @doc See external documentation. +-spec setVirtualSizeHints(This, MinW, MinH, [Option]) -> ok when + This::wxWindow(), MinW::integer(), MinH::integer(), + Option :: {maxW, integer()} + | {maxH, integer()}. setVirtualSizeHints(#wx_ref{type=ThisT,ref=ThisRef},MinW,MinH, Options) when is_integer(MinW),is_integer(MinH),is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1577,48 +1741,54 @@ setVirtualSizeHints(#wx_ref{type=ThisT,ref=ThisRef},MinW,MinH, Options) wxe_util:cast(?wxWindow_SetVirtualSizeHints_3, <>). -%% @spec (This::wxWindow(), Style::integer()) -> ok %% @doc See external documentation. +-spec setWindowStyle(This, Style) -> ok when + This::wxWindow(), Style::integer(). setWindowStyle(#wx_ref{type=ThisT,ref=ThisRef},Style) when is_integer(Style) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetWindowStyle, <>). -%% @spec (This::wxWindow(), Style::integer()) -> ok %% @doc See external documentation. +-spec setWindowStyleFlag(This, Style) -> ok when + This::wxWindow(), Style::integer(). setWindowStyleFlag(#wx_ref{type=ThisT,ref=ThisRef},Style) when is_integer(Style) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetWindowStyleFlag, <>). -%% @spec (This::wxWindow(), Variant::WxWindowVariant) -> ok -%% WxWindowVariant = integer() %% @doc See external documentation. -%%
WxWindowVariant is one of ?wxWINDOW_VARIANT_NORMAL | ?wxWINDOW_VARIANT_SMALL | ?wxWINDOW_VARIANT_MINI | ?wxWINDOW_VARIANT_LARGE | ?wxWINDOW_VARIANT_MAX +%%
Variant = ?wxWINDOW_VARIANT_NORMAL | ?wxWINDOW_VARIANT_SMALL | ?wxWINDOW_VARIANT_MINI | ?wxWINDOW_VARIANT_LARGE | ?wxWINDOW_VARIANT_MAX +-spec setWindowVariant(This, Variant) -> ok when + This::wxWindow(), Variant::wx:wx_enum(). setWindowVariant(#wx_ref{type=ThisT,ref=ThisRef},Variant) when is_integer(Variant) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_SetWindowVariant, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec shouldInheritColours(This) -> boolean() when + This::wxWindow(). shouldInheritColours(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_ShouldInheritColours, <>). -%% @spec (This::wxWindow()) -> bool() %% @equiv show(This, []) +-spec show(This) -> boolean() when + This::wxWindow(). + show(This) when is_record(This, wx_ref) -> show(This, []). -%% @spec (This::wxWindow(), [Option]) -> bool() -%% Option = {show, bool()} %% @doc See external documentation. +-spec show(This, [Option]) -> boolean() when + This::wxWindow(), + Option :: {show, boolean()}. show(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1628,43 +1798,50 @@ show(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxWindow_Show, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec thaw(This) -> ok when + This::wxWindow(). thaw(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_Thaw, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec transferDataFromWindow(This) -> boolean() when + This::wxWindow(). transferDataFromWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_TransferDataFromWindow, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec transferDataToWindow(This) -> boolean() when + This::wxWindow(). transferDataToWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_TransferDataToWindow, <>). -%% @spec (This::wxWindow()) -> ok %% @doc See external documentation. +-spec update(This) -> ok when + This::wxWindow(). update(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_Update, <>). -%% @spec (This::wxWindow()) -> ok %% @equiv updateWindowUI(This, []) +-spec updateWindowUI(This) -> ok when + This::wxWindow(). + updateWindowUI(This) when is_record(This, wx_ref) -> updateWindowUI(This, []). -%% @spec (This::wxWindow(), [Option]) -> ok -%% Option = {flags, integer()} %% @doc See external documentation. +-spec updateWindowUI(This, [Option]) -> ok when + This::wxWindow(), + Option :: {flags, integer()}. updateWindowUI(#wx_ref{type=ThisT,ref=ThisRef}, Options) when is_list(Options) -> ?CLASS(ThisT,wxWindow), @@ -1674,23 +1851,25 @@ updateWindowUI(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:cast(?wxWindow_UpdateWindowUI, <>). -%% @spec (This::wxWindow()) -> bool() %% @doc See external documentation. +-spec validate(This) -> boolean() when + This::wxWindow(). validate(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxWindow), wxe_util:call(?wxWindow_Validate, <>). -%% @spec (This::wxWindow(), X::integer(), Y::integer()) -> ok %% @doc See external documentation. +-spec warpPointer(This, X, Y) -> ok when + This::wxWindow(), X::integer(), Y::integer(). warpPointer(#wx_ref{type=ThisT,ref=ThisRef},X,Y) when is_integer(X),is_integer(Y) -> ?CLASS(ThisT,wxWindow), wxe_util:cast(?wxWindow_WarpPointer, <>). -%% @spec (This::wxWindow()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxWindow) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxWindow), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxWindowCreateEvent.erl b/lib/wx/src/gen/wxWindowCreateEvent.erl index c8b3c74f81..f17d6011d9 100644 --- a/lib/wx/src/gen/wxWindowCreateEvent.erl +++ b/lib/wx/src/gen/wxWindowCreateEvent.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,11 +40,13 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxWindowCreateEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxWindowCreateEvent() :: wx:wx_object(). %% From wxCommandEvent %% @hidden setString(This,S) -> wxCommandEvent:setString(This,S). diff --git a/lib/wx/src/gen/wxWindowDC.erl b/lib/wx/src/gen/wxWindowDC.erl index 17cbd3d378..ba7bdf50aa 100644 --- a/lib/wx/src/gen/wxWindowDC.erl +++ b/lib/wx/src/gen/wxWindowDC.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 @@ -52,25 +52,28 @@ setPen/2,setTextBackground/2,setTextForeground/2,setUserScale/3,startDoc/2, startPage/1]). +-export_type([wxWindowDC/0]). %% @hidden parent_class(wxDC) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxWindowDC() +-type wxWindowDC() :: wx:wx_object(). %% @doc See external documentation. +-spec new() -> wxWindowDC(). new() -> wxe_util:construct(?wxWindowDC_new_0, <<>>). -%% @spec (Win::wxWindow:wxWindow()) -> wxWindowDC() %% @doc See external documentation. +-spec new(Win) -> wxWindowDC() when + Win::wxWindow:wxWindow(). new(#wx_ref{type=WinT,ref=WinRef}) -> ?CLASS(WinT,wxWindow), wxe_util:construct(?wxWindowDC_new_1, <>). -%% @spec (This::wxWindowDC()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxWindowDC) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxWindowDC), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wxWindowDestroyEvent.erl b/lib/wx/src/gen/wxWindowDestroyEvent.erl index e62700da4a..909f521d82 100644 --- a/lib/wx/src/gen/wxWindowDestroyEvent.erl +++ b/lib/wx/src/gen/wxWindowDestroyEvent.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,11 +40,13 @@ parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1, skip/1,skip/2,stopPropagation/1]). +-export_type([wxWindowDestroyEvent/0]). %% @hidden parent_class(wxCommandEvent) -> true; parent_class(wxEvent) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). +-type wxWindowDestroyEvent() :: wx:wx_object(). %% From wxCommandEvent %% @hidden setString(This,S) -> wxCommandEvent:setString(This,S). diff --git a/lib/wx/src/gen/wxXmlResource.erl b/lib/wx/src/gen/wxXmlResource.erl index 2b69a49bd7..c18f6ce051 100644 --- a/lib/wx/src/gen/wxXmlResource.erl +++ b/lib/wx/src/gen/wxXmlResource.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 @@ -34,17 +34,21 @@ %% inherited exports -export([parent_class/1]). +-export_type([wxXmlResource/0]). %% @hidden parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -%% @spec () -> wxXmlResource() +-type wxXmlResource() :: wx:wx_object(). %% @equiv new([]) +-spec new() -> wxXmlResource(). + new() -> new([]). -%% @spec ([Option]) -> wxXmlResource() -%% Option = {flags, integer()} | {domain, string()} %% @doc See external documentation. +-spec new([Option]) -> wxXmlResource() when + Option :: {flags, integer()} + | {domain, string()}. new(Options) when is_list(Options) -> MOpts = fun({flags, Flags}, Acc) -> [<<1:32/?UI,Flags:32/?UI>>|Acc]; @@ -54,9 +58,11 @@ new(Options) wxe_util:construct(?wxXmlResource_new_1, <>). -%% @spec (Filemask::string(), [Option]) -> wxXmlResource() -%% Option = {flags, integer()} | {domain, string()} %% @doc See external documentation. +-spec new(Filemask, [Option]) -> wxXmlResource() when + Filemask::string(), + Option :: {flags, integer()} + | {domain, string()}. new(Filemask, Options) when is_list(Filemask),is_list(Options) -> Filemask_UC = unicode:characters_to_binary([Filemask,0]), @@ -67,15 +73,18 @@ new(Filemask, Options) wxe_util:construct(?wxXmlResource_new_2, <<(byte_size(Filemask_UC)):32/?UI,(Filemask_UC)/binary, 0:(((8- ((4+byte_size(Filemask_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxXmlResource(), Name::string(), Control::wxWindow:wxWindow()) -> bool() %% @equiv attachUnknownControl(This,Name,Control, []) +-spec attachUnknownControl(This, Name, Control) -> boolean() when + This::wxXmlResource(), Name::string(), Control::wxWindow:wxWindow(). + attachUnknownControl(This,Name,Control) when is_record(This, wx_ref),is_list(Name),is_record(Control, wx_ref) -> attachUnknownControl(This,Name,Control, []). -%% @spec (This::wxXmlResource(), Name::string(), Control::wxWindow:wxWindow(), [Option]) -> bool() -%% Option = {parent, wxWindow:wxWindow()} %% @doc See external documentation. +-spec attachUnknownControl(This, Name, Control, [Option]) -> boolean() when + This::wxXmlResource(), Name::string(), Control::wxWindow:wxWindow(), + Option :: {parent, wxWindow:wxWindow()}. attachUnknownControl(#wx_ref{type=ThisT,ref=ThisRef},Name,#wx_ref{type=ControlT,ref=ControlRef}, Options) when is_list(Name),is_list(Options) -> ?CLASS(ThisT,wxXmlResource), @@ -87,50 +96,57 @@ attachUnknownControl(#wx_ref{type=ThisT,ref=ThisRef},Name,#wx_ref{type=ControlT, wxe_util:call(?wxXmlResource_AttachUnknownControl, <>). -%% @spec (This::wxXmlResource()) -> ok %% @doc See external documentation. +-spec clearHandlers(This) -> ok when + This::wxXmlResource(). clearHandlers(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxXmlResource), wxe_util:cast(?wxXmlResource_ClearHandlers, <>). -%% @spec (This::wxXmlResource(), Major::integer(), Minor::integer(), Release::integer(), Revision::integer()) -> integer() %% @doc See external documentation. +-spec compareVersion(This, Major, Minor, Release, Revision) -> integer() when + This::wxXmlResource(), Major::integer(), Minor::integer(), Release::integer(), Revision::integer(). compareVersion(#wx_ref{type=ThisT,ref=ThisRef},Major,Minor,Release,Revision) when is_integer(Major),is_integer(Minor),is_integer(Release),is_integer(Revision) -> ?CLASS(ThisT,wxXmlResource), wxe_util:call(?wxXmlResource_CompareVersion, <>). -%% @spec () -> wxXmlResource() %% @doc See external documentation. +-spec get() -> wxXmlResource(). get() -> wxe_util:call(?wxXmlResource_Get, <<>>). -%% @spec (This::wxXmlResource()) -> integer() %% @doc See external documentation. +-spec getFlags(This) -> integer() when + This::wxXmlResource(). getFlags(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxXmlResource), wxe_util:call(?wxXmlResource_GetFlags, <>). -%% @spec (This::wxXmlResource()) -> integer() %% @doc See external documentation. +-spec getVersion(This) -> integer() when + This::wxXmlResource(). getVersion(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxXmlResource), wxe_util:call(?wxXmlResource_GetVersion, <>). -%% @spec (Str_id::[string()]) -> integer() %% @equiv getXRCID(Str_id, []) +-spec getXRCID(Str_id) -> integer() when + Str_id::[string()]. + getXRCID(Str_id) when is_list(Str_id) -> getXRCID(Str_id, []). -%% @spec (Str_id::[string()], [Option]) -> integer() -%% Option = {value_if_not_found, integer()} %% @doc See external documentation. +-spec getXRCID(Str_id, [Option]) -> integer() when + Str_id::[string()], + Option :: {value_if_not_found, integer()}. getXRCID(Str_id, Options) when is_list(Str_id),is_list(Options) -> Str_id_UC = unicode:characters_to_binary([Str_id,0]), @@ -140,15 +156,17 @@ getXRCID(Str_id, Options) wxe_util:call(?wxXmlResource_GetXRCID, <<(byte_size(Str_id_UC)):32/?UI,(Str_id_UC)/binary, 0:(((8- ((4+byte_size(Str_id_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxXmlResource()) -> ok %% @doc See external documentation. +-spec initAllHandlers(This) -> ok when + This::wxXmlResource(). initAllHandlers(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxXmlResource), wxe_util:cast(?wxXmlResource_InitAllHandlers, <>). -%% @spec (This::wxXmlResource(), Filemask::string()) -> bool() %% @doc See external documentation. +-spec load(This, Filemask) -> boolean() when + This::wxXmlResource(), Filemask::string(). load(#wx_ref{type=ThisT,ref=ThisRef},Filemask) when is_list(Filemask) -> ?CLASS(ThisT,wxXmlResource), @@ -156,8 +174,9 @@ load(#wx_ref{type=ThisT,ref=ThisRef},Filemask) wxe_util:call(?wxXmlResource_Load, <>). -%% @spec (This::wxXmlResource(), Name::string()) -> wxBitmap:wxBitmap() %% @doc See external documentation. +-spec loadBitmap(This, Name) -> wxBitmap:wxBitmap() when + This::wxXmlResource(), Name::string(). loadBitmap(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -165,8 +184,9 @@ loadBitmap(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxXmlResource_LoadBitmap, <>). -%% @spec (This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string()) -> wxDialog:wxDialog() %% @doc See external documentation. +-spec loadDialog(This, Parent, Name) -> wxDialog:wxDialog() when + This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string(). loadDialog(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -175,8 +195,9 @@ loadDialog(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},N wxe_util:call(?wxXmlResource_LoadDialog_2, <>). -%% @spec (This::wxXmlResource(), Dlg::wxDialog:wxDialog(), Parent::wxWindow:wxWindow(), Name::string()) -> bool() %% @doc See external documentation. +-spec loadDialog(This, Dlg, Parent, Name) -> boolean() when + This::wxXmlResource(), Dlg::wxDialog:wxDialog(), Parent::wxWindow:wxWindow(), Name::string(). loadDialog(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DlgT,ref=DlgRef},#wx_ref{type=ParentT,ref=ParentRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -186,8 +207,9 @@ loadDialog(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=DlgT,ref=DlgRef},#wx_ref wxe_util:call(?wxXmlResource_LoadDialog_3, <>). -%% @spec (This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string()) -> wxFrame:wxFrame() %% @doc See external documentation. +-spec loadFrame(This, Parent, Name) -> wxFrame:wxFrame() when + This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string(). loadFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -196,8 +218,9 @@ loadFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Na wxe_util:call(?wxXmlResource_LoadFrame_2, <>). -%% @spec (This::wxXmlResource(), Frame::wxFrame:wxFrame(), Parent::wxWindow:wxWindow(), Name::string()) -> bool() %% @doc See external documentation. +-spec loadFrame(This, Frame, Parent, Name) -> boolean() when + This::wxXmlResource(), Frame::wxFrame:wxFrame(), Parent::wxWindow:wxWindow(), Name::string(). loadFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef},#wx_ref{type=ParentT,ref=ParentRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -207,8 +230,9 @@ loadFrame(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=FrameT,ref=FrameRef},#wx_ wxe_util:call(?wxXmlResource_LoadFrame_3, <>). -%% @spec (This::wxXmlResource(), Name::string()) -> wxIcon:wxIcon() %% @doc See external documentation. +-spec loadIcon(This, Name) -> wxIcon:wxIcon() when + This::wxXmlResource(), Name::string(). loadIcon(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -216,8 +240,9 @@ loadIcon(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxXmlResource_LoadIcon, <>). -%% @spec (This::wxXmlResource(), Name::string()) -> wxMenu:wxMenu() %% @doc See external documentation. +-spec loadMenu(This, Name) -> wxMenu:wxMenu() when + This::wxXmlResource(), Name::string(). loadMenu(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -225,8 +250,9 @@ loadMenu(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxXmlResource_LoadMenu, <>). -%% @spec (This::wxXmlResource(), Name::string()) -> wxMenuBar:wxMenuBar() %% @doc See external documentation. +-spec loadMenuBar(This, Name) -> wxMenuBar:wxMenuBar() when + This::wxXmlResource(), Name::string(). loadMenuBar(#wx_ref{type=ThisT,ref=ThisRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -234,8 +260,9 @@ loadMenuBar(#wx_ref{type=ThisT,ref=ThisRef},Name) wxe_util:call(?wxXmlResource_LoadMenuBar_1, <>). -%% @spec (This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string()) -> wxMenuBar:wxMenuBar() %% @doc See external documentation. +-spec loadMenuBar(This, Parent, Name) -> wxMenuBar:wxMenuBar() when + This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string(). loadMenuBar(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -244,8 +271,9 @@ loadMenuBar(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, wxe_util:call(?wxXmlResource_LoadMenuBar_2, <>). -%% @spec (This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string()) -> wxPanel:wxPanel() %% @doc See external documentation. +-spec loadPanel(This, Parent, Name) -> wxPanel:wxPanel() when + This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string(). loadPanel(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -254,8 +282,9 @@ loadPanel(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Na wxe_util:call(?wxXmlResource_LoadPanel_2, <>). -%% @spec (This::wxXmlResource(), Panel::wxPanel:wxPanel(), Parent::wxWindow:wxWindow(), Name::string()) -> bool() %% @doc See external documentation. +-spec loadPanel(This, Panel, Parent, Name) -> boolean() when + This::wxXmlResource(), Panel::wxPanel:wxPanel(), Parent::wxWindow:wxWindow(), Name::string(). loadPanel(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PanelT,ref=PanelRef},#wx_ref{type=ParentT,ref=ParentRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -265,8 +294,9 @@ loadPanel(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=PanelT,ref=PanelRef},#wx_ wxe_util:call(?wxXmlResource_LoadPanel_3, <>). -%% @spec (This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string()) -> wxToolBar:wxToolBar() %% @doc See external documentation. +-spec loadToolBar(This, Parent, Name) -> wxToolBar:wxToolBar() when + This::wxXmlResource(), Parent::wxWindow:wxWindow(), Name::string(). loadToolBar(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Name) when is_list(Name) -> ?CLASS(ThisT,wxXmlResource), @@ -275,23 +305,26 @@ loadToolBar(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef}, wxe_util:call(?wxXmlResource_LoadToolBar, <>). -%% @spec (Res::wxXmlResource()) -> wxXmlResource() %% @doc See external documentation. +-spec set(Res) -> wxXmlResource() when + Res::wxXmlResource(). set(#wx_ref{type=ResT,ref=ResRef}) -> ?CLASS(ResT,wxXmlResource), wxe_util:call(?wxXmlResource_Set, <>). -%% @spec (This::wxXmlResource(), Flags::integer()) -> ok %% @doc See external documentation. +-spec setFlags(This, Flags) -> ok when + This::wxXmlResource(), Flags::integer(). setFlags(#wx_ref{type=ThisT,ref=ThisRef},Flags) when is_integer(Flags) -> ?CLASS(ThisT,wxXmlResource), wxe_util:cast(?wxXmlResource_SetFlags, <>). -%% @spec (This::wxXmlResource(), Filename::string()) -> bool() %% @doc See external documentation. +-spec unload(This, Filename) -> boolean() when + This::wxXmlResource(), Filename::string(). unload(#wx_ref{type=ThisT,ref=ThisRef},Filename) when is_list(Filename) -> ?CLASS(ThisT,wxXmlResource), @@ -318,8 +351,8 @@ xrcctrl(Window = #wx_ref{}, Name, Type) when is_list(Name), is_atom(Type) -> Res = wxWindow:findWindow(Window,ID), wx:typeCast(Res, Type). -%% @spec (This::wxXmlResource()) -> ok %% @doc Destroys this object, do not use object again +-spec destroy(This::wxXmlResource) -> ok. destroy(Obj=#wx_ref{type=Type}) -> ?CLASS(Type,wxXmlResource), wxe_util:destroy(?DESTROY_OBJECT,Obj), diff --git a/lib/wx/src/gen/wx_misc.erl b/lib/wx/src/gen/wx_misc.erl index 3382d898e4..81dd16c0c4 100644 --- a/lib/wx/src/gen/wx_misc.erl +++ b/lib/wx/src/gen/wx_misc.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 @@ -30,42 +30,44 @@ launchDefaultBrowser/2,newId/0,registerId/1,setDetectableAutoRepeat/1, shell/0,shell/1,shutdown/1]). -%% @spec (Key::WxKeyCode) -> bool() -%% WxKeyCode = integer() %% @doc See external documentation. -%%
WxKeyCode is one of ?WXK_BACK | ?WXK_TAB | ?WXK_RETURN | ?WXK_ESCAPE | ?WXK_SPACE | ?WXK_DELETE | ?WXK_START | ?WXK_LBUTTON | ?WXK_RBUTTON | ?WXK_CANCEL | ?WXK_MBUTTON | ?WXK_CLEAR | ?WXK_SHIFT | ?WXK_ALT | ?WXK_CONTROL | ?WXK_MENU | ?WXK_PAUSE | ?WXK_CAPITAL | ?WXK_END | ?WXK_HOME | ?WXK_LEFT | ?WXK_UP | ?WXK_RIGHT | ?WXK_DOWN | ?WXK_SELECT | ?WXK_PRINT | ?WXK_EXECUTE | ?WXK_SNAPSHOT | ?WXK_INSERT | ?WXK_HELP | ?WXK_NUMPAD0 | ?WXK_NUMPAD1 | ?WXK_NUMPAD2 | ?WXK_NUMPAD3 | ?WXK_NUMPAD4 | ?WXK_NUMPAD5 | ?WXK_NUMPAD6 | ?WXK_NUMPAD7 | ?WXK_NUMPAD8 | ?WXK_NUMPAD9 | ?WXK_MULTIPLY | ?WXK_ADD | ?WXK_SEPARATOR | ?WXK_SUBTRACT | ?WXK_DECIMAL | ?WXK_DIVIDE | ?WXK_F1 | ?WXK_F2 | ?WXK_F3 | ?WXK_F4 | ?WXK_F5 | ?WXK_F6 | ?WXK_F7 | ?WXK_F8 | ?WXK_F9 | ?WXK_F10 | ?WXK_F11 | ?WXK_F12 | ?WXK_F13 | ?WXK_F14 | ?WXK_F15 | ?WXK_F16 | ?WXK_F17 | ?WXK_F18 | ?WXK_F19 | ?WXK_F20 | ?WXK_F21 | ?WXK_F22 | ?WXK_F23 | ?WXK_F24 | ?WXK_NUMLOCK | ?WXK_SCROLL | ?WXK_PAGEUP | ?WXK_PAGEDOWN | ?WXK_NUMPAD_SPACE | ?WXK_NUMPAD_TAB | ?WXK_NUMPAD_ENTER | ?WXK_NUMPAD_F1 | ?WXK_NUMPAD_F2 | ?WXK_NUMPAD_F3 | ?WXK_NUMPAD_F4 | ?WXK_NUMPAD_HOME | ?WXK_NUMPAD_LEFT | ?WXK_NUMPAD_UP | ?WXK_NUMPAD_RIGHT | ?WXK_NUMPAD_DOWN | ?WXK_NUMPAD_PAGEUP | ?WXK_NUMPAD_PAGEDOWN | ?WXK_NUMPAD_END | ?WXK_NUMPAD_BEGIN | ?WXK_NUMPAD_INSERT | ?WXK_NUMPAD_DELETE | ?WXK_NUMPAD_EQUAL | ?WXK_NUMPAD_MULTIPLY | ?WXK_NUMPAD_ADD | ?WXK_NUMPAD_SEPARATOR | ?WXK_NUMPAD_SUBTRACT | ?WXK_NUMPAD_DECIMAL | ?WXK_NUMPAD_DIVIDE | ?WXK_WINDOWS_LEFT | ?WXK_WINDOWS_RIGHT | ?WXK_WINDOWS_MENU | ?WXK_COMMAND | ?WXK_SPECIAL1 | ?WXK_SPECIAL2 | ?WXK_SPECIAL3 | ?WXK_SPECIAL4 | ?WXK_SPECIAL5 | ?WXK_SPECIAL6 | ?WXK_SPECIAL7 | ?WXK_SPECIAL8 | ?WXK_SPECIAL9 | ?WXK_SPECIAL10 | ?WXK_SPECIAL11 | ?WXK_SPECIAL12 | ?WXK_SPECIAL13 | ?WXK_SPECIAL14 | ?WXK_SPECIAL15 | ?WXK_SPECIAL16 | ?WXK_SPECIAL17 | ?WXK_SPECIAL18 | ?WXK_SPECIAL19 | ?WXK_SPECIAL20 +%%
Key = ?WXK_BACK | ?WXK_TAB | ?WXK_RETURN | ?WXK_ESCAPE | ?WXK_SPACE | ?WXK_DELETE | ?WXK_START | ?WXK_LBUTTON | ?WXK_RBUTTON | ?WXK_CANCEL | ?WXK_MBUTTON | ?WXK_CLEAR | ?WXK_SHIFT | ?WXK_ALT | ?WXK_CONTROL | ?WXK_MENU | ?WXK_PAUSE | ?WXK_CAPITAL | ?WXK_END | ?WXK_HOME | ?WXK_LEFT | ?WXK_UP | ?WXK_RIGHT | ?WXK_DOWN | ?WXK_SELECT | ?WXK_PRINT | ?WXK_EXECUTE | ?WXK_SNAPSHOT | ?WXK_INSERT | ?WXK_HELP | ?WXK_NUMPAD0 | ?WXK_NUMPAD1 | ?WXK_NUMPAD2 | ?WXK_NUMPAD3 | ?WXK_NUMPAD4 | ?WXK_NUMPAD5 | ?WXK_NUMPAD6 | ?WXK_NUMPAD7 | ?WXK_NUMPAD8 | ?WXK_NUMPAD9 | ?WXK_MULTIPLY | ?WXK_ADD | ?WXK_SEPARATOR | ?WXK_SUBTRACT | ?WXK_DECIMAL | ?WXK_DIVIDE | ?WXK_F1 | ?WXK_F2 | ?WXK_F3 | ?WXK_F4 | ?WXK_F5 | ?WXK_F6 | ?WXK_F7 | ?WXK_F8 | ?WXK_F9 | ?WXK_F10 | ?WXK_F11 | ?WXK_F12 | ?WXK_F13 | ?WXK_F14 | ?WXK_F15 | ?WXK_F16 | ?WXK_F17 | ?WXK_F18 | ?WXK_F19 | ?WXK_F20 | ?WXK_F21 | ?WXK_F22 | ?WXK_F23 | ?WXK_F24 | ?WXK_NUMLOCK | ?WXK_SCROLL | ?WXK_PAGEUP | ?WXK_PAGEDOWN | ?WXK_NUMPAD_SPACE | ?WXK_NUMPAD_TAB | ?WXK_NUMPAD_ENTER | ?WXK_NUMPAD_F1 | ?WXK_NUMPAD_F2 | ?WXK_NUMPAD_F3 | ?WXK_NUMPAD_F4 | ?WXK_NUMPAD_HOME | ?WXK_NUMPAD_LEFT | ?WXK_NUMPAD_UP | ?WXK_NUMPAD_RIGHT | ?WXK_NUMPAD_DOWN | ?WXK_NUMPAD_PAGEUP | ?WXK_NUMPAD_PAGEDOWN | ?WXK_NUMPAD_END | ?WXK_NUMPAD_BEGIN | ?WXK_NUMPAD_INSERT | ?WXK_NUMPAD_DELETE | ?WXK_NUMPAD_EQUAL | ?WXK_NUMPAD_MULTIPLY | ?WXK_NUMPAD_ADD | ?WXK_NUMPAD_SEPARATOR | ?WXK_NUMPAD_SUBTRACT | ?WXK_NUMPAD_DECIMAL | ?WXK_NUMPAD_DIVIDE | ?WXK_WINDOWS_LEFT | ?WXK_WINDOWS_RIGHT | ?WXK_WINDOWS_MENU | ?WXK_COMMAND | ?WXK_SPECIAL1 | ?WXK_SPECIAL2 | ?WXK_SPECIAL3 | ?WXK_SPECIAL4 | ?WXK_SPECIAL5 | ?WXK_SPECIAL6 | ?WXK_SPECIAL7 | ?WXK_SPECIAL8 | ?WXK_SPECIAL9 | ?WXK_SPECIAL10 | ?WXK_SPECIAL11 | ?WXK_SPECIAL12 | ?WXK_SPECIAL13 | ?WXK_SPECIAL14 | ?WXK_SPECIAL15 | ?WXK_SPECIAL16 | ?WXK_SPECIAL17 | ?WXK_SPECIAL18 | ?WXK_SPECIAL19 | ?WXK_SPECIAL20 +-spec getKeyState(Key) -> boolean() when + Key::wx:wx_enum(). getKeyState(Key) when is_integer(Key) -> wxe_util:call(?utils_wxGetKeyState, <>). -%% @spec () -> {X::integer(), Y::integer()} %% @doc See external documentation. +-spec getMousePosition() -> {X::integer(), Y::integer()}. getMousePosition() -> wxe_util:call(?utils_wxGetMousePosition, <<>>). -%% @spec () -> wx:wxMouseState() %% @doc See external documentation. +-spec getMouseState() -> wx:wx_wxMouseState(). getMouseState() -> wxe_util:call(?utils_wxGetMouseState, <<>>). -%% @spec (Flag::bool()) -> bool() %% @doc See external documentation. +-spec setDetectableAutoRepeat(Flag) -> boolean() when + Flag::boolean(). setDetectableAutoRepeat(Flag) when is_boolean(Flag) -> wxe_util:call(?utils_wxSetDetectableAutoRepeat, <<(wxe_util:from_bool(Flag)):32/?UI>>). -%% @spec () -> ok %% @doc See external documentation. +-spec bell() -> ok. bell() -> wxe_util:cast(?utils_wxBell, <<>>). -%% @spec (Frame::wxFrame:wxFrame(), MenuString::string(), ItemString::string()) -> integer() %% @doc See external documentation. +-spec findMenuItemId(Frame, MenuString, ItemString) -> integer() when + Frame::wxFrame:wxFrame(), MenuString::string(), ItemString::string(). findMenuItemId(#wx_ref{type=FrameT,ref=FrameRef},MenuString,ItemString) when is_list(MenuString),is_list(ItemString) -> ?CLASS(FrameT,wxFrame), @@ -74,28 +76,31 @@ findMenuItemId(#wx_ref{type=FrameT,ref=FrameRef},MenuString,ItemString) wxe_util:call(?utils_wxFindMenuItemId, <>). -%% @spec (Pt::{X::integer(), Y::integer()}) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec genericFindWindowAtPoint(Pt) -> wxWindow:wxWindow() when + Pt::{X::integer(), Y::integer()}. genericFindWindowAtPoint({PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> wxe_util:call(?utils_wxGenericFindWindowAtPoint, <>). -%% @spec (Pt::{X::integer(), Y::integer()}) -> wxWindow:wxWindow() %% @doc See external documentation. +-spec findWindowAtPoint(Pt) -> wxWindow:wxWindow() when + Pt::{X::integer(), Y::integer()}. findWindowAtPoint({PtX,PtY}) when is_integer(PtX),is_integer(PtY) -> wxe_util:call(?utils_wxFindWindowAtPoint, <>). -%% @spec () -> ok %% @equiv beginBusyCursor([]) +-spec beginBusyCursor() -> ok. + beginBusyCursor() -> beginBusyCursor([]). -%% @spec ([Option]) -> ok -%% Option = {cursor, wxCursor:wxCursor()} %% @doc See external documentation. +-spec beginBusyCursor([Option]) -> ok when + Option :: {cursor, wxCursor:wxCursor()}. beginBusyCursor(Options) when is_list(Options) -> MOpts = fun({cursor, #wx_ref{type=CursorT,ref=CursorRef}}, Acc) -> ?CLASS(CursorT,wxCursor),[<<1:32/?UI,CursorRef:32/?UI>>|Acc]; @@ -104,35 +109,36 @@ beginBusyCursor(Options) wxe_util:cast(?utils_wxBeginBusyCursor, <>). -%% @spec () -> ok %% @doc See external documentation. +-spec endBusyCursor() -> ok. endBusyCursor() -> wxe_util:cast(?utils_wxEndBusyCursor, <<>>). -%% @spec () -> bool() %% @doc See external documentation. +-spec isBusy() -> boolean(). isBusy() -> wxe_util:call(?utils_wxIsBusy, <<>>). -%% @spec (WFlags::WxShutdownFlags) -> bool() -%% WxShutdownFlags = integer() %% @doc See external documentation. -%%
WxShutdownFlags is one of ?wxSHUTDOWN_POWEROFF | ?wxSHUTDOWN_REBOOT +%%
WFlags = ?wxSHUTDOWN_POWEROFF | ?wxSHUTDOWN_REBOOT +-spec shutdown(WFlags) -> boolean() when + WFlags::wx:wx_enum(). shutdown(WFlags) when is_integer(WFlags) -> wxe_util:call(?utils_wxShutdown, <>). -%% @spec () -> bool() %% @equiv shell([]) +-spec shell() -> boolean(). + shell() -> shell([]). -%% @spec ([Option]) -> bool() -%% Option = {command, string()} %% @doc See external documentation. +-spec shell([Option]) -> boolean() when + Option :: {command, string()}. shell(Options) when is_list(Options) -> MOpts = fun({command, Command}, Acc) -> Command_UC = unicode:characters_to_binary([Command,0]),[<<1:32/?UI,(byte_size(Command_UC)):32/?UI,(Command_UC)/binary, 0:(((8- ((0+byte_size(Command_UC)) band 16#7)) band 16#7))/unit:8>>|Acc]; @@ -141,15 +147,18 @@ shell(Options) wxe_util:call(?utils_wxShell, <>). -%% @spec (Url::string()) -> bool() %% @equiv launchDefaultBrowser(Url, []) +-spec launchDefaultBrowser(Url) -> boolean() when + Url::string(). + launchDefaultBrowser(Url) when is_list(Url) -> launchDefaultBrowser(Url, []). -%% @spec (Url::string(), [Option]) -> bool() -%% Option = {flags, integer()} %% @doc See external documentation. +-spec launchDefaultBrowser(Url, [Option]) -> boolean() when + Url::string(), + Option :: {flags, integer()}. launchDefaultBrowser(Url, Options) when is_list(Url),is_list(Options) -> Url_UC = unicode:characters_to_binary([Url,0]), @@ -159,57 +168,58 @@ launchDefaultBrowser(Url, Options) wxe_util:call(?utils_wxLaunchDefaultBrowser, <<(byte_size(Url_UC)):32/?UI,(Url_UC)/binary, 0:(((8- ((4+byte_size(Url_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec () -> string() %% @doc See external documentation. +-spec getEmailAddress() -> string(). getEmailAddress() -> wxe_util:call(?utils_wxGetEmailAddress, <<>>). -%% @spec () -> string() %% @doc See external documentation. +-spec getUserId() -> string(). getUserId() -> wxe_util:call(?utils_wxGetUserId, <<>>). -%% @spec () -> string() %% @doc See external documentation. +-spec getHomeDir() -> string(). getHomeDir() -> wxe_util:call(?utils_wxGetHomeDir, <<>>). -%% @spec () -> integer() %% @doc See external documentation. +-spec newId() -> integer(). newId() -> wxe_util:call(?utils_wxNewId, <<>>). -%% @spec (Id::integer()) -> ok %% @doc See external documentation. +-spec registerId(Id) -> ok when + Id::integer(). registerId(Id) when is_integer(Id) -> wxe_util:cast(?utils_wxRegisterId, <>). -%% @spec () -> integer() %% @doc See external documentation. +-spec getCurrentId() -> integer(). getCurrentId() -> wxe_util:call(?utils_wxGetCurrentId, <<>>). -%% @spec () -> string() %% @doc See external documentation. +-spec getOsDescription() -> string(). getOsDescription() -> wxe_util:call(?utils_wxGetOsDescription, <<>>). -%% @spec () -> bool() %% @doc See external documentation. +-spec isPlatformLittleEndian() -> boolean(). isPlatformLittleEndian() -> wxe_util:call(?utils_wxIsPlatformLittleEndian, <<>>). -%% @spec () -> bool() %% @doc See external documentation. +-spec isPlatform64Bit() -> boolean(). isPlatform64Bit() -> wxe_util:call(?utils_wxIsPlatform64Bit, <<>>). diff --git a/lib/wx/src/wx.erl b/lib/wx/src/wx.erl index 9d76f3bc42..ecdc6e2647 100644 --- a/lib/wx/src/wx.erl +++ b/lib/wx/src/wx.erl @@ -1,46 +1,46 @@ %% %% %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 %% compliance with the License. You should have received a copy of the %% Erlang Public License along with this software. If not, it can be %% retrieved online at http://www.erlang.org/. -%% +%% %% Software distributed under the License is distributed on an "AS IS" %% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See %% the License for the specific language governing rights and limitations %% under the License. -%% +%% %% %CopyrightEnd% %%%------------------------------------------------------------------- %%% File : wx.erl %%% Author : Dan Gudmundsson -%%% Description : +%%% Description : %%% %%% Created : 22 Feb 2007 by Dan Gudmundsson %%%------------------------------------------------------------------- %% @doc A port of wxWidgets. -%% +%% %% This is the base api of wxWidgets. -%% This module contains functions for +%% This module contains functions for %% starting and stopping the wx-server, as well as other utility functions. %% %% wxWidgets is object oriented, and not functional. Thus, in wxErlang a %% module represents a class, and the object created by this class %% has an own type, wxCLASS(). This module represents the base %% class, and all other wxMODULE's are sub-classes of this class. -%% -%% Objects of a class are created with wxCLASS:new(...) and destroyed with +%% +%% Objects of a class are created with wxCLASS:new(...) and destroyed with %% wxCLASS:destroy(). Member functions are called with wxCLASS:member(Object, ...) %% instead of as in C++ Object.member(...). -%% +%% %% Sub class modules inherit (non static) functions from their parents. %% The inherited functions are not documented in the sub-classes. -%% +%% %% This erlang port of wxWidgets tries to be a one-to-one mapping with %% the original wxWidgets library. Some things are different though, %% as the optional arguments use property lists and can be in any @@ -59,42 +59,43 @@ %% %% Global (classless) functions are located in the wx_misc module. -%% @type wxObject(). Opaque object -%% @type wx_env(). Wx process environment -%% @type wx_mem(). Wx memory area -%% @type colour(). A 3 or 4 tuple: {R,G,B,A} or as argument {R,G,B} is also accepted -%% where each colour channel is a an integer between 0-255. -%% @type datetime(). {{Year,Month,Day}, {Hour,Minute,Second}} in local timezone. -%% @type mouseState(). See #wxMouseState{} defined in wx.hrl - - -module(wx). -export([parent_class/1, new/0, new/1, destroy/0, get_env/0,set_env/1, debug/1, batch/1,foreach/2,map/2,foldl/3,foldr/3, - getObjectType/1, typeCast/2, + getObjectType/1, typeCast/2, null/0, is_null/1]). -export([create_memory/1, get_memory_bin/1, retain_memory/1, release_memory/1]). - -export([demo/0]). - +-export_type([wx_colour/0, wx_datetime/0, wx_enum/0, wx_mouseState/0, wx_wxHtmlLinkInfo/0]). -include("wxe.hrl"). +-include("../include/wx.hrl"). + +-opaque wx_object() :: tuple(). %% Opaque object reference +-opaque wx_env() :: tuple(). %% Opaque process environment +-opaque wx_memory() :: tuple(). %% Opaque memory reference +-type wx_colour() :: {R::byte(),G::byte(),B::byte()} | + {R::byte(),G::byte(),B::byte(), A::byte()}. %% Always RGBA as return values +-type wx_datetime() :: {{Year::integer(),Month::integer(),Day::integer()}, + {Hour::integer(),Minute::integer(),Second::integer()}}. %% In Local Timezone +-type wx_mouseState() :: #wxMouseState{}. %% See #wxMouseState{} defined in wx.hrl +-type wx_enum() :: integer(). %% Constant defined in wx.hrl +-type wx_wxHtmlLinkInfo() :: #wxHtmlLinkInfo{}. -%% @hidden parent_class(_) -> true. %% Let the null pointers be sent down. -%% @spec () -> wxObject() %% @doc Starts a wx server. +-spec new() -> wx_object(). new() -> new([]). -%% @spec ([Option]) -> wxObject() -%% @doc Starts a wx server. +%% @doc Starts a wx server. %% Option may be {debug, Level}, see debug/1. +-spec new([Option]) -> wx_object() when Option :: {debug, list() | atom()}. new(Options) when is_list(Options) -> #wx_env{port=Port} = wxe_server:start(), put(opengl_port, Port), @@ -102,130 +103,129 @@ new(Options) when is_list(Options) -> debug(Debug), null(). -%% @spec () -> ok %% @doc Stops a wx server. +-spec destroy() -> ok. destroy() -> wxe_server:stop(), erase(?WXE_IDENTIFIER), ok. -%% @spec () -> wx_env() %% @doc Gets this process's current wx environment. %% Can be sent to other processes to allow them use this process wx environment. %% @see set_env/1 +-spec get_env() -> wx_env(). get_env() -> case get(?WXE_IDENTIFIER) of undefined -> erlang:error({wxe,unknown_port}); Env = #wx_env{} -> Env end. -%% @spec (wx_env()) -> ok %% @doc Sets the process wx environment, allows this process to use %% another process wx environment. +-spec set_env(wx_env()) -> ok. set_env(#wx_env{sv=Pid, port=Port} = Env) -> - put(?WXE_IDENTIFIER, Env), + put(?WXE_IDENTIFIER, Env), put(opengl_port, Port), %% wxe_util:cast(?REGISTER_PID, <<>>), wxe_server:register_me(Pid), ok. -%% @spec () -> wxObject() %% @doc Returns the null object +-spec null() -> wx_object(). null() -> #wx_ref{ref=0, type=wx}. -%% @spec (wxObject()) -> boolean() %% @doc Returns true if object is null, false otherwise +-spec is_null(wx_object()) -> boolean(). is_null(#wx_ref{ref=NULL}) -> NULL =:= 0. -%% @spec (wxObject()) -> atom() %% @doc Returns the object type +-spec getObjectType(wx_object()) -> atom(). getObjectType(#wx_ref{type=Type}) -> Type. -%% @spec (wxObject(), atom()) -> wxObject() %% @doc Casts the object to class NewType. -%% It is needed when using functions like wxWindow:findWindow/2, which +%% It is needed when using functions like wxWindow:findWindow/2, which %% returns a generic wxObject type. +-spec typeCast(wx_object(), atom()) -> wx_object(). typeCast(Old=#wx_ref{}, NewType) when is_atom(NewType) -> Old#wx_ref{type=NewType}. -%% @spec (function()) -> term() %% @doc Batches all wx commands %% used in the fun. Improves performance of the command processing by %% grabbing the wxWidgets thread so that no event processing will be %% done before the complete batch of commands is invoked. -%% +%% %% @see map/2 %% @see foreach/2 %% @see foldl/3 %% @see foldr/3 +-spec batch(function()) -> term(). batch(Fun) -> ok = wxe_util:cast(?BATCH_BEGIN, <<>>), try Fun() - catch + catch error:W -> erlang:exit({W, erlang:get_stacktrace()}); throw:W -> erlang:throw(W); exit:W -> erlang:exit(W) - after + after ok = wxe_util:cast(?BATCH_END, <<>>) end. -%% @spec (function(), list()) -> ok -%% @doc Behaves like {@link //stdlib/lists:foreach/2} but batches wx commands. See {@link batch/1}. +%% @doc Behaves like {@link //stdlib/lists:foreach/2} but batches wx commands. See {@link batch/1}. +-spec foreach(function(), list()) -> ok. foreach(Fun, List) -> ok = wxe_util:cast(?BATCH_BEGIN, <<>>), try lists:foreach(Fun, List) - catch + catch error:W -> erlang:exit({W, erlang:get_stacktrace()}); throw:W -> erlang:throw(W); exit:W -> erlang:exit(W) - after + after ok = wxe_util:cast(?BATCH_END, <<>>) end. -%% @spec (function(), list()) -> list() -%% @doc Behaves like {@link //stdlib/lists:map/2} but batches wx commands. See {@link batch/1}. +%% @doc Behaves like {@link //stdlib/lists:map/2} but batches wx commands. See {@link batch/1}. +-spec map(function(), list()) -> list(). map(Fun, List) -> ok = wxe_util:cast(?BATCH_BEGIN, <<>>), try lists:map(Fun, List) - catch + catch error:W -> erlang:exit({W, erlang:get_stacktrace()}); throw:W -> erlang:throw(W); exit:W -> erlang:exit(W) - after + after ok = wxe_util:cast(?BATCH_END, <<>>) end. -%% @spec (function(), term(), list()) -> term() -%% @doc Behaves like {@link //stdlib/lists:foldl/3} but batches wx commands. See {@link batch/1}. +%% @doc Behaves like {@link //stdlib/lists:foldl/3} but batches wx commands. See {@link batch/1}. +-spec foldl(function(), term(), list()) -> term(). foldl(Fun, Acc, List) -> ok = wxe_util:cast(?BATCH_BEGIN, <<>>), try lists:foldl(Fun, Acc, List) - catch + catch error:W -> erlang:exit({W, erlang:get_stacktrace()}); throw:W -> erlang:throw(W); exit:W -> erlang:exit(W) - after + after ok = wxe_util:cast(?BATCH_END, <<>>) end. -%% @spec (function(), term(), list()) -> term() -%% @doc Behaves like {@link //stdlib/lists:foldr/3} but batches wx commands. See {@link batch/1}. +%% @doc Behaves like {@link //stdlib/lists:foldr/3} but batches wx commands. See {@link batch/1}. +-spec foldr(function(), term(), list()) -> term(). foldr(Fun, Acc, List) -> ok = wxe_util:cast(?BATCH_BEGIN, <<>>), try lists:foldr(Fun, Acc, List) - catch + catch error:W -> erlang:exit({W, erlang:get_stacktrace()}); throw:W -> erlang:throw(W); exit:W -> erlang:exit(W) - after + after ok = wxe_util:cast(?BATCH_END, <<>>) end. -define(MIN_BIN_SIZE, 64). %% Current emulator min off heap size -%% @spec (integer()) -> wx_memory() %% @doc Creates a memory area (of Size in bytes) which can be used by an external library (i.e. opengl). %% It is up to the client to keep a reference to this object so it does %% not get garbage collected by erlang while still in use by the external @@ -233,22 +233,23 @@ foldr(Fun, Acc, List) -> %% %% This is far from erlang's intentional usage and can crash the erlang emulator. %% Use it carefully. +-spec create_memory(integer()) -> wx_memory(). create_memory(Size) when Size > ?MIN_BIN_SIZE -> #wx_mem{bin = <<0:(Size*8)>>, size = Size}; create_memory(Size) -> #wx_mem{bin = <<0:((?MIN_BIN_SIZE+1)*8)>>, size = Size}. -%% @spec (wx_memory()) -> binary() %% @doc Returns the memory area as a binary. +-spec get_memory_bin(wx_memory()) -> binary(). get_memory_bin(#wx_mem{bin=Bin, size=Size}) when Size > ?MIN_BIN_SIZE -> Bin; get_memory_bin(#wx_mem{bin=Bin, size=Size}) -> <> = Bin, WithCorrectSize. -%% @spec (wx_memory()) -> ok %% @doc Saves the memory from deletion until release_memory/1 is called. %% If release_memory/1 is not called the memory will not be garbage collected. +-spec retain_memory(wx_memory()) -> ok. retain_memory(#wx_mem{bin=Bin}) -> wxe_util:send_bin(Bin), ok = wxe_util:cast(?WXE_BIN_INCR, <<>>); @@ -260,30 +261,29 @@ retain_memory(Bin) when is_binary(Bin) -> wxe_util:send_bin(Bin), ok = wxe_util:cast(?WXE_BIN_INCR, <<>>). +-spec release_memory(wx_memory()) -> ok. release_memory(#wx_mem{bin=Bin}) -> wxe_util:send_bin(Bin), ok = wxe_util:cast(?WXE_BIN_DECR, <<>>); release_memory(Bin) when is_binary(Bin) -> wxe_util:send_bin(Bin), ok = wxe_util:cast(?WXE_BIN_DECR, <<>>). - - - -%% @spec (Level::term()) -> ok -%% Level = none | verbose | trace | driver | [Level] %% @doc Sets debug level. If debug level is verbose or trace -%% each call is printed on console. If Level is driver each allocated +%% each call is printed on console. If Level is driver each allocated %% object and deletion is printed on the console. +-spec debug(Level | [Level]) -> ok + when Level :: none | verbose | trace | driver. + debug(none) -> debug(0); debug(verbose) -> debug(1); debug(trace) -> debug(2); debug(driver) -> debug(16); debug([]) -> debug(0); -debug(List) when is_list(List) -> - {Drv,Erl} = - lists:foldl(fun(verbose, {Drv,_Erl}) -> +debug(List) when is_list(List) -> + {Drv,Erl} = + lists:foldl(fun(verbose, {Drv,_Erl}) -> {Drv,1}; (trace, {Drv,_Erl}) -> {Drv,2}; @@ -295,28 +295,28 @@ debug(Level) when is_integer(Level) -> case get(?WXE_IDENTIFIER) of undefined -> erlang:error({wxe,unknown_port}); #wx_env{debug=Old} when Old =:= Level -> ok; - Env = #wx_env{sv=Server, port=Port, debug=Old} -> - if + Env = #wx_env{sv=Server, port=Port, debug=Old} -> + if Old > 16, Level > 16 -> ok; Old < 16, Level < 16 -> ok; true -> erlang:port_call(Port,?WXE_DEBUG_DRIVER, [Level bsr 4]) - end, + end, put(?WXE_IDENTIFIER, Env#wx_env{debug=Level}), wxe_server:set_debug(Server,Level), ok end. -%% @spec () -> ok %% @doc Starts a wxErlang demo if examples directory exists and is compiled +-spec demo() -> ok. demo() -> Priv = code:priv_dir(wx), Demo = filename:join([filename:dirname(Priv),examples,demo]), Mod = list_to_atom("demo"), %% Fool xref tests case file:set_cwd(Demo) of - ok -> + ok -> apply(Mod, start, []); _ -> {error, no_demo_dir} end. - + -- cgit v1.2.3