gear_mc
 All Classes Namespaces Functions Variables
Public Member Functions | Public Attributes | List of all members
gear.xsi.ppg.PPGLayout Class Reference

PPG LAYOUT. More...

Inheritance diagram for gear.xsi.ppg.PPGLayout:

Public Member Functions

def __init__
 Init method. More...
 
def addTab
 Add an new tab to layout. More...
 
def setCodeBefore
 Add code to the PPGLayout before the layout itself. More...
 
def setCodeAfter
 
def getTab
 Get Tab from given index. More...
 
def getTabByName
 Get Tab from given name. More...
 
def getTabItems
 Get items from given Tab index. More...
 
def getTabItemsByName
 Get items from given Tab name. More...
 
def getValue
 Return the layout code as a string. More...
 

Public Attributes

 tabs
 Dictionary of Tab.
 
 tabIndex
 List of tab name to be able to get tab in creation order.
 
 beforeCode
 Code list.
 
 afterCode
 
 value
 real PPGLayout value
 

Detailed Description

PPG LAYOUT.

Dynamic PPG Layout class
Allows the creation of dynamic layout for PPG and still add items to already created tabs, groups or row.
Usefull to generate layout code for the sn_PSet property. Code is in Python !

Constructor & Destructor Documentation

def gear.xsi.ppg.PPGLayout.__init__ (   self)

Init method.

Parameters
self

Member Function Documentation

def gear.xsi.ppg.PPGLayout.addTab (   self,
  name 
)

Add an new tab to layout.

Parameters
self
nameString - Tab name.
Returns
Tab - return the newly created Tab. If the name already exists return the existing Tab.
def gear.xsi.ppg.PPGLayout.getTab (   self,
  index = 0 
)

Get Tab from given index.

Parameters
self
indexInteger - Tab index.
Returns
Tab - return the Tab. Return False if it doesn't exists.
def gear.xsi.ppg.PPGLayout.getTabByName (   self,
  name 
)

Get Tab from given name.

Parameters
self
nameString - Tab name.
Returns
Tab - return the Tab. Return False if it doesn't exists.
def gear.xsi.ppg.PPGLayout.getTabItems (   self,
  index = 0 
)

Get items from given Tab index.

Parameters
self
indexInteger - Tab Index.
Returns
List of LayoutComponent - return the items of Tab. Return False if it doesn't exists.
def gear.xsi.ppg.PPGLayout.getTabItemsByName (   self,
  name 
)

Get items from given Tab name.

Parameters
self
nameString - Tab name.
Returns
List of LayoutComponent - return the items of Tab. Return False if it doesn't exists.
def gear.xsi.ppg.PPGLayout.getValue (   self)

Return the layout code as a string.

Code is in Python.

Parameters
self
Returns
String - The layout.
def gear.xsi.ppg.PPGLayout.setCodeBefore (   self,
  code 
)

Add code to the PPGLayout before the layout itself.


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