Libraries.Interface.Views.MenuItemView Documentation

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

Summary

Actions Summary Table

ActionsDescription
BeginMouseOver()
ClickedMouse()
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Copy()
Draw(Libraries.Game.Graphics.Painter2D painter)
EnableMenuArrow(boolean enable)
EndMouseOver()
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GainedSelection()
GetHashCode()This action gets the hash code for an object.
GetIconWidth()
GetItem()
GetNameWidth()
GetShortcut()
GetShortcutWidth()
GetSubmenuIconWidth()
GetText()
GetViewHeight()
GetViewWidth()
Initialize(text name)
Initialize(text name, text shortcut)
LostSelection()
PadWidth(number iconWidth, number nameWidth, number shortcutWidth, number submenuIconWidth)
QueueForDrawing(Libraries.Game.Graphics.Painter2D painter)
ReleasedMouse()
SetItem(Libraries.Interface.Item2D item)
SetShortcut(text shortcut)
SetText(text value)
UpdateFlipping(boolean flipX, boolean flipY)
UpdatePosition(number x, number y, number z)
UpdateRotation(number angle)
UpdateSize(number width, number height)

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.

Example Code

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

Parameters

Return

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

Copy()

Return

Libraries.Interface.Views.ControlView

Draw(Libraries.Game.Graphics.Painter2D painter)

Parameters

EnableMenuArrow(boolean enable)

Parameters

EndMouseOver()

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

Return

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

GainedSelection()

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.

GetIconWidth()

Return

number

GetItem()

Return

Libraries.Interface.Item2D

GetNameWidth()

Return

number

GetShortcut()

Return

text

GetShortcutWidth()

Return

number

GetSubmenuIconWidth()

Return

number

GetText()

Return

text

GetViewHeight()

Return

number

GetViewWidth()

Return

number

Initialize(text name)

Parameters

Initialize(text name, text shortcut)

Parameters

LostSelection()

PadWidth(number iconWidth, number nameWidth, number shortcutWidth, number submenuIconWidth)

Parameters

QueueForDrawing(Libraries.Game.Graphics.Painter2D painter)

Parameters

ReleasedMouse()

SetItem(Libraries.Interface.Item2D item)

Parameters

SetShortcut(text shortcut)

Parameters

SetText(text value)

Parameters

UpdateFlipping(boolean flipX, boolean flipY)

Parameters

UpdatePosition(number x, number y, number z)

Parameters

UpdateRotation(number angle)

Parameters

UpdateSize(number width, number height)

Parameters