---
title: "GuiSystem"
description: "API documentation for GuiSystem"
url: https://developer.disguise.one/python-api/docs/guisystem/
---

# GuiSystem

A system which manages the general, high level and global variables and methods for the Designer GUI.

Base class (inherits properties and methods): _[Subsystem](/python-api/docs/subsystem#subsystem)_

## Nested Classes

-   [VisualiseMode](/python-api/docs/guisystem.visualisemode#visualisemode)

## Properties

#### **acceptDropDelegate** : _Callable_

A delegate for a function which accepts a drop operation for a widget

#### **consoleWindowDelegate** : _Callable_

A delegate for a function which creates the console window Widget.

#### **currentSetList** : _[SetList](/python-api/docs/setlist#setlist)_

The current active set list.

#### **currentTransportManager** : _[TransportManager](/python-api/docs/transportmanager#transportmanager)_ _(Read-Only)_

The current active transport manager.

#### **debugWindowDelegate** : _Callable_

A delegate for a function which creates the debug window Widget.

#### **feedDisplayProxyLevelsDelegate** : _Callable_

A delegate for a function which updates proxy levels in the feed view.

#### **getSeparatorOpenDelegate** : _Callable_

A delegate for a function which returns whether a separator is open.

#### **gui** : _Gui_

The GUI object, primarily used for widget management.

#### **hasCustomEditorDelegate** : _Callable_

A delegate for a function which returns whether a Resource has a custom Editor.

#### **inputMapTransport** : _EventTransportInputMap_ _(Read-Only)_

The input map event transport which channels playback commands from the track widget.

#### **makeCueListDelegate** : _Callable_

A delegate for a function which makes a new cue list.

#### **makeDropOperationDelegate** : _Callable_

A delegate for a function which makes a drop operation for a widget.

#### **makeEditorDelegate** : _Callable_

A delegate for a function which makes a new Editor.

#### **makeLinkDelegate** : _Callable_

A delegate for a function which makes a link between Widgets.

#### **makeListEditorDelegate** : _Callable_

A delegate for a function which makes a new list Editor.

#### **makeWidgetDelegate** : _Callable_

A delegate for a function which makes a new Widget.

#### **player** : _[TrackPlayer](/python-api/docs/trackplayer#trackplayer)_ _(Read-Only)_

The track player from the current active transport manager.

#### **populateEditorDelegate** : _Callable_

A delegate for a function which populates an Editor.

#### **restoreFeedBookmarkDelegate** : _Callable_

A delegate for a function which restores a feed bookmark.

#### **selectedLayers** : _Any_ _(Read-Only)_

The set of layers selected in the GUI

#### **selectedLayersDelegate** : _Callable_

A delegate for a function which returns the layers currently selected in the GUI.

#### **setFeedBookmarkDelegate** : _Callable_

A delegate for a function which sets a feed bookmark

#### **setSeparatorOpenDelegate** : _Callable_

A delegate for a function which opens a separator.

#### **toggleQuantiserWindowDelegate** : _Callable_

A delegate for a function which toggles the quantiser window.

#### **toggleStickyDelegate** : _Callable_

A delegate for a function which toggles the sticky status of a widget.

#### **track** : _[Track](/python-api/docs/track#track)_ _(Read-Only)_

The current track being edited

#### **visualiseMode** : _[GuiSystem.VisualiseMode](/python-api/docs/guisystem.visualisemode#visualisemode)_

The visualisation mode of the GUI system.

## Variables

#### **VisualiseFeed** : _Final\[[GuiSystem.VisualiseMode](/python-api/docs/guisystem.visualisemode#visualisemode)\]_ = GuiSystem.VisualiseMode.VisualiseFeed

The index of the ‘VisualiseFeed’ VisualiseMode option.

#### **VisualiseNone** : _Final\[[GuiSystem.VisualiseMode](/python-api/docs/guisystem.visualisemode#visualisemode)\]_ = GuiSystem.VisualiseMode.VisualiseNone

The index of the ‘VisualiseNone’ VisualiseMode option.

#### **VisualiseSpace** : _Final\[[GuiSystem.VisualiseMode](/python-api/docs/guisystem.visualisemode#visualisemode)\]_ = GuiSystem.VisualiseMode.VisualiseSpace

The index of the ‘VisualiseSpace’ VisualiseMode option.

## Constructors

#### **\_\_init\_\_**(self)

## Methods

#### **closeActiveWidget**(self)

Close active widget

#### **closeAllWidgets**(self)

Close all non-sticking widgets

#### **copyTextToClipboard**(self, text: _str_)

Copies the given text to the clipboard.

**Parameters**:

-   text: The text to be copied.

#### **customFps**(self) -> _optional\[float\]_

Returns the custom FPS value, if it is set.

This method returns the custom fps value, if it has been set by the user. If the transport manager does not exist or does not have a custom fps value set, an empty optional is returned.

**Returns** The custom FPS value, if it is set. An empty optional otherwise.

#### **cycleBackward**(self)

Cycle backwards through windows

#### **cycleEditFieldNext**(self)

Select the next editable field in the current window

#### **cycleEditFieldPrev**(self)

Select the previous editable field in the current window

#### **cycleForward**(self)

Cycle forwards through windows

#### **directorForceQuitAll**(self)

Force quit all machines in the session

#### **directorQuitAll**(self)

Quit all machines in the session

#### **directorRestartAll**(self)

Restart all machines in the session

#### **directorStartAll**(self)

Start all machines in the session

#### **editorDisplayProxyLevelsCallback**(self, levels: _VisibilityProxyLevels_, display: _[Display](/python-api/docs/display#display)_, targetLod: _float_)

Callback function for updating the visibility proxy levels in the editor, based on what is being viewed in the GUI.

**Parameters**:

-   levels: The proxy levels object.
-   display: The Display to update the proxy levels for.
-   targetLod: The level of detail (LOD) value for the current target.

#### **getDeviceManager**(self) -> _[DeviceManager](/python-api/docs/devicemanager#devicemanager)_

The current active device manager.

#### **getTextFromClipboard**(self) -> _str_

Get text from the clipboard.

**Returns** The text from the clipboard, or an empty string if there is no text available.

#### **mouseDragArrow**(self, state: _[InputDragState](/python-api/docs/inputdragstate#inputdragstate)_, start: _[Vec2](/python-api/docs/vec2#vec2) | [Int2](/python-api/docs/int2#int2) | [Vec](/python-api/docs/vec#vec)_, pos: _[Vec2](/python-api/docs/vec2#vec2) | [Int2](/python-api/docs/int2#int2) | [Vec](/python-api/docs/vec#vec)_)

Create an arrow connection between two widgets

#### **onAppStarted**(self)

Called when the application starts and sets up the GUI system.

#### **quitEverything**(self)

Save and exit all machines in session without confirmation

#### **quitOption**(self)

Save and exit with confirmation

#### **requestCapture**(self, includeWidgets: _bool_, size: _[Int2](/python-api/docs/int2#int2) | [Vec2](/python-api/docs/vec2#vec2)_) -> _shared\_future\[[Path](/python-api/docs/path#path)\]_

Schedule a capture of the GUI display. Returns a future which holds the path to the completed capture.

#### **smpteClockType**(self) -> _[SMPTEClockType](/python-api/docs/smpteclocktype#smpteclocktype)_

Returns the SMPTE clock type used by the transport manager.

If there is no current transport manager, or if it does not have an SMPTE clock, this method returns the project clock type as a fallback.

**Returns** The SMPTE clock type.

#### **toggleConsole**(self)

Toggle dynamic console window

#### **toggleDebugWindow**(self)

Toggle debug output window

#### **toggleHelpWindow**(self)

Toggle context-sensitive shortcuts window

#### **writeNoteConsole**(self)

Write user note to Console