cmdScrollFieldExecuter

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

cmdScrollFieldExecuter([appendText=string], [autoCloseBraces=boolean], [clear=boolean], [commandCompletion=boolean], [copySelection=boolean], [currentLine=uint], [cutSelection=boolean], [execute=boolean], [executeAll=boolean], [filterKeyPress=script], [hasFocus=boolean], [hasSelection=boolean], [insertText=string], [load=boolean], [loadContents=string], [numberOfLines=uint], [objectPathCompletion=boolean], [pasteSelection=boolean], [redo=boolean], [removeStoredContents=string], [replaceAll=[string, string]], [saveSelection=string], [saveSelectionToShelf=boolean], [searchAndSelect=boolean], [searchDown=boolean], [searchMatchCase=boolean], [searchString=string], [searchWraps=boolean], [select=[uint, uint]], [selectAll=boolean], [selectedText=boolean], [showLineNumbers=boolean], [showTooltipHelp=boolean], [source=boolean], [sourceType=string], [spacesPerTab=uint], [storeContents=string], [tabsForIndent=boolean], [text=string], [textLength=boolean], [undo=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

cmdScrollFieldExecuter is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
load(ld)	boolean
Prompts the user for a script to load into this field.
source(src)	boolean
Prompts the user for a script to source (execute without loading).
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.
selectAll(sla)	boolean
Selects all text.
select(sl)	[uint, uint]
Selects text within a specified range.
hasSelection(hsl)	boolean
Whether this control currently has a selection or not.
selectedText(slt)	boolean
The text in the current selection range.
clear(clr)	boolean
Clears the field.
text(t)	string
Replaces the field text with the given string.
textLength(tl)	boolean
The number of characters in this text field.
cutSelection(ct)	boolean
Cuts the current selection from this field.
copySelection(cp)	boolean
Copies the current selection from this field.
pasteSelection(pst)	boolean
Pastes text into this field at the current caret position.
hasFocus(hf)	boolean
Whether this control is currently in focus.
undo(ud)	boolean
Undo the last operation.
redo(rd)	boolean
Redo the last operation.
execute(exc)	boolean
Executes the current selection. If there is no selection, all text is executed.
executeAll(exa)	boolean
Executes all text.
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.
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.
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.
appendText(at)	string
Appends text to the end of this field.
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.
sourceType(st)	string
Sets the source type for this command executer field. Valid values are "mel" (enabled by default), and "python".
showLineNumbers(sln)	boolean
Shows/hides the line numbes column.
commandCompletion(cco)	boolean
Enable/disable command completion
objectPathCompletion(opc)	boolean
Enable/disable path completion
showTooltipHelp(sth)	boolean
Enable/disable tooltips in the command execution window
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.
searchWraps(sw)	boolean
Specifies whether the search should wrap around.
searchString(ss)	string
Specifies the string to search for.
searchAndSelect(sas)	boolean
Searches for (and selects) the sepecified search string using the specified search options.
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.
currentLine(cl)	uint
Sets/returns the current line which the cursor is on.
numberOfLines(nl)	uint
Returns the total number of lines in the document.
spacesPerTab(spt)	uint
Specifies the number of spaces equivalent to one tab stop. (default 4)
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.
tabsForIndent(tfi)	boolean
Specifies whether tab characters should be inserted when indenting. (default on)
autoCloseBraces(acb)	boolean
Specifies whether a closing brace should automatically be added when hitting enter after an opening brace. (default on)

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.

Python examples

import maya.cmds as cmds

# this will create a tiny window with a Mel command executer.
cmds.window()
cmds.columnLayout()
cmds.cmdScrollFieldExecuter(width=200, height=100)
cmds.showWindow()

# this will create a tiny window with a Python command executer.
cmds.window()
cmds.columnLayout()
cmds.cmdScrollFieldExecuter(width=200, height=100, sourceType="python")
cmds.showWindow()