pymel.core.windows.iconTextScrollList

iconTextScrollList(*args, **kwargs)

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.

Flags:

Long name (short name)		Argument Types	Properties
allowMultiSelection (ams)		bool
	Specify multi or single selection mode.
annotation (ann)		unicode
	Annotate the control with an extra string value.
append (a)		unicode
	Add an item to the end of the list.
backgroundColor (bgc)		float, float, float
	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.
changeCommand (cc)		callable
defineTemplate (dt)		unicode
	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.
deselectAll (da)		bool
	Deselect all items.
docTag (dtg)		unicode
	Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
doubleClickCommand (dcc)		callable
	Specify the command to be executed when an item is double clicked.
dragCallback (dgc)		callable
	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 dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’
dragFeedbackVisible (dfv)		bool
dropCallback (dpc)		callable
	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 dragControlvalue 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)		callable
	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. Flag can have multiple arguments, passed either as a tuple or a list.
editIndexed (ei)		int
editable (ed)		bool
enable (en)		bool
	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)		bool
	Enables the background color of the control.
exists (ex)		bool
	Returns true|false depending upon whether the specified object exists. Other flags are ignored.
fullPathName (fpn)		bool
	Return the full path name of the widget, which includes all the parents
height (h)		int
	The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
isObscured (io)		bool
	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
	Return the name of the item, if any, located at given point
manage (m)		bool
	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.
numberOfIcons (nic)		int
numberOfPopupMenus (npm)		bool
	Return the number of popup menus attached to this control.
numberOfRows (nr)		bool
	Number of visible rows.
parent (p)		unicode
	The parent layout for this control.
popupMenuArray (pma)		bool
	Return the names of all the popup menus attached to this control.
preventOverride (po)		bool
	If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
removeAll (ra)		bool
	Remove all items.
selectCommand (sc)		callable
	Specify the command to be executed when an item is selected.
selectIndexedItem (sii)		int
selectItem (si)		unicode
	Select the item that contains the specified text.
useTemplate (ut)		unicode
	Force the command to use a command template other than the current one.
visible (vis)		bool
	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)		callable
	Command that gets executed when visible state of the control changes.
visualRectAt (vra)		int, int
	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.
width (w)		int
	The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.iconTextScrollList

Example:

import pymel.core as pm

pm.window()
# Result: ui.Window('window1') #
pm.paneLayout()
# Result: ui.PaneLayout('window1|paneLayout6') #
pm.iconTextScrollList(allowMultiSelection=True, append=('one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten', 'eleven', 'twelve', 'thirteen', 'fourteen', 'fifteen'), selectItem='six' )
# Result: ui.IconTextScrollList('window1|paneLayout6|iconTextScrollList1') #
pm.showWindow()