StateChangedEvent Class Reference

Event fired when a contact state changes. More...

#include <statechangedevent.h>

Inheritance diagram for StateChangedEvent:

Event BaseMessage List of all members.

Public Member Functions

 StateChangedEvent ()
 Empty Constructor.
 StateChangedEvent (const int contactID, const Contact::Status newStatus)
 Constructor.
 ~StateChangedEvent ()
 Destructor.
void setContactID (const int contactID)
 Sets the Contact ID.
void setNewStatus (const Contact::Status newStatus)
 Sets the new status.
void processMessage () const
 Process the event.
void toXMLExt (XMLWriter &writer) const
 Specific method for derived class to write their own XML specific representation.
virtual std::string toString () const
 Returns a string representation of the event.
StateChangedEventcopy () const
 Returns a copy of this message.

Detailed Description

Event fired when a contact state changes.

Author:
Sylvain Archenault <sylvain.archenault@laposte.net>

Yves Houpert <yves.houpert@insa-rouen.fr>


Constructor & Destructor Documentation

StateChangedEvent::StateChangedEvent const int  contactID,
const Contact::Status  newStatus
 

Constructor.

Parameters:
contactID Contact ID status has changed
newStatus New contact status.


Member Function Documentation

StateChangedEvent & StateChangedEvent::copy  )  const [virtual]
 

Returns a copy of this message.

Returns:
Copy of the message.

Implements BaseMessage.

void StateChangedEvent::setContactID const int  contactID  )  [inline]
 

Sets the Contact ID.

Parameters:
contactID Contact ID status has changed.

void StateChangedEvent::setNewStatus const Contact::Status  newStatus  )  [inline]
 

Sets the new status.

Parameters:
newStatus New contact status.

std::string StateChangedEvent::toString  )  const [virtual]
 

Returns a string representation of the event.

Returns:
String representation.

Reimplemented from Event.

void StateChangedEvent::toXMLExt XMLWriter writer  )  const [virtual]
 

Specific method for derived class to write their own XML specific representation.

Parameters:
writer XMLWriter object used to write XML representation.

Implements Event.


The documentation for this class was generated from the following files:
Generated on Fri May 19 12:15:55 2006 for Bamboo Ch@t by  doxygen 1.4.6