wxTextCtrl(3)

NAME
wxTextCtrl - See external documentation: wxTextCtrl.

DESCRIPTION

See external documentation: wxTextCtrl.

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.

new(Parent, Id) -> wxTextCtrl()

    Types:
        Parent = wxWindow() (see module wxWindow)
        Id = integer()

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

new(Parent, Id, Options::[Option]) -> wxTextCtrl()

    Types:
        Parent = wxWindow() (see module wxWindow)
        Id = integer()
        Option = {value, chardata() (see module unicode)} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx_object() (see module wx)}

    See external documentation.

appendText(This, Text) -> ok

    Types:
        This = wxTextCtrl()
        Text = chardata() (see module unicode)

    See external documentation.

canCopy(This) -> boolean()

    Types:
        This = wxTextCtrl()

    See external documentation.

canCut(This) -> boolean()

    Types:
        This = wxTextCtrl()

    See external documentation.

canPaste(This) -> boolean()

    Types:
        This = wxTextCtrl()

    See external documentation.

canRedo(This) -> boolean()

    Types:
        This = wxTextCtrl()

    See external documentation.

canUndo(This) -> boolean()

    Types:
        This = wxTextCtrl()

    See external documentation.

clear(This) -> ok

    Types:
        This = wxTextCtrl()

    See external documentation.

copy(This) -> ok

    Types:
        This = wxTextCtrl()

    See external documentation.

create(This, Parent, Id) -> boolean()

    Types:
        This = wxTextCtrl()
        Parent = wxWindow() (see module wxWindow)
        Id = integer()

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

create(This, Parent, Id, Options::[Option]) -> boolean()

    Types:
        This = wxTextCtrl()
        Parent = wxWindow() (see module wxWindow)
        Id = integer()
        Option = {value, chardata() (see module unicode)} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx_object() (see module wx)}

    See external documentation.

cut(This) -> ok

    Types:
        This = wxTextCtrl()

    See external documentation.

discardEdits(This) -> ok

    Types:
        This = wxTextCtrl()

    See external documentation.

changeValue(This, Value) -> ok

    Types:
        This = wxTextCtrl()
        Value = chardata() (see module unicode)

    See external documentation.

emulateKeyPress(This, Event) -> boolean()

    Types:
        This = wxTextCtrl()
        Event = wxKeyEvent() (see module wxKeyEvent)

    See external documentation.

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

    Types:
        This = wxTextCtrl()

    See external documentation.

getInsertionPoint(This) -> integer()

    Types:
        This = wxTextCtrl()

    See external documentation.

getLastPosition(This) -> integer()

    Types:
        This = wxTextCtrl()

    See external documentation.

getLineLength(This, LineNo) -> integer()

    Types:
        This = wxTextCtrl()
        LineNo = integer()

    See external documentation.

getLineText(This, LineNo) -> charlist() (see module unicode)

    Types:
        This = wxTextCtrl()
        LineNo = integer()

    See external documentation.

getNumberOfLines(This) -> integer()

    Types:
        This = wxTextCtrl()

    See external documentation.

getRange(This, From, To) -> charlist() (see module unicode)

    Types:
        This = wxTextCtrl()
        From = integer()
        To = integer()

    See external documentation.

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

    Types:
        This = wxTextCtrl()

    See external documentation.

getStringSelection(This) -> charlist() (see module unicode)

    Types:
        This = wxTextCtrl()

    See external documentation.

getStyle(This, Position, Style) -> boolean()

    Types:
        This = wxTextCtrl()
        Position = integer()
        Style = wxTextAttr() (see module wxTextAttr)

    See external documentation.

getValue(This) -> charlist() (see module unicode)

    Types:
        This = wxTextCtrl()

    See external documentation.

isEditable(This) -> boolean()

    Types:
        This = wxTextCtrl()

    See external documentation.

isModified(This) -> boolean()

    Types:
        This = wxTextCtrl()

    See external documentation.

isMultiLine(This) -> boolean()

    Types:
        This = wxTextCtrl()

    See external documentation.

isSingleLine(This) -> boolean()

    Types:
        This = wxTextCtrl()

    See external documentation.

loadFile(This, File) -> boolean()

    Types:
        This = wxTextCtrl()
        File = chardata() (see module unicode)

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

loadFile(This, File, Options::[Option]) -> boolean()

    Types:
        This = wxTextCtrl()
        File = chardata() (see module unicode)
        Option = {fileType, integer()}

    See external documentation.

markDirty(This) -> ok

    Types:
        This = wxTextCtrl()

    See external documentation.

paste(This) -> ok

    Types:
        This = wxTextCtrl()

    See external documentation.

positionToXY(This, Pos) -> Result

    Types:
        Result = {Res::boolean(), X::integer(), Y::integer()}
        This = wxTextCtrl()
        Pos = integer()

    See external documentation.

redo(This) -> ok

    Types:
        This = wxTextCtrl()

    See external documentation.

remove(This, From, To) -> ok

    Types:
        This = wxTextCtrl()
        From = integer()
        To = integer()

    See external documentation.

replace(This, From, To, Value) -> ok

    Types:
        This = wxTextCtrl()
        From = integer()
        To = integer()
        Value = chardata() (see module unicode)

    See external documentation.

saveFile(This) -> boolean()

    Types:
        This = wxTextCtrl()

    Equivalent to saveFile(This, []).

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

    Types:
        This = wxTextCtrl()
        Option = {file, chardata() (see module unicode)} | {fileType, integer()}

    See external documentation.

setDefaultStyle(This, Style) -> boolean()

    Types:
        This = wxTextCtrl()
        Style = wxTextAttr() (see module wxTextAttr)

    See external documentation.

setEditable(This, Editable) -> ok

    Types:
        This = wxTextCtrl()
        Editable = boolean()

    See external documentation.

setInsertionPoint(This, Pos) -> ok

    Types:
        This = wxTextCtrl()
        Pos = integer()

    See external documentation.

setInsertionPointEnd(This) -> ok

    Types:
        This = wxTextCtrl()

    See external documentation.

setMaxLength(This, Len) -> ok

    Types:
        This = wxTextCtrl()
        Len = integer()

    See external documentation.

setSelection(This, From, To) -> ok

    Types:
        This = wxTextCtrl()
        From = integer()
        To = integer()

    See external documentation.

setStyle(This, Start, End, Style) -> boolean()

    Types:
        This = wxTextCtrl()
        Start = integer()
        End = integer()
        Style = wxTextAttr() (see module wxTextAttr)

    See external documentation.

setValue(This, Value) -> ok

    Types:
        This = wxTextCtrl()
        Value = chardata() (see module unicode)

    See external documentation.

showPosition(This, Pos) -> ok

    Types:
        This = wxTextCtrl()
        Pos = integer()

    See external documentation.

undo(This) -> ok

    Types:
        This = wxTextCtrl()

    See external documentation.

writeText(This, Text) -> ok

    Types:
        This = wxTextCtrl()
        Text = chardata() (see module unicode)

    See external documentation.

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

    Types:
        This = wxTextCtrl()
        X = integer()
        Y = integer()

    See external documentation.

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

    Destroys this object, do not use object again

AUTHORS

<>