Go to: Synopsis. Return value. Flags. Python examples.
cmdShell(
[string]
, [annotation=string], [backgroundColor=[float, float, float]], [clear=boolean], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [exists=boolean], [fullPathName=string], [height=int], [isObscured=boolean], [manage=boolean], [noBackground=boolean], [numberOfHistoryLines=int], [numberOfPopupMenus=boolean], [numberOfSavedLines=int], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [prompt=string], [useTemplate=string], [visible=boolean], [visibleChangeCommand=script], [width=int])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
cmdShell is undoable, queryable, and editable.
This command creates a scrolling field that behaves similar to
a unix shell for entering user input. You may specify the number
of lines that will be remembered by the field with
the -nsl/numberOfSavedLines flag. The default number of lines saved
is 100. The shellField also maintains a command history buffer.
You can specify the number of input lines that will be saved with
the -hlc/historyLineCount flag. The default size of this buffer is 10.
| string | Full path name to the control. |
In query mode, return type is based on queried flag.
annotation, backgroundColor, clear, defineTemplate, docTag, dragCallback, dropCallback, enable, enableBackground, exists, fullPathName, height, isObscured, manage, noBackground, numberOfHistoryLines, numberOfPopupMenus, numberOfSavedLines, parent, popupMenuArray, preventOverride, prompt, useTemplate, visible, visibleChangeCommand, width
| 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
|
|
prompt(pr)
|
string
|
|
|
The text that is used as a prompt.
|
|
clear(cl)
|
boolean
|
|
|
Erases all visible text, and also deletes any text that had
scrolled of the top of the field. After clearing the field
it will be blank, and you will not be able to scroll up to
see previous lines. This flag does not affect the command
history buffer, however.
|
|
numberOfSavedLines(nsl)
|
int
|
|
|
The total number of lines (the scrolled lines and
currently visible lines) that will be remembered by the field.
Any lines beyond this number will be lost, and the user will not
be able to review them by scrolling. Valid values are 1 through
32767. Any value less than 1 will be handled as if 1 was
specified. Similarly, any value greater than 32767 will be
handled as if 32767 was specified.
|
|
numberOfHistoryLines(nhl)
|
int
|
|
|
The number of input lines to be saved in the
command history buffer. You can cycle through this buffer by
pressing the up and down arrow keys. Valid values are 0 through
32767. Any value less than 0 will be handled as if 0 was
specified. Similarly, any value greater than 32767 will be
handled as if 32767 was specified.
|
|
|
Flag can appear in Create mode of command
|
Flag can appear in Edit mode of command
|
|
Flag can appear in Query mode of command
|
Flag can have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
import maya.cmds as cmds
# Delete the window if it already exists.
#
if cmds.window( 'ExampleWindow', exists=True):
cmds.deleteUI( 'ExampleWindow', window=True)
# Create a window containing a cmdShell and a couple buttons.
#
# Use a form layout to position the controls.
#
cmds.window( 'ExampleWindow', widthHeight=(300, 300) )
form = cmds.formLayout()
cmdShell = cmds.cmdShell()
clearButton = cmds.button(label='Clear', command=('cmds.cmdShell(\"' + cmdShell + '\", edit=True, clear=True)' ))
closeButton = cmds.button(label='Close', command=('cmds.deleteUI( "ExampleWindow", window=True )' ) )
# Set up the attachments.
#
cmds.formLayout( form, edit=True,
attachForm=((cmdShell, 'top', 0), (cmdShell, 'left', 0), (cmdShell, 'right', 0), (clearButton, 'left', 0),
(clearButton, 'bottom', 0), (closeButton, 'bottom', 0), (closeButton, 'right', 0)),
attachControl=(cmdShell, 'bottom', 0, clearButton),
attachNone=((clearButton, 'top'), (closeButton, 'top')),
attachPosition=((clearButton, 'right', 0, 50), (closeButton, 'left', 0, 50)))
cmds.showWindow( 'ExampleWindow' )