Cortex  10.0.0-a4
Public Member Functions | List of all members
IECoreMaya.ModalDialogue Class Reference

This class provides a useful base for implementing modal dialogues in an object oriented manner. More...

+ Inheritance diagram for IECoreMaya.ModalDialogue:

Public Member Functions

def __init__ (self)
 Derived classes should call the base class init before constructing their ui. More...
 
def run (cls, args, kwargs)
 Call this method to open a dialogue - the return value is the object supplied by the derived class, or the string supplied to layoutDialog( dismiss=s ) if called directly. More...
 
- Public Member Functions inherited from IECoreMaya.UIElement
def __init__ (self, topLevelUI)
 Derived classes must create a ui element which is the parent of the rest of their ui, and call this init function passing it as the topLevelUI parameter. More...
 
def parent (self)
 Returns the UIElement which forms the parent for this one. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IECoreMaya.UIElement
def instances
 Returns a list of all the active instances derived from the specified type. More...
 

Detailed Description

This class provides a useful base for implementing modal dialogues in an object oriented manner.

Constructor & Destructor Documentation

def IECoreMaya.ModalDialogue.__init__ (   self)

Derived classes should call the base class init before constructing their ui.

The result of self._topLevelUI() will be a form layout in which the ui should be constructed. Clients shouldn't construct ModalDialogues directly but instead use the run() method documented below.

References IECoreMaya.UIElement.__init__().

Member Function Documentation

def IECoreMaya.ModalDialogue.run (   cls,
  args,
  kwargs 
)

Call this method to open a dialogue - the return value is the object supplied by the derived class, or the string supplied to layoutDialog( dismiss=s ) if called directly.

If the string 'None', 'True', or 'False' is passed to a direct call, then the equivalent python object is returned instead of a string.


The documentation for this class was generated from the following file: