wxTextCtrl(3)

MODULE
wxTextCtrl - See external documentation: wxTextCtrl.

DESCRIPTION

See external documentation: wxTextCtrl <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html>.

This class is derived (and can use functions) from:
wxControl
wxWindow
wxEvtHandler

DATA TYPES

    wxTextCtrl():

        An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

new() -> wxTextCtrl()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlwxtextctrl>.

new(Parent::wxWindow() (see module wxWindow), Id::integer()) -> wxTextCtrl()

    Equivalent to new(Parent, Id, []).

new(Parent::wxWindow() (see module wxWindow), Id::integer(), Options::[Option]) -> wxTextCtrl()

    Types
        Option = {value, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx() (see module wx)}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlwxtextctrl>.

appendText(This::wxTextCtrl(), Text::string()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlappendtext>.

canCopy(This::wxTextCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlcancopy>.

canCut(This::wxTextCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlcancut>.

canPaste(This::wxTextCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlcanpaste>.

canRedo(This::wxTextCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlcanredo>.

canUndo(This::wxTextCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlcanundo>.

clear(This::wxTextCtrl()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlclear>.

copy(This::wxTextCtrl()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlcopy>.

create(This::wxTextCtrl(), Parent::wxWindow() (see module wxWindow), Id::integer()) -> bool()

    Equivalent to create(This, Parent, Id, []).

create(This::wxTextCtrl(), Parent::wxWindow() (see module wxWindow), Id::integer(), Options::[Option]) -> bool()

    Types
        Option = {value, string()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx() (see module wx)}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlcreate>.

cut(This::wxTextCtrl()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlcut>.

discardEdits(This::wxTextCtrl()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrldiscardedits>.

emulateKeyPress(This::wxTextCtrl(), Event::wxKeyEvent() (see module wxKeyEvent)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlemulatekeypress>.

getDefaultStyle(This::wxTextCtrl()) -> wxTextAttr() (see module wxTextAttr)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetdefaultstyle>.

getInsertionPoint(This::wxTextCtrl()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetinsertionpoint>.

getLastPosition(This::wxTextCtrl()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetlastposition>.

getLineLength(This::wxTextCtrl(), LineNo::integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetlinelength>.

getLineText(This::wxTextCtrl(), LineNo::integer()) -> string()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetlinetext>.

getNumberOfLines(This::wxTextCtrl()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetnumberoflines>.

getRange(This::wxTextCtrl(), From::integer(), To::integer()) -> string()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetrange>.

getSelection(This::wxTextCtrl()) -> {From::integer(), To::integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetselection>.

getStringSelection(This::wxTextCtrl()) -> string()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetstringselection>.

getStyle(This::wxTextCtrl(), Position::integer(), Style::wxTextAttr() (see module wxTextAttr)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetstyle>.

getValue(This::wxTextCtrl()) -> string()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlgetvalue>.

isEditable(This::wxTextCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrliseditable>.

isModified(This::wxTextCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlismodified>.

isMultiLine(This::wxTextCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlismultiline>.

isSingleLine(This::wxTextCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlissingleline>.

loadFile(This::wxTextCtrl(), File::string()) -> bool()

    Equivalent to loadFile(This, File, []).

loadFile(This::wxTextCtrl(), File::string(), Options::[Option]) -> bool()

    Types
        Option = {fileType, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlloadfile>.

markDirty(This::wxTextCtrl()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlmarkdirty>.

paste(This::wxTextCtrl()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlpaste>.

positionToXY(This::wxTextCtrl(), Pos::integer()) -> {bool(), X::integer(), Y::integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlpositiontoxy>.

redo(This::wxTextCtrl()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlredo>.

remove(This::wxTextCtrl(), From::integer(), To::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlremove>.

replace(This::wxTextCtrl(), From::integer(), To::integer(), Value::string()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlreplace>.

saveFile(This::wxTextCtrl()) -> bool()

    Equivalent to saveFile(This, []).

saveFile(This::wxTextCtrl(), Options::[Option]) -> bool()

    Types
        Option = {file, string()} | {fileType, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlsavefile>.

setDefaultStyle(This::wxTextCtrl(), Style::wxTextAttr() (see module wxTextAttr)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlsetdefaultstyle>.

setEditable(This::wxTextCtrl(), Editable::bool()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlseteditable>.

setInsertionPoint(This::wxTextCtrl(), Pos::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlsetinsertionpoint>.

setInsertionPointEnd(This::wxTextCtrl()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlsetinsertionpointend>.

setMaxLength(This::wxTextCtrl(), Len::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlsetmaxlength>.

setSelection(This::wxTextCtrl(), From::integer(), To::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlsetselection>.

setStyle(This::wxTextCtrl(), Start::integer(), End::integer(), Style::wxTextAttr() (see module wxTextAttr)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlsetstyle>.

setValue(This::wxTextCtrl(), Value::string()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlsetvalue>.

showPosition(This::wxTextCtrl(), Pos::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlshowposition>.

undo(This::wxTextCtrl()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlundo>.

writeText(This::wxTextCtrl(), Text::string()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlwritetext>.

xYToPosition(This::wxTextCtrl(), X::integer(), Y::integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtextctrl.html#wxtextctrlxytoposition>.

destroy(This::wxTextCtrl()) -> ok

    Destroys this object, do not use object again