pymel.core.windows.dockControl¶

dockControl(*args, **kwargs)¶

Create a dockable control, also known as tool palette or utility window. Dock controls are secondary windows placed in the dock area around the central control in a main window. Dock windows can be moved inside their current area, moved into new areas and floated (e.g. undocked). Dock control consists of a title bar and the content area. The titlebar displays the dock control window title, a float button and a close button. Depending on the state of the dock control, the float and close buttons may be either disabled or not shown at all.

Flags:

Long Name / Short Name		Argument Types	Properties
allowedArea / aa		unicode
	Areas where the dock control may be placed. Valid values are top, left, bottom, rightand all. The default is all.
annotation / ann		unicode
	Annotate the control with an extra string value.
area / a		unicode
	The initial dock area for this dock control. This is a required flag.
backgroundColor / bgc		float, float, float
	The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.
closeCommand / cc		script
	Script executed after the dock control is closed.
content / con		unicode
	The name of the control that is the content of this dock control. This is a required flag.
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.
docTag / dtg		unicode
	Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
dockStation / ds		unicode
	The name of the control the window can be docked into. If this is not set it is assumed to be the main window.
dragCallback / dgc		script
	Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form: global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y, modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’
dropCallback / dpc		script
	Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages, x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d’
enable / en		bool
	The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
enableBackground / ebg		bool
	Enables the background color of the control.
enablePopupOption / epo		bool
	Whether or not the menu option for the dock control in the UI Elements popup menu is enabled.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
fixedHeight / fh		bool
	Whether or not the dockControl height may be interactively resized.
fixedWidth / fw		bool
	Whether or not the dockControl width may be interactively resized.
floatChangeCommand / fcc		script
	The script executed when the floating state of the dock widget changes.
floating / fl		bool
	Whether the dock widget is floating. A floating dock widget is presented to the user as an independent window on topof main window, instead of being docked in the main window.
fullPathName / fpn		bool
	Return the full path name of the widget, which includes all the parents
height / h		int
	The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
highlightColor / hlc		float, float, float
	The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
isObscured / io		bool
	Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control’s window is invisible or iconified.
label / l		unicode
	The label text. The default label is the name of the control.
manage / m		bool
	Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
moveable / mov		bool
	Control over whether or not the dockControl may be undocked/redocked.
noBackground / nbg		bool
	Clear/reset the control’s background. Passing true means the background should not be drawn at all, false means the background should be drawn. The state of this flag is inherited by children of this control.
numberOfPopupMenus / npm		bool
	Return the number of popup menus attached to this control.
parent / p		unicode
	The parent layout for this control.
popupMenuArray / pma		bool
	Return the names of all the popup menus attached to this control.
preventOverride / po		bool
	If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
r / r		bool
	Whether the dock widget is visible and either floating or at the top of its dock widget area.
retain / ret		bool
	Control over whether or not the window and its contents are deleted when closed. The default is true. The window and its contents are retained when closed unless this is set to false.
sizeable / s		bool
	Whether or not the dockControl width may be interactively resized. Deprecated!! Use the fixedWidth flag instead.
splitLayout / sl		unicode
	When two windows are added to a single docking area they are by default tabbed together. Setting a value for splitLayout will allow it to be placed next to another control in the same area. The flag’s argument controls the orientation of the split. Valid values are horizontalor vertical.
state / st		unicode
	When queried this flag will return a string holding the dock control state information. This string is a hexadecimal representation of a binary string and is not meant to be humanly readable, but can be saved and loaded using the optionVar command to restore a dock control’s state across sessions of Maya.
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one.
visible / vis		bool
	The visible state of the control. A control is created visible by default. Note that a control’s actual appearance is also dependent on the visible state of its parent layout(s).
visibleChangeCommand / vcc		script
	Command that gets executed when visible state of the control changes.
width / w		int
	The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.dockControl

Example:

import pymel.core as pm

myWindow = pm.window()
buttonForm = pm.formLayout( parent = myWindow )
pm.button( parent = buttonForm )
# Result: ui.Button('window1|formLayout53|button26') #
allowedAreas = ['right', 'left']
pm.dockControl( area='left', content=myWindow, allowedArea=allowedAreas )
# Result: u'MayaWindow|dockControl6' #