Skip to content

XUICEUndoableInsertLine

Implements XUIUndoableAction

Description

Stores the data required to undo / redo the insertion of a line within the XUICodeEditor.

Properties

Name Type Read-Only
mCaretPos Integer
mContents String
mDescription String
mEditor XUICodeEditor
mID Integer
mLineNumber Integer

Methods

Name Parameters Returns
Constructor editor As XUICodeEditor, id As Integer, description As String, lineNumber As Integer, caretPos As Integer, contents As String
Description String
ID Integer
ID Assigns value As Integer
Redo
Undo

Property Descriptions

mCaretPos As Integer

The caret position that the new line insertion occurred at.

mContents As String

The contents of the newly inserted line.

mDescription As String

A description of this action.

mEditor As XUICodeEditor

The editor where the new line insertion occurred.

mID As Integer

Internal cache of this action's ID.

mLineNumber As Integer

The 1-based line number that the new line was inserted at.

Method Descriptions

Constructor(editor As XUICodeEditor, id As Integer, description As String, lineNumber As Integer, caretPos As Integer, contents As String)

Default constructor.

  • editor is the XUICodeEditor to perform this action on.
  • id is the unique ID for this action.
  • description is a human-radable description of this action for displaying in menubars and contextual menus.
  • lineNumber is the 1-based line number that the new line was inserted at.
  • caretPos is the caret position that the new line insertion occurred at.
  • contents is the contents of the newly inserted line.

Description() As String

A description of this undoable action.

Part of the XUIUndoableAction interface.

ID() As Integer

This action's unique ID.

Part of the XUIUndoableAction interface.

ID(Assigns value As Integer)

This action's unique ID.

Part of the XUIUndoableAction interface.

Redo()

Redo the insertion of a line at the specified line number.

Part of the XUIUndoableAction interface.

Undo()

Undo the insertion of a line at the specified line number.

Part of the XUIUndoableAction interface.