pymel.core.windows.paneLayout

paneLayout(*args, **kwargs)

This command creates a pane layout. A pane layout may have any number of children but at any one time only certain children may be visible, as determined by the current layout configuration. For example a horizontally split pane shows only two children, one on top of the other and a visible separator between the two. The separator may be moved to vary the size of each pane. Various other pane configurations are available and all display a moveable separator that define the size of each pane in the layout.

Flags:

Long Name / Short Name Argument Types Properties
activeFrameThickness / aft int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The thickness of the frame drawn around the active frame. Specify an integer value greater than or equal to 0.
activePane / ap unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The active pane has a colored border surrounding it. Only one pane may be active at any one time. Using either of the flags -ap/activePaneor -api/activePaneIndexwill automatically deactivate the previously active pane. The argument is the full or short name of the child control.
activePaneIndex / api int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The active pane index. The active pane has a colored border surrounding it. Only one pane may be active at any one time. Using either of the flags -ap/activePaneor -api/activePaneIndexwill automatically deactivate the previously active pane. The argument is an integer value ranging from 1 to 4. Panes for any particular configuration are numbered clockwise beginning with the pane in the top left corner of the layout. If any other index is specified then the current active pane is deactivated.
annotation / ann unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Annotate the control with an extra string value.
backgroundColor / bgc float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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.
childArray / ca bool ../../../_images/query.gif
  Returns a string array of the names of the layout’s immediate children.
configuration / cn unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Set the layout configuration for the panes. Valid values are: single, horizontal2, vertical2, horizontal3, vertical3, top3, left3, bottom3, right3, horizontal4, vertical4, top4, left4, bottom4, right4, quad
defineTemplate / dt unicode ../../../_images/create.gif
  Puts the command in a mode where any other flags and arguments 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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Add a documentation flag to the control. The documentation flag has a directory structure. (e.g., -dt render/multiLister/createNode/material)
dragCallback / dgc script ../../../_images/create.gif ../../../_images/edit.gif
  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 CTRL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL, 3 == CTRL + 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 ../../../_images/create.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Enables the background color of the control.
exists / ex bool ../../../_images/create.gif
  Returns whether the specified object exists or not. Other flags are ignored.
fullPathName / fpn bool ../../../_images/query.gif
  Return the full path name of the widget, which includes all the parents.
height / h int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/query.gif
  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.
manage / m bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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.
noBackground / nbg bool ../../../_images/create.gif ../../../_images/edit.gif
  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.
numberOfChildren / nch bool ../../../_images/query.gif
  Returns in an int the number of immediate children of the layout.
numberOfPopupMenus / npm bool ../../../_images/query.gif
  Return the number of popup menus attached to this control.
numberOfVisiblePanes / nvp bool ../../../_images/query.gif
  Return the number of panes visible for the present configuration.
pane1 / p1 bool ../../../_images/query.gif
   
pane2 / p2 bool ../../../_images/query.gif
   
pane3 / p3 bool ../../../_images/query.gif
   
pane4 / p4 bool ../../../_images/query.gif
  Return the name of the control in the respective pane.
paneSize / ps int, int, int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The size of a pane in the current pane layout configuration. The first argument specifies the pane index and is an integer value ranging from 1 to 4. Panes for any particular configuration are numbered clockwise beginning with the pane in the top left corner of the layout. The width and height of the pane are specified by the last two arguments. Both are integer values and they indicate the percentage of the total pane layout size rather that the number of pixels.
paneUnderPointer / pup bool ../../../_images/query.gif
  Return the name of the child occupying the pane that the pointer is currently over. An empty string is returned if the pointer is not over a pane.
parent / p unicode ../../../_images/create.gif ../../../_images/query.gif
  The parent layout for this control.
popupMenuArray / pma bool ../../../_images/query.gif
  Return the names of all the popup menus attached to this control.
preventOverride / po bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  If true, this flag prevents overriding the control’s attribute via the control’s right mouse button menu.
separatorMovedCommand / smc script ../../../_images/create.gif ../../../_images/edit.gif
  This command executed when the pane separators are moved.
separatorThickness / st int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The thickness of the separators between the panes. Specify an integer value greater than 0. This flag has no effect on Windows systems.
setPane / sp unicode, int ../../../_images/create.gif ../../../_images/edit.gif
  This flag allows you to put a child of this layout in a particular pane. The first argument is the full or short name of the control. The second argument is an integer value ranging from 1 to 4. Panes for any particular configuration are numbered clockwise beginning with the pane in the top left corner of the layout.
staticHeightPane / shp int ../../../_images/create.gif ../../../_images/edit.gif
  Set a pane to have a static height, i.e. its height will not change when the layout is dynamically resized. Only one pane can be set to have a static height at one time. This state will be retained even if another child is switched into the pane. Specify 0 to set a pane back to the default state. Any state will be lost if the pane configuration is changed.
staticWidthPane / swp int ../../../_images/create.gif ../../../_images/edit.gif
  Set a pane to have a static width, i.e. its width will not change when the layout is dynamically resized. Only one pane can be set to have a static width at one time. This state will be retained even if another child is switched into the pane. Specify 0 to set a pane back to the default state. Any state will be lost if the pane configuration is changed.
statusBarMessage / sbm unicode ../../../_images/create.gif ../../../_images/edit.gif
  Extra string to display in the status bar when the mouse is over the control.
useTemplate / ut unicode ../../../_images/create.gif
  Forces the command to use a command template other than the current one.
visible / vis bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Command that gets executed when visible state of the control changes.
width / w int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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.paneLayout

Example:

import pymel.core as pm

pm.window()
# Result: ui.Window('window1') #
pm.paneLayout( configuration='quad' )
# Result: ui.PaneLayout('window1|paneLayout9') #
pm.button()
# Result: ui.Button('window1|paneLayout9|button62') #
pm.textScrollList( append=['one', 'two', 'three'] )
# Result: ui.TextScrollList('window1|paneLayout9|textScrollList2') #
pm.scrollField()
# Result: ui.ScrollField('window1|paneLayout9|scrollField2') #
pm.scrollLayout()
# Result: ui.ScrollLayout('window1|paneLayout9|scrollLayout1') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|paneLayout9|scrollLayout1|columnLayout67') #
pm.button()
# Result: ui.Button('window1|paneLayout9|scrollLayout1|columnLayout67|button63') #
pm.button()
# Result: ui.Button('window1|paneLayout9|scrollLayout1|columnLayout67|button64') #
pm.button()
# Result: ui.Button('window1|paneLayout9|scrollLayout1|columnLayout67|button65') #
pm.showWindow()