messageCountEvent Class Reference

#include <events.hpp>

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< size_t > &nums)
shared_ptr< folder >	getFolder () const
Types	getType () const
const std::vector< size_t > &	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 &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

Event about the message count in a folder.

Member Enumeration Documentation

Types

enum Types

Enumerator
TYPE_ADDED	New messages have been added.
TYPE_REMOVED	Messages have been expunged (renumbering).

Constructor & Destructor Documentation

messageCountEvent()

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

Member Function Documentation

dispatch()

void dispatch

(

class messageCountListener *

listener

)

Dispatch the event to the specified listener.

Parameters

listener

listener to notify

References vmime::dynamicCast(), messageCountListener::messagesAdded(), messageCountListener::messagesRemoved(), and TYPE_ADDED.

getClass()

const char * getClass ( ) const

virtual

Implements event.

References EVENT_CLASS.

getFolder()

shared_ptr< folder > getFolder

(

)

const

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

Returns

folder in which message count changed

getNumbers()

const std::vector< size_t > & getNumbers

(

)

const

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

Returns

a list of message numbers

getType()

messageCountEvent::Types getType

(

)

const

Return the event type.

Returns

event type (see messageCountEvent::Types)

Member Data Documentation

EVENT_CLASS

const char * EVENT_CLASS = "messageCountEvent"

static

Referenced by getClass(), and folder::notifyEvent().

---

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

• events.hpp
• events.cpp