Libraries.Interface.Views.ToggleView Documentation

Inherits from: Libraries.Language.Object, Libraries.Interface.Views.View2D, Libraries.Interface.Views.ControlView

Actions Documentation

BeginMouseOver()

ClickedMouse()

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)

Draw(Libraries.Game.Graphics.Painter2D painter)

EndMouseOver()

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)

GainedFocus()

GainedSelection()

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

GetText()

Return

text

GetToggleState()

Return

boolean

LostFocus()

LostSelection()

QueueForDrawing(Libraries.Game.Graphics.Painter2D painter)

ReleasedMouse()

SetItem(Libraries.Interface.Item2D item)

SetText(text value)

Parameters

  • text value

SetToggleState(boolean open)

Parameters

  • boolean open

UpdateFlipping(boolean flipX, boolean flipY)

Parameters

  • boolean flipX
  • boolean flipY

UpdatePosition(number x, number y, number z)

Parameters

  • number x
  • number y
  • number z

UpdateRotation(number angle)

Parameters

  • number angle

UpdateSize(number width, number height)

Parameters

  • number width
  • number height