From 4a9055ebb2f5fc69205a1082bbc813839c0e3138 Mon Sep 17 00:00:00 2001 From: Dan Gudmundsson Date: Thu, 21 Nov 2013 14:18:31 +0100 Subject: wx: Update documentation links to wxWidgets --- lib/wx/src/gen/wxToolBar.erl | 82 ++++++++++++++++++++++---------------------- 1 file changed, 41 insertions(+), 41 deletions(-) (limited to 'lib/wx/src/gen/wxToolBar.erl') diff --git a/lib/wx/src/gen/wxToolBar.erl b/lib/wx/src/gen/wxToolBar.erl index 9401e30e20..f8e4b7704a 100644 --- a/lib/wx/src/gen/wxToolBar.erl +++ b/lib/wx/src/gen/wxToolBar.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2012. All Rights Reserved. +%% Copyright Ericsson AB 2008-2013. 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 @@ -17,7 +17,7 @@ %% %CopyrightEnd% %% This file is generated DO NOT EDIT -%% @doc See external documentation: wxToolBar. +%% @doc See external documentation: wxToolBar. %%

This class is derived (and can use functions) from: %%
{@link wxControl} %%
{@link wxWindow} @@ -85,7 +85,7 @@ parent_class(wxEvtHandler) -> true; parent_class(_Class) -> erlang:error({badtype, ?MODULE}). -type wxToolBar() :: wx:wx_object(). -%% @doc See external documentation. +%% @doc See external documentation. -spec addControl(This, Control) -> wx:wx_object() when This::wxToolBar(), Control::wxControl:wxControl(). addControl(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ControlT,ref=ControlRef}) -> @@ -94,7 +94,7 @@ addControl(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ControlT,ref=ControlRef} wxe_util:call(?wxToolBar_AddControl, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec addSeparator(This) -> wx:wx_object() when This::wxToolBar(). addSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -102,7 +102,7 @@ addSeparator(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxToolBar_AddSeparator, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec addTool(This, Tool) -> wx:wx_object() when This::wxToolBar(), Tool::wx:wx_object(). addTool(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ToolT,ref=ToolRef}) -> @@ -119,7 +119,7 @@ addTool(This,Toolid,Bitmap) when is_record(This, wx_ref),is_integer(Toolid),is_record(Bitmap, wx_ref) -> addTool(This,Toolid,Bitmap, []). -%% @doc See external documentation. +%% @doc See external documentation. %%
Also:
%% addTool(This, Toolid, Bitmap, BmpDisabled) -> wx:wx_object() when
%% This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap();
@@ -156,7 +156,7 @@ addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,#wx_ref{type=BitmapT,ref=BitmapRe wxe_util:call(?wxToolBar_AddTool_3, <>). -%% @doc See external documentation. +%% @doc See external documentation. %%
Also:
%% addTool(This, Toolid, Label, Bitmap, [Option]) -> wx:wx_object() when
%% This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(),
@@ -211,7 +211,7 @@ addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,#wx_ref{type=BitmapT,ref=BitmapRe wxe_util:call(?wxToolBar_AddTool_4_1, <>). -%% @doc See external documentation. +%% @doc See external documentation. %%
Also:
%% addTool(This, Toolid, Label, Bitmap, BmpDisabled, [Option]) -> wx:wx_object() when
%% This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(),
@@ -248,7 +248,7 @@ addTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Label,#wx_ref{type=BitmapT,ref=Bi wxe_util:call(?wxToolBar_AddTool_5, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec addTool(This, Toolid, Bitmap, BmpDisabled, Toggle, XPos, [Option]) -> wx:wx_object() when This::wxToolBar(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(), Toggle::boolean(), XPos::integer(), Option :: {yPos, integer()} @@ -277,7 +277,7 @@ 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, []). -%% @doc See external documentation. +%% @doc See external documentation. -spec addCheckTool(This, Toolid, Label, Bitmap, [Option]) -> wx:wx_object() when This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(), Option :: {bmpDisabled, wxBitmap:wxBitmap()} @@ -306,7 +306,7 @@ 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, []). -%% @doc See external documentation. +%% @doc See external documentation. -spec addRadioTool(This, Toolid, Label, Bitmap, [Option]) -> wx:wx_object() when This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(), Option :: {bmpDisabled, wxBitmap:wxBitmap()} @@ -327,7 +327,7 @@ addRadioTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Label,#wx_ref{type=BitmapT,r wxe_util:call(?wxToolBar_AddRadioTool, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec deleteTool(This, Toolid) -> boolean() when This::wxToolBar(), Toolid::integer(). deleteTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid) @@ -336,7 +336,7 @@ deleteTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid) wxe_util:call(?wxToolBar_DeleteTool, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec deleteToolByPos(This, Pos) -> boolean() when This::wxToolBar(), Pos::integer(). deleteToolByPos(#wx_ref{type=ThisT,ref=ThisRef},Pos) @@ -345,7 +345,7 @@ deleteToolByPos(#wx_ref{type=ThisT,ref=ThisRef},Pos) wxe_util:call(?wxToolBar_DeleteToolByPos, <>). -%% @doc See external documentation. +%% @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) @@ -354,7 +354,7 @@ enableTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid,Enable) wxe_util:cast(?wxToolBar_EnableTool, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec findById(This, Toolid) -> wx:wx_object() when This::wxToolBar(), Toolid::integer(). findById(#wx_ref{type=ThisT,ref=ThisRef},Toolid) @@ -363,7 +363,7 @@ findById(#wx_ref{type=ThisT,ref=ThisRef},Toolid) wxe_util:call(?wxToolBar_FindById, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec findControl(This, Toolid) -> wxControl:wxControl() when This::wxToolBar(), Toolid::integer(). findControl(#wx_ref{type=ThisT,ref=ThisRef},Toolid) @@ -372,7 +372,7 @@ findControl(#wx_ref{type=ThisT,ref=ThisRef},Toolid) wxe_util:call(?wxToolBar_FindControl, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec findToolForPosition(This, X, Y) -> wx:wx_object() when This::wxToolBar(), X::integer(), Y::integer(). findToolForPosition(#wx_ref{type=ThisT,ref=ThisRef},X,Y) @@ -381,7 +381,7 @@ findToolForPosition(#wx_ref{type=ThisT,ref=ThisRef},X,Y) wxe_util:call(?wxToolBar_FindToolForPosition, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getToolSize(This) -> {W::integer(), H::integer()} when This::wxToolBar(). getToolSize(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -389,7 +389,7 @@ getToolSize(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxToolBar_GetToolSize, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getToolBitmapSize(This) -> {W::integer(), H::integer()} when This::wxToolBar(). getToolBitmapSize(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -397,7 +397,7 @@ getToolBitmapSize(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxToolBar_GetToolBitmapSize, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getMargins(This) -> {W::integer(), H::integer()} when This::wxToolBar(). getMargins(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -405,7 +405,7 @@ getMargins(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxToolBar_GetMargins, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getToolEnabled(This, Toolid) -> boolean() when This::wxToolBar(), Toolid::integer(). getToolEnabled(#wx_ref{type=ThisT,ref=ThisRef},Toolid) @@ -414,7 +414,7 @@ getToolEnabled(#wx_ref{type=ThisT,ref=ThisRef},Toolid) wxe_util:call(?wxToolBar_GetToolEnabled, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getToolLongHelp(This, Toolid) -> unicode:charlist() when This::wxToolBar(), Toolid::integer(). getToolLongHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid) @@ -423,7 +423,7 @@ getToolLongHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid) wxe_util:call(?wxToolBar_GetToolLongHelp, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getToolPacking(This) -> integer() when This::wxToolBar(). getToolPacking(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -431,7 +431,7 @@ getToolPacking(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxToolBar_GetToolPacking, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getToolPos(This, Id) -> integer() when This::wxToolBar(), Id::integer(). getToolPos(#wx_ref{type=ThisT,ref=ThisRef},Id) @@ -440,7 +440,7 @@ getToolPos(#wx_ref{type=ThisT,ref=ThisRef},Id) wxe_util:call(?wxToolBar_GetToolPos, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getToolSeparation(This) -> integer() when This::wxToolBar(). getToolSeparation(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -448,7 +448,7 @@ getToolSeparation(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxToolBar_GetToolSeparation, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getToolShortHelp(This, Toolid) -> unicode:charlist() when This::wxToolBar(), Toolid::integer(). getToolShortHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid) @@ -457,7 +457,7 @@ getToolShortHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid) wxe_util:call(?wxToolBar_GetToolShortHelp, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getToolState(This, Toolid) -> boolean() when This::wxToolBar(), Toolid::integer(). getToolState(#wx_ref{type=ThisT,ref=ThisRef},Toolid) @@ -466,7 +466,7 @@ getToolState(#wx_ref{type=ThisT,ref=ThisRef},Toolid) wxe_util:call(?wxToolBar_GetToolState, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec insertControl(This, Pos, Control) -> wx:wx_object() when This::wxToolBar(), Pos::integer(), Control::wxControl:wxControl(). insertControl(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=ControlT,ref=ControlRef}) @@ -476,7 +476,7 @@ insertControl(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=ControlT,ref=Cont wxe_util:call(?wxToolBar_InsertControl, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec insertSeparator(This, Pos) -> wx:wx_object() when This::wxToolBar(), Pos::integer(). insertSeparator(#wx_ref{type=ThisT,ref=ThisRef},Pos) @@ -485,7 +485,7 @@ insertSeparator(#wx_ref{type=ThisT,ref=ThisRef},Pos) wxe_util:call(?wxToolBar_InsertSeparator, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec insertTool(This, Pos, Tool) -> wx:wx_object() when This::wxToolBar(), Pos::integer(), Tool::wx:wx_object(). insertTool(#wx_ref{type=ThisT,ref=ThisRef},Pos,#wx_ref{type=ToolT,ref=ToolRef}) @@ -503,7 +503,7 @@ 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, []). -%% @doc See external documentation. +%% @doc See external documentation. %%
Also:
%% insertTool(This, Pos, Toolid, Bitmap, [Option]) -> wx:wx_object() when
%% This::wxToolBar(), Pos::integer(), Toolid::integer(), Bitmap::wxBitmap:wxBitmap(),
@@ -541,7 +541,7 @@ insertTool(#wx_ref{type=ThisT,ref=ThisRef},Pos,Toolid,#wx_ref{type=BitmapT,ref=B wxe_util:call(?wxToolBar_InsertTool_4, <>). -%% @doc See external documentation. +%% @doc See external documentation. %%
Kind = ?wxITEM_SEPARATOR | ?wxITEM_NORMAL | ?wxITEM_CHECK | ?wxITEM_RADIO | ?wxITEM_MAX -spec insertTool(This, Pos, Toolid, Label, Bitmap, [Option]) -> wx:wx_object() when This::wxToolBar(), Pos::integer(), Toolid::integer(), Label::unicode:chardata(), Bitmap::wxBitmap:wxBitmap(), @@ -565,7 +565,7 @@ insertTool(#wx_ref{type=ThisT,ref=ThisRef},Pos,Toolid,Label,#wx_ref{type=BitmapT wxe_util:call(?wxToolBar_InsertTool_5, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec realize(This) -> boolean() when This::wxToolBar(). realize(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -573,7 +573,7 @@ realize(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxToolBar_Realize, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec removeTool(This, Toolid) -> wx:wx_object() when This::wxToolBar(), Toolid::integer(). removeTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid) @@ -582,7 +582,7 @@ removeTool(#wx_ref{type=ThisT,ref=ThisRef},Toolid) wxe_util:call(?wxToolBar_RemoveTool, <>). -%% @doc See external documentation. +%% @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) @@ -591,7 +591,7 @@ setMargins(#wx_ref{type=ThisT,ref=ThisRef},X,Y) wxe_util:cast(?wxToolBar_SetMargins, <>). -%% @doc See external documentation. +%% @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}) @@ -600,7 +600,7 @@ setToolBitmapSize(#wx_ref{type=ThisT,ref=ThisRef},{SizeW,SizeH}) wxe_util:cast(?wxToolBar_SetToolBitmapSize, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setToolLongHelp(This, Toolid, HelpString) -> ok when This::wxToolBar(), Toolid::integer(), HelpString::unicode:chardata(). setToolLongHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid,HelpString) @@ -610,7 +610,7 @@ setToolLongHelp(#wx_ref{type=ThisT,ref=ThisRef},Toolid,HelpString) wxe_util:cast(?wxToolBar_SetToolLongHelp, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setToolPacking(This, Packing) -> ok when This::wxToolBar(), Packing::integer(). setToolPacking(#wx_ref{type=ThisT,ref=ThisRef},Packing) @@ -619,7 +619,7 @@ setToolPacking(#wx_ref{type=ThisT,ref=ThisRef},Packing) wxe_util:cast(?wxToolBar_SetToolPacking, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setToolShortHelp(This, Id, HelpString) -> ok when This::wxToolBar(), Id::integer(), HelpString::unicode:chardata(). setToolShortHelp(#wx_ref{type=ThisT,ref=ThisRef},Id,HelpString) @@ -629,7 +629,7 @@ setToolShortHelp(#wx_ref{type=ThisT,ref=ThisRef},Id,HelpString) wxe_util:cast(?wxToolBar_SetToolShortHelp, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setToolSeparation(This, Separation) -> ok when This::wxToolBar(), Separation::integer(). setToolSeparation(#wx_ref{type=ThisT,ref=ThisRef},Separation) @@ -638,7 +638,7 @@ setToolSeparation(#wx_ref{type=ThisT,ref=ThisRef},Separation) wxe_util:cast(?wxToolBar_SetToolSeparation, <>). -%% @doc See external documentation. +%% @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) -- cgit v1.2.3