frameLayout is undoable, queryable, and editable.
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.
In query mode, return type is based on queried flag.
| Long name (short name) |
Argument types |
Properties |
exists(ex)
|
boolean
|
|
|
Returns true|false depending upon whether the
specified object exists. Other flags are ignored.
|
|
defineTemplate(dt)
|
string
|
|
|
Puts a 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.
|
|
useTemplate(ut)
|
string
|
|
|
Force the command to use a command template other than
the current one.
|
|
parent(p)
|
string
|
|
|
The parent layout for this control.
|
|
enable(en)
|
boolean
|
|
|
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.
|
|
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.
|
|
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.
|
|
visible(vis)
|
boolean
|
|
|
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.
|
|
isObscured(io)
|
boolean
|
|
|
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)
|
boolean
|
|
|
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.
|
|
numberOfPopupMenus(npm)
|
boolean
|
|
|
Return the number of popup menus attached to this control.
|
|
popupMenuArray(pma)
|
boolean
|
|
|
Return the names of all the popup menus attached to this
control.
|
|
preventOverride(po)
|
boolean
|
|
|
If true, this flag disallows overriding the control's
attribute via the control's right mouse button menu.
|
|
annotation(ann)
|
string
|
|
|
Annotate the control with an extra string value.
|
|
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.
|
|
noBackground(nbg)
|
boolean
|
|
|
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.
|
|
enableBackground(ebg)
|
boolean
|
|
|
Enables the background color of the control.
|
|
docTag(dtg)
|
string
|
|
|
Add a documentation flag to the control. The documentation flag
has a directory structure like hierarchy.
Eg. -dt render/multiLister/createNode/material
|
|
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
"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'")
|
|
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 "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'")
|
|
fullPathName(fpn)
|
string
|
|
|
Return the full path name of the widget, which includes all the parents
|
|
numberOfChildren(nch)
|
boolean
|
|
|
Returns in an int the number of immediate children of the layout.
|
|
childArray(ca)
|
boolean
|
|
|
Returns a string array of the names of the layout's
immediate children.
|
|
borderVisible(bv)
|
boolean
|
|
|
Visibility of the border.
|
|
borderStyle(bs)
|
string
|
|
|
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.
|
|
collapse(cl)
|
boolean
|
|
|
Collapse state of the frame layout.
|
|
collapsable(cll)
|
boolean
|
|
|
Collapsibility of the frame layout.
|
|
label(l)
|
string
|
|
|
Label string for the frame layout.
|
|
labelVisible(lv)
|
boolean
|
|
|
Visibility of the frame label.
|
|
labelIndent(li)
|
int
|
|
|
Indentation for the frame label.
|
|
font(fn)
|
string
|
|
|
The font for the frame label. Valid values are
"boldLabelFont", "smallBoldLabelFont", "tinyBoldLabelFont",
"plainLabelFont", "smallPlainLabelFont", "obliqueLabelFont",
"smallObliqueLabelFont", "fixedWidthFont"
and "smallFixedWidthFont".
|
|
marginHeight(mh)
|
int
|
|
|
Vertical distance between the frame and its children.
|
|
marginWidth(mw)
|
int
|
|
|
Horizontal distance between the frame and its children.
|
|
collapseCommand(cc)
|
script
|
|
|
Command executed after the frame is collapsed.
|
|
expandCommand(ec)
|
script
|
|
|
Command executed after the frame is expanded.
|
|
preCollapseCommand(pcc)
|
script
|
|
|
Command executed just before the frame is collapsed.
|
|
preExpandCommand(pec)
|
script
|
|
|
Command executed just before the frame is expanded.
|
|
Flag can have multiple arguments, passed either as a tuple or a list.