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

Synopsis

iconTextScrollList( [string] , [allowMultiSelection=boolean], [annotation=string], [append=string], [backgroundColor=[float, float, float]], [defineTemplate=string], [deselectAll=boolean], [docTag=string], [doubleClickCommand=script], [dragCallback=script], [dropCallback=script], [dropRectCallback=script], [enable=boolean], [enableBackground=boolean], [exists=boolean], [fullPathName=boolean], [height=int], [highlightColor=[float, float, float]], [isObscured=boolean], [itemAt=[int, int]], [itemTextColor=[int, float, float, float]], [manage=boolean], [noBackground=boolean], [numberOfPopupMenus=boolean], [numberOfRows=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [removeAll=boolean], [selectCommand=script], [selectIndexedItem=int], [selectItem=string], [useTemplate=string], [visible=boolean], [visibleChangeCommand=script], [visualRectAt=[int, int]], [width=int])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

iconTextScrollList is undoable, queryable, and editable.

This command creates/edits/queries a text scrolling list. The list can be in single select mode where only one item at at time is selected, or in multi-select mode where many items may be selected.

Return value

stringFull path name to the control.

In query mode, return type is based on queried flag.

Flags

allowMultiSelection, annotation, append, backgroundColor, defineTemplate, deselectAll, docTag, doubleClickCommand, dragCallback, dropCallback, dropRectCallback, enable, enableBackground, exists, fullPathName, height, highlightColor, isObscured, itemAt, itemTextColor, manage, noBackground, numberOfPopupMenus, numberOfRows, parent, popupMenuArray, preventOverride, removeAll, selectCommand, selectIndexedItem, selectItem, useTemplate, visible, visibleChangeCommand, visualRectAt, width
Long name (short name) Argument types Properties
allowMultiSelection(ams) boolean createqueryedit
Specify multi or single selection mode.
annotation(ann) string createqueryedit
Annotate the control with an extra string value.
append(a) string createeditmultiuse
Add an item to the end of the list.
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.
defineTemplate(dt) string create
Puts the command in a mode where any other flags and args 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.
deselectAll(da) boolean createedit
Deselect all items.
docTag(dtg) string createqueryedit
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
doubleClickCommand(dcc) script createedit
Specify the command to be executed when an item is double clicked.
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 CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + 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'")

dropRectCallback(drc) script edit
Adds a callback that is called when a drag and drop operation is hovering above the drop site. It returns the shape of the rectangle to be drawn to highlight the entry, if the control can receive the dropped data. The MEL version of the callback is of the form:

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

The return value is an array of size 4, with the parameters, in order, being the left and top coordinates of the rectangle to be drawn, followed by the width and height. This functionality is currently only implemented in MEL.

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.
exists(ex) boolean create
Returns whether the specified object exists or not. Other flags are ignored.
fullPathName(fpn) boolean query
Return the full path name of the widget, which includes all the parents
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) boolean 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.
itemAt(ia) [int, int] query
Return the name of the item, if any, located at given point

In query mode, this flag needs a value.
itemTextColor(itc) [int, float, float, float] createeditmultiuse
Set the text color of the item at the given index. Arguments are: index, red, green, and blue. Indices are 1-based. Each color component ranges in value from 0.0 to 1.0.
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) boolean query
Return the number of popup menus attached to this control.
numberOfRows(nr) boolean query
Number of visible rows.
parent(p) string createquery
The parent layout for this control.
popupMenuArray(pma) boolean query
Return the names of all the popup menus attached to this control.
preventOverride(po) boolean createqueryedit
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
removeAll(ra) boolean createedit
Remove all items.
selectCommand(sc) script createedit
Specify the command to be executed when an item is selected.
selectIndexedItem(sii) int createqueryeditmultiuse
Select the indexed item. Indices are 1-based.
selectItem(si) string createqueryeditmultiuse
Select the item that contains the specified text.
useTemplate(ut) string create
Force 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.
visualRectAt(vra) [int, int] query
Return the visual rectangle of the item, if any, located at given point. The result is a an array of 4 integers, in local coordinates, describing the rectangle, in the following order: left, top, width, height.

In query mode, this flag needs a value.
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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

cmds.window()
cmds.paneLayout()
cmds.iconTextScrollList(allowMultiSelection=True, append=('one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten', 'eleven', 'twelve', 'thirteen', 'fourteen', 'fifteen'), selectItem='six' )
cmds.showWindow()