s&
info
About
info
About s&box
newspaper
Latest News
published_with_changes
Changes
map
Roadmap
monitoring
Metrics
games
Games
sports_esports
Browse Games
explore
Discover Games
category
Workshop
sports_esports
Games
landscape
Maps
view_in_ar
Models
texture
Materials
apparel
Clothing
construction
More..
forum
Forum
menu_book
Learn
docs
Documentation
api
Api Reference
school
Tutorials
manage_search
Code Search
input
Log in with Steam
chevron_left
Change Language
简体中文
English
Русский
Español
Português-Brasil
Deutsch
日本語
Français
Polski
Türkçe
한국어
Pirate
Italiano
ไทย
繁體中文
Українська
Čeština
Nederlands
Magyar
Dansk
Suomi
Svenska
Norsk
Ελληνικά
Română
Български
Tiếng Việt
Bahasa Indonesia
Español-Latinoamérica
العربية
Api
Editor Classes
DockManager
chevron_left
Editor Classes
class
DockManager
Constructors
functions
DockManager
Properties
data_object
DockTypes
data_object
OnLayoutLoaded
data_object
State
Methods
functions
AddDock
functions
Clear
functions
CreateDockWidget
functions
FindDockWidget
functions
IsDockOpen
functions
OpenDock
functions
RaiseDock
functions
RegisterDock
functions
RemoveDock
functions
RestoreState
functions
SetCentralWidget
functions
SetDockState
functions
SetSplitterProportions
functions
UnregisterDockType
DockManager
class
Editor
.
account_tree
extends
Widget
Sandbox.Tools
build
Constructors
1
DockManager
(
parent
)
data_object
Properties
3
DockTypes
IEnumerable`1
A list of dock types that are registered.
OnLayoutLoaded
Action
Called when the layout state is loaded, e.g. when the default layout is applied or a saved layout is restored.
State
string
A string representing the entire state of the dock manager (position of all docks, etc). Setting this restores the layout and invokes Editor.DockManager.OnLayoutLoaded.
functions
Methods
14
AddDock
(
widget
,
area
)
Adds a Editor.DockWidget into the given area.
Clear
(
)
Clear all registered dock types.
CreateDockWidget
(
name
,
icon
,
widget
)
DockWidget
Creates a native dock widget container for the given widget.
FindDockWidget
(
name
)
DockWidget
Find an existing dock widget by name. Returns null if not found.
IsDockOpen
(
name
)
bool
Whether the named dock is currently open (visible).
OpenDock
(
name
,
area
,
relativeTo
)
DockWidget
Open a registered dock and move it into the given area, creating it if needed.
RaiseDock
(
name
)
bool
Raise a dock to the front of its tab group.
RegisterDock
(
info
)
Register a dock type and create it closed in its default area, so it's available to view menus and layout restoring without appearing in the layout.
RemoveDock
(
widget
)
Remove a dock widget from the manager.
RestoreState
(
state
)
bool
Restore a layout previously captured from Editor.DockManager.State. Returns false if the state couldn't be restored, e.g. it was saved by an incompatible version.
SetCentralWidget
(
widget
)
DockWidget
Sets a widget as the central (always present, non-closable) area. Must be called before any other dock is added. Returns the dock hosting it, which can be used as a target for relative docking.
SetDockState
(
name
,
visible
)
Toggle a registered dock's visibility by name. If the dock doesn't exist yet, it will be created from its registered Editor.DockManager.DockInfo.
SetSplitterProportions
(
dock
,
proportions
)
bool
UnregisterDockType
(
name
)
Unregister a dock type by name.
Inheritance
QObject
Widget
DockManager
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.