ChatState Class Reference

An implementation of Chat State Notifications (XEP-0085) as a StanzaExtension. More...

#include <chatstate.h>

Inherits gloox::StanzaExtension.

List of all members.

Public Member Functions

 ChatState (const Tag *tag)
 ChatState (ChatStateType state)
virtual ~ChatState ()
ChatStateType state () const
virtual const std::string & filterString () const
virtual StanzaExtensionnewInstance (const Tag *tag) const
Tagtag () const
virtual StanzaExtensionclone () const

Detailed Description

An implementation of Chat State Notifications (XEP-0085) as a StanzaExtension.

Author:
Vincent Thomasset
Jakob Schroeter <js@camaya.net>
Since:
1.0

Definition at line 33 of file chatstate.h.


Constructor & Destructor Documentation

ChatState ( const Tag tag  ) 

Constructs a new object from the given Tag.

Parameters:
tag A Tag to parse.

Definition at line 30 of file chatstate.cpp.

ChatState ( ChatStateType  state  )  [inline]

Constructs a new object of the given type.

Parameters:
state The chat state.

Definition at line 47 of file chatstate.h.

virtual ~ChatState (  )  [inline, virtual]

Virtual destructor.

Definition at line 54 of file chatstate.h.


Member Function Documentation

virtual StanzaExtension* clone (  )  const [inline, virtual]

Returns an identical copy of the current StanzaExtension.

Returns:
An identical copy of the current StanzaExtension.

Implements StanzaExtension.

Definition at line 75 of file chatstate.h.

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 37 of file chatstate.cpp.

virtual StanzaExtension* newInstance ( const Tag tag  )  const [inline, virtual]

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

 StanzaExtension* FooExtension::newInstance( const Tag* tag ) const
 {
   return new FooExtension( tag );
 }
Returns:
The derived extension's new instance.

Implements StanzaExtension.

Definition at line 66 of file chatstate.h.

ChatStateType state (  )  const [inline]

Returns the object's state.

Returns:
The object's state.

Definition at line 60 of file chatstate.h.

Tag * tag (  )  const [virtual]

Returns a Tag representation of the extension.

Returns:
A Tag representation of the extension.

Implements StanzaExtension.

Definition at line 48 of file chatstate.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Jun 8 23:37:55 2010 for gloox by  doxygen 1.6.3