textScrollList

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

Synopsis

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

textScrollList is undoable, queryable, and editable.

Return value

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

Flags

Long name (short name)	Argument types	Properties
-exists(-ex)
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate(-dt)	string
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
Force the command to use a command template other than the current one.
-parent(-p)	string
The parent layout for this control.
-enable(-en)	boolean
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
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
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
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
Command that gets executed when visible state of the control changes.
-isObscured(-io)
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
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)
Return the number of popup menus attached to this control.
-popupMenuArray(-pma)
Return the names of all the popup menus attached to this control.
-preventOverride(-po)	boolean
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
-annotation(-ann)	string
Annotate the control with an extra string value.
-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.
-noBackground(-nbg)	boolean
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
Enables the background color of the control.
-docTag(-dtg)	string
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
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
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
Return the full path name of the widget, which includes all the parents
-append(-a)	string
Add an item to the end of the list.
-appendPosition(-ap)	int string
Append an item at the specified position. The position is a 1-based index.
-allItems(-ai)
All the items.
-allowAutomaticSelection( -aas)	boolean
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
Specify multi or single selection mode.
-doubleClickCommand(-dcc)	script
Specify the command to be executed when an item is double clicked.
-deleteKeyCommand(-dkc)	script
Specify the command to be executed when the delete or backspace key is pressed.
-lineFont(-lf)	int string
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)
Number of items.
-numberOfRows(-nr)	int
Number of visible rows.
-numberOfSelectedItems(-nsi)
Number of selected items.
-removeAll(-ra)
Remove all items.
-removeItem(-ri)	string
Remove the item with the specified text.
-removeIndexedItem(-rii)	int
Remove the indexed item. Indices are 1-based.
-selectCommand(-sc)	script
Specify the command to be executed when an item is selected.
-selectItem(-si)	string
Select the item that contains the specified text.
-selectIndexedItem(-sii)	int
Select the indexed item. Indices are 1-based.
-deselectAll(-da)
Deselect all items.
-deselectItem(-di)	string
Deselect the item that contains the specified text.
-deselectIndexedItem(-dii)	int
Deselect the indexed item. Indices are 1-based.
-showIndexedItem(-shi)	int
Show the indexed item. Scroll the list as necessary so that the indexed item is visible. Indices are 1-based.
-font(-fn)	string
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 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

window;
paneLayout;
textScrollList -numberOfRows 8 -allowMultiSelection true
    -append "one"      -append "two"      -append "three"
    -append "four"     -append "five"     -append "six"
    -append "seven"    -append "eight"    -append "nine"
    -append "ten"      -append "eleven"   -append "twelve"
    -append "thirteen" -append "fourteen" -append "fifteen"
    -selectItem "six"
    -showIndexedItem 4;
showWindow;