Prefixed function names with 'get' + written some doc for functions.
This commit is contained in:
parent
b2c3554be7
commit
e782caba67
@ -2,6 +2,11 @@
|
||||
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>
|
||||
|
||||
* Started version 0.6.3.
|
||||
|
@ -32,7 +32,7 @@ namespace events {
|
||||
//
|
||||
|
||||
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_nums.resize(nums.size());
|
||||
@ -40,9 +40,9 @@ messageCountEvent::messageCountEvent
|
||||
}
|
||||
|
||||
|
||||
const folder* messageCountEvent::folder() const { return (const_cast <class folder*>(m_folder)); }
|
||||
const messageCountEvent::Types messageCountEvent::type() const { return (m_type); }
|
||||
const std::vector <int>& messageCountEvent::numbers() const { return (m_nums); }
|
||||
const folder* messageCountEvent::getFolder() const { return (const_cast <folder*>(m_folder)); }
|
||||
const messageCountEvent::Types messageCountEvent::getType() const { return (m_type); }
|
||||
const std::vector <int>& messageCountEvent::getNumbers() const { return (m_nums); }
|
||||
|
||||
|
||||
void messageCountEvent::dispatch(messageCountListener* listener) const
|
||||
@ -59,7 +59,7 @@ void messageCountEvent::dispatch(messageCountListener* listener) const
|
||||
//
|
||||
|
||||
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_nums.resize(nums.size());
|
||||
@ -67,9 +67,9 @@ messageChangedEvent::messageChangedEvent
|
||||
}
|
||||
|
||||
|
||||
const folder* messageChangedEvent::folder() const { return (const_cast <class folder*>(m_folder)); }
|
||||
const messageChangedEvent::Types messageChangedEvent::type() const { return (m_type); }
|
||||
const std::vector <int>& messageChangedEvent::numbers() const { return (m_nums); }
|
||||
const folder* messageChangedEvent::getFolder() const { return (const_cast <folder*>(m_folder)); }
|
||||
const messageChangedEvent::Types messageChangedEvent::getType() const { return (m_type); }
|
||||
const std::vector <int>& messageChangedEvent::getNumbers() const { return (m_nums); }
|
||||
|
||||
|
||||
void messageChangedEvent::dispatch(messageChangedListener* listener) const
|
||||
@ -83,18 +83,18 @@ void messageChangedEvent::dispatch(messageChangedListener* listener) const
|
||||
//
|
||||
|
||||
folderEvent::folderEvent
|
||||
(class folder* folder, const Types type,
|
||||
(folder* folder, const Types type,
|
||||
const utility::path& oldPath, const utility::path& newPath)
|
||||
: m_folder(folder), m_type(type), m_oldPath(oldPath), m_newPath(newPath)
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
const class folder* folderEvent::folder() const { return (m_folder); }
|
||||
const folderEvent::Types folderEvent::type() const { return (m_type); }
|
||||
const folder* folderEvent::getFolder() const { return (m_folder); }
|
||||
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)
|
||||
{
|
||||
|
@ -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;
|
||||
const Types type() const;
|
||||
const std::vector <int>& numbers() const;
|
||||
/** Return the folder in which messages have been added/removed.
|
||||
*
|
||||
* @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;
|
||||
|
||||
private:
|
||||
|
||||
class folder* m_folder;
|
||||
folder* m_folder;
|
||||
const Types m_type;
|
||||
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;
|
||||
const Types type() const;
|
||||
const std::vector <int>& numbers() const;
|
||||
/** Return the folder in which messages have changed.
|
||||
*
|
||||
* @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;
|
||||
|
||||
private:
|
||||
|
||||
class folder* m_folder;
|
||||
folder* m_folder;
|
||||
const Types m_type;
|
||||
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;
|
||||
const Types type() const;
|
||||
/** Return the folder on which the event occured.
|
||||
*
|
||||
* @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;
|
||||
|
||||
private:
|
||||
|
||||
class folder* m_folder;
|
||||
folder* m_folder;
|
||||
const Types m_type;
|
||||
const utility::path m_oldPath;
|
||||
const utility::path m_newPath;
|
||||
|
Loading…
Reference in New Issue
Block a user