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

Synopsis

cmdScrollFieldReporter([clear=boolean], [copySelection=boolean], [cutSelection=boolean], [echoAllCommands=boolean], [filterSourceType=string], [hasFocus=boolean], [lineNumbers=boolean], [pasteSelection=boolean], [receiveFocusCommand=script], [saveSelection=string], [saveSelectionToShelf=boolean], [select=[uint, uint]], [selectAll=boolean], [stackTrace=boolean], [suppressErrors=boolean], [suppressInfo=boolean], [suppressResults=boolean], [suppressStackTrace=boolean], [suppressWarnings=boolean], [text=string], [textLength=boolean])

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

cmdScrollFieldReporter is undoable, queryable, and editable.

A script editor reporter control used to receive and display the history of processed commmands.

Return value

stringThe name of the reporter control

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

Flags

clear, copySelection, cutSelection, echoAllCommands, filterSourceType, hasFocus, lineNumbers, pasteSelection, receiveFocusCommand, saveSelection, saveSelectionToShelf, select, selectAll, stackTrace, suppressErrors, suppressInfo, suppressResults, suppressStackTrace, suppressWarnings, text, textLength
Long name (short name) Argument types Properties
clear(clr) boolean createedit
Clears the field.
copySelection(cp) boolean createedit
Copies the current selection from this field.
cutSelection(ct) boolean createedit
Cuts the current selection from this field.
echoAllCommands(eac) boolean createqueryedit
Echo all commands. (Global parameter, affects all command reporters)
filterSourceType(fst) string createqueryedit
Filters the specified source type from showing in this command reporter. Currently supports either "mel", "python", or "" (default). Setting the filter to the empty string ("") will remove all filtering and show both "mel" and "python" results.
hasFocus(hf) boolean query
Whether this control is currently in focus.
lineNumbers(ln) boolean createqueryedit
Show line numbers (in Error/Warning messages). (Global parameter, affects all command reporters)
pasteSelection(pst) boolean createedit
Pastes text into this field at the current caret position.
receiveFocusCommand(rfc) script createedit
Command executed when the field receives focus.
saveSelection(sv) string createedit
Prompts to save the current selection to a file. The default filename prompt will be prepended with the given string.
saveSelectionToShelf(svs) boolean createedit
Prompts to save the current selection to an item in the shelf.
select(sl) [uint, uint] createedit
Selects text within a specified range.
selectAll(sla) boolean createedit
Selects all text.
stackTrace(st) boolean createqueryedit
Show stack trace. (Global parameter, affects all command reporters)
suppressErrors(se) boolean createqueryedit
Suppress errors.
suppressInfo(si) boolean createqueryedit
Suppress info.
suppressResults(sr) boolean createqueryedit
Suppress results.
suppressStackTrace(sst) boolean createqueryedit
Suppress stack trace.
suppressWarnings(sw) boolean createqueryedit
Suppress warnings.
text(t) string createqueryedit
Replaces the field text with the given string.
textLength(tl) boolean query
The number of characters in this text field.
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 command history reporter
cmds.window()
cmds.columnLayout()
cmds.cmdScrollFieldReporter(width=200, height=100)
cmds.showWindow()