pymel.core.windows.frameLayout

frameLayout(*args, **kwargs)

This command creates frame layout control. A frame layout may draw a border around its child controls as well as a display a title. Frame layouts may also be collapsable. Collapsing a frame layout will make the child of the frame layout invisible and shrink the frame layout size. The frame layout may then be expanded to make its child visible. Note that the frame layout may have only one child control. If you wish to have more than one child inside a frame layout then you must use some other control layout as the immediate child of the frame layout.

Flags:

Long Name / Short Name Argument Types Properties
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.
backgroundShade / bgs bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Controls whether the background of the frame layout draws with a shaded effect. It is turned off by default.
borderStyle / bs unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  This flag is obsolete. The border style is no longer supported. Using this flag will return a warning.
borderVisible / bv bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Visibility of the border.
childArray / ca bool ../../../_images/query.gif
  Returns a string array of the names of the layout’s immediate children.
collapsable / cll bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Collapsibility of the frame layout.
collapse / cl bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Collapse state of the frame layout.
collapseCommand / cc script ../../../_images/create.gif ../../../_images/edit.gif
  Command executed after the frame is collapsed.
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.
expandCommand / ec script ../../../_images/create.gif ../../../_images/edit.gif
  Command executed after the frame is expanded.
font / fn unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The font for the frame label. Valid values are boldLabelFont, smallBoldLabelFont, tinyBoldLabelFont, plainLabelFont, smallPlainLabelFont, obliqueLabelFont, smallObliqueLabelFont, fixedWidthFontand smallFixedWidthFont.
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.
label / l unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Label string for the frame layout.
labelAlign / la unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  How to align the label. Default is top.
labelIndent / li int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Indentation for the frame label.
labelVisible / lv bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Visibility of the frame label.
labelWidth / lw int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Width of the label.
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.
marginHeight / mh int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Vertical distance between the frame and its children.
marginWidth / mw int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Horizontal distance between the frame and its children.
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.
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.
preCollapseCommand / pcc script ../../../_images/create.gif ../../../_images/edit.gif
  Command executed just before the frame is collapsed.
preExpandCommand / pec script ../../../_images/create.gif ../../../_images/edit.gif
  Command executed just before the frame is expanded.
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.
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.frameLayout

Example:

import pymel.core as pm

pm.window()
# Result: ui.Window('window1') #
pm.scrollLayout( 'scrollLayout' )
# Result: ui.ScrollLayout('window1|scrollLayout') #
pm.columnLayout( adjustableColumn=True )
# Result: ui.ColumnLayout('window1|scrollLayout|columnLayout36') #
pm.frameLayout( label='Buttons', borderStyle='in' )
# Result: ui.FrameLayout('window1|scrollLayout|columnLayout36|frameLayout9') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|scrollLayout|columnLayout36|frameLayout9|columnLayout37') #
pm.button()
# Result: ui.Button('window1|scrollLayout|columnLayout36|frameLayout9|columnLayout37|button36') #
pm.button()
# Result: ui.Button('window1|scrollLayout|columnLayout36|frameLayout9|columnLayout37|button37') #
pm.button()
# Result: ui.Button('window1|scrollLayout|columnLayout36|frameLayout9|columnLayout37|button38') #
pm.setParent( '..' )
# Result: u'window1|scrollLayout|columnLayout36|frameLayout9' #
pm.setParent( '..' )
# Result: u'window1|scrollLayout|columnLayout36' #
pm.frameLayout( label='Scroll Bars', borderStyle='out' )
# Result: ui.FrameLayout('window1|scrollLayout|columnLayout36|frameLayout10') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|scrollLayout|columnLayout36|frameLayout10|columnLayout38') #
pm.intSlider()
# Result: ui.IntSlider('window1|scrollLayout|columnLayout36|frameLayout10|columnLayout38|intSlider1') #
pm.intSlider()
# Result: ui.IntSlider('window1|scrollLayout|columnLayout36|frameLayout10|columnLayout38|intSlider2') #
pm.intSlider()
# Result: ui.IntSlider('window1|scrollLayout|columnLayout36|frameLayout10|columnLayout38|intSlider3') #
pm.setParent( '..' )
# Result: u'window1|scrollLayout|columnLayout36|frameLayout10' #
pm.setParent( '..' )
# Result: u'window1|scrollLayout|columnLayout36' #
pm.frameLayout( label='Fields', borderStyle='etchedIn' )
# Result: ui.FrameLayout('window1|scrollLayout|columnLayout36|frameLayout11') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|scrollLayout|columnLayout36|frameLayout11|columnLayout39') #
pm.intField()
# Result: ui.IntField('window1|scrollLayout|columnLayout36|frameLayout11|columnLayout39|intField1') #
pm.intField()
# Result: ui.IntField('window1|scrollLayout|columnLayout36|frameLayout11|columnLayout39|intField2') #
pm.intField()
# Result: ui.IntField('window1|scrollLayout|columnLayout36|frameLayout11|columnLayout39|intField3') #
pm.setParent( '..' )
# Result: u'window1|scrollLayout|columnLayout36|frameLayout11' #
pm.setParent( '..' )
# Result: u'window1|scrollLayout|columnLayout36' #
pm.frameLayout( label='Check Boxes', borderStyle='etchedOut' )
# Result: ui.FrameLayout('window1|scrollLayout|columnLayout36|frameLayout12') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|scrollLayout|columnLayout36|frameLayout12|columnLayout40') #
pm.checkBox()
# Result: ui.CheckBox('window1|scrollLayout|columnLayout36|frameLayout12|columnLayout40|checkBox5') #
pm.checkBox()
# Result: ui.CheckBox('window1|scrollLayout|columnLayout36|frameLayout12|columnLayout40|checkBox6') #
pm.checkBox()
# Result: ui.CheckBox('window1|scrollLayout|columnLayout36|frameLayout12|columnLayout40|checkBox7') #
pm.setParent( '..' )
# Result: u'window1|scrollLayout|columnLayout36|frameLayout12' #
pm.setParent( '..' )
# Result: u'window1|scrollLayout|columnLayout36' #
pm.showWindow()