Go to: Synopsis. Return value. Flags. Python examples.
promptDialog([backgroundColor=[float, float, float]], [button=string], [cancelButton=string], [defaultButton=string], [dismissString=string], [message=string], [messageAlign=string], [parent=string], [scrollableField=boolean], [style=string], [text=string], [title=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
promptDialog is undoable, queryable, and NOT editable.
The promptDialog command creates a modal dialog with a message to the
user, a text field in which the user may enter a response, and a
variable number of buttons to dismiss the dialog. The dialog is
dismissed when the user presses any button or chooses the
close item from the window menu. In the case where a button is
pressed then the name of the button selected is returned. If the
dialog is dismissed via the close item then the string returned is
specified by the -ds/dismissString flag.
The default behaviour when no arguments are specified is to create an
empty single button dialog.
To obtain the text entered by the user simply query
the -tx/text flag.
| string | Indicates how the dialog was dismissed. If a button is
pressed then the label of the button is returned. If the dialog is
closed then the value for the flag ds/dismissString is
returned. |
In query mode, return type is based on queried flag.
backgroundColor, button, cancelButton, defaultButton, dismissString, message, messageAlign, parent, scrollableField, style, text, title
| Long name (short name) |
Argument types |
Properties |
title(t)
|
string
|
|
|
|
message(m)
|
string
|
|
|
The message text appearing in the dialog.
|
|
messageAlign(ma)
|
string
|
|
|
Align the message left, center, or right.
|
|
text(tx)
|
string
|
|
|
|
scrollableField(sf)
|
boolean
|
|
|
By default a single line text field is used in the dialog.
Specify true for a multi-line scroll field.
|
|
button(b)
|
string
|
|
|
Create a button with the given string as it's text.
|
|
defaultButton(db)
|
string
|
|
|
The default button is activated by pressing the enter key.
Note that this flag does not create a button, it simply indicates
which button created via the -b/button flag shall respond
to the enter key.
|
|
cancelButton(cb)
|
string
|
|
|
The cancel button is activated by pressing the escape key.
Note that this flag does not create a button, it simply indicates
which button created via the -b/button flag shall respond
to the escape key.
|
|
dismissString(ds)
|
string
|
|
|
The string returned when the user selects the 'Close' item
from the Window Manager menu. If this flag is not set then the
string "dismiss" is returned.
|
|
parent(p)
|
string
|
|
|
Specify the parent window for the dialog. The dialog will
be centered on this window and raise and lower with it's parent.
By default, the dialog is not parented to a particular window and
is simply centered on the screen.
|
|
style(st)
|
string
|
|
|
Specify the type of input expected in the input field.
Vaid input types are "integer" "float" "text".
If this flag is not specified, we assume the input type is "text".
|
|
backgroundColor(bgc)
|
[float, float, float]
|
|
|
The background color of the dialog. The arguments correspond
to the red, green, and blue color components. Each component ranges
in value from 0.0 to 1.0. (Windows only flag)
|
|
|
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
# Create an OK/Cancel prompt dialog.
#
# +-+---------------------+
# |-| Rename Object |
# +-----------------------+
# | Enter Name: |
# | +-------------------+ |
# | | | |
# | | | |
# | +-------------------+ |
# +-----------------------+
# | +-------+ +--------+ |
# | | OK | | Cancel | |
# | +-------+ +--------+ |
# +-----------------------+
#
result = cmds.promptDialog(
title='Rename Object',
message='Enter Name:',
button=['OK', 'Cancel'],
defaultButton='OK',
cancelButton='Cancel',
dismissString='Cancel')
if result == 'OK':
text = cmds.promptDialog(query=True, text=True)