Edit object

The Edit widget provides rich text input and formatting capabilities

Event Description
Edit:onCaret() Event fired when the Edit cursor position changed
Edit:onChange() Event fired when Edit content has been modified
Edit:onClick() Event occurs when the user clicks on the Edit
Edit:onCreate() Event fired when Edit has just been created
Edit:onDrop() Event fired when the Edit received a drag and drop content
Edit:onHide() Event fired when the Edit is hidden
Edit:onMouseDown() Event fired when the user presses a mouse button over the Edit
Edit:onMouseUp() Event fired when the user releases a mouse button over the Edit
Edit:onSelect() Event fired when the user has made a selection in the Edit
Edit:onShow() Event fired when the Edit is shown
Property Description Access Type
Edit.align Align the Edit relative to its parent readwrite boolean
Edit.allowdrop Controls whether the Edit is a drag and drop target readwrite boolean
Edit.bgcolor Get/set the global Edit background color readwrite number
Edit.border Controls whether the Edit border is visible readwrite boolean
Edit.canredo Get wether the user can redo the last Edit operation readonly boolean
Edit.canundo Get wether the user can undo the last Edit operation readonly boolean
Edit.caret Get/set the Edit's caret position readwrite number
Edit.cursor Get/set the image of the mouse cursor as it hovers over the Edit readwrite string
Edit.enabled Controls whether the Edit responds to mouse and other events readwrite boolean
Edit.fgcolor Get/set the global Edit text color readwrite number
Edit.font Get/set the Edit font readwrite string
Edit.fontsize Get/set the Edit font size readwrite number
Edit.fontstyle Get/set the Edit font style readwrite table
Edit.height Get/set the Edit's height readwrite number
Edit.line Get/set the Edit current line position readwrite number
Edit.lines Get/set the lines of text in the Edit readonly table
Edit.modified Get/set wether the Edit content has been modified readwrite boolean
Edit.mousepos Get the nearest character position from the mouse coordinates readonly number
Edit.parent Get the Edit's parent widget readonly
Edit.readonly Get/set Edit readonly mode readwrite boolean
Edit.richtext Get/set the Edit text content using Rich Text Format readwrite boolean
Edit.rtf Get/set Rich Text Formatting readwrite boolean
Edit.selection Get current Edit selection readonly table
Edit.text Get/set the Edit text content readwrite string
Edit.textlength Get Edit content's length in characters readonly number
Edit.textlimit Get/set maximum character limit readwrite number
Edit.tooltip Get/set the Edit tooltip text readwrite string
Edit.visible Controls whether the Edit appears on screen readwrite boolean
Edit.width Get/set the Edit's width readwrite number
Edit.wordwrap Get/set the Edit wordwrap mode readwrite boolean
Edit.x Get/set the Edit's horizontal position readwrite number
Edit.y Get/set the Edit's vertical position readwrite number
Methods Description Return value
Edit:append() Append text to Edit content -
Edit:center() Centers the Edit on the parent widget -
Edit:constructor() Edit object constructor
Edit:copy() Copies the text to the clipboard -
Edit:cut() Cuts the text to the clipboard -
Edit:hide() Hides the Edit -
Edit:hscroll() Scrolls the text horizontally -
Edit:load() Load Edit text from file boolean
Edit:paste() Pastes the text from the clipboard -
Edit:redo() Redoes the last edit operation -
Edit:save() Save Edit content to file boolean
Edit:searchdown() Search down text withins the Edit content number, number nil
Edit:searchup() Search up text withins the Edit content number, number nil
Edit:show() Shows the Edit -
Edit:toback() Puts the widget to the back -
Edit:tofront() Brings the widget in front -
Edit:undo() Undoes the last edit operation -
Edit:vscroll() Scrolls the text vertically -