Package mrv :: Package maya :: Package ui :: Module control :: Class TextScrollList

Class TextScrollList

         object --+                
                  |                
         basestring --+            
                      |            
                unicode --+        
                          |        
             object --+   |        
                      |   |        
            base.BaseUI --+        
                          |        
         object --+       |        
                  |       |        
interface.Interface --+   |        
                      |   |        
     interface.iDagItem --+        
                          |        
         object --+       |        
                  |       |        
   util.EventSender --+   |        
                      |   |        
     util.EventSenderUI --+        
                          |        
               base.NamedUI --+    
                              |    
              base.SizedControl --+
                                  |
                                 TextScrollList

Class defining attributes and events for the text-scroll list

Nested Classes

[hide private]

Inherited from base.SizedControl: __metaclass__

Inherited from util.EventSenderUI (private): _UIEvent

Instance Methods

[hide private]

Inherited from base.SizedControl: p_pma, p_popupMenuArray

Inherited from base.NamedUI: delete, exists, shortName, type, uiDeleted

Inherited from base.NamedUI (private): _parentString

Inherited from unicode: __add__, __contains__, __eq__, __format__, __ge__, __getattribute__, __getitem__, __getnewargs__, __getslice__, __gt__, __hash__, __le__, __len__, __lt__, __mod__, __mul__, __ne__, __rmod__, __rmul__, __sizeof__, __str__, capitalize, center, count, decode, encode, endswith, expandtabs, find, format, index, isalnum, isalpha, isdecimal, isdigit, islower, isnumeric, isspace, istitle, isupper, join, ljust, lower, lstrip, partition, replace, rfind, rindex, rjust, rpartition, rsplit, rstrip, split, splitlines, startswith, strip, swapcase, title, translate, upper, zfill

Inherited from unicode (private): _formatter_field_name_split, _formatter_parser

Inherited from interface.Interface: supports

Inherited from util.EventSender: clearAllEvents, sender

Inherited from object: __delattr__, __reduce__, __reduce_ex__, __subclasshook__

Interface

items(self)
Returns: list of currently available items

source code

selectedIndex(self)
is nothing selected :note: even if multiple selections are possible

source code

selectedIndices(self)
is nothing selected

source code

selectedItem(self)
Returns: the first selected item, or None if nothing is selected

source code

selectedItems(self)
is selected

source code

setItems(self, items)
Set the given items to be shown.

source code

addItem(self, item)
Add the given item to the end of the list :return: self

source code

addItems(self, items)
Add multiple items to the end of the list :return: self

source code

setSelectedItem(self, item)
Set the given item selected, or clear the selection...

source code

removeItem(self, item)
Remove the given item from the list.

source code

Query Methods

Inherited from base.SizedControl: annotation, dimension, popupMenuArray

Inherited from base.NamedUI: children, childrenDeep, parent

Inherited from interface.iDagItem: basename, isPartOf, isRoot, isRootOf, parentDeep, root

Edit Methods

Inherited from base.SizedControl: setAnnotation, setDimension, setFocus

Overridden Methods

Inherited from base.NamedUI: __init__, __new__, __repr__, __setattr__

Properties

Inherited from base.NamedUI: p_ex, p_exists

Iterators

Inherited from interface.iDagItem: iterParents

Name Generation

Inherited from interface.iDagItem: fullChildName

Class Methods

[hide private]

Inherited from util.EventSender: listEventNames

Overridden Methods

Inherited from base.NamedUI (private): _exists

Hierachy Handling

Inherited from base.NamedUI: activeParent

Name Generation

Inherited from interface.iDagItem: addSep

Class Variables

[hide private]

_properties_ = "append", "a", "appendPosition", "ap", "allItem...

_events_ = "doubleClickCommand", "dcc", "deleteKeyCommand", "d...

Inherited from base.SizedControl: p_ann, p_annotation, p_dimension

Inherited from base.NamedUI (private): _is_menu

Inherited from base.BaseUI: __melcmd__

Inherited from interface.iDagItem: kOrder_BreadthFirst, kOrder_DepthFirst

Inherited from util.EventSenderUI: reraise_on_error, sender_as_argument

Configuration

Inherited from base.NamedUI (private): _sep

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

items(self)

source code

Returns:: list of currently available items

selectedIndex(self)

source code

is nothing selected :note: even if multiple selections are possible

Returns:: First selected index - the index is 1-based, or -1 if there

selectedIndices(self)

source code

is nothing selected

Returns:: tuple of all selected 1-based indices, or an empty tuple if there

selectedItem(self)

source code

Returns:: the first selected item, or None if nothing is selected

selectedItems(self)

source code

is selected

Returns:: list of all selected items as strings, or an empty list if nothing

setItems(self, items)

source code

Set the given items to be shown.
:param items: iterable of items 
        if empty, the control will be empty after this call.
:return: self

setSelectedItem(self, item)

source code

Set the given item selected, or clear the selection
:param item: item to select, or clear the selection if None is given
:note: it is not considered an error if the item doesnt exist - following 
        maya's behaviour
:return: self

removeItem(self, item)

source code

Remove the given item from the list. It is not an error if it doesn't exist in the first place :return: self

Class Variable Details

[hide private]

_properties_

Value:

"append", "a", "appendPosition", "ap", "allItems", "ai", "allowAutomat
icSelection", "aas", "allowMultiSelection", "ams", "numberOfItems", "n
i", "numberOfRows", "nr", "numberOfSelectedItems", "nsi", "removeAll",
 "ra" "removeItem", "ri", "removeIndexedItem", "rii", "selectItem", "s
i", "selectIndexedItem", "sii", "deselectAll", "da", "deselectItem", "
di", "deselectIndexedItem", "dii", "showIndexedItem", "shi", "font", "
fn"

_events_

Value:

"doubleClickCommand", "dcc", "deleteKeyCommand", "dkc", "selectCommand
", "sc"