Package pyxmpp :: Package jabber :: Module dataforms :: Class Option
[show private | hide private]
[frames | no frames]

Type Option

         object --+    
                  |    
StanzaPayloadObject --+
                      |
                     Option


One of optional data form field values.
Method Summary
  __init__(self, values, label)
Initialize an Option object.
  complete_xml_element(self, xmlnode, doc)
Complete the XML node with self content.
Option _new_from_xml(cls, xmlnode)
Create a new Option object from an XML element. (Class method)
    Inherited from StanzaPayloadObject
libxml2.xmlNode or libxml2.xmlDoc as_xml(self, parent, doc)
Get the XML representation of self.
    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
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Instance Variable Summary
unicode label: option label.
list of unicode values: option values.

Class Variable Summary
unicode xml_element_name: name for the XML element provided by the class.
unicode xml_element_namespace: namespace URI for the XML element provided by the class.

Instance Method Details

__init__(self, values, label=None)
(Constructor)

Initialize an Option object.
Parameters:
values - option values.
           (type=list of unicode)
label - option label (human-readable description).
           (type=unicode)
Overrides:
__builtin__.object.__init__

complete_xml_element(self, xmlnode, doc)

Complete the XML node with self content.
Parameters:
xmlnode - XML node with the element being built. It has already right name and namespace, but no attributes or content.
           (type=libxml2.xmlNode)
doc - document to which the element belongs.
           (type=libxml2.xmlDoc)
Overrides:
pyxmpp.objects.StanzaPayloadObject.complete_xml_element

Class Method Details

_new_from_xml(cls, xmlnode)

Create a new Option object from an XML element.
Parameters:
xmlnode - the XML element.
           (type=libxml2.xmlNode)
Returns:
the object created.
           (type=Option)

Instance Variable Details

label

option label.
Type:
unicode

values

option values.
Type:
list of unicode

Class Variable Details

xml_element_name

name for the XML element provided by the class.
Type:
unicode
Value:
'option'                                                               

xml_element_namespace

namespace URI for the XML element provided by the class.
Type:
unicode
Value:
'jabber:x:data'