pymel.core.uitypes.TextScrollList

class TextScrollList

class counterpart of mel function textScrollList

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.

append(val=True, **kwargs)

Add an item to the end of the list.

Derived from mel command maya.cmds.textScrollList

appendPosition(val=True, **kwargs)

Append an item at the specified position. The position is a 1-based index.

Derived from mel command maya.cmds.textScrollList

deleteKeyCommand(val=True, **kwargs)

Specify the command to be executed when the delete or backspace key is pressed.

Derived from mel command maya.cmds.textScrollList

deselectAll(val=True, **kwargs)

Deselect all items.

Derived from mel command maya.cmds.textScrollList

deselectIndexedItem(val=True, **kwargs)

Deselect the indexed item. Indecies are 1-based.

Derived from mel command maya.cmds.textScrollList

deselectItem(val=True, **kwargs)

Deselect the item that contains the specified text.

Derived from mel command maya.cmds.textScrollList

doubleClickCommand(val=True, **kwargs)

Specify the command to be executed when an item is double clicked.

Derived from mel command maya.cmds.textScrollList

dragCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.textScrollList

dropCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.textScrollList

extend(appendList)

append a list of strings

getAllItems(**kwargs)

All the items.

Derived from mel command maya.cmds.textScrollList

getAllowAutomaticSelection(**kwargs)

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 someCommandis set, someCommandwill be called for each selected item. If -aas/allowAutomaticSelectionis off, then only the item selected when the mouse button is up will be the selected item, so -sc/selectCommand someCommandis only called once if it is set.

Derived from mel command maya.cmds.textScrollList

getAllowMultiSelection(**kwargs)

Specify multi or single selection mode.

Derived from mel command maya.cmds.textScrollList

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.textScrollList

getBackgroundColor(**kwargs)

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.

Derived from mel command maya.cmds.textScrollList

getDocTag(**kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.textScrollList

getEnable(**kwargs)

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.

Derived from mel command maya.cmds.textScrollList

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.textScrollList

getFont(**kwargs)

The font for the list items. Valid values are “boldLabelFont”, “smallBoldLabelFont”, “tinyBoldLabelFont”, “plainLabelFont”, “smallPlainLabelFont”, “obliqueLabelFont”, “smallObliqueLabelFont”, “fixedWidthFont” and “smallFixedWidthFont”.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.textScrollList

getFullPathName(**kwargs)

Return the full path name of the widget, which includes all the parents

Derived from mel command maya.cmds.textScrollList

getHeight(**kwargs)

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

getIsObscured(**kwargs)

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.

Derived from mel command maya.cmds.textScrollList

getManage(**kwargs)

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.

Derived from mel command maya.cmds.textScrollList

getNumberOfItems(**kwargs)

Number of items.

Derived from mel command maya.cmds.textScrollList

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.textScrollList

getNumberOfRows(**kwargs)

Number of visible rows.

Derived from mel command maya.cmds.textScrollList

getNumberOfSelectedItems(**kwargs)

Number of selected items.

Derived from mel command maya.cmds.textScrollList

getPopupMenuArray(**kwargs)

Return the names of all the popup menus attached to this control.

Derived from mel command maya.cmds.textScrollList

getPreventOverride(**kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.textScrollList

getSelectIndexedItem(**kwargs)

Select the indexed item. Indecies are 1-based.

Derived from mel command maya.cmds.textScrollList

getSelectItem(**kwargs)

Select the item that contains the specified text.

Derived from mel command maya.cmds.textScrollList

getVisible(**kwargs)

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

Derived from mel command maya.cmds.textScrollList

getVisibleChangeCommand(**kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.textScrollList

getWidth(**kwargs)

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

removeAll(val=True, **kwargs)

Remove all items.

Derived from mel command maya.cmds.textScrollList

removeIndexedItem(val=True, **kwargs)

Remove the indexed item. Indecies are 1-based.

Derived from mel command maya.cmds.textScrollList

removeIndexedItems(removeList)

remove a list of indices

removeItem(val=True, **kwargs)

Remove the item with the specified text.

Derived from mel command maya.cmds.textScrollList

selectAll()

select all items

selectCommand(val=True, **kwargs)

Specify the command to be executed when an item is selected.

Derived from mel command maya.cmds.textScrollList

selectIndexedItems(selectList)

select a list of indices

setAllowAutomaticSelection(val=True, **kwargs)

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 someCommandis set, someCommandwill be called for each selected item. If -aas/allowAutomaticSelectionis off, then only the item selected when the mouse button is up will be the selected item, so -sc/selectCommand someCommandis only called once if it is set.

Derived from mel command maya.cmds.textScrollList

setAllowMultiSelection(val=True, **kwargs)

Specify multi or single selection mode.

Derived from mel command maya.cmds.textScrollList

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.textScrollList

setBackgroundColor(val=True, **kwargs)

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.

Derived from mel command maya.cmds.textScrollList

setDocTag(val=True, **kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.textScrollList

setEnable(val=True, **kwargs)

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.

Derived from mel command maya.cmds.textScrollList

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.textScrollList

setFont(val=True, **kwargs)

The font for the list items. Valid values are “boldLabelFont”, “smallBoldLabelFont”, “tinyBoldLabelFont”, “plainLabelFont”, “smallPlainLabelFont”, “obliqueLabelFont”, “smallObliqueLabelFont”, “fixedWidthFont” and “smallFixedWidthFont”.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.textScrollList

setHeight(val=True, **kwargs)

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

setManage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.textScrollList

setNumberOfRows(val=True, **kwargs)

Number of visible rows.

Derived from mel command maya.cmds.textScrollList

setPreventOverride(val=True, **kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.textScrollList

setSelectIndexedItem(val=True, **kwargs)

Select the indexed item. Indecies are 1-based.

Derived from mel command maya.cmds.textScrollList

setSelectItem(val=True, **kwargs)

Select the item that contains the specified text.

Derived from mel command maya.cmds.textScrollList

setVisible(val=True, **kwargs)

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

Derived from mel command maya.cmds.textScrollList

setVisibleChangeCommand(val=True, **kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.textScrollList

setWidth(val=True, **kwargs)

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

showIndexedItem(val=True, **kwargs)

Show the indexed item. Scroll the list as necessary so that the indexed item is visible. Indecies are 1-based.

Derived from mel command maya.cmds.textScrollList