qm.fields.BooleanField

Package qm :: Module fields :: Class BooleanField

[show private | hide private]

Type BooleanField

object --+                
         |                
     Field --+            
             |            
     TextField --+        
                 |        
       ChoiceField --+    
                     |    
      EnumerationField --+
                         |
                        BooleanField

A field containing a boolean value.

The enumeration contains two values: true and false.

Method Summary
	`__init__(self, name, default_value, **properties)`
	`Validate(self, value)` Validate a field value.
Inherited from EnumerationField
	`GetHelp(self)` Generate help text about this field in structured text format.
	`GetItems(self)` Return a sequence of enumerals.
	`GetValueFromDomNode(self, node, attachment_store)` Return a value for this field represented by DOM 'node'.
	`MakeDomNodeForValue(self, value, document)` Generate a DOM element node for a value of this field.
Inherited from ChoiceField
	`FormatValueAsHtml(self, server, value, style, name)` Return an HTML rendering of a 'value' for this field.
Inherited from TextField
	`FormatValueAsText(self, value, columns)` Return a plain text rendering of a 'value' for this field.
	`ParseFormValue(self, request, name, attachment_stores)` Convert a value submitted from an HTML form.
	`ParseTextValue(self, value)` Parse a value represented as a string.
Inherited from Field
	`__repr__(self)`
	`GetBriefDescription(self)` Return a brief description of this field.
	`GetDefaultValue(self)` Return the default value for this field.
	`GetDescription(self)` Return a description of this field.
	`GetHtmlFormFieldName(self)` Return the form field name corresponding this field.
	`GetHtmlHelp(self, edit)` Generate help text about this field in HTML format.
	`GetName(self)` Return the name of the field.
	`GetSubfields(self)` Returns the sequence of subfields contained in this field.
	`GetTitle(self)` Return the user-friendly title of the field.
	`IsComputed(self)` Returns true if this field is computed automatically.
	`IsHidden(self)` Returns true if this 'Field' should be hidden from users.
	`IsReadOnly(self)` Returns true if this 'Field' cannot be modified by users.
	`SetName(self, name)` Set the name of the field.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
Inherited from Field
`str`	`form_field_prefix` = `'_field_'`

Method Details

Validate(self, value)

Validate a field value.

For an acceptable type and value, return the representation of 'value' in the underlying field storage.

'value' -- A value to validate for this field.

returns -- If the 'value' is valid, returns 'value' or an equivalent "canonical" version of 'value'. (For example, this function may search a hash table and return an equivalent entry from the hash table.)

This function must raise an exception if the value is not valid. The string representation of the exception will be used as an error message in some situations.

Implementations of this method must be idempotent.

Overrides:: qm.fields.ChoiceField.Validate (inherited documentation)

Generated by Epydoc 2.1 on Thu Sep 27 15:49:06 2007

http://epydoc.sf.net