Home       Trees       Index       Help   

PyXMPP

Package pyxmpp :: Package jabber :: Module muccore :: Class MucXBase
[show private | hide private]
[frames | no frames]

Type MucXBase

                object --+    
                         |    
StanzaPayloadWrapperObject --+
                             |
                            MucXBase

Known Subclasses:
MucOwnerX, MucUserX, MucX
Base class for MUC-specific stanza payload - wrapper around
an XML element.

:Ivariables:
    - `xmlnode`: the wrapped XML node
Method Summary
  __init__(self, xmlnode, copy, parent)
Copy MucXBase object or create a new one, possibly based on or wrapping an XML node.
  __del__(self)
  free(self)
Unlink and free the XML node owned by `self`.
  free_borrowed(self)
Detach the XML node borrowed by `self`.
  serialize(self)
Serialize `self` as XML.
  xpath_eval(self, expr)
Evaluate XPath expression in context of `self.xmlnode`.
    Inherited from StanzaPayloadWrapperObject
  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)

Class Variable Summary
str element = 'x'
NoneType ns = None                                                                  

Method Details

__init__(self, xmlnode=None, copy=True, parent=None)
(Constructor) 

Copy MucXBase object or create a new one, possibly
based on or wrapping an XML node.

:Parameters:
    - `xmlnode`: is the object to copy or an XML node to wrap.
    - `copy`: when `True` a copy of the XML node provided will be included
      in `self`, the node will be copied otherwise.
    - `parent`: parent node for the created/copied XML element.
:Types:
    - `xmlnode`: `MucXBase` or `libxml2.xmlNode`
    - `copy`: `bool`
    - `parent`: `libxml2.xmlNode`
Overrides:
__builtin__.object.__init__

free(self) 

Unlink and free the XML node owned by `self`.

free_borrowed(self) 

Detach the XML node borrowed by `self`.

serialize(self) 

Serialize `self` as XML.

:return: serialized `self.xmlnode`.
:returntype: `str`

xpath_eval(self, expr) 

Evaluate XPath expression in context of `self.xmlnode`.

:Parameters:
    - `expr`: the XPath expression
:Types:
    - `expr`: `unicode`

:return: the result of the expression evaluation.
:returntype: list of `libxml2.xmlNode`

Class Variable Details

element

Type:
str
Value:
'x'

ns

Type:
NoneType
Value:
None                                                                  

   Home       Trees       Index       Help   

PyXMPP

Generated by Epydoc 2.1 on Wed May 31 22:36:58 2006 http://epydoc.sf.net