pymel.core.uitypes.FrameLayout

class FrameLayout

class counterpart of mel function frameLayout

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.

collapseCommand(val=True, **kwargs)

Command executed after the frame is collapsed.

Derived from mel command maya.cmds.frameLayout

dragCallback(val=True, **kwargs)

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 “dragControl” value is a string and the other values are integers (eg the callback string could be “print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’”)

Derived from mel command maya.cmds.frameLayout

dropCallback(val=True, **kwargs)

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 “dragControl” value 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’”)

Derived from mel command maya.cmds.frameLayout

expandCommand(val=True, **kwargs)

Command executed after the frame is expanded.

Derived from mel command maya.cmds.frameLayout

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.frameLayout

getBackgroundColor(**kwargs)

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.

Derived from mel command maya.cmds.frameLayout

getBorderStyle(**kwargs)

Border style. Valid values are “in”, “out”, “etchedIn”, or “etchedOut”. “in” will make the frame appear sunk in. “out” will make the frame appear raised. “etchedIn” will make the border itself appear sunk in. Similary, “etchedOut” will make the border appear raised.

Derived from mel command maya.cmds.frameLayout

getBorderVisible(**kwargs)

Visibility of the border.

Derived from mel command maya.cmds.frameLayout

getChildArray(**kwargs)

Returns a string array of the names of the layout’s immediate children.

Derived from mel command maya.cmds.frameLayout

getCollapsable(**kwargs)

Collapsibility of the frame layout.

Derived from mel command maya.cmds.frameLayout

getCollapse(**kwargs)

Collapse state of the frame layout.

Derived from mel command maya.cmds.frameLayout

getDocTag(**kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.frameLayout

getEnable(**kwargs)

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.

Derived from mel command maya.cmds.frameLayout

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.frameLayout

getFont(**kwargs)

The font for the frame label. Valid values are “boldLabelFont”, “smallBoldLabelFont”, “tinyBoldLabelFont”, “plainLabelFont”, “smallPlainLabelFont”, “obliqueLabelFont”, “smallObliqueLabelFont”, “fixedWidthFont” and “smallFixedWidthFont”.

Derived from mel command maya.cmds.frameLayout

getFullPathName(**kwargs)

Return the full path name of the widget, which includes all the parents

Derived from mel command maya.cmds.frameLayout

getHeight(**kwargs)

The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.frameLayout

getIsObscured(**kwargs)

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.

Derived from mel command maya.cmds.frameLayout

getLabel(**kwargs)

Label string for the frame layout.

Derived from mel command maya.cmds.frameLayout

getLabelIndent(**kwargs)

Indentation for the frame label.

Derived from mel command maya.cmds.frameLayout

getLabelVisible(**kwargs)

Visibility of the frame label.

Derived from mel command maya.cmds.frameLayout

getManage(**kwargs)

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.

Derived from mel command maya.cmds.frameLayout

getMarginHeight(**kwargs)

Vertical distance between the frame and its children.

Derived from mel command maya.cmds.frameLayout

getMarginWidth(**kwargs)

Horizontal distance between the frame and its children.

Derived from mel command maya.cmds.frameLayout

getNumberOfChildren(**kwargs)

Returns in an int the number of immediate children of the layout.

Derived from mel command maya.cmds.frameLayout

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.frameLayout

getPopupMenuArray(**kwargs)

Return the names of all the popup menus attached to this control.

Derived from mel command maya.cmds.frameLayout

getPreventOverride(**kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.frameLayout

getVisible(**kwargs)

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).

Derived from mel command maya.cmds.frameLayout

getVisibleChangeCommand(**kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.frameLayout

getWidth(**kwargs)

The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.frameLayout

preCollapseCommand(val=True, **kwargs)

Command executed just before the frame is collapsed.

Derived from mel command maya.cmds.frameLayout

preExpandCommand(val=True, **kwargs)

Command executed just before the frame is expanded.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.frameLayout

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.frameLayout

setBackgroundColor(val=True, **kwargs)

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.

Derived from mel command maya.cmds.frameLayout

setBorderStyle(val=True, **kwargs)

Border style. Valid values are “in”, “out”, “etchedIn”, or “etchedOut”. “in” will make the frame appear sunk in. “out” will make the frame appear raised. “etchedIn” will make the border itself appear sunk in. Similary, “etchedOut” will make the border appear raised.

Derived from mel command maya.cmds.frameLayout

setBorderVisible(val=True, **kwargs)

Visibility of the border.

Derived from mel command maya.cmds.frameLayout

setCollapsable(val=True, **kwargs)

Collapsibility of the frame layout.

Derived from mel command maya.cmds.frameLayout

setCollapse(val=True, **kwargs)

Collapse state of the frame layout.

Derived from mel command maya.cmds.frameLayout

setDocTag(val=True, **kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.frameLayout

setEnable(val=True, **kwargs)

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.

Derived from mel command maya.cmds.frameLayout

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.frameLayout

setFont(val=True, **kwargs)

The font for the frame label. Valid values are “boldLabelFont”, “smallBoldLabelFont”, “tinyBoldLabelFont”, “plainLabelFont”, “smallPlainLabelFont”, “obliqueLabelFont”, “smallObliqueLabelFont”, “fixedWidthFont” and “smallFixedWidthFont”.

Derived from mel command maya.cmds.frameLayout

setHeight(val=True, **kwargs)

The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.frameLayout

setLabel(val=True, **kwargs)

Label string for the frame layout.

Derived from mel command maya.cmds.frameLayout

setLabelIndent(val=True, **kwargs)

Indentation for the frame label.

Derived from mel command maya.cmds.frameLayout

setLabelVisible(val=True, **kwargs)

Visibility of the frame label.

Derived from mel command maya.cmds.frameLayout

setManage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.frameLayout

setMarginHeight(val=True, **kwargs)

Vertical distance between the frame and its children.

Derived from mel command maya.cmds.frameLayout

setMarginWidth(val=True, **kwargs)

Horizontal distance between the frame and its children.

Derived from mel command maya.cmds.frameLayout

setPreventOverride(val=True, **kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.frameLayout

setVisible(val=True, **kwargs)

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).

Derived from mel command maya.cmds.frameLayout

setVisibleChangeCommand(val=True, **kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.frameLayout

setWidth(val=True, **kwargs)

The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.frameLayout