Libraries.Interface.Events.GutterEvent Documentation
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |
GetGutter() | The Set action is used to set all of the values of this GutterEvent. |
GetHashCode() | This action gets the hash code for an object. |
GetLine() | |
GetMouseEvent() | |
GetTextBox() | |
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. |
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.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Example Code
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
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.
Example Code
Object o
integer hash = o:GetHashCode()
Return
integer: The integer hash code of the object.
GetLine()
Return
integer
GetMouseEvent()
Return
Libraries.Interface.Events.MouseEvent
GetTextBox()
Return
Libraries.Interface.Controls.TextBox
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
- Libraries.Interface.Controls.Gutter: The Gutter that triggered this GutterEvent.
- integer line: Which line of the gutter was interacted with.
- Libraries.Interface.Events.MouseEvent: A MouseEvent describing how the Gutter was clicked, or undefined if it was not clicked.