pymel.core.uitypes.CmdScrollFieldExecuter

class CmdScrollFieldExecuter

class counterpart of mel function cmdScrollFieldExecuter

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

appendText(val=True, **kwargs)

Appends text to the end of this field.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

clear(val=True, **kwargs)

Clears the field.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

copySelection(val=True, **kwargs)

Copies the current selection from this field.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

cutSelection(val=True, **kwargs)

Cuts the current selection from this field.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

execute(val=True, **kwargs)

Executes the current selection. If there is no selection, all text is executed.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

executeAll(val=True, **kwargs)

Executes all text.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getAutoCloseBraces(**kwargs)

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.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getCommandCompletion(**kwargs)

Enable/disable command completion

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getCurrentLine(**kwargs)

Sets/returns the current line which the cursor is on.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getFilterKeyPress(**kwargs)

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.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getHasFocus(**kwargs)

Whether this control is currently in focus.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getHasSelection(**kwargs)

Whether this control currently has a selection or not.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getNumberOfLines(**kwargs)

Returns the total number of lines in the document.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getObjectPathCompletion(**kwargs)

Enable/disable path completion

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getSearchAndSelect(**kwargs)

Searches for (and selects) the sepecified search string using the specified search options.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getSearchDown(**kwargs)

Specifies whether to search from the cursor down, or up.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getSearchMatchCase(**kwargs)

Specifies whether the search is to be case sensitive or not.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getSearchString(**kwargs)

Specifies the string to search for.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getSearchWraps(**kwargs)

Specifies whether the search should wrap around.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getSelectedText(**kwargs)

The text in the current selection range.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getShowLineNumbers(**kwargs)

Shows/hides the line numbes column.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getShowTooltipHelp(**kwargs)

Enable/disable tooltips in the command execution window

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getSourceType(**kwargs)

Sets the source type for this command executer field. Valid values are “mel” (enabled by default), and “python”.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getSpacesPerTab(**kwargs)

Specifies the number of spaces equivalent to one tab stop. (default 4)

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getTabsForIndent(**kwargs)

Specifies whether tab characters should be inserted when indenting. (default on)

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getText(**kwargs)

Replaces the field text with the given string.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

getTextLength(**kwargs)

The number of characters in this text field.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

insertText(val=True, **kwargs)

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.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

load(val=True, **kwargs)

Prompts the user for a script to load into this field.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

loadContents(val=True, **kwargs)

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.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

pasteSelection(val=True, **kwargs)

Pastes text into this field at the current caret position.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

redo(val=True, **kwargs)

Redo the last operation.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

removeStoredContents(val=True, **kwargs)

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.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

replaceAll(val=True, **kwargs)

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.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

saveSelection(val=True, **kwargs)

Prompts to save the current selection to a file. The default filename prompt will be prepended with the given string.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

saveSelectionToShelf(val=True, **kwargs)

Prompts to save the current selection to an item in the shelf.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

select(val=True, **kwargs)

Selects text within a specified range.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

selectAll(val=True, **kwargs)

Selects all text.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setAutoCloseBraces(val=True, **kwargs)

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.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setCommandCompletion(val=True, **kwargs)

Enable/disable command completion

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setCurrentLine(val=True, **kwargs)

Sets/returns the current line which the cursor is on.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setFilterKeyPress(val=True, **kwargs)

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.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setObjectPathCompletion(val=True, **kwargs)

Enable/disable path completion

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setSearchDown(val=True, **kwargs)

Specifies whether to search from the cursor down, or up.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setSearchMatchCase(val=True, **kwargs)

Specifies whether the search is to be case sensitive or not.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setSearchString(val=True, **kwargs)

Specifies the string to search for.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setSearchWraps(val=True, **kwargs)

Specifies whether the search should wrap around.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setShowLineNumbers(val=True, **kwargs)

Shows/hides the line numbes column.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setShowTooltipHelp(val=True, **kwargs)

Enable/disable tooltips in the command execution window

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setSpacesPerTab(val=True, **kwargs)

Specifies the number of spaces equivalent to one tab stop. (default 4)

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setTabsForIndent(val=True, **kwargs)

Specifies whether tab characters should be inserted when indenting. (default on)

Derived from mel command maya.cmds.cmdScrollFieldExecuter

setText(val=True, **kwargs)

Replaces the field text with the given string.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

source(val=True, **kwargs)

Prompts the user for a script to source (execute without loading).

Derived from mel command maya.cmds.cmdScrollFieldExecuter

storeContents(val=True, **kwargs)

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.

Derived from mel command maya.cmds.cmdScrollFieldExecuter

undo(val=True, **kwargs)

Undo the last operation.

Derived from mel command maya.cmds.cmdScrollFieldExecuter