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

The Panel class provides a handy base class for the implementation of maya scripted panels. More...

+ Inheritance diagram for IECoreMaya.Panel:

Public Member Functions

def __init__ (self, topLevelUI)
 Derived classes must implement this to create their ui, calling Panel.__init__ with the top level of the ui. More...
 
def create
 Call this to instantiate a panel. More...
 
def registerPanel (cls, subclass)
 Must be called to register all subclasses. 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

The Panel class provides a handy base class for the implementation of maya scripted panels.

It allows the panel to be represented as an object with member data, reduces the number of methods that must be implemented, and allows normal python objects to be used as the state persistence mechanism.

Constructor & Destructor Documentation

def IECoreMaya.Panel.__init__ (   self,
  topLevelUI 
)

Derived classes must implement this to create their ui, calling Panel.__init__ with the top level of the ui.

A new instance is made each time maya wishes to populate a ui with a panel (effectively this method implements the create, init and add callbacks of the maya scripted panel).

References IECoreMaya.UIElement.__init__().

Member Function Documentation

def IECoreMaya.Panel.create (   cls,
  label = None 
)

Call this to instantiate a panel.

Note that one panel instantiation as far as maya is concerned may result in multiple IECoreMaya.Panel instantiations - typically one for each time maya wishes to reparent or copy the panel.

def IECoreMaya.Panel.registerPanel (   cls,
  subclass 
)

Must be called to register all subclasses.

This should typically be done during plugin initialisation.


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