cmdScrollFieldReporter

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

Synopsis

cmdScrollFieldReporter([clear=boolean], [copySelection=boolean], [cutSelection=boolean], [echoAllCommands=boolean], [filterSourceType=string], [hasFocus=boolean], [lineNumbers=boolean], [pasteSelection=boolean], [receiveFocusCommand=string], [saveSelection=string], [saveSelectionToShelf=boolean], [select=[int, int]], [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.

Flags

Long name (short name)	[argument types]	Properties
filterSourceType(fst)	string
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. In query mode, this flag needs a value.
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)	[int, int]
Selects text within a specified range.
clear(clr)	boolean
Clears the field.
text(t)	string
Replaces the field text with the given string. In query mode, this flag needs a value.
textLength(tl)	boolean
The number of characters in this text field. In query mode, this flag needs a value.
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. In query mode, this flag needs a value.
receiveFocusCommand(rfc)	string
Command executed when the field receives focus.
echoAllCommands(eac)	boolean
Echo all commands. (Global parameter, affects all command reporters) In query mode, this flag needs a value.
lineNumbers(ln)	boolean
Show line numbers (in Error/Warning messages). (Global parameter, affects all command reporters) In query mode, this flag needs a value.
stackTrace(st)	boolean
Show stack trace. (Global parameter, affects all command reporters) In query mode, this flag needs a value.
suppressResults(sr)	boolean
Suppress results. In query mode, this flag needs a value.
suppressInfo(si)	boolean
Suppress info. In query mode, this flag needs a value.
suppressWarnings(sw)	boolean
Suppress warnings. In query mode, this flag needs a value.
suppressErrors(se)	boolean
Suppress errors. In query mode, this flag needs a value.
suppressStackTrace(sst)	boolean
Suppress stack trace. In query mode, this flag needs a value.

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.

Return value

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()