IUIObject Interface Reference

Inheritance diagram for IUIObject:

List of all members.

Public Member Functions
void	OnInput (POINTER_INFO ptr)
	This is where input handling code should go in any derived class.
void	SetInputDelegate (EZInputDelegate del)
	Sets the method to be called when input occurs (input is forwarded from OnInput()). NOTE: This will replace any and all delegates which have been set or added previously. If you are unsure if any delegates are already registered, use AddInputDelegate() instead, or RemoveInputDelegate() to unset a previously registered delegate. Only use this when you are sure you want to replace all previously registered delegates.
void	AddInputDelegate (EZInputDelegate del)
	Adds a method to be called when input occurs (input is forwarded from OnInput()).
void	RemoveInputDelegate (EZInputDelegate del)
	Removes a method added with AddInputDelegate().
void	SetValueChangedDelegate (EZValueChangedDelegate del)
	Sets the method to be called when the value of a control changes (such as a checkbox changing from false to true, or a slider being moved). NOTE: This will replace any and all delegates which have been set or added previously. If you are unsure if any delegates are already registered, use AddValueChangedDelegate() instead, or RemoveValueChangedDelegate() to unset a previously registered delegate. Only use this when you are sure you want to replace all previously registered delegates.
void	AddValueChangedDelegate (EZValueChangedDelegate del)
	Adds a method to be called when the value of a control changes (such as a checkbox changing from false to true, or a slider being moved).
void	RemoveValueChangedDelegate (EZValueChangedDelegate del)
	Removes a method added with AddValueChangedDelegate().
void	CancelDrag ()
	Cancels any pending drag and drop operation.
void	AddDragDropDelegate (EZDragDropDelegate del)
	Adds a delegate to be called with drag and drop notifications.
void	RemoveDragDropDelegate (EZDragDropDelegate del)
	Removes a delegate from the list of those to be called with drag and drop notifications.
void	SetDragDropDelegate (EZDragDropDelegate del)
	Sets the delegate to be called with drag and drop notifications. NOTE: This will replace any previously registered delegates.
Properties
bool	controlIsEnabled [get, set]
	Controls whether this control is in an enabled state or not. If it is not, input is not processed. This can also be used to cause a control to take on a "grayed out" appearance when disabled.
bool	DetargetOnDisable [get, set]
	When set to true, the control will instruct any pointers which have it as their target to de-target them. Use this if you are deactivating a control and want no input to go to it. It is strongly recommended NOT to use this feature on any control that appears in a scroll list, or else you may be unable to scroll past the edge of the list's viewable area.
object	Data [get, set]
	Holds "boxed" data for the control. This can be used to associate any object or value with the control for later reference and use.
bool	IsDraggable [get, set]
	Indicates whether the object can be dragged as part of a drag & drop operation.
LayerMask	DropMask [get, set]
	A mask which can be used to make the object only be "droppable" on objects in a certain layer. NOTE: This mask is combined with the camera's mask.
bool	IsDragging [get, set]
	Indicates whether the object is being dragged as part of a drag & drop operation. Setting this value to false while the object is being dragged will cause the drag and drop operation to be cancelled.
GameObject	DropTarget [get, set]
	The GameObject over which the object being dragged is hovering and will attempt to be dropped if it let go.
bool	DropHandled [get, set]
	In the context of a drag & drop operation, this indicates whether the drop action was handled. If this is not set to true in response to a Dropped message sent to OnEZDragDrop(), the drop will be considered to be unhandled and will result in a cancelled drop, causing the dragged object to return to its original position.
float	DragOffset [get, set]
	The distance an object being dragged and dropped should be offset toward the camera to ensure it hovers above other objects and controls in the scene.
EZAnimation.EASING_TYPE	CancelDragEasing [get, set]
	The type of easing to use to animate the object back to its starting position when a drag operation is cancelled.
float	CancelDragDuration [get, set]
	The duration of the easing animation when a drag and drop operation is cancelled.

---

Detailed Description

A generic interface for a UI element.

---

Member Function Documentation

void IEZDragDrop.AddDragDropDelegate

(

EZDragDropDelegate

del

)

[inherited]

Adds a delegate to be called with drag and drop notifications.

Parameters:

del

The delegate to add.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IUIObject.AddInputDelegate

(

EZInputDelegate

del

)

Adds a method to be called when input occurs (input is forwarded from OnInput()).

Parameters:

del

A method that conforms to the EZInputDelegate pattern.

Implemented in UIScrollList, UISlider, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IUIObject.AddValueChangedDelegate

(

EZValueChangedDelegate

del

)

Adds a method to be called when the value of a control changes (such as a checkbox changing from false to true, or a slider being moved).

Parameters:

del

A method that conforms to the EZValueChangedDelegate pattern.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IEZDragDrop.CancelDrag

(

)

[inherited]

Cancels any pending drag and drop operation.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IUIObject.OnInput

