mrv :: maya :: ui :: base :: SizedControl :: Class SizedControl

Class SizedControl

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

Base Class for all controls having a dimension

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_pma(self)
Returns: popup menus attached to this control

source code

p_popupMenuArray(self)
Returns: popup menus attached to this control

source code

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__

Query Methods

annotation(self)
:return : the annotation string

source code

dimension(self)
Returns: (x,y) tuple of x and y dimensions of the UI element

source code

popupMenuArray(self)
Returns: popup menus attached to this control

source code

Inherited from NamedUI: children, childrenDeep, parent

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

Edit Methods

setAnnotation(self, ann)
Set the UI element's annotation :note: not all named UI elements can have their annotation set

source code

setDimension(self, dimension)
Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

source code

setFocus(self)
Set the global keyboard focus to this control

source code

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_ = "dt", "defineTemplate", "ut", "useTemplate", "w...

_events_ = "dgc", "dragCallback", "dpc", "dropCallback", "vcc"...

p_annotation = property(annotation, setAnnotation)

p_ann = property(annotation, setAnnotation)

p_dimension = property(dimension, setDimension)

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]

dimension(self)

source code

Returns:: (x,y) tuple of x and y dimensions of the UI element

popupMenuArray(self)

source code

Returns:: popup menus attached to this control

p_pma(self)

source code

Returns:: popup menus attached to this control

p_popupMenuArray(self)

source code

Returns:: popup menus attached to this control

Class Variable Details

[hide private]

_properties_

Value:

"dt", "defineTemplate", "ut", "useTemplate", "w", "width", "h", "heigh
t", "vis", "visible", "m", "manage", "en", "enable", "io", "isObscured
", "npm", "numberOfPopupMenus", "po", "preventOverride", "bgc", "backg
roundColor", "dtg", "doctTag", "fpn", "fullPathName", "ebg", "enableBa
ckground"

_events_

Value:

"dgc", "dragCallback", "dpc", "dropCallback", "vcc", "visibleChangeCom
mand"