Package mrv :: Package maya :: Package ui :: Module qa :: Class QACheckLayout
[hide private]
[frames] | no frames]

Class QACheckLayout

source code

         object --+                        
                  |                        
         basestring --+                    
                      |                    
                unicode --+                
                          |                
             object --+   |                
                      |   |                
            base.BaseUI --+                
                          |                
         object --+       |                
                  |       |                
interface.Interface --+   |                
                      |   |                
     interface.iDagItem --+                
                          |                
         object --+       |                
                  |       |                
   util.EventSender --+   |                
                      |   |                
     util.EventSenderUI --+                
                          |                
               base.NamedUI --+            
                              |            
              base.SizedControl --+        
                                  |        
                     object --+   |        
                              |   |        
           util.UIContainerBase --+        
                                  |        
                      layout.Layout --+    
                                      |    
                       layout.RowLayout --+
                                          |
                                         QACheckLayout

Row Layout able to display a qa check and related information

Note: currently we make assumptions about the positions of the children in the RowLayout, thus you may only append new ones

Nested Classes [hide private]

Inherited from base.SizedControl: __metaclass__

Inherited from util.EventSenderUI (private): _UIEvent

Instance Methods [hide private]
 
_toNiceName(self, name)
Returns: nice name version of name, replacing underscores by spaces, and separating camel cases, as well as chaning to the capitalizaion of word
source code
 
_create(self)
Create our layout elements according to the details given in check
source code
 
update(self)
Update ourselves to match information in our stored check
source code
 
check(self)
Returns: check we are operating upon
source code

Inherited from layout.Layout: __getitem__, setParentActive

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__, __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__

    Check Callbacks
 
_runCheck(self, *args, **kwargs)
Run our check
source code
 
selectPressed(self, *args)
Called if the selected button has been pressed Triggers a workflow run if not yet done
source code
 
preCheck(self)
Runs before the check starts
source code
 
postCheck(self, result)
Runs after the check has finished including the given result
source code
 
checkError(self, exception, workflow)
Called if the checks fails with an error
source code
 
setResult(self, result)
Setup ourselves to indicate the given check result
source code
    Properties

Inherited from layout.Layout: p_ca, p_childArray

Inherited from base.NamedUI: p_ex, p_exists

    Query Methods

Inherited from layout.Layout: children

Inherited from base.SizedControl: annotation, dimension, popupMenuArray

Inherited from base.NamedUI: childrenDeep, parent

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

    Edit Methods

Inherited from base.SizedControl: setAnnotation, setDimension, setFocus

    Overridden Methods
a new object with type S, a subtype of T
__new__(cls, *args, **kwargs)
Initialize this RowColumnLayout instance with a check instance
source code
 
__init__(self, *args, **kwargs)
Initialize our instance with members
source code

Inherited from base.NamedUI: __repr__, __setattr__

    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

Static Methods [hide private]
 
_replInsSpace(match)
Generate a replace string from the match in the match object
source code
Class Variables [hide private]
  reNiceNamePattern = re.compile("[A-Z][a-z]")

Inherited from layout.RowLayout: _properties_

Inherited from base.SizedControl: _events_, 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
  icons = ["offRadioBtnIcon.xpm", "onRadioBtnIcon.xpm", "fstop.x...
  height = 25
  numcols = 3

Inherited from base.NamedUI (private): _sep

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__new__(cls, *args, **kwargs)

source code 
Initialize this RowColumnLayout instance with a check instance
Parameters:
  • kwargs -
    • check:

      the check this instance should attach itself to - it needs to be set or the instance creation will fail

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

__init__(self, *args, **kwargs)
(Constructor)

source code 
Initialize our instance with members
Overrides: object.__init__

_replInsSpace(match)
Static Method

source code 
Generate a replace string from the match in the match object

Note: match should contain only a range of two chars

_toNiceName(self, name)

source code 
Returns:
nice name version of name, replacing underscores by spaces, and separating camel cases, as well as chaning to the capitalizaion of word

check(self)

source code 
Returns:
check we are operating upon

_runCheck(self, *args, **kwargs)

source code 
Run our check
Parameters:
  • kwargs - will be passed to the workflow's runChecks method. The following additional kwargs may be specified:

    • force_check:

      if True, default True, a computation will be forced, otherwise a cached result may be used

Returns:
result of our check

Note: we may also be used as a ui callback and figure out ourselves whether we have been pressed by the fix button or by the run button

checkError(self, exception, workflow)

source code 
Called if the checks fails with an error
Parameters:
  • exception - exception object that was thrown by our check
  • workflow - workflow that ran the check

setResult(self, result)

source code 
Setup ourselves to indicate the given check result
Returns:
our adjusted iconTextButton Member

Class Variable Details [hide private]

icons

Value:
["offRadioBtnIcon.xpm", "onRadioBtnIcon.xpm", "fstop.xpm", "fstop.xpm"\
]