path: root/vmime-master/src/vmime/net/events.hpp

//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library.  Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//

#ifndef VMIME_NET_EVENTS_HPP_INCLUDED
#define VMIME_NET_EVENTS_HPP_INCLUDED


#include "vmime/config.hpp"


#if VMIME_HAVE_MESSAGING_FEATURES


#include <vector>

#include "vmime/utility/path.hpp"


namespace vmime {
namespace net {

class folder;

namespace events {


/** Event occurring on folders or messages.
  */
class VMIME_EXPORT event : public object, public enable_shared_from_this <event> {

public:

	event();
	virtual ~event();

	virtual const char* getClass() const = 0;
};


/** Event about the message count in a folder.
  */
class VMIME_EXPORT messageCountEvent : public event {

public:

	static const char* EVENT_CLASS;


	enum Types {
		TYPE_ADDED,     /**< New messages have been added. */
		TYPE_REMOVED    /**< Messages have been expunged (renumbering). */
	};


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

	/** Return the folder in which messages have been added/removed.
	  *
	  * @return folder in which message count changed
	  */
	shared_ptr <folder> getFolder() const;

	/** Return the event type.
	  *
	  * @return event type (see messageCountEvent::Types)
	  */
	Types getType() const;

	/** Return the numbers of the messages that have been added/removed.
	  *
	  * @return a list of message numbers
	  */
	const std::vector <size_t>& getNumbers() const;

	/** Dispatch the event to the specified listener.
	  *
	  * @param listener listener to notify
	  */
	void dispatch(class messageCountListener* listener);


	const char* getClass() const;

private:

	shared_ptr <folder> m_folder;
	const Types m_type;
	std::vector <size_t> m_nums;
};


/** Listener for events about the message count in a folder.
  */
class VMIME_EXPORT messageCountListener {

protected:

	virtual ~messageCountListener() { }

public:

	virtual void messagesAdded(const shared_ptr <messageCountEvent>& event) = 0;
	virtual void messagesRemoved(const shared_ptr <messageCountEvent>& event) = 0;
};


/** Event occuring on a message.
  */
class VMIME_EXPORT messageChangedEvent : public event {

public:

	static const char* EVENT_CLASS;


	enum Types {
		TYPE_FLAGS    // flags changed
	};


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

	/** Return the folder in which messages have changed.
	  *
	  * @return folder in which message count changed
	  */
	shared_ptr <folder> getFolder() const;

	/** Return the event type.
	  *
	  * @return event type (see messageChangedEvent::Types)
	  */
	Types getType() const;

	/** Return the numbers of the messages that have changed.
	  *
	  * @return a list of message numbers
	  */
	const std::vector <size_t>& getNumbers() const;

	/** Dispatch the event to the specified listener.
	  *
	  * @param listener listener to notify
	  */
	void dispatch(class messageChangedListener* listener);


	const char* getClass() const;

private:

	shared_ptr <folder> m_folder;
	const Types m_type;
	std::vector <size_t> m_nums;
};


/** Listener for events occuring on a message.
  */
class VMIME_EXPORT messageChangedListener {

protected:

	virtual ~messageChangedListener() { }

public:

	virtual void messageChanged(const shared_ptr <messageChangedEvent>& event) = 0;
};


/** Event occuring on a folder.
  */
class VMIME_EXPORT folderEvent : public event {

public:

	static const char* EVENT_CLASS;


	enum Types {
		TYPE_CREATED,   /**< A folder was created. */
		TYPE_DELETED,   /**< A folder was deleted. */
		TYPE_RENAMED    /**< A folder was renamed. */
	};


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

	/** Return the folder on which the event occurred.
	  *
	  * @return folder on which the event occurred
	  */
	shared_ptr <folder> getFolder() const;

	/** Return the event type.
	  *
	  * @return event type (see folderEvent::Types)
	  */
	Types getType() const;

	/** Dispatch the event to the specified listener.
	  *
	  * @param listener listener to notify
	  */
	void dispatch(class folderListener* listener);


	const char* getClass() const;

private:

	shared_ptr <folder> m_folder;
	const Types m_type;
	const utility::path m_oldPath;
	const utility::path m_newPath;
};


/** Listener for events occuring on a folder.
  */
class VMIME_EXPORT folderListener {

protected:

	virtual ~folderListener() { }

public:

	virtual void folderCreated(const shared_ptr <folderEvent>& event) = 0;
	virtual void folderRenamed(const shared_ptr <folderEvent>& event) = 0;
	virtual void folderDeleted(const shared_ptr <folderEvent>& event) = 0;
};


} // events
} // net
} // vmime


#endif // VMIME_HAVE_MESSAGING_FEATURES

#endif // VMIME_NET_EVENTS_HPP_INCLUDED