Class IGui

Interface for GUI functionality.

Hierarchy (View Summary)

IPluginComponent
- IGui
  - Gui

Index

Constructors

Properties

dialogs interfaceId workspaces

Methods

createDialog createWidget getTypeName isOfType isSame

Constructors

`Protected`constructor

new IGui(): IGui
Snap Hidden
Returns IGui
Overrides IPluginComponent.constructor

Properties

`Readonly`dialogs

dialogs: IDialogs

Manager for all open dialogs.

`Static`interfaceId

interfaceId: InterfaceId

Interface identifier for IGui.

`Readonly` `Beta`workspaces

workspaces: IWorkspaceManager

Manager for workspace layouts and panels.

Methods

createDialog

createDialog(): Dialog
Create a new dialog window.

Returns Dialog

createWidget

createWidget(): Widget
Create a new widget.

Returns Widget

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPluginComponent.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPluginComponent.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPluginComponent.isSame