Package peppy :: Package lib :: Module userparams :: Class DirParam

Class DirParam

      object --+        
               |        
debug.debugmixin --+    
                   |    
               Param --+
                       |
                      DirParam

Known Subclasses:

PathParam

Directory parameter that displays a DirBrowseButton2 as its user interface.

A string that represents a directory path is used as the value. It will always be a normalized path.

Instance Methods

getCtrl(self, parent, initial=None)
Create and editing control.

setValue(self, ctrl, value)
Populate the control given the user value.

Inherited from Param: OnCallback, __init__, __str__, getLabel, getValue, isSettable, isVisible, processCallback, setCallback, setInitialState, setValueWithoutCallback, textToValue, valueToText

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Class Methods
Inherited from `debug.debugmixin`: `dprint`

Class Variables
	default = `'/home/rob/src/peppy-git'`
	callback_event = `None`
Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

getCtrl(self, parent, initial=None)

Create and editing control.

Given the parent window, create a user interface element to edit the param.

Overrides: Param.getCtrl: (inherited documentation)

setValue(self, ctrl, value)

Populate the control given the user value.

If any conversion is needed to show the user value in the control, do it here.

Overrides: Param.setValue: (inherited documentation)