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

Synopsis

textScrollList( [string] , [allItems=boolean], [allowAutomaticSelection=boolean], [allowMultiSelection=boolean], [annotation=string], [append=string], [appendPosition=[int, string]], [backgroundColor=[float, float, float]], [defineTemplate=string], [deleteKeyCommand=script], [deselectAll=boolean], [deselectIndexedItem=int], [deselectItem=string], [docTag=string], [doubleClickCommand=script], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [exists=boolean], [font=string], [fullPathName=string], [height=int], [isObscured=boolean], [lineFont=[int, string]], [manage=boolean], [noBackground=boolean], [numberOfItems=boolean], [numberOfPopupMenus=boolean], [numberOfRows=int], [numberOfSelectedItems=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [removeAll=boolean], [removeIndexedItem=int], [removeItem=string], [selectCommand=script], [selectIndexedItem=int], [selectItem=string], [selectUniqueTagItem=string], [showIndexedItem=int], [uniqueTag=string], [useTemplate=string], [visible=boolean], [visibleChangeCommand=script], [width=int])

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

textScrollList 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.

Note: The -dgc/dragCallback flag works only on Windows.

Return value

stringFull path name to the control.

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

Flags

allItems, allowAutomaticSelection, allowMultiSelection, annotation, append, appendPosition, backgroundColor, defineTemplate, deleteKeyCommand, deselectAll, deselectIndexedItem, deselectItem, docTag, doubleClickCommand, dragCallback, dropCallback, enable, enableBackground, exists, font, fullPathName, height, isObscured, lineFont, manage, noBackground, numberOfItems, numberOfPopupMenus, numberOfRows, numberOfSelectedItems, parent, popupMenuArray, preventOverride, removeAll, removeIndexedItem, removeItem, selectCommand, selectIndexedItem, selectItem, selectUniqueTagItem, showIndexedItem, uniqueTag, useTemplate, visible, visibleChangeCommand, width
Long name (short name) Argument types Properties
exists(ex) boolean create
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
defineTemplate(dt) string create
Puts a 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.
useTemplate(ut) string create
Force the command to use a command template other than the current one.
parent(p) string createquery
The parent layout for this control.
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.
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.
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.
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.
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.
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.
numberOfPopupMenus(npm) boolean query
Return the number of popup menus attached to 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.
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.
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.
enableBackground(ebg) boolean createqueryedit
Enables the background color of the control.
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
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'")

fullPathName(fpn) string query
Return the full path name of the widget, which includes all the parents
append(a) string createeditmultiuse
Add an item to the end of the list.
appendPosition(ap) [int, string] createeditmultiuse
Append an item at the specified position. The position is a 1-based index.
allItems(ai) boolean query
All the items.
allowAutomaticSelection(aas) boolean createqueryedit
Specify automatic selection mode. When automaticSelection is on each item that the mouse is over (during dragging once an item has been selected) will be selected. Thus, if -sc/selectCommand someCommand is set, someCommand will be called for each selected item. If -aas/allowAutomaticSelection is off, then only the item selected when the mouse button is up will be the selected item, so -sc/selectCommand someCommand is only called once if it is set.
allowMultiSelection(ams) boolean createqueryedit
Specify multi or single selection mode.
doubleClickCommand(dcc) script createedit
Specify the command to be executed when an item is double clicked.
deleteKeyCommand(dkc) script createedit
Specify the command to be executed when the delete or backspace key is pressed.
lineFont(lf) [int, string] createeditmultiuse
Specify the font for a specific line of the list. The indices are 1-based. Valid font values are "boldLabelFont", "smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont", "obliqueLabelFont", "smallObliqueLabelFont", "fixedWidthFont" and "smallFixedWidthFont".
numberOfItems(ni) boolean query
Number of items.
numberOfRows(nr) int createqueryedit
Number of visible rows.
numberOfSelectedItems(nsi) boolean query
Number of selected items.
removeAll(ra) boolean createedit
Remove all items.
removeItem(ri) string createeditmultiuse
Remove the item with the specified text.
removeIndexedItem(rii) int createeditmultiuse
Remove the indexed item. Indices are 1-based.
selectCommand(sc) script createedit
Specify the command to be executed when an item is selected.
selectItem(si) string createqueryeditmultiuse
Select the item that contains the specified text.
selectIndexedItem(sii) int createqueryeditmultiuse
Select the indexed item. Indices are 1-based.
deselectAll(da) boolean createedit
Deselect all items.
deselectItem(di) string createeditmultiuse
Deselect the item that contains the specified text.
deselectIndexedItem(dii) int createeditmultiuse
Deselect the indexed item. Indices are 1-based.
showIndexedItem(shi) int createedit
Show the indexed item. Scroll the list as necessary so that the indexed item is visible. Indices are 1-based.
font(fn) string createqueryedit
The font for the list items. Valid values are "boldLabelFont", "smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont", "obliqueLabelFont", "smallObliqueLabelFont", "fixedWidthFont" and "smallFixedWidthFont".
uniqueTag(utg) string createeditmultiuse
This flag can only be used in conjunction with the append or the appendPosition flag. The string specifies a unique tag for the appended item; the tag can then be used to query an item. This tag provides an alternate way to uniquely identify a list item using a string instead of by index. Tags are case insensitive.
selectUniqueTagItem(sut) string createqueryeditmultiuse
Allow item selections based on the unique tag. In query mode, it will return the unique tag of the selected items.
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.textScrollList( numberOfRows=8, allowMultiSelection=True,
			append=['one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten',
					'eleven', 'twelve', 'thirteen', 'fourteen', 'fifteen'],
			selectItem='six', showIndexedItem=4 )
cmds.showWindow()

cmds.window()
cmds.paneLayout()
cmds.textScrollList( "myControlObj", allowMultiSelection=True,
			append=[ "Only two things are infinite, the universe and human stupidity, and I'm not sure about the former.",
					 "Each problem that I solved became a rule, which served afterwards to solve other problems."],
		    uniqueTag=["Albert Einstein","Rene Descartes"])
cmds.showWindow()
cmds.textScrollList( "myControlObj", edit=True, selectUniqueTagItem=["Albert Einstein"])
cmds.textScrollList( "myControlObj", query=True, selectUniqueTagItem=True)
cmds.textScrollList( "myControlObj", edit=True, append=["Your theory is crazy, but it's not crazy enough to be true."],
                                                uniqueTag=["Niels Bohr"] )
cmds.textScrollList( "myControlObj", edit=True, selectUniqueTagItem=["Rene Descartes", "Niels Bohr"])
cmds.textScrollList( "myControlObj", query=True, selectUniqueTagItem=True)