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

Synopsis

cmdScrollFieldReporter [-annotation string] [-backgroundColor float float float] [-clear] [-copySelection] [-cutSelection] [-defineTemplate string] [-docTag string] [-dragCallback script] [-dropCallback script] [-echoAllCommands boolean] [-enable boolean] [-enableBackground boolean] [-enableKeyboardFocus boolean] [-exists] [-filterSourceType string] [-fullPathName] [-hasFocus] [-height int] [-highlightColor float float float] [-isObscured] [-lineNumbers boolean] [-manage boolean] [-noBackground boolean] [-numberOfPopupMenus] [-parent string] [-pasteSelection] [-popupMenuArray] [-preventOverride boolean] [-receiveFocusCommand script] [-saveSelection string] [-saveSelectionToShelf] [-select uint uint] [-selectAll] [-stackTrace boolean] [-statusBarMessage string] [-suppressErrors boolean] [-suppressInfo boolean] [-suppressResults boolean] [-suppressStackTrace boolean] [-suppressWarnings boolean] [-text string] [-textLength] [-useTemplate string] [-visible boolean] [-visibleChangeCommand script] [-width int]

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

annotation, backgroundColor, clear, copySelection, cutSelection, defineTemplate, docTag, dragCallback, dropCallback, echoAllCommands, enable, enableBackground, enableKeyboardFocus, exists, filterSourceType, fullPathName, hasFocus, height, highlightColor, isObscured, lineNumbers, manage, noBackground, numberOfPopupMenus, parent, pasteSelection, popupMenuArray, preventOverride, receiveFocusCommand, saveSelection, saveSelectionToShelf, select, selectAll, stackTrace, statusBarMessage, suppressErrors, suppressInfo, suppressResults, suppressStackTrace, suppressWarnings, text, textLength, useTemplate, visible, visibleChangeCommand, width
Long name (short name) Argument types Properties
-annotation(-ann) string createqueryedit
Annotate the control with an extra string value.
-backgroundColor(-bgc) float float float createqueryedit
The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.
-clear(-clr) createedit
Clears the field.
-copySelection(-cp) createedit
Copies the current selection from this field.
-cutSelection(-ct) createedit
Cuts the current selection from this field.
-defineTemplate(-dt) string create
Puts the command in a mode where any other flags and arguments are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
-docTag(-dtg) string createqueryedit
Add a documentation flag to the control. The documentation flag has a directory structure. (e.g., -dt render/multiLister/createNode/material)
-dragCallback(-dgc) script createedit
Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:

global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods)

The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTRL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL, 3 == CTRL + SHIFT.

In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form:

def callbackName( dragControl, x, y, modifiers ):

The values of these arguments are the same as those for the MEL version above.

The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys "dragControl", "x", "y", "modifiers". The "dragControl" value is a string and the other values are integers (eg the callback string could be "print '%(dragControl)s %(x)d %(y)d %(modifiers)d'")

-dropCallback(-dpc) script createedit
Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form:

global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type)

The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link.

In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form:

def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ):

The values of these arguments are the same as those for the MEL version above.

The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys "dragControl", "dropControl", "messages", "x", "y", "type". The "dragControl" value is a string and the other values are integers (eg the callback string could be "print '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'")

-echoAllCommands(-eac) boolean createqueryedit
Echo all commands. (Global parameter, affects all command reporters)
-enable(-en) boolean createqueryedit
The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
-enableBackground(-ebg) boolean createqueryedit
Enables the background color of the control.
-enableKeyboardFocus(-ekf) boolean createqueryedit
If enabled, the user can navigate to the control with the tab key and select values with the keyboard or mouse. This flag would typically be used to turn off focus support from controls that get it by default, like Edit and List controls. If disabled, text in text fields can still be selected with the mouse but cannot be copied (except on Linux when "Middle Click Paste" is enabled).
-exists(-ex) create
Returns whether the specified object exists or not. Other flags are ignored.
-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.
-fullPathName(-fpn) query
Return the full path name of the widget, which includes all the parents.
-hasFocus(-hf) query
Whether this control is currently in focus.
-height(-h) int createqueryedit
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
-highlightColor(-hlc) float float float createqueryedit
The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
-isObscured(-io) query
Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's window is invisible or iconified.
-lineNumbers(-ln) boolean createqueryedit
Show line numbers (in Error/Warning messages). (Global parameter, affects all command reporters)
-manage(-m) boolean createqueryedit
Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
-noBackground(-nbg) boolean createedit
Clear/reset the control's background. Passing true means the background should not be drawn at all, false means the background should be drawn. The state of this flag is inherited by children of this control.
-numberOfPopupMenus(-npm) query
Return the number of popup menus attached to this control.
-parent(-p) string createquery
The parent layout for this control.
-pasteSelection(-pst) createedit
Pastes text into this field at the current caret position.
-popupMenuArray(-pma) query
Return the names of all the popup menus attached to this control.
-preventOverride(-po) boolean createqueryedit
If true, this flag prevents overriding the control's attribute via the control's right mouse button menu.
-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) 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) createedit
Selects all text.
-stackTrace(-st) boolean createqueryedit
Show stack trace. (Global parameter, affects all command reporters)
-statusBarMessage(-sbm) string createedit
Extra string to display in the status bar when the mouse is over the control.
-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) query
The number of characters in this text field.
-useTemplate(-ut) string create
Forces the command to use a command template other than the current one.
-visible(-vis) boolean createqueryedit
The visible state of the control. A control is created visible by default. Note that a control's actual appearance is also dependent on the visible state of its parent layout(s).
-visibleChangeCommand(-vcc) script createqueryedit
Command that gets executed when visible state of the control changes.
-width(-w) int createqueryedit
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
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 be used more than once in a command.

MEL examples

// this will create a tiny window with a command history reporter
window;
    columnLayout;
        cmdScrollFieldReporter -width 200 -height 100;
showWindow;