gloox  1.1-svn
Public Member Functions | List of all members
XHtmlIM Class Reference

#include <xhtmlim.h>

Inheritance diagram for XHtmlIM:
Inheritance graph
[legend]

Public Member Functions

 XHtmlIM (const Tag *xhtml=0)
virtual ~XHtmlIM ()
const Tagxhtml () const
virtual const std::string & filterString () const
virtual StanzaExtensionnewInstance (const Tag *tag) const
virtual Tagtag () const
virtual StanzaExtensionclone () const
- Public Member Functions inherited from StanzaExtension
 StanzaExtension (int type)
virtual ~StanzaExtension ()
int extensionType () const

Detailed Description

This is a wrapper of an XHTML-IM (XEP-0071) message body.

Author
Jakob Schroeter js@ca.nosp@m.maya.nosp@m..net
Since
1.0

Definition at line 34 of file xhtmlim.h.

Constructor & Destructor Documentation

XHtmlIM ( const Tag xhtml = 0)

Constructs a new object with the given resource string.

Parameters
xhtmlXHTML to include.

Definition at line 21 of file xhtmlim.cpp.

~XHtmlIM ( )
virtual

Virtual Destructor.

Definition at line 33 of file xhtmlim.cpp.

Member Function Documentation

StanzaExtension * clone ( ) const
virtual

Returns an identical copy of the current StanzaExtension.

Returns
An identical copy of the current StanzaExtension.

Implements StanzaExtension.

Definition at line 49 of file xhtmlim.cpp.

const std::string & filterString ( ) const
virtual

Returns an XPath expression that describes a path to child elements of a stanza that an extension handles.

Returns
The extension's filter string.

Implements StanzaExtension.

Definition at line 38 of file xhtmlim.cpp.

virtual StanzaExtension* newInstance ( const Tag tag) const
inlinevirtual

Returns a new Instance of the derived type. Usually, for a derived class FooExtension, the implementation of this function looks like:

{
return new FooExtension( tag );
}
Returns
The derived extension's new instance.

Implements StanzaExtension.

Definition at line 60 of file xhtmlim.h.

Tag * tag ( ) const
virtual

Returns a Tag representation of the extension.

Returns
A Tag representation of the extension.

Implements StanzaExtension.

Definition at line 44 of file xhtmlim.cpp.

const Tag* xhtml ( ) const
inline

Returns a pointer to the internally stored XHTML, as opposed to tag(), which returns a copy (which you need to delete manually).

Returns
A pointer to the XHTML. Do not delete this Tag.

Definition at line 54 of file xhtmlim.h.


The documentation for this class was generated from the following files: