Libraries.Interface.Events.GutterEvent Documentation

Inherits from: Libraries.Language.Object

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)

GetControl()

Return

Libraries.Interface.Controls.ScrollableLineControl

GetGutter()

The Set action is used to set all of the values of this GutterEvent. This is primarily used for initialization. Most programmers using GutterEvents won't need to call this action directly.

Return

Libraries.Interface.Controls.Gutter:

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()

GetLine()

Return

integer

GetMouseEvent()

Return

Libraries.Interface.Events.MouseEvent

Set(Libraries.Interface.Controls.Gutter gutter, integer line, Libraries.Interface.Events.MouseEvent event)

The Set action is used to set all of the values of this GutterEvent. This is primarily used for initialization. Most programmers using GutterEvents won't need to call this action directly.

Parameters