folderEvent Class Reference

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

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	(	shared_ptr< folder >	folder,
		const Types	type,
		const utility::path &	oldPath,
		const utility::path &	newPath
	)

Member Function Documentation

void dispatch

(

class folderListener *

listener

)

Dispatch the event to the specified listener.

Parameters

listener

listener to notify

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

const char * getClass ( ) const

virtual

Implements event.

References folderEvent::EVENT_CLASS.

shared_ptr< folder > getFolder

(

)

const

Return the folder on which the event occured.

Returns

folder on which the event occured

folderEvent::Types getType

(

)

const

Return the event type.

Returns

event type (see folderEvent::Types)

Member Data Documentation

const char * EVENT_CLASS = "folderEvent"

static

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

---

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

• events.hpp
• events.cpp