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

The UIElement base class assists in implementing ui elements in an object oriented manner in python. More...

+ Inheritance diagram for IECoreMaya.UIElement:

Public Member Functions

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...
 

Static Public Member Functions

def instances
 Returns a list of all the active instances derived from the specified type. More...
 

Detailed Description

The UIElement base class assists in implementing ui elements in an object oriented manner in python.

Todo:
Preexisting ui elements should be rewritten to take advantage of this base class wherever possible.

Constructor & Destructor Documentation

def IECoreMaya.UIElement.__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.

The base class will ensure that the UIElement instance is kept alive as long as the ui exists, and that it will be destroyed when the ui is destroyed.

References IECoreMaya.UIElement.__topLevelUI, and IECoreMaya.UIElement.__uiDeleted().

Referenced by IECoreMaya.ParameterUI.__init__(), IECoreMaya.ModalDialogue.__init__(), IECoreMaya.Panel.__init__(), IECoreMaya.FnDagNode.defaultShapeName(), IECoreMaya._CollapsibleMotif.frameLayout(), and IECoreMaya.ClassVectorParameterUI.registerToolsMenuCallback().

Member Function Documentation

def IECoreMaya.UIElement.instances (   type = None)
static

Returns a list of all the active instances derived from the specified type.

Referenced by IECoreMaya.FnDagNode.defaultShapeName(), and IECoreMaya.ClassVectorParameterUI.setCollapsed().

def IECoreMaya.UIElement.parent (   self)

Returns the UIElement which forms the parent for this one.

References IECoreMaya.UIElement.__instances, IECoreMaya.UIElement.__topLevelUI, and IECoreMaya.UIElement._topLevelUI().

Referenced by IECoreMaya.ClassVectorParameterUI.registerToolsMenuCallback().


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