Home       Trees       Indices       Help   
qm :: fields :: PythonField :: Class PythonField
[hide private]
[frames] | no frames]

Class PythonField

source code

object --+    
         |    
     Field --+
             |
            PythonField

A 'PythonField' stores a Python value.

All 'PythonField's are computed; they are never written out, nor can they be specified directly by users. They are used in situations where the value of the field is specified programatically by the system.

Instance Methods [hide private]
 
__init__(self, name='', default_value=None)
Create a new (generic) field.		 source code

Inherited from Field: FormatValueAsHtml, FormatValueAsText, GetBriefDescription, GetDefaultValue, GetDescription, GetHelp, GetHtmlFormFieldName, GetHtmlHelp, GetName, GetSubfields, GetTitle, GetValueFromDomNode, IsComputed, IsHidden, IsReadOnly, MakeDomNodeForValue, ParseFormValue, ParseTextValue, SetName, Validate, __repr__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from Field: form_field_prefix

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name='', default_value=None)
(Constructor)

source code 

Create a new (generic) field.

'name' -- The name of the field.

'default_value' -- The default value for this field.

'title' -- The name given this field when it is displayed in user interfaces.

'description' -- A string explaining the purpose of this field. The 'description' must be provided as structured text. The first line of the structured text must be a one-sentence description of the field; that line is extracted by 'GetBriefDescription'.

'hidden' -- If true, this field is for internal puprpose only and is not shown in user interfaces.

'read_only' -- If true, this field may not be modified by users.

'computed' -- If true, this field is computed automatically. All computed fields are implicitly hidden and implicitly read-only.

The boolean parameters (such as 'hidden') use the convention that true is represented by the string '"true"'; any other value is false. This convention is a historical artifact.

Overrides: object.__init__
(inherited documentation)

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Dec 23 12:30:40 2011 http://epydoc.sourceforge.net