VMime
messageCountEvent Class Reference
Inheritance diagram for messageCountEvent:
Collaboration diagram for messageCountEvent:

Public Types

enum  Types { TYPE_ADDED, TYPE_REMOVED }
 

Public Member Functions

 messageCountEvent (shared_ptr< folder > folder, const Types type, const std::vector< int > &nums)
 
shared_ptr< foldergetFolder () const
 
Types getType () const
 
const std::vector< int > & getNumbers () const
 
void dispatch (class messageCountListener *listener)
 
const char * getClass () const
 
- Public Member Functions inherited from event
 event ()
 
virtual ~event ()
 

Static Public Attributes

static const char * EVENT_CLASS = "messageCountEvent"
 

Additional Inherited Members

- Protected Member Functions inherited from object
 object ()
 
 object (const object &)
 
objectoperator= (const object &)
 
virtual ~object ()
 

Detailed Description

Event about the message count in a folder.

Member Enumeration Documentation

enum Types
Enumerator
TYPE_ADDED 

New messages have been added.

TYPE_REMOVED 

Messages have been expunged (renumbering).

Constructor & Destructor Documentation

messageCountEvent ( shared_ptr< folder folder,
const Types  type,
const std::vector< int > &  nums 
)

Member Function Documentation

void dispatch ( class messageCountListener listener)

Dispatch the event to the specified listener.

Parameters
listenerlistener to notify

References messageCountListener::messagesAdded(), messageCountListener::messagesRemoved(), and messageCountEvent::TYPE_ADDED.

const char * getClass ( ) const
virtual

Implements event.

References messageCountEvent::EVENT_CLASS.

shared_ptr< folder > getFolder ( ) const

Return the folder in which messages have been added/removed.

Returns
folder in which message count changed
const std::vector< int > & getNumbers ( ) const

Return the numbers of the messages that have been added/removed.

Returns
a list of message numbers
messageCountEvent::Types getType ( ) const

Return the event type.

Returns
event type (see messageCountEvent::Types)

Member Data Documentation

const char * EVENT_CLASS = "messageCountEvent"
static

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