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 |
|
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)
|
|
clear(clr)
|
boolean
|
|
|
commandCompletion(cco)
|
boolean
|
|
|
Enable/disable command completion
|
|
copySelection(cp)
|
boolean
|
|
|
Copies the current selection from this field.
|
|
currentLine(cl)
|
uint
|
|
|
Sets/returns the current line which the cursor is on.
|
|
cutSelection(ct)
|
boolean
|
|
|
Cuts the current selection from this field.
|
|
execute(exc)
|
boolean
|
|
|
Executes the current selection. If there is no selection, all text is executed.
|
|
executeAll(exa)
|
boolean
|
|
|
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.
|
|
hasFocus(hf)
|
boolean
|
|
|
Whether this control is currently in focus.
|
|
hasSelection(hsl)
|
boolean
|
|
|
Whether this control currently has a selection or not.
|
|
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.
|
|
load(ld)
|
boolean
|
|
|
Prompts the user for a script to load into this field.
|
|
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.
|
|
numberOfLines(nl)
|
uint
|
|
|
Returns the total number of lines in the document.
|
|
objectPathCompletion(opc)
|
boolean
|
|
|
Enable/disable path completion
|
|
pasteSelection(pst)
|
boolean
|
|
|
Pastes text into this field at the current caret position.
|
|
redo(rd)
|
boolean
|
|
|
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 contens 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.
|
|
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)
|
boolean
|
|
|
Prompts to save the current selection to an item in the shelf.
|
|
searchAndSelect(sas)
|
boolean
|
|
|
Searches for (and selects) the sepecified 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)
|
boolean
|
|
|
selectedText(slt)
|
boolean
|
|
|
The text in the current selection range.
|
|
showLineNumbers(sln)
|
boolean
|
|
|
Shows/hides the line numbes column.
|
|
showTooltipHelp(sth)
|
boolean
|
|
|
Enable/disable tooltips in the command execution window
|
|
source(src)
|
boolean
|
|
|
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)
|
|
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)
|
boolean
|
|
|
The number of characters in this text field.
|
|
undo(ud)
|
boolean
|
|
|