HappyDoc Generated Documentation Class: pwCheckbox

widget.py / pwCheckbox 

Checkbox widget class
A simple input widget for checkboxes

Arguments:

  • obj: the object that contains the attribute associated with this field
  • attr: the name of the attribute

Common Keywords:

  • divClass: allows the user to override the class of the
  • fieldSpecial: allows the user to add "special" HTML attributes to the output element
  • id: overrides the HTML "id" attribute
  • selectable: controls whether this field is selectable or not
  • inputType: mostly for internal use -- overrides the type designation in the output hidden fields

Keywords:

  • label: the label for this checkbox (text)
  • onclick: a javascript function to perform after a box is checked (or unchecked)
  • type: the type of checkbox (checkbox vs. radio)
  • name: the name value associated with the checkbox (for form processing)
  • checked: if "true" this box will be checked
  • labelPosition: the position of the label with respect to the checkbox (left, right, top, bottom)
  • value: the value of the checkbox when checked (used for forms processing)

Default divClass: pwCheckbox

Base Classes   

pwCheckbox
  pyWidget

Methods   
  display 
display ( self,  lvl )
  __init__ 
__init__ (
        self,
        obj,
        attr,
        **kwlist,
        )

This document was automatically generated Tue Sep 21 18:50:52 2004 by HappyDoc version 3.0.a1