mrv :: maya :: ui :: base :: SubMenuItem :: Class SubMenuItem
[hide private]
[frames] | no frames]

Class SubMenuItem

source code

         object --+                    
                  |                    
         basestring --+                
                      |                
                unicode --+            
                          |            
             object --+   |            
                      |   |            
                 BaseUI --+            
                          |            
         object --+       |            
                  |       |            
interface.Interface --+   |            
                      |   |            
     interface.iDagItem --+            
                          |            
         object --+       |            
                  |       |            
   util.EventSender --+   |            
                      |   |            
     util.EventSenderUI --+            
                          |            
                    NamedUI --+        
                              |        
                       MenuBase --+    
                                  |    
                           MenuItem --+
                                      |
                                     SubMenuItem

A menu which is always a submenu. This type greatly facilitates subclasses to enforce being a MenuItem which is a submenu as no additional code is required
Nested Classes [hide private]

Inherited from NamedUI: __metaclass__

Inherited from util.EventSenderUI (private): _UIEvent

Instance Methods [hide private]

Inherited from MenuItem: toMenu

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

Inherited from 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__

    Overridden Methods
a new object with type S, a subtype of T
__new__(cls, *args, **kwargs)
If name is given, the newly created UI will wrap the UI with the given name.
source code

Inherited from NamedUI: __init__, __repr__, __setattr__

    Properties

Inherited from NamedUI: p_ex, p_exists

    Query Methods

Inherited from NamedUI: children, childrenDeep, parent

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

    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 NamedUI (private): _exists

    Hierachy Handling

Inherited from NamedUI: activeParent

    Name Generation

Inherited from interface.iDagItem: addSep

Class Variables [hide private]

Inherited from MenuItem: _events_, _properties_

Inherited from MenuBase (private): _is_menu

Inherited from BaseUI: __melcmd__

Inherited from interface.iDagItem: kOrder_BreadthFirst, kOrder_DepthFirst

Inherited from util.EventSenderUI: reraise_on_error, sender_as_argument

    Configuration
  tearOff = False
hash(x)
  allowOptionBoxes = False
hash(x)

Inherited from NamedUI (private): _sep

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__new__(cls, *args, **kwargs)

source code 
If name is given, the newly created UI will wrap the UI with the given name. Otherwise the UIelement will be created
Parameters:
  • kwargs -
    • name:

      name of the user interface to wrap or the target name of a new elf element. Valid names for creation are short names ( without a | in it's path ), valid names for wrapping are short and preferably long names.

    • wrap_only:

      if True, default False, a wrap will be done even if the passed in name uses the short form ( for non-window elements ). If it exists, one cannot be sure whether more elements with the given name exist. If False, the system will create a new element of our type.

    • force_creation:

      if True, default False, a new item will be created even if an item with the given name uniquely exists. This might be necessary that you wish to create the given named item under the current parent, although an item with that name might already exist below another parent. This is required if you have a short name only

Returns: a new object with type S, a subtype of T
Overrides: object.__new__
(inherited documentation)