diff options
Diffstat (limited to 'lib/wx/src/gen/wxSplitterWindow.erl')
-rw-r--r-- | lib/wx/src/gen/wxSplitterWindow.erl | 115 |
1 files changed, 77 insertions, 38 deletions
diff --git a/lib/wx/src/gen/wxSplitterWindow.erl b/lib/wx/src/gen/wxSplitterWindow.erl index 9e27be7475..231f93911f 100644 --- a/lib/wx/src/gen/wxSplitterWindow.erl +++ b/lib/wx/src/gen/wxSplitterWindow.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 @@ -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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowwxsplitterwindow">external documentation</a>. +-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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowwxsplitterwindow">external documentation</a>. +-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, <<ParentRef:32/?UI, 0:32,BinOpt/binary>>). -%% @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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowcreate">external documentation</a>. +-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, <<ThisRef:32/?UI,ParentRef:32/?UI, BinOpt/binary>>). -%% @spec (This::wxSplitterWindow()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowgetminimumpanesize">external documentation</a>. +-spec getMinimumPaneSize(This) -> integer() when + This::wxSplitterWindow(). getMinimumPaneSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetMinimumPaneSize, <<ThisRef:32/?UI>>). -%% @spec (This::wxSplitterWindow()) -> float() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowgetsashgravity">external documentation</a>. +-spec getSashGravity(This) -> number() when + This::wxSplitterWindow(). getSashGravity(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetSashGravity, <<ThisRef:32/?UI>>). -%% @spec (This::wxSplitterWindow()) -> integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowgetsashposition">external documentation</a>. +-spec getSashPosition(This) -> integer() when + This::wxSplitterWindow(). getSashPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetSashPosition, <<ThisRef:32/?UI>>). -%% @spec (This::wxSplitterWindow()) -> WxSplitMode -%% WxSplitMode = integer() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowgetsplitmode">external documentation</a>. -%%<br /> WxSplitMode is one of ?wxSPLIT_HORIZONTAL | ?wxSPLIT_VERTICAL +%%<br /> 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, <<ThisRef:32/?UI>>). -%% @spec (This::wxSplitterWindow()) -> wxWindow:wxWindow() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowgetwindow1">external documentation</a>. +-spec getWindow1(This) -> wxWindow:wxWindow() when + This::wxSplitterWindow(). getWindow1(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetWindow1, <<ThisRef:32/?UI>>). -%% @spec (This::wxSplitterWindow()) -> wxWindow:wxWindow() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowgetwindow2">external documentation</a>. +-spec getWindow2(This) -> wxWindow:wxWindow() when + This::wxSplitterWindow(). getWindow2(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_GetWindow2, <<ThisRef:32/?UI>>). -%% @spec (This::wxSplitterWindow(), Window::wxWindow:wxWindow()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowinitialize">external documentation</a>. +-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, <<ThisRef:32/?UI,WindowRef:32/?UI>>). -%% @spec (This::wxSplitterWindow()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowissplit">external documentation</a>. +-spec isSplit(This) -> boolean() when + This::wxSplitterWindow(). isSplit(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:call(?wxSplitterWindow_IsSplit, <<ThisRef:32/?UI>>). -%% @spec (This::wxSplitterWindow(), WinOld::wxWindow:wxWindow(), WinNew::wxWindow:wxWindow()) -> bool() %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowreplacewindow">external documentation</a>. +-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, <<ThisRef:32/?UI,WinOldRef:32/?UI,WinNewRef:32/?UI>>). -%% @spec (This::wxSplitterWindow(), Gravity::float()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowsetsashgravity">external documentation</a>. +-spec setSashGravity(This, Gravity) -> ok when + This::wxSplitterWindow(), Gravity::number(). setSashGravity(#wx_ref{type=ThisT,ref=ThisRef},Gravity) - when is_float(Gravity) -> + when is_number(Gravity) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:cast(?wxSplitterWindow_SetSashGravity, <<ThisRef:32/?UI,0:32,Gravity:64/?F>>). -%% @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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowsetsashposition">external documentation</a>. +-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, <<ThisRef:32/?UI,Position:32/?UI, BinOpt/binary>>). -%% @spec (This::wxSplitterWindow(), Width::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowsetsashsize">external documentation</a>. +-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, <<ThisRef:32/?UI,Width:32/?UI>>). -%% @spec (This::wxSplitterWindow(), Min::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowsetminimumpanesize">external documentation</a>. +-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, <<ThisRef:32/?UI,Min:32/?UI>>). -%% @spec (This::wxSplitterWindow(), Mode::integer()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowsetsplitmode">external documentation</a>. +-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, <<ThisRef:32/?UI,Mode:32/?UI>>). -%% @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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowsplithorizontally">external documentation</a>. +-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, <<ThisRef:32/?UI,Window1Ref:32/?UI,Window2Ref:32/?UI, 0:32,BinOpt/binary>>). -%% @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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowsplitvertically">external documentation</a>. +-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, <<ThisRef:32/?UI,Window1Ref:32/?UI,Window2Ref:32/?UI, 0:32,BinOpt/binary>>). -%% @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 <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowunsplit">external documentation</a>. +-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, <<ThisRef:32/?UI, 0:32,BinOpt/binary>>). -%% @spec (This::wxSplitterWindow()) -> ok %% @doc See <a href="http://www.wxwidgets.org/manuals/stable/wx_wxsplitterwindow.html#wxsplitterwindowupdatesize">external documentation</a>. +-spec updateSize(This) -> ok when + This::wxSplitterWindow(). updateSize(#wx_ref{type=ThisT,ref=ThisRef}) -> ?CLASS(ThisT,wxSplitterWindow), wxe_util:cast(?wxSplitterWindow_UpdateSize, <<ThisRef:32/?UI>>). -%% @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), |