folderEvent Class Reference

#include <events.hpp>

Inheritance diagram for folderEvent:

Collaboration diagram for folderEvent:

Public Types
enum	Types { TYPE_CREATED , TYPE_DELETED , TYPE_RENAMED }

Public Member Functions
	folderEvent (shared_ptr< folder > folder, const Types type, const utility::path &oldPath, const utility::path &newPath)
shared_ptr< folder >	getFolder () const
Types	getType () const
void	dispatch (class folderListener *listener)
const char *	getClass () const
Public Member Functions inherited from event
	event ()
virtual	~event ()

Static Public Attributes
static const char *	EVENT_CLASS = "folderEvent"

Additional Inherited Members
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

Event occuring on a folder.

Member Enumeration Documentation

Types

enum Types

Enumerator
TYPE_CREATED	A folder was created.
TYPE_DELETED	A folder was deleted.
TYPE_RENAMED	A folder was renamed.

Constructor & Destructor Documentation

folderEvent()

folderEvent	(	shared_ptr< folder >	folder,
		const Types	type,
		const utility::path &	oldPath,
		const utility::path &	newPath )

Member Function Documentation

dispatch()

void dispatch

(

class folderListener *

listener

)

Dispatch the event to the specified listener.

Parameters

listener

listener to notify

References vmime::dynamicCast(), folderListener::folderCreated(), folderListener::folderDeleted(), folderListener::folderRenamed(), TYPE_CREATED, TYPE_DELETED, and TYPE_RENAMED.

getClass()

const char * getClass ( ) const

virtual

Implements event.

References EVENT_CLASS.

getFolder()

shared_ptr< folder > getFolder

(

)

const

Return the folder on which the event occurred.

Returns

folder on which the event occurred

getType()

folderEvent::Types getType

(

)

const

Return the event type.

Returns

event type (see folderEvent::Types)

Member Data Documentation

EVENT_CLASS

const char * EVENT_CLASS = "folderEvent"

static

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

---

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

• events.hpp
• events.cpp