pymel.core.windows.cmdScrollFieldReporter

cmdScrollFieldReporter(*args, **kwargs)

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

Flags:
Long name (short name) Argument Types Properties
annotation (ann) unicode  
   
backgroundColor (bgc) float, float, float  
   
clear (clr) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Clears the field.
copySelection (cp) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Copies the current selection from this field.
cutSelection (ct) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Cuts the current selection from this field.
defineTemplate (dt) unicode  
   
docTag (dtg) unicode  
   
dragCallback (dgc) callable  
   
dropCallback (dpc) callable  
   
echoAllCommands (eac) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Echo all commands. (Global parameter, affects all command reporters)
enable (en) bool  
   
enableBackground (ebg) bool  
   
exists (ex) bool  
   
filterSourceType (fst) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 meland pythonresults.

fullPathName (fpn) bool  
   
hasFocus (hf) bool ../../../_images/query.gif
 
Whether this control is currently in focus.
height (h) int  
   
isObscured (io) bool  
   
lineNumbers (ln) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Show line numbers (in Error/Warning messages). (Global parameter, affects all command reporters)
manage (m) bool  
   
numberOfPopupMenus (npm) bool  
   
parent (p) unicode  
   
pasteSelection (pst) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Pastes text into this field at the current caret position.
popupMenuArray (pma) bool  
   
preventOverride (po) bool  
   
receiveFocusCommand (rfc) callable ../../../_images/create.gif ../../../_images/edit.gif
 
Command executed when the field receives focus.
saveSelection (sv) unicode ../../../_images/create.gif ../../../_images/edit.gif
 
Prompts to save the current selection to a file. The default filename prompt will be prepended with the given string.
saveSelectionToShelf (svs) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Prompts to save the current selection to an item in the shelf.
select (sl) int, int ../../../_images/create.gif ../../../_images/edit.gif
 
Selects text within a specified range.
selectAll (sla) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Selects all text.
stackTrace (st) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Show stack trace. (Global parameter, affects all command reporters)
suppressErrors (se) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Suppress errors.
suppressInfo (si) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Suppress info.
suppressResults (sr) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Suppress results.
suppressStackTrace (sst) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Suppress stack trace. Flag can have multiple arguments, passed either as a tuple or a list.
suppressWarnings (sw) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Suppress warnings.
text (t) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Replaces the field text with the given string.
textLength (tl) bool ../../../_images/query.gif
 
The number of characters in this text field.
useTemplate (ut) unicode  
   
visible (vis) bool  
   
visibleChangeCommand (vcc) callable  
   
width (w) int  
   

Derived from mel command maya.cmds.cmdScrollFieldReporter

Example:

import pymel.core as pm

# this will create a tiny window with a command history reporter
pm.window()
# Result: ui.Window('window1') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout15') #
pm.cmdScrollFieldReporter(width=200, height=100)
# Result: ui.CmdScrollFieldReporter('window1|columnLayout15|cmdScrollFieldReporter2') #
pm.showWindow()

Previous topic

pymel.core.windows.cmdScrollFieldExecuter

Next topic

pymel.core.windows.cmdShell

Core

Core Modules

Other Modules

This Page