qm.fields.TimeField

Package qm :: Module fields :: Class TimeField

[show private | hide private]

Type TimeField

object --+        
         |        
     Field --+    
             |    
  IntegerField --+
                 |
                TimeField

A field containing a date and time.

The data and time is stored as seconds since the start of the UNIX epoch, UTC (the semantics of the standard 'time' function), with one-second precision. User representations of 'TimeField' fields show one-minue precision.

Method Summary
	`__init__(self, name, **properties)` Create a time field.
	`FormatValueAsHtml(self, server, value, style, name)` Return an HTML rendering of a 'value' for this field.
	`FormatValueAsText(self, value, columns)` Return a plain text rendering of a 'value' for this field.
	`GetDefaultValue(self)` Return the default value for this field.
	`GetHelp(self)` Generate help text about this field in structured text format.
	`ParseTextValue(self, value)` Parse a value represented as a string.
Inherited from IntegerField
	`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.
	`Validate(self, value)` Validate a field value.
Inherited from Field
	`__repr__(self)`
	`GetBriefDescription(self)` Return a brief description of 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.
	`ParseFormValue(self, request, name, attachment_stores)` Convert a value submitted from an HTML form.
	`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

init(self, name='', **properties)
(Constructor)

Create a time field.

The field is given a default value for this field is 'None', which corresponds to the current time when the field value is first created.

Overrides:: qm.fields.IntegerField.__init__

FormatValueAsHtml(self, server, value, style, name=None)

Return an HTML rendering of a 'value' for this field.

'server' -- The 'WebServer' in which the HTML will be displayed.

'value' -- The value for this field. May be 'None', which renders a default value (useful for blank forms).

'style' -- The rendering style. Can be "full" or "brief" (both read-only), or "new" or "edit" or "hidden".

'name' -- The name to use for the primary HTML form element containing the value of this field, if 'style' specifies the generation of form elements. If 'name' is 'None', the value returned by 'GetHtmlFormFieldName()' should be used.

returns -- A string containing the HTML representation of 'value'.

Overrides:: qm.fields.IntegerField.FormatValueAsHtml (inherited documentation)

FormatValueAsText(self, value, columns=72)

Return a plain text rendering of a 'value' for this field.

'columns' -- The maximum width of each line of text.

returns -- A plain-text string representing 'value'.

Overrides:: qm.fields.IntegerField.FormatValueAsText (inherited documentation)

GetDefaultValue(self)

Return the default value for this field.

Overrides:: qm.fields.Field.GetDefaultValue (inherited documentation)

GetHelp(self)

Generate help text about this field in structured text format.

Overrides:: qm.fields.IntegerField.GetHelp (inherited documentation)

ParseTextValue(self, value)

Parse a value represented as a string.

'value' -- A string representing the value.

returns -- The corresponding field value. The value returned should be processed by 'Validate' to ensure that it is valid before it is returned.

Overrides:: qm.fields.IntegerField.ParseTextValue (inherited documentation)

Generated by Epydoc 2.1 on Thu Sep 27 15:48:59 2007

http://epydoc.sf.net