diff options
Diffstat (limited to 'lib/wx/src/gen/wxAuiManager.erl')
| -rw-r--r-- | lib/wx/src/gen/wxAuiManager.erl | 120 |
1 files changed, 72 insertions, 48 deletions
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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagerwxauimanager">external documentation</a>. +-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, <<BinOpt/binary>>). -%% @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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanageraddpane">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% addPane(This::wxAuiManager(), Window::wxWindow:wxWindow(), [Option]) -> bool() </c> -%%<br /> Option = {direction, integer()} | {caption, string()} -%% </p> -%% <p><c> -%% addPane(This::wxAuiManager(), Window::wxWindow:wxWindow(), Pane_info::wxAuiPaneInfo:wxAuiPaneInfo()) -> bool() </c> -%% </p> +-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, <<ThisRef:32/?UI,WindowRef:32/?UI,Pane_infoRef:32/?UI>>). -%% @spec (This::wxAuiManager(), Window::wxWindow:wxWindow(), Pane_info::wxAuiPaneInfo:wxAuiPaneInfo(), Drop_pos::{X::integer(), Y::integer()}) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanageraddpane">external documentation</a>. +-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, <<ThisRef:32/?UI,WindowRef:32/?UI,Pane_infoRef:32/?UI,Drop_posX:32/?UI,Drop_posY:32/?UI>>). -%% @spec (This::wxAuiManager(), Window::wxWindow:wxWindow()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagerdetachpane">external documentation</a>. +-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, <<ThisRef:32/?UI,WindowRef:32/?UI>>). -%% @spec (This::wxAuiManager()) -> wxAuiPaneInfoArray:wxAuiPaneInfoArray() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagergetallpanes">external documentation</a>. +-spec getAllPanes(This) -> wxAuiPaneInfoArray:wxAuiPaneInfoArray() when + This::wxAuiManager(). getAllPanes(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_GetAllPanes, <<ThisRef:32/?UI>>). -%% @spec (This::wxAuiManager()) -> wxAuiDockArt:wxAuiDockArt() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagergetartprovider">external documentation</a>. +-spec getArtProvider(This) -> wxAuiDockArt:wxAuiDockArt() when + This::wxAuiManager(). getArtProvider(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_GetArtProvider, <<ThisRef:32/?UI>>). -%% @spec (This::wxAuiManager()) -> {Width_pct::float(), Height_pct::float()} %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagergetdocksizeconstraint">external documentation</a>. +-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, <<ThisRef:32/?UI>>). -%% @spec (This::wxAuiManager()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagergetflags">external documentation</a>. +-spec getFlags(This) -> integer() when + This::wxAuiManager(). getFlags(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_GetFlags, <<ThisRef:32/?UI>>). -%% @spec (This::wxAuiManager()) -> wxWindow:wxWindow() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagergetmanagedwindow">external documentation</a>. +-spec getManagedWindow(This) -> wxWindow:wxWindow() when + This::wxAuiManager(). getManagedWindow(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_GetManagedWindow, <<ThisRef:32/?UI>>). -%% @spec (Window::wxWindow:wxWindow()) -> wxAuiManager() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagergetmanager">external documentation</a>. +-spec getManager(Window) -> wxAuiManager() when + Window::wxWindow:wxWindow(). getManager(#wx_ref{type=WindowT,ref=WindowRef}) -> ?CLASS(WindowT,wxWindow), wxe_util:call(?wxAuiManager_GetManager, <<WindowRef:32/?UI>>). -%% @spec (This::wxAuiManager(),X::string()|term()) -> wxAuiPaneInfo:wxAuiPaneInfo() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagergetpane">external documentation</a>. -%% <br /> Alternatives: -%% <p><c> -%% getPane(This::wxAuiManager(), Name::string()) -> wxAuiPaneInfo:wxAuiPaneInfo() </c> -%% </p> -%% <p><c> -%% getPane(This::wxAuiManager(), Window::wxWindow:wxWindow()) -> wxAuiPaneInfo:wxAuiPaneInfo() </c> -%% </p> +-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, <<ThisRef:32/?UI,WindowRef:32/?UI>>). -%% @spec (This::wxAuiManager()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagerhidehint">external documentation</a>. +-spec hideHint(This) -> ok when + This::wxAuiManager(). hideHint(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:cast(?wxAuiManager_HideHint, <<ThisRef:32/?UI>>). -%% @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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagerinsertpane">external documentation</a>. +-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, <<ThisRef:32/?UI,WindowRef:32/?UI,Insert_locationRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxAuiManager(), Pane_part::string(), Pane::wxAuiPaneInfo:wxAuiPaneInfo()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagerloadpaneinfo">external documentation</a>. +-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, <<ThisRef:32/?UI,(byte_size(Pane_part_UC)):32/?UI,(Pane_part_UC)/binary, 0:(((8- ((0+byte_size(Pane_part_UC)) band 16#7)) band 16#7))/unit:8,PaneRef:32/?UI>>). -%% @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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagerloadperspective">external documentation</a>. +-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, <<ThisRef:32/?UI,(byte_size(Perspective_UC)):32/?UI,(Perspective_UC)/binary, 0:(((8- ((0+byte_size(Perspective_UC)) band 16#7)) band 16#7))/unit:8, BinOpt/binary>>). -%% @spec (This::wxAuiManager(), Pane::wxAuiPaneInfo:wxAuiPaneInfo()) -> string() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagersavepaneinfo">external documentation</a>. +-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, <<ThisRef:32/?UI,PaneRef:32/?UI>>). -%% @spec (This::wxAuiManager()) -> string() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagersaveperspective">external documentation</a>. +-spec savePerspective(This) -> string() when + This::wxAuiManager(). savePerspective(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:call(?wxAuiManager_SavePerspective, <<ThisRef:32/?UI>>). -%% @spec (This::wxAuiManager(), Art_provider::wxAuiDockArt:wxAuiDockArt()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagersetartprovider">external documentation</a>. +-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, <<ThisRef:32/?UI,Art_providerRef:32/?UI>>). -%% @spec (This::wxAuiManager(), Width_pct::float(), Height_pct::float()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagersetdocksizeconstraint">external documentation</a>. +-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, <<ThisRef:32/?UI,0:32,Width_pct:64/?F,Height_pct:64/?F>>). -%% @spec (This::wxAuiManager(), Flags::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagersetflags">external documentation</a>. +-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, <<ThisRef:32/?UI,Flags:32/?UI>>). -%% @spec (This::wxAuiManager(), Managed_wnd::wxWindow:wxWindow()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagersetmanagedwindow">external documentation</a>. +-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, <<ThisRef:32/?UI,Managed_wndRef:32/?UI>>). -%% @spec (This::wxAuiManager(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagershowhint">external documentation</a>. +-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, <<ThisRef:32/?UI,RectX:32/?UI,RectY:32/?UI,RectW:32/?UI,RectH:32/?UI>>). -%% @spec (This::wxAuiManager()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanageruninit">external documentation</a>. +-spec unInit(This) -> ok when + This::wxAuiManager(). unInit(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:cast(?wxAuiManager_UnInit, <<ThisRef:32/?UI>>). -%% @spec (This::wxAuiManager()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxauimanager.html#wxauimanagerupdate">external documentation</a>. +-spec update(This) -> ok when + This::wxAuiManager(). update(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxAuiManager), wxe_util:cast(?wxAuiManager_Update, <<ThisRef:32/?UI>>). -%% @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), |