GpgFrontend/vmime
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Prefixed function names with 'get' + written some doc for functions.

Browse Source
This commit is contained in:
Vincent Richard 2005-01-13 21:45:20 +00:00
parent b2c3554be7
commit e782caba67
3 changed files with 80 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -2,6 +2,11 @@
VERSION 0.6.3cvs VERSION 0.6.3cvs
================ ================
2005-01-13 Vincent Richard <vincent@vincent-richard.net>
* messaging/events.*: prefixed function names with 'get' + written
some documentation for functions.
2005-01-05 Vincent Richard <vincent@vincent-richard.net> 2005-01-05 Vincent Richard <vincent@vincent-richard.net>
* Started version 0.6.3. * Started version 0.6.3.

24
src/messaging/events.cpp
View File

@ -32,7 +32,7 @@ namespace events {
// //
messageCountEvent::messageCountEvent messageCountEvent::messageCountEvent
(class folder* folder, const Types type, const std::vector <int>& nums) (folder* folder, const Types type, const std::vector <int>& nums)
: m_folder(folder), m_type(type) : m_folder(folder), m_type(type)
{ {
m_nums.resize(nums.size()); m_nums.resize(nums.size());
@ -40,9 +40,9 @@ messageCountEvent::messageCountEvent
} }
const folder* messageCountEvent::folder() const { return (const_cast <class folder*>(m_folder)); } const folder* messageCountEvent::getFolder() const { return (const_cast <folder*>(m_folder)); }
const messageCountEvent::Types messageCountEvent::type() const { return (m_type); } const messageCountEvent::Types messageCountEvent::getType() const { return (m_type); }
const std::vector <int>& messageCountEvent::numbers() const { return (m_nums); } const std::vector <int>& messageCountEvent::getNumbers() const { return (m_nums); }
void messageCountEvent::dispatch(messageCountListener* listener) const void messageCountEvent::dispatch(messageCountListener* listener) const
@ -59,7 +59,7 @@ void messageCountEvent::dispatch(messageCountListener* listener) const
// //
messageChangedEvent::messageChangedEvent messageChangedEvent::messageChangedEvent
(class folder* folder, const Types type, const std::vector <int>& nums) (folder* folder, const Types type, const std::vector <int>& nums)
: m_folder(folder), m_type(type) : m_folder(folder), m_type(type)
{ {
m_nums.resize(nums.size()); m_nums.resize(nums.size());
@ -67,9 +67,9 @@ messageChangedEvent::messageChangedEvent
} }
const folder* messageChangedEvent::folder() const { return (const_cast <class folder*>(m_folder)); } const folder* messageChangedEvent::getFolder() const { return (const_cast <folder*>(m_folder)); }
const messageChangedEvent::Types messageChangedEvent::type() const { return (m_type); } const messageChangedEvent::Types messageChangedEvent::getType() const { return (m_type); }
const std::vector <int>& messageChangedEvent::numbers() const { return (m_nums); } const std::vector <int>& messageChangedEvent::getNumbers() const { return (m_nums); }
void messageChangedEvent::dispatch(messageChangedListener* listener) const void messageChangedEvent::dispatch(messageChangedListener* listener) const
@ -83,18 +83,18 @@ void messageChangedEvent::dispatch(messageChangedListener* listener) const
// //
folderEvent::folderEvent folderEvent::folderEvent
(class folder* folder, const Types type, (folder* folder, const Types type,
const utility::path& oldPath, const utility::path& newPath) const utility::path& oldPath, const utility::path& newPath)
: m_folder(folder), m_type(type), m_oldPath(oldPath), m_newPath(newPath) : m_folder(folder), m_type(type), m_oldPath(oldPath), m_newPath(newPath)
{ {
} }
const class folder* folderEvent::folder() const { return (m_folder); } const folder* folderEvent::getFolder() const { return (m_folder); }
const folderEvent::Types folderEvent::type() const { return (m_type); } const folderEvent::Types folderEvent::getType() const { return (m_type); }
void folderEvent::dispatch(class folderListener* listener) const void folderEvent::dispatch(folderListener* listener) const
{ {
switch (m_type) switch (m_type)
{ {

77
vmime/messaging/events.hpp
View File

@ -48,17 +48,35 @@ public:
}; };
messageCountEvent(class folder* folder, const Types type, const std::vector <int>& nums); messageCountEvent(folder* folder, const Types type, const std::vector <int>& nums);
const class folder* folder() const; /** Return the folder in which messages have been added/removed.
const Types type() const; *
const std::vector <int>& numbers() const; * @return folder in which message count changed
*/
const folder* getFolder() const;
/** Return the event type.
*
* @return event type (see messageCountEvent::Types)
*/
const Types getType() const;
/** Return the numbers of the messages that have been added/removed.
*
* @return a list of message numbers
*/
const std::vector <int>& getNumbers() const;
/** Dispatch the event to the specified listener.
*
* @param listener listener to notify
*/
void dispatch(class messageCountListener* listener) const; void dispatch(class messageCountListener* listener) const;
private: private:
class folder* m_folder; folder* m_folder;
const Types m_type; const Types m_type;
std::vector <int> m_nums; std::vector <int> m_nums;
}; };
@ -93,17 +111,35 @@ public:
}; };
messageChangedEvent(class folder* folder, const Types type, const std::vector <int>& nums); messageChangedEvent(folder* folder, const Types type, const std::vector <int>& nums);
const class folder* folder() const; /** Return the folder in which messages have changed.
const Types type() const; *
const std::vector <int>& numbers() const; * @return folder in which message count changed
*/
const folder* getFolder() const;
/** Return the event type.
*
* @return event type (see messageChangedEvent::Types)
*/
const Types getType() const;
/** Return the numbers of the messages that have changed.
*
* @return a list of message numbers
*/
const std::vector <int>& getNumbers() const;
/** Dispatch the event to the specified listener.
*
* @param listener listener to notify
*/
void dispatch(class messageChangedListener* listener) const; void dispatch(class messageChangedListener* listener) const;
private: private:
class folder* m_folder; folder* m_folder;
const Types m_type; const Types m_type;
std::vector <int> m_nums; std::vector <int> m_nums;
}; };
@ -139,16 +175,29 @@ public:
}; };
folderEvent(class folder* folder, const Types type, const utility::path& oldPath, const utility::path& newPath); folderEvent(folder* folder, const Types type, const utility::path& oldPath, const utility::path& newPath);
const class folder* folder() const; /** Return the folder on which the event occured.
const Types type() const; *
* @return folder on which the event occured
*/
const folder* getFolder() const;
/** Return the event type.
*
* @return event type (see folderEvent::Types)
*/
const Types getType() const;
/** Dispatch the event to the specified listener.
*
* @param listener listener to notify
*/
void dispatch(class folderListener* listener) const; void dispatch(class folderListener* listener) const;
private: private:
class folder* m_folder; folder* m_folder;
const Types m_type; const Types m_type;
const utility::path m_oldPath; const utility::path m_oldPath;
const utility::path m_newPath; const utility::path m_newPath;