aboutsummaryrefslogtreecommitdiffstats
path: root/src/messaging/events.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/messaging/events.hpp')
-rw-r--r--src/messaging/events.hpp34
1 files changed, 20 insertions, 14 deletions
diff --git a/src/messaging/events.hpp b/src/messaging/events.hpp
index d51ca2d0..f2ab9e29 100644
--- a/src/messaging/events.hpp
+++ b/src/messaging/events.hpp
@@ -34,9 +34,8 @@ class folder;
namespace events {
-//
-// messageCountEvent
-//
+/** Event about the message count in a folder.
+ */
class messageCountEvent
{
@@ -44,8 +43,8 @@ public:
enum Types
{
- TYPE_ADDED, // new messages
- TYPE_REMOVED // expunged messages: renumbering
+ TYPE_ADDED, /**< New messages have been added. */
+ TYPE_REMOVED /**< Messages have been expunged (renumbering). */
};
@@ -65,6 +64,9 @@ private:
};
+/** Listener for events about the message count in a folder.
+ */
+
class messageCountListener
{
protected:
@@ -78,9 +80,8 @@ public:
};
-//
-// messageChangedEvent
-//
+/** Event occuring on a message.
+ */
class messageChangedEvent
{
@@ -108,6 +109,9 @@ private:
};
+/** Listener for events occuring on a message.
+ */
+
class messageChangedListener
{
protected:
@@ -120,9 +124,8 @@ public:
};
-//
-// folderEvent
-//
+/** Event occuring on a folder.
+ */
class folderEvent
{
@@ -130,9 +133,9 @@ public:
enum Types
{
- TYPE_CREATED, // a folder was created
- TYPE_DELETED, // a folder was deleted
- TYPE_RENAMED // a folder was renamed
+ TYPE_CREATED, /**< A folder was created. */
+ TYPE_DELETED, /**< A folder was deleted. */
+ TYPE_RENAMED /**< A folder was renamed. */
};
@@ -152,6 +155,9 @@ private:
};
+/** Listener for events occuring on a folder.
+ */
+
class folderListener
{
protected: