eDriven Framework API
Gui Class
NamespaceseDriven.GuiGui
eDriven Framework API
Gui class inherits UnityEngine.MonoBehaviour Normally it should be extended and put into the hierarchy manually Alternatively it could be created dinamically Upon starting or enabling, it registers itself to the StageManager instance The Depth property is used for layering the multiple GUIs in the application Internally it creates the Stage instance It listens for the changes in the inspector and propagates them to the Stage instance
Declaration Syntax
C#Visual BasicVisual C++
public class Gui : MonoBehaviour, IChildList, IEventDispatcher, 
	IDisposable
Public Class Gui _
	Inherits MonoBehaviour _
	Implements IChildList, IEventDispatcher, IDisposable
public ref class Gui : public MonoBehaviour, 
	IChildList, IEventDispatcher, IDisposable
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
Gui()()()()
Initializes a new instance of the Gui class

active Obsolete. (Inherited from Component.)
AddChild(DisplayListMember)
Adds the child to a stage

AddChildAt(DisplayListMember, Int32)
Adds a child to the container to the specified index

AddEventListener(String, EventHandler)
Adds event listener

AddEventListener(String, EventHandler, Int32)
Adds the event listener

AddEventListener(String, EventHandler, EventPhase)
Adds the event listener

AddEventListener(String, EventHandler, EventPhase, Int32)
Adds the event listener

animation (Inherited from Component.)
audio (Inherited from Component.)
BroadcastMessage(String, Object, SendMessageOptions) (Inherited from Component.)
BroadcastMessage(String, Object) (Inherited from Component.)
BroadcastMessage(String) (Inherited from Component.)
BroadcastMessage(String, SendMessageOptions) (Inherited from Component.)
camera (Inherited from Component.)
CancelInvoke()()()() (Inherited from MonoBehaviour.)
CancelInvoke(String) (Inherited from MonoBehaviour.)
Children
The child components of the container

collider (Inherited from Component.)
collider2D (Inherited from Component.)
CompareTag(String) (Inherited from Component.)
constantForce (Inherited from Component.)
Contains(DisplayListMember)
Returns true if the stage contains the specified child

Contains(DisplayListMember, Boolean)
Returns true if the stage contains the specified child

CreateChildren()()()()
This method should be used for creating children of the corresponding Stage

DebugMode
Debug mode

DispatchEvent(Event)
Dispatches an event with stage as target

DispatchEvent(Event, Boolean)
Dispatches an event with stage as target

Dispose()()()()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

