Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   Related Pages  

ICQ2000::ICQMessageEvent Class Reference

Base class for ICQ messages (not SMS). More...

#include <events.h>

Inheritance diagram for ICQ2000::ICQMessageEvent:

ICQ2000::MessageEvent ICQ2000::Event ICQ2000::AuthAckEvent ICQ2000::AuthReqEvent ICQ2000::AwayMessageEvent ICQ2000::NormalMessageEvent ICQ2000::URLMessageEvent ICQ2000::UserAddEvent List of all members.

Public Methods

 ICQMessageEvent (ContactRef c)
 Constructor for a ICQMessageEvent.

bool isUrgent () const
 get whether the message was sent marked as urgent

void setUrgent (bool b)
 set whether the message shall be marked as urgent

bool isToContactList () const
 get whether the message was sent 'to contact list'

void setToContactList (bool b)
 set whether the message shall be marked as urgent

bool isOfflineMessage () const
 get if this was an offline message

void setOfflineMessage (bool b)
 set whether this was an offline message

unsigned int getSenderUIN () const
 get the uin of the sender.

std::string getAwayMessage () const
 get the away message

void setAwayMessage (const std::string &msg)
 set the away message

virtual ICQMessageEvent * copy () const=0

Detailed Description

Base class for ICQ messages (not SMS).


Constructor & Destructor Documentation

ICQ2000::ICQMessageEvent::ICQMessageEvent ContactRef    c
 

Constructor for a ICQMessageEvent.

Parameters:
c  the contact related to this event


Member Function Documentation

string ICQ2000::ICQMessageEvent::getAwayMessage   const
 

get the away message

Returns:
the away message

unsigned int ICQ2000::ICQMessageEvent::getSenderUIN   const
 

get the uin of the sender.

This is really miss-named, if you were sending the message, this would be the UIN of the recipient.

Returns:
the uin

Reimplemented in ICQ2000::UserAddEvent.

bool ICQ2000::ICQMessageEvent::isOfflineMessage   const
 

get if this was an offline message

Returns:
if this was an offline message

bool ICQ2000::ICQMessageEvent::isToContactList   const
 

get whether the message was sent 'to contact list'

Returns:
whether message was to contact list

bool ICQ2000::ICQMessageEvent::isUrgent   const
 

get whether the message was sent marked as urgent

Returns:
the urgency

void ICQ2000::ICQMessageEvent::setAwayMessage const std::string &    msg
 

set the away message

Parameters:
msg  the away message

void ICQ2000::ICQMessageEvent::setUrgent bool    b
 

set whether the message shall be marked as urgent

Parameters:
b  urgent


The documentation for this class was generated from the following files:
Generated on Sun Jul 21 10:57:33 2002 for libicq2000 by doxygen1.2.16