pymel.core.windows.cmdScrollFieldExecuter

cmdScrollFieldExecuter(*args, **kwargs)

A script editor executer control used to issue script commands to Maya.

Flags:

Long name (short name)		Argument Types	Properties
annotation (ann)		unicode
appendText (at)		unicode
	Appends text to the end of this field.
autoCloseBraces (acb)		bool
	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 commandFlag can have multiple arguments, passed either as a tuple or a list.
backgroundColor (bgc)		float, float, float
clear (clr)		bool
	Clears the field.
commandCompletion (cco)		bool
	Enable/disable command completion
copySelection (cp)		bool
	Copies the current selection from this field.
currentLine (cl)		int
	Sets/returns the current line which the cursor is on.
cutSelection (ct)		bool
	Cuts the current selection from this field.
defineTemplate (dt)		unicode
docTag (dtg)		unicode
dragCallback (dgc)		callable
dropCallback (dpc)		callable
enable (en)		bool
enableBackground (ebg)		bool
execute (exc)		bool
	Executes the current selection. If there is no selection, all text is executed.
executeAll (exa)		bool
	Executes all text.
exists (ex)		bool
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 F12The function should return 1 to indicate that they key event has been handled, and 0 to indicate that it has not been handled.
fullPathName (fpn)		bool
hasFocus (hf)		bool
	Whether this control is currently in focus.
hasSelection (hsl)		bool
	Whether this control currently has a selection or not.
height (h)		int
indentSelection (isl)		bool
insertText (it)		unicode
	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 selectflag. Appends text to the end of this field.
isObscured (io)		bool
load (ld)		bool
	Prompts the user for a script to load into this field.
loadContents (ldc)		unicode
	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.
manage (m)		bool
numberOfLines (nl)		int
	Returns the total number of lines in the document.
numberOfPopupMenus (npm)		bool
objectPathCompletion (opc)		bool
	Enable/disable path completion
parent (p)		unicode
pasteSelection (pst)		bool
	Pastes text into this field at the current caret position.
popupMenuArray (pma)		bool
preventOverride (po)		bool
receiveFocusCommand (rfc)		callable
redo (rd)		bool
	Redo the last operation.
removeStoredContents (rsc)		unicode
	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)		unicode, unicode
	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)		unicode
	Prompts to save the current selection to a file. The default filename prompt will be prepended with the given string.
saveSelectionToShelf (svs)		bool
	Prompts to save the current selection to an item in the shelf.
searchAndSelect (sas)		bool
	Searches for (and selects) the sepecified search string using the specified search options.
searchDown (sd)		bool
	Specifies whether to search from the cursor down, or up.
searchMatchCase (smc)		bool
	Specifies whether the search is to be case sensitive or not.
searchString (ss)		unicode
	Specifies the string to search for.
searchWraps (sw)		bool
	Specifies whether the search should wrap around.
select (sl)		int, int
	Selects text within a specified range.
selectAll (sla)		bool
	Selects all text.
selectedText (slt)		bool
	The text in the current selection range.
showLineNumbers (sln)		bool
	Shows/hides the line numbes column.
showTooltipHelp (sth)		bool
	Enable/disable tooltips in the command execution window
source (src)		bool
	Prompts the user for a script to source (execute without loading).
sourceType (st)		unicode
	Sets the source type for this command executer field. Valid values are “mel” (enabled by default), and “python”.
spacesPerTab (spt)		int
	Specifies the number of spaces equivalent to one tab stop. (default 4)
storeContents (stc)		unicode
	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)		bool
	Specifies whether tab characters should be inserted when indenting. (default on)
text (t)		unicode
	Replaces the field text with the given string.
textLength (tl)		bool
	The number of characters in this text field.
undo (ud)		bool
	Undo the last operation.
unindentSelection (usl)		bool
useTemplate (ut)		unicode
visible (vis)		bool
visibleChangeCommand (vcc)		callable
width (w)		int

Derived from mel command maya.cmds.cmdScrollFieldExecuter

Example:

import pymel.core as pm

import maya.cmds as cmds

# this will create a tiny window with a Mel command executer.
pm.window()
# Result: ui.Window('window1') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout13') #
pm.cmdScrollFieldExecuter(width=200, height=100)
# Result: ui.CmdScrollFieldExecuter('window1|columnLayout13|cmdScrollFieldExecuter4') #
pm.showWindow()

# this will create a tiny window with a Python command executer.
pm.window()
# Result: ui.Window('window2') #
pm.columnLayout()
# Result: ui.ColumnLayout('window2|columnLayout14') #
pm.cmdScrollFieldExecuter(width=200, height=100, sourceType="python")
# Result: ui.CmdScrollFieldExecuter('window2|columnLayout14|cmdScrollFieldExecuter5') #
pm.showWindow()