cmdScrollFieldExecuter is undoable, queryable, and editable.
A script editor executer control used to issue script commands to
Maya.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
|
-annotation(-ann)
|
string
|
|
|
Annotate the control with an extra string value.
|
|
-appendText(-at)
|
string
|
|
|
Appends text to the end of this field.
|
|
-autoCloseBraces(-acb)
|
boolean
|
|
|
Specifies whether a closing brace should automatically be added when
hitting enter after an opening brace. (default on)
|
|
-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.
|
|
-clear(-clr)
|
|
|
|
-commandCompletion(-cco)
|
boolean
|
|
|
Enable/disable command completion
|
|
-copySelection(-cp)
|
|
|
|
Copies the current selection from this field.
|
|
-currentLine(-cl)
|
uint
|
|
|
Sets/returns the current line which the cursor is on.
|
|
-cutSelection(-ct)
|
|
|
|
Cuts the current selection from this field.
|
|
-defineTemplate(-dt)
|
string
|
|
|
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)
|
string
|
|
|
Add a documentation flag to the control. The documentation flag
has a directory structure.
(e.g., -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 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
"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'")
|
|
-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.
|
|
-enableBackground(-ebg)
|
boolean
|
|
|
Enables the background color of the control.
|
|
-enableKeyboardFocus(-ekf)
|
boolean
|
|
|
If enabled, the user can navigate to the control with the tab key and select values with the keyboard or mouse.
This flag would typically be used to turn off focus support from controls that get it by default, like Edit and List controls.
If disabled, text in text fields can still be selected with the mouse but cannot be copied (except on Linux when "Middle Click Paste" is enabled).
|
|
-execute(-exc)
|
|
|
|
Executes the current selection. If there is no selection, all text is executed.
|
|
-executeAll(-exa)
|
|
|
|
-exists(-ex)
|
|
|
|
Returns whether the
specified object exists or not. Other flags are ignored.
|
|
-fileChangedCommand(-fcc)
|
script
|
|
|
Only valid when this field contains a file.
Sets a script which will be called whenever the file is externally modified,
renamed or removed from disk.
In MEL, the function should have the following signature:
proc fileChanged(string $file)
|
|
-filename(-fn)
|
|
|
|
Returns the full path + filename of the script which was either loaded or saved.
If there isn't one returns an empty string.
|
|
-filterKeyPress(-fkp)
|
script
|
|
|
Sets a script which will be called to handle key-press events.
The function should have the following signature:
proc int filterKeyPress(int $modifiers, string $key)
modifiers: a bit mask where Shift is bit 1, Ctrl is bit 3,
Alt is bit 4, and bit 5 is the 'Windows' key on Windows keyboards
and the Command key on Mac keyboards.
key: Specifies what key was pressed. The key is either a single
ascii character or one of the keyword strings for the special
keyboard characters. For example:
Up, Down, Right, Left,
Home, End, Page_Up, Page_Down, Insert
Return, Space
F1 to F12
The function should return 1 to indicate that they key event has been
handled, and 0 to indicate that it has not been handled.
|
|
-fullPathName(-fpn)
|
|
|
|
Return the full path name of the widget, which includes all the parents.
|
|
-hasFocus(-hf)
|
|
|
|
Whether this control is currently in focus.
|
|
-hasSelection(-hsl)
|
|
|
|
Whether this control currently has a selection or not.
|
|
-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.
|
|
-highlightColor(-hlc)
|
float float float
|
|
|
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.
|
|
-insertText(-it)
|
string
|
|
|
Inserts the specified text into the position under the cursor,
replacing any currently selected text. The selection and cursor
position can be set using the select flag. Appends text to the
end of this field.
|
|
-isObscured(-io)
|
|
|
|
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.
|
|
-load(-ld)
|
|
|
|
Prompts the user for a script to load into this field. The loaded filename becomes
associated with this executer field and saving will save directly to the file.
|
|
-loadContents(-ldc)
|
string
|
|
|
Loads the contents of the specified filename into this field. The path and extension for this filename
is provided internally. This command is only intended for loading the contents of this executer field from a previous
instance of this executer field.
|
|
-loadFile(-ldf)
|
string
|
|
|
If the provided string is a fully specified file path, then attempts to load the
file contents into this field. If the string is empty or not valid then prompts
the user for a script to load into this field. In both cases the filename becomes
associated with this executer field and saving will save directly to the file.
|
|
-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.
|
|
-modificationChangedCommand(-mcc)
|
script
|
|
|
Sets a script which will be called whenever the content of this field changes in
a way that affects the modification state.
In MEL, the function should have the following signature:
proc modificationChanged(int $m)
If $m is true, the field has been modified; otherwise it is false.
|
|
-modified(-mod)
|
|
|
|
Sets or returns whether the field has been modified.
|
|
-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.
|
|
-numberOfLines(-nl)
|
uint
|
|
|
Returns the total number of lines in the document.
|
|
-numberOfPopupMenus(-npm)
|
|
|
|
Return the number of popup menus attached to this control.
|
|
-objectPathCompletion(-opc)
|
boolean
|
|
|
Enable/disable path completion
|
|
-parent(-p)
|
string
|
|
|
The parent layout for this control.
|
|
-pasteSelection(-pst)
|
|
|
|
Pastes text into this field at the current caret position.
|
|
-popupMenuArray(-pma)
|
|
|
|
Return the names of all the popup menus attached to this
control.
|
|
-preventOverride(-po)
|
boolean
|
|
|
If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu.
|
|
-redo(-rd)
|
|
|
|
-removeStoredContents(-rsc)
|
string
|
|
|
Removes the stored contents of this field with the specified filename. The path and extension for the file is
provided internally. This command is only intended for removing previously stored contents of this executer field.
|
|
-replaceAll(-rpa)
|
string string
|
|
|
Replaces all instances of the first string in the field text with the
second string. The case sensitivity of this operation is set with the
-searchMatchCase flag.
|
|
-saveFile(-svf)
|
string
|
|
|
Saves the entire script contents of this field directly to the specified file path.
|
|
-saveSelection(-sv)
|
string
|
|
|
Prompts to save the current selection to a file. The default filename prompt will be prepended with the given string.
|
|
-saveSelectionToShelf(-svs)
|
|
|
|
Prompts to save the current selection to an item in the shelf.
|
|
-searchAndSelect(-sas)
|
|
|
|
Searches for (and selects) the specified search string using the
specified search options.
|
|
-searchDown(-sd)
|
boolean
|
|
|
Specifies whether to search from the cursor down, or up.
|
|
-searchMatchCase(-smc)
|
boolean
|
|
|
Specifies whether the search is to be case sensitive or not.
|
|
-searchString(-ss)
|
string
|
|
|
Specifies the string to search for.
|
|
-searchWraps(-sw)
|
boolean
|
|
|
Specifies whether the search should wrap around.
|
|
-select(-sl)
|
uint uint
|
|
|
Selects text within a specified range.
|
|
-selectAll(-sla)
|
|
|
|
-selectedText(-slt)
|
|
|
|
The text in the current selection range.
|
|
-showLineNumbers(-sln)
|
boolean
|
|
|
Shows/hides the line numbes column.
|
|
-showTabsAndSpaces(-sts) 2023
|
boolean
|
|
|
Visually show tab and space indicators. (default off)
|
|
-showTooltipHelp(-sth)
|
boolean
|
|
|
Enable/disable tooltips in the command execution window
|
|
-source(-src)
|
|
|
|
Prompts the user for a script to source (execute without loading).
|
|
-sourceType(-st)
|
string
|
|
|
Sets the source type for this command executer field.
Valid values are "mel" (enabled by default)
and "python".
|
|
-spacesPerTab(-spt)
|
uint
|
|
|
Specifies the number of spaces equivalent to one tab stop. (default 4)
|
|
-statusBarMessage(-sbm)
|
string
|
|
|
Extra string to display in the status bar when the mouse is over the control.
|
|
-storeContents(-stc)
|
string
|
|
|
If the provided string is a fully specified file path, then attempts to store the contents of this field
to that path. Otherwise, uses the provided string as a filename only and uses an internally generated
path and extension for the file, as used by the -loadContents and -removeStoredContents flags.
In both cases, a new unique filename will be generated if the specified name exists.
Returns the filename of the file saved upon completion, and an empty string otherwise.
|
|
-tabsForIndent(-tfi)
|
boolean
|
|
|
Specifies whether tab characters should be inserted when indenting. (default on)
|
|
-text(-t)
|
string
|
|
|
Replaces the field text with the given string.
|
|
-textLength(-tl)
|
|
|
|
The number of characters in this text field.
|
|
-undo(-ud)
|
|
|
|
-useTemplate(-ut)
|
string
|
|
|
Forces the command to use a command template other than
the current one.
|
|
-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.
|
|
-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.
|
|