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/wxTextCtrl.erl | 102 +++++++++++++++++++++--------------------- 1 file changed, 51 insertions(+), 51 deletions(-) (limited to 'lib/wx/src/gen/wxTextCtrl.erl') diff --git a/lib/wx/src/gen/wxTextCtrl.erl b/lib/wx/src/gen/wxTextCtrl.erl index e1f82c40c3..cb85652ceb 100644 --- a/lib/wx/src/gen/wxTextCtrl.erl +++ b/lib/wx/src/gen/wxTextCtrl.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: wxTextCtrl. +%% @doc See external documentation: wxTextCtrl. %%

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 wxTextCtrl() :: wx:wx_object(). -%% @doc See external documentation. +%% @doc See external documentation. -spec new() -> wxTextCtrl(). new() -> wxe_util:construct(?wxTextCtrl_new_0, @@ -99,7 +99,7 @@ new(Parent,Id) when is_record(Parent, wx_ref),is_integer(Id) -> new(Parent,Id, []). -%% @doc See external documentation. +%% @doc See external documentation. -spec new(Parent, Id, [Option]) -> wxTextCtrl() when Parent::wxWindow:wxWindow(), Id::integer(), Option :: {value, unicode:chardata()} @@ -120,7 +120,7 @@ new(#wx_ref{type=ParentT,ref=ParentRef},Id, Options) wxe_util:construct(?wxTextCtrl_new_3, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec appendText(This, Text) -> ok when This::wxTextCtrl(), Text::unicode:chardata(). appendText(#wx_ref{type=ThisT,ref=ThisRef},Text) @@ -130,7 +130,7 @@ appendText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxTextCtrl_AppendText, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec canCopy(This) -> boolean() when This::wxTextCtrl(). canCopy(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -138,7 +138,7 @@ canCopy(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_CanCopy, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec canCut(This) -> boolean() when This::wxTextCtrl(). canCut(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -146,7 +146,7 @@ canCut(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_CanCut, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec canPaste(This) -> boolean() when This::wxTextCtrl(). canPaste(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -154,7 +154,7 @@ canPaste(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_CanPaste, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec canRedo(This) -> boolean() when This::wxTextCtrl(). canRedo(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -162,7 +162,7 @@ canRedo(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_CanRedo, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec canUndo(This) -> boolean() when This::wxTextCtrl(). canUndo(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -170,7 +170,7 @@ canUndo(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_CanUndo, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec clear(This) -> ok when This::wxTextCtrl(). clear(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -178,7 +178,7 @@ clear(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxTextCtrl_Clear, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec copy(This) -> ok when This::wxTextCtrl(). copy(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -194,7 +194,7 @@ create(This,Parent,Id) when is_record(This, wx_ref),is_record(Parent, wx_ref),is_integer(Id) -> create(This,Parent,Id, []). -%% @doc See external documentation. +%% @doc See external documentation. -spec create(This, Parent, Id, [Option]) -> boolean() when This::wxTextCtrl(), Parent::wxWindow:wxWindow(), Id::integer(), Option :: {value, unicode:chardata()} @@ -216,7 +216,7 @@ create(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=ParentT,ref=ParentRef},Id, O wxe_util:call(?wxTextCtrl_Create, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec cut(This) -> ok when This::wxTextCtrl(). cut(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -224,7 +224,7 @@ cut(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxTextCtrl_Cut, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec discardEdits(This) -> ok when This::wxTextCtrl(). discardEdits(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -232,7 +232,7 @@ discardEdits(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxTextCtrl_DiscardEdits, <>). -%% @doc See external documentation. +%% @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}) -> @@ -241,7 +241,7 @@ emulateKeyPress(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=EventT,ref=EventRef wxe_util:call(?wxTextCtrl_EmulateKeyPress, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getDefaultStyle(This) -> wxTextAttr:wxTextAttr() when This::wxTextCtrl(). getDefaultStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -249,7 +249,7 @@ getDefaultStyle(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_GetDefaultStyle, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getInsertionPoint(This) -> integer() when This::wxTextCtrl(). getInsertionPoint(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -257,7 +257,7 @@ getInsertionPoint(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_GetInsertionPoint, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getLastPosition(This) -> integer() when This::wxTextCtrl(). getLastPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -265,7 +265,7 @@ getLastPosition(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_GetLastPosition, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getLineLength(This, LineNo) -> integer() when This::wxTextCtrl(), LineNo::integer(). getLineLength(#wx_ref{type=ThisT,ref=ThisRef},LineNo) @@ -274,7 +274,7 @@ getLineLength(#wx_ref{type=ThisT,ref=ThisRef},LineNo) wxe_util:call(?wxTextCtrl_GetLineLength, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getLineText(This, LineNo) -> unicode:charlist() when This::wxTextCtrl(), LineNo::integer(). getLineText(#wx_ref{type=ThisT,ref=ThisRef},LineNo) @@ -283,7 +283,7 @@ getLineText(#wx_ref{type=ThisT,ref=ThisRef},LineNo) wxe_util:call(?wxTextCtrl_GetLineText, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getNumberOfLines(This) -> integer() when This::wxTextCtrl(). getNumberOfLines(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -291,7 +291,7 @@ getNumberOfLines(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_GetNumberOfLines, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getRange(This, From, To) -> unicode:charlist() when This::wxTextCtrl(), From::integer(), To::integer(). getRange(#wx_ref{type=ThisT,ref=ThisRef},From,To) @@ -300,7 +300,7 @@ getRange(#wx_ref{type=ThisT,ref=ThisRef},From,To) wxe_util:call(?wxTextCtrl_GetRange, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getSelection(This) -> {From::integer(), To::integer()} when This::wxTextCtrl(). getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -308,7 +308,7 @@ getSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_GetSelection, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getStringSelection(This) -> unicode:charlist() when This::wxTextCtrl(). getStringSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -316,7 +316,7 @@ getStringSelection(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_GetStringSelection, <>). -%% @doc See external documentation. +%% @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}) @@ -326,7 +326,7 @@ getStyle(#wx_ref{type=ThisT,ref=ThisRef},Position,#wx_ref{type=StyleT,ref=StyleR wxe_util:call(?wxTextCtrl_GetStyle, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec getValue(This) -> unicode:charlist() when This::wxTextCtrl(). getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -334,7 +334,7 @@ getValue(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_GetValue, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec isEditable(This) -> boolean() when This::wxTextCtrl(). isEditable(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -342,7 +342,7 @@ isEditable(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_IsEditable, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec isModified(This) -> boolean() when This::wxTextCtrl(). isModified(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -350,7 +350,7 @@ isModified(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_IsModified, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec isMultiLine(This) -> boolean() when This::wxTextCtrl(). isMultiLine(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -358,7 +358,7 @@ isMultiLine(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:call(?wxTextCtrl_IsMultiLine, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec isSingleLine(This) -> boolean() when This::wxTextCtrl(). isSingleLine(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -374,7 +374,7 @@ loadFile(This,File) when is_record(This, wx_ref),is_list(File) -> loadFile(This,File, []). -%% @doc See external documentation. +%% @doc See external documentation. -spec loadFile(This, File, [Option]) -> boolean() when This::wxTextCtrl(), File::unicode:chardata(), Option :: {fileType, integer()}. @@ -388,7 +388,7 @@ loadFile(#wx_ref{type=ThisT,ref=ThisRef},File, Options) wxe_util:call(?wxTextCtrl_LoadFile, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec markDirty(This) -> ok when This::wxTextCtrl(). markDirty(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -396,7 +396,7 @@ markDirty(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxTextCtrl_MarkDirty, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec paste(This) -> ok when This::wxTextCtrl(). paste(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -404,7 +404,7 @@ paste(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxTextCtrl_Paste, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec positionToXY(This, Pos) -> Result when Result ::{Res ::boolean(), X::integer(), Y::integer()}, This::wxTextCtrl(), Pos::integer(). @@ -414,7 +414,7 @@ positionToXY(#wx_ref{type=ThisT,ref=ThisRef},Pos) wxe_util:call(?wxTextCtrl_PositionToXY, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec redo(This) -> ok when This::wxTextCtrl(). redo(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -422,7 +422,7 @@ redo(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxTextCtrl_Redo, <>). -%% @doc See external documentation. +%% @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) @@ -431,7 +431,7 @@ remove(#wx_ref{type=ThisT,ref=ThisRef},From,To) wxe_util:cast(?wxTextCtrl_Remove, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec replace(This, From, To, Value) -> ok when This::wxTextCtrl(), From::integer(), To::integer(), Value::unicode:chardata(). replace(#wx_ref{type=ThisT,ref=ThisRef},From,To,Value) @@ -449,7 +449,7 @@ saveFile(This) when is_record(This, wx_ref) -> saveFile(This, []). -%% @doc See external documentation. +%% @doc See external documentation. -spec saveFile(This, [Option]) -> boolean() when This::wxTextCtrl(), Option :: {file, unicode:chardata()} @@ -464,7 +464,7 @@ saveFile(#wx_ref{type=ThisT,ref=ThisRef}, Options) wxe_util:call(?wxTextCtrl_SaveFile, <>). -%% @doc See external documentation. +%% @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}) -> @@ -473,7 +473,7 @@ setDefaultStyle(#wx_ref{type=ThisT,ref=ThisRef},#wx_ref{type=StyleT,ref=StyleRef wxe_util:call(?wxTextCtrl_SetDefaultStyle, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setEditable(This, Editable) -> ok when This::wxTextCtrl(), Editable::boolean(). setEditable(#wx_ref{type=ThisT,ref=ThisRef},Editable) @@ -482,7 +482,7 @@ setEditable(#wx_ref{type=ThisT,ref=ThisRef},Editable) wxe_util:cast(?wxTextCtrl_SetEditable, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setInsertionPoint(This, Pos) -> ok when This::wxTextCtrl(), Pos::integer(). setInsertionPoint(#wx_ref{type=ThisT,ref=ThisRef},Pos) @@ -491,7 +491,7 @@ setInsertionPoint(#wx_ref{type=ThisT,ref=ThisRef},Pos) wxe_util:cast(?wxTextCtrl_SetInsertionPoint, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setInsertionPointEnd(This) -> ok when This::wxTextCtrl(). setInsertionPointEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -499,7 +499,7 @@ setInsertionPointEnd(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxTextCtrl_SetInsertionPointEnd, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setMaxLength(This, Len) -> ok when This::wxTextCtrl(), Len::integer(). setMaxLength(#wx_ref{type=ThisT,ref=ThisRef},Len) @@ -508,7 +508,7 @@ setMaxLength(#wx_ref{type=ThisT,ref=ThisRef},Len) wxe_util:cast(?wxTextCtrl_SetMaxLength, <>). -%% @doc See external documentation. +%% @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) @@ -517,7 +517,7 @@ setSelection(#wx_ref{type=ThisT,ref=ThisRef},From,To) wxe_util:cast(?wxTextCtrl_SetSelection, <>). -%% @doc See external documentation. +%% @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}) @@ -527,7 +527,7 @@ setStyle(#wx_ref{type=ThisT,ref=ThisRef},Start,End,#wx_ref{type=StyleT,ref=Style wxe_util:call(?wxTextCtrl_SetStyle, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec setValue(This, Value) -> ok when This::wxTextCtrl(), Value::unicode:chardata(). setValue(#wx_ref{type=ThisT,ref=ThisRef},Value) @@ -537,7 +537,7 @@ setValue(#wx_ref{type=ThisT,ref=ThisRef},Value) wxe_util:cast(?wxTextCtrl_SetValue, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec showPosition(This, Pos) -> ok when This::wxTextCtrl(), Pos::integer(). showPosition(#wx_ref{type=ThisT,ref=ThisRef},Pos) @@ -546,7 +546,7 @@ showPosition(#wx_ref{type=ThisT,ref=ThisRef},Pos) wxe_util:cast(?wxTextCtrl_ShowPosition, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec undo(This) -> ok when This::wxTextCtrl(). undo(#wx_ref{type=ThisT,ref=ThisRef}) -> @@ -554,7 +554,7 @@ undo(#wx_ref{type=ThisT,ref=ThisRef}) -> wxe_util:cast(?wxTextCtrl_Undo, <>). -%% @doc See external documentation. +%% @doc See external documentation. -spec writeText(This, Text) -> ok when This::wxTextCtrl(), Text::unicode:chardata(). writeText(#wx_ref{type=ThisT,ref=ThisRef},Text) @@ -564,7 +564,7 @@ writeText(#wx_ref{type=ThisT,ref=ThisRef},Text) wxe_util:cast(?wxTextCtrl_WriteText, <>). -%% @doc See external documentation. +%% @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) -- cgit v1.2.3