HappyDoc Generated Documentation .\chimera\pbgPanel.py

. / chimera / pbgPanel.py 

Functions   
  addColumns 
addColumns ( columnInfo,  defaultShown=1 )

Add columns to the groups table.

columnInfo is a list of 3-tuples, one for each column to add. The tuple consists of (column name, value type, value-fetch function). The value type should be text, image, or imagetext. The value-fetch function takes one argument (a pseudobond group) and should return the value to display in the table cell (which for imagetext is an (image, text) tuple). The value of an image is the name of the image (the Tix name, e.g. tick for tickmark). A value of None for image or text will leave a blank cell.

defaultShown controls whether the column is shown in the group table or not as long as the user has not yet expressed a preference in the Configuration panel about it.

Exceptions   

ValueError, "Duplicate pseudobond group" " panel column name: %s" % name

  toggleModelField 
toggleModelField (
        groups,
        field,
        onVal=1,
        offVal=0,
        )
  attributesCmd 
attributesCmd ( groups )
  setGroupFieldOnly 
setGroupFieldOnly (
        groups,
        field,
        onVal=1,
        offVal=0,
        )
  selectCmd 
selectCmd ( groups )
  addButton 
addButton (
        name,
        callback,
        minGroups=1,
        maxGroups=None,
        balloon=None,
        )

Add a button to the Group Actions button list.

name is the button name (duh). callback is the function to call when the button is pressed. The arg to callback will be a list of groups. min/maxGroups indicate how many groups have to be selected in the browser for the button to be active (None indicates no limit).

This is a module function so that it can be called even if the group panel has not yet been created.

Exceptions   

KeyError, "Button named '%s' already exists" % name

  setGroupField 
setGroupField (
        groups,
        field,
        value,
        )

functions used in groups panel buttons; could be called directly also

  selectBondedCmd 
selectBondedCmd ( groups )
Classes   

PseudoBondGroupPanel


This document was automatically generated Thu Feb 02 15:18:24 2006 by HappyDoc version 3.0.a1