Libraries.Interface.Events.BlockChangeEvent Documentation

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
integer TEXT_CHANGE
integer ADDED
integer DELETED
integer MODIFIED

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetAddedText()

Returns the BlockEditor where the event happened

Return

text: The block editor

GetBlock()

Returns the item that was added or removed

Return

Libraries.Interface.Controls.Blocks.Block: The item that was added or removed

GetBlockEditor()

Returns the BlockEditor where the event happened

Return

Libraries.Interface.Controls.Blocks.CodeEditor: The block editor

GetBlockIndex()

Returns the event type. If 1 the item was added, if 2 the item was removed.

Return

integer: The event type

GetCharacterIndex()

Returns the parent of the item that triggered the event

Return

integer: The parent item

GetDeletedText()

Return

text

GetEventType()

Returns the event type. If 1 the item was added, if 2 the item was removed.

Return

integer: The event type

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetNewCode()

Return

Libraries.Containers.MultipleLineText

GetOldCode()

Return

Libraries.Containers.MultipleLineText

GetParentBlock()

Returns the parent of the item that triggered the event

Return

Libraries.Interface.Controls.Blocks.Block: The parent item

GetPreserveChildren()

Return

boolean

Set(Libraries.Interface.Controls.Blocks.CodeEditor editor, integer characterIndex, integer blockIndex, Libraries.Interface.Controls.Blocks.Block block, Libraries.Interface.Controls.Blocks.Block parentBlock, text added, text deleted, integer eventType)

The Set action sets all the fields of the event. When creating a new event this action is called so the object contains all the information needed for the listeners to react to it.

Parameters

Set(Libraries.Interface.Controls.Blocks.CodeEditor editor, Libraries.Containers.MultipleLineText oldText, Libraries.Containers.MultipleLineText newText)

The Set action sets all the fields of the event. When creating a new event this action is called so the object contains all the information needed for the listeners to react to it.

Parameters

SetAddedText(text added)

Returns the item that was added or removed

Parameters

  • text added

SetDeletedText(text deleted)

Parameters

  • text deleted

SetPreserveChildren(boolean deleteContents)

Parameters

  • boolean deleteContents