GUIComponent

From Virtual World Web Wiki
Jump to: navigation, search

This is the base class for all GUI components. More

  • Inherits class: GUIContainer
  • This is a JavaScript visible object

Remarks [edit]

Properties

bool AllowDrag {get; set;}
Can you drag this component?
bool AllowDrop {get; set;}
Can this component accept drops?
string ContextTag {get; set;}
Setting a ContextTag causes this component to trigger a context menu when right-clicked. The ContextTag can then be checked in the OnPrepareMenu event.
DragItemExtended DragItem {get;}
Details related to this item's drag capabilities
DropTargetExtended DropTarget {get;}
Details about this component's drop-accepting abilities
bool Enabled {get; set;}
Is this component enabled for interaction
bool FitHorizontal {get; set;}
Should this component adjust its horizontal size to accomodate its content? Note: Content does not include Children unless this component also has a LayoutGroup
bool FitVertical {get; set;}
Should this component adjust its vertical size to accomodate its content? Note: Content does not include Children unless this component also has a LayoutGroup
bool IgnoreLayout {get; set;}
Do not apply a parent LayoutGroup to this Component
string Name {get; set;}
GUIContainer Parent {get; set;}
Changes the parent within the hierarchy
ScrollHandlerExtended ScrollHandler {get;}
int SiblingIndex {get; set;}
What is this component's index within its parents children list
string ToolTip {get; set;}
Text to display when mousing over the component
ResourceValue ToolTipCursor {get; set;}
Cursor to display when mousing over the component
bool ToolTipCursorMiddle {get; set;}
When using a custom cursor, should the cursor be centered (like a crosshair?)
ResourceValue ToolTipImage {get; set;}
Image to display when mousing over the component
string ToolTipTitle {get; set;}
Title text to display when mousing over the component
bool Visible {get; set;}
GUIBaseWindow Window {get; set;}
Which window is this component part of?

Events

OnMouseEnter()
OnMouseExit()

Methods

GUIComponent Clone(GUIContainer parent = NULL)
Duplicates this component, optionally under a new parent
void DropFocus()
void MoveToScreen()