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

Class Window

source code

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

Simple Window Wrapper

Note: Window does not support some of the properties provided by sizedControl

Nested Classes [hide private]
  __metaclass__
Builds the base hierarchy for the given classname based on our typetree.

Inherited from util.EventSenderUI (private): _UIEvent

Instance Methods [hide private]
 
p_numberOfMenus(self)
Returns: number of menus in the menu array
source code
 
p_nm(self)
Returns: number of menus in the menu array
source code

Inherited from SizedControl: p_pma, p_popupMenuArray

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 util.UIContainerBase: __enter__, __exit__, add, childByName, clearChildren, deleteChild, listChildren, removeChild, setActive

Inherited from object: __delattr__, __reduce__, __reduce_ex__, __subclasshook__

    Window Specific Methods
 
show(self)
Show Window :return: self
source code
 
numberOfMenus(self)
Returns: number of menus in the menu array
source code
 
menuArray(self)
Returns: Menu instances attached to this window
source code
 
isFrontWindow(self)
Returns: True if we are the front window
source code
 
setMenuIndex(self, menu, index)
Set the menu index of the specified menu
source code
    Query Methods

Inherited from SizedControl: annotation, dimension, popupMenuArray

Inherited from NamedUI: children, childrenDeep, parent

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

    Edit Methods

Inherited from SizedControl: setAnnotation, setDimension, setFocus

    Overridden Methods

Inherited from NamedUI: __init__, __new__, __repr__, __setattr__

    Properties

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

    Hierachy Handling

Inherited from NamedUI: activeParent

    Name Generation

Inherited from interface.iDagItem: addSep

Class Variables [hide private]
  _properties_ = "t", "title", "i", "iconify", "s", "sizeable", ...
  _events_ = "rc", "restoreCommand", "mnc", "minimizeCommand"

Inherited from SizedControl: p_ann, p_annotation, p_dimension

Inherited from NamedUI (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

Inherited from NamedUI (private): _sep

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

numberOfMenus(self)

source code 
Returns:
number of menus in the menu array

menuArray(self)

source code 
Returns:
Menu instances attached to this window

isFrontWindow(self)

source code 
Returns:
True if we are the front window

setMenuIndex(self, menu, index)

source code 
Set the menu index of the specified menu
Parameters:
  • menu - name of child menu to set
  • index - new index at which the menu should appear

p_numberOfMenus(self)

source code 
Returns:
number of menus in the menu array

p_nm(self)

source code 
Returns:
number of menus in the menu array

Class Variable Details [hide private]

_properties_

Value:
"t", "title", "i", "iconify", "s", "sizeable", "wh", "widthHeight" "in\
", "iconName", "tb", "titleBar", "mnb", "minimizeButton", "mxb", "maxi\
mizeButton", "tlb", "toolbox", "tbm", "titleBarMenu", "mbv", "menuBarV\
isible", "tlc", "topLeftCorner", "te", "topEdge", "tl", "leftEdge", "m\
w", "mainWindow", "rtf", "resizeToFitChildren", "dt", "docTag"