enabled (Inherited from Behaviour.)
Equals(Object) (Inherited from Object.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
FocusedComponent
The reference to the focused component

FocusEnabled
Does this stage receive focus

gameObject (Inherited from Component.)
GetChildAt(Int32)
Gets stage child at specified position

GetChildIndex(DisplayListMember)
Gets stage child index

GetComponent(Type) (Inherited from Component.)
GetComponent``1()()()() (Inherited from Component.)
GetComponent(String) (Inherited from Component.)
GetComponentInChildren(Type) (Inherited from Component.)
GetComponentInChildren``1()()()() (Inherited from Component.)
GetComponents(Type) (Inherited from Component.)
GetComponents``1()()()() (Inherited from Component.)
GetComponentsInChildren(Type) (Inherited from Component.)
GetComponentsInChildren(Type, Boolean) (Inherited from Component.)
GetComponentsInChildren``1(Boolean) (Inherited from Component.)
GetComponentsInChildren``1()()()() (Inherited from Component.)
GetHashCode()()()() (Inherited from Object.)
GetInstanceID()()()() (Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
guiElement Obsolete. (Inherited from Component.)
guiText (Inherited from Component.)
guiTexture (Inherited from Component.)
HasBubblingEventListener(String)
Checks whether an event listener of specified type is registered with stage

HasChild(DisplayListMember)
Returns true if the stage contains the specified child

HasEventListener(String)
Checks whether an event listener of specified type is registered with stage

hideFlags (Inherited from Object.)
hingeJoint (Inherited from Component.)
Id
Stage ID

Initialized
Returns true if the Stage is initialized

Invoke(String, Single) (Inherited from MonoBehaviour.)
InvokeRepeating(String, Single, Single) (Inherited from MonoBehaviour.)
IsInvoking(String) (Inherited from MonoBehaviour.)
IsInvoking()()()() (Inherited from MonoBehaviour.)
Layout
Gets or sets the stage layout

light (Inherited from Component.)
LiveMediaQueries
Media queries are being run by default

Matrix
Matrix

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MouseDownComponent
The reference to the mouse-downed component

MouseEnabled
Does stage react on mouse events, or suppresses mouse event propagation to background (other stages or 3D)

MouseTarget
The reference to component under the mouse
This component is looked upon after each mouse move on all stages

MouseWheelTargets
The reference to a component stack that will receive mouse wheel events
The stuck is built after each mouse move (contains components from multiple stages)

name (Inherited from Object.)
networkView (Inherited from Component.)
NumberOfChildren
Number of children

OnCreationComplete()()()()
Handler that fires on Stage creation complete

OnInitialize()()()()
Handler that fires on Stage initialize

OnPreinitialize()()()()
Handler that fires on Stage preinitialize

OnResize(Point)
Handler that fires on Stage (screen) resize

OnStart()()()()
Run after the Stage is initialized, and before the layout is initialized

particleEmitter (Inherited from Component.)
particleSystem (Inherited from Component.)
ProcessStyles()()()()
Called from the editor when we want the total reprocessing of styles

RemoveAllChildren()()()()
Removes all children from the stage

RemoveAllListeners(String)
Removes all stage event listeners

RemoveChild(DisplayListMember)
Removes a chold from the stage

RemoveChildAt(Int32)
Adds a child from the container at specified index

RemoveEventListener(String, EventHandler)
Removes an event listener

RemoveEventListener(String, EventHandler, EventPhase)
Removes an event listener

renderer (Inherited from Component.)
rigidbody (Inherited from Component.)
rigidbody2D (Inherited from Component.)
SendMessage(String, Object, SendMessageOptions) (Inherited from Component.)
SendMessage(String, Object) (Inherited from Component.)
SendMessage(String) (Inherited from Component.)
SendMessage(String, SendMessageOptions) (Inherited from Component.)
SendMessageUpwards(String, Object, SendMessageOptions) (Inherited from Component.)
SendMessageUpwards(String, Object) (Inherited from Component.)
SendMessageUpwards(String) (Inherited from Component.)
SendMessageUpwards(String, SendMessageOptions) (Inherited from Component.)
SetChildIndex(DisplayListMember, Int32)
Sets stage child index

Stage
Exposes Stage instance to the script

StartCoroutine(IEnumerator) (Inherited from MonoBehaviour.)
StartCoroutine(String, Object) (Inherited from MonoBehaviour.)
StartCoroutine(String) (Inherited from MonoBehaviour.)
StartCoroutine_Auto(IEnumerator) (Inherited from MonoBehaviour.)
StopAllCoroutines()()()() (Inherited from MonoBehaviour.)
StopCoroutine(String) (Inherited from MonoBehaviour.)
StyleCacheDirty
Set this flag to true if in need to reset the declaration cache For instance, the editor should set this flag to true if any of style declarations added/removed/changed, just before reloading the style sheet collection (calling the Load() method)

SwapChildren(DisplayListMember, DisplayListMember)
Swaps two children of the stage

tag (Inherited from Component.)
ToString()()()() (Inherited from Object.)
transform (Inherited from Component.)
useGUILayout (Inherited from MonoBehaviour.)
Visible
Stage visibility

ZIndex
GUI depth applied to this stage

Remarks
Author: Danko Kozar
Inheritance Hierarchy
Object
Object
 Component
  Behaviour
   MonoBehaviour
    Gui

Assembly: eDriven.Gui (Module: eDriven.Gui) Version: 2.0.1.0 (2.0.1.0)