(

POINTER_INFO

ptr

)

This is where input handling code should go in any derived class.

Parameters:

ptr

POINTER_INFO struct that contains information on the pointer that caused the event, as well as the event that occurred.

Implemented in UIListItemContainer, UIScrollList, UIVirtualScreen, UIBistateInteractivePanel, UIInteractivePanel, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IEZDragDrop.RemoveDragDropDelegate

(

EZDragDropDelegate

del

)

[inherited]

Removes a delegate from the list of those to be called with drag and drop notifications.

Parameters:

del

The delegate to add.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IUIObject.RemoveInputDelegate

(

EZInputDelegate

del

)

Removes a method added with AddInputDelegate().

Parameters:

del

A method that conforms to the EZInputDelegate pattern.

Implemented in UIScrollList, UISlider, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IUIObject.RemoveValueChangedDelegate

(

EZValueChangedDelegate

del

)

Removes a method added with AddValueChangedDelegate().

Parameters:

del

A method that conforms to the EZValueChangedDelegate pattern.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IEZDragDrop.SetDragDropDelegate

(

EZDragDropDelegate

del

)

[inherited]

Sets the delegate to be called with drag and drop notifications. NOTE: This will replace any previously registered delegates.

Parameters:

del

The delegate to add.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IUIObject.SetInputDelegate

(

EZInputDelegate

del

)

Sets the method to be called when input occurs (input is forwarded from OnInput()). NOTE: This will replace any and all delegates which have been set or added previously. If you are unsure if any delegates are already registered, use AddInputDelegate() instead, or RemoveInputDelegate() to unset a previously registered delegate. Only use this when you are sure you want to replace all previously registered delegates.

Parameters:

del

A method that conforms to the EZInputDelegate pattern.

Implemented in UIScrollList, UISlider, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

void IUIObject.SetValueChangedDelegate

(

EZValueChangedDelegate

del

)

Sets the method to be called when the value of a control changes (such as a checkbox changing from false to true, or a slider being moved). NOTE: This will replace any and all delegates which have been set or added previously. If you are unsure if any delegates are already registered, use AddValueChangedDelegate() instead, or RemoveValueChangedDelegate() to unset a previously registered delegate. Only use this when you are sure you want to replace all previously registered delegates.

Parameters:

del

A method that conforms to the EZValueChangedDelegate pattern.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

---

Property Documentation

float IEZDragDrop.CancelDragDuration [get, set, inherited]

The duration of the easing animation when a drag and drop operation is cancelled.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

EZAnimation.EASING_TYPE IEZDragDrop.CancelDragEasing [get, set, inherited]

The type of easing to use to animate the object back to its starting position when a drag operation is cancelled.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

bool IUIObject.controlIsEnabled [get, set]

Controls whether this control is in an enabled state or not. If it is not, input is not processed. This can also be used to cause a control to take on a "grayed out" appearance when disabled.

Implemented in UIButton, UIButton3D, UIRadioBtn, UIRadioBtn3D, UIScrollList, UISlider, UIStateToggleBtn, UIStateToggleBtn3D, UITextField, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

object IEZDragDrop.Data [get, set, inherited]

Holds "boxed" data for the control. This can be used to associate any object or value with the control for later reference and use.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

bool IUIObject.DetargetOnDisable [get, set]

When set to true, the control will instruct any pointers which have it as their target to de-target them. Use this if you are deactivating a control and want no input to go to it. It is strongly recommended NOT to use this feature on any control that appears in a scroll list, or else you may be unable to scroll past the edge of the list's viewable area.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

float IEZDragDrop.DragOffset [get, set, inherited]

The distance an object being dragged and dropped should be offset toward the camera to ensure it hovers above other objects and controls in the scene.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

bool IEZDragDrop.DropHandled [get, set, inherited]

In the context of a drag & drop operation, this indicates whether the drop action was handled. If this is not set to true in response to a Dropped message sent to OnEZDragDrop(), the drop will be considered to be unhandled and will result in a cancelled drop, causing the dragged object to return to its original position.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

LayerMask IEZDragDrop.DropMask [get, set, inherited]

A mask which can be used to make the object only be "droppable" on objects in a certain layer. NOTE: This mask is combined with the camera's mask.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

GameObject IEZDragDrop.DropTarget [get, set, inherited]

The GameObject over which the object being dragged is hovering and will attempt to be dropped if it let go.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

bool IEZDragDrop.IsDraggable [get, set, inherited]

Indicates whether the object can be dragged as part of a drag & drop operation.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

bool IEZDragDrop.IsDragging [get, set, inherited]

Indicates whether the object is being dragged as part of a drag & drop operation. Setting this value to false while the object is being dragged will cause the drag and drop operation to be cancelled.

Implemented in UIScrollList, UIVirtualScreen, UIPanelManager, AutoSpriteControlBase, and UIPanelBase.

---

The documentation for this interface was generated from the following file:

• IUIObject.cs