pymel.core.windows.workspaceControl¶

workspaceControl(*args, **kwargs)¶

Creates and manages the widget used to host windows in a layout which enables docking and stacking windows together.

Flags:

Long Name / Short Name		Argument Types	Properties
checksPlugins / cp		bool
	Sets whether the UI (as defined by the uiScript) checks the loaded state of one or more plugins in its code. The UI will not be loaded until the auto-loading of plugins is complete. Default value is false.
close / cl		bool
	Closes the workspace control.
defineTemplate / dt		unicode
	Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
dockToControl / dtc		unicode, unicode
	Dock this workspace control next to the given control. The first argument is the control name, the second is dock position relative to the control (valid values are: left, right, top, bottom).
dockToMainWindow / dtm		unicode, bool
	Dock this workspace control into the main window. The first argument is dock position along the sides of the main window (valid values are: left, right, top, bottom), the second is whether or not the control should be tabbed into the first control found at the dock position.
dockToPanel / dtp		unicode, unicode, bool
	Dock this workspace control into the given workspace docking panel. The first argument is the panel name, the second is dock position along the sides of the panel (valid values are: left, right, top, bottom), the third is whether or not the control should be tabbed into the first control found at the dock position.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
floating / fl		bool
	Whether the workspace control is floating.
height / h		bool
	Query only flag returning the current height of the control.
heightProperty / hp		unicode
initialHeight / ih		int
	The initial height of the workspace control when first shown.
initialWidth / iw		int
	The initial width of the workspace control when first shown.
label / l		unicode
	The label text. The default label is the name of the workspace control.
loadImmediately / li		bool
	Sets whether the UI (as defined by the uiScript) will be built immediately on workspace control creation (true) or delayed until the control is actually shown (false). Default value is false.
minimumWidth / mw		bool
	Sets the minimum width of control to the initial width. This should be used along with initial width flag.
r / r		bool
	Whether the workspace control widget is visible and either floating or at the top of its workspace area.
requiredPlugin / rp		unicode
	The name of a plug-in that needs to be loaded in order to build the workspace control UI.
retain / rt		bool
	Sets whether the workspace control is retained (i.e. only hidden) or deleted when closed. Default value is true.
tabToControl / ttc		unicode, int
	Tab this workspace control into the given control. The first argument is the control name, the second is the index position within the containing tab widget (invalid values mean append).
uiScript / ui		script
	The specified script will be invoked to build the UI of the workspaceControl. This is a required flag.
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one.
visible / vis		bool
	The visible state of the workspace control. A control is created visible by default.
visibleChangeCommand / vcc		script
	Command that gets executed when visible state of the workspace control changes.
width / w		bool
	Query only flag returning the current width of the control. Flag can have multiple arguments, passed either as a tuple or a list.
widthProperty / wp		unicode

Derived from mel command maya.cmds.workspaceControl