Fairport
v1.0.38
|
Search Folder object. More...
#include <folder.h>
Public Types | |
typedef boost::transform_iterator < message_transform_row, const_table_row_iter > | message_iterator |
Message iterator type; a transform iterator over a table row iterator. | |
typedef boost::transform_iterator < contact_transform_row, row_filter_iterator > | contact_iterator |
Contact iterator type; a transform iterator over a filter iterator over a table row iterator. | |
typedef boost::transform_iterator < task_transform_row, row_filter_iterator > | task_iterator |
Task iterator type; a transform iterator over a filter iterator over a table row iterator. | |
Public Member Functions | |
search_folder (const node &n) | |
Construct a search folder object. | |
message_iterator | message_begin () const |
Get an iterator to the first message in this folder. | |
message_iterator | message_end () const |
Get the end message iterator. | |
contact_iterator | contact_begin () const |
Get an iterator to the first contact in this folder. | |
contact_iterator | contact_end () const |
Get the end contact iterator. | |
task_iterator | task_begin () const |
Get an iterator to the first task in this folder. | |
task_iterator | task_end () const |
Get the end contact iterator. | |
std::wstring | get_name () const |
Get the display name of this folder. | |
size_t | get_unread_message_count () const |
Get the number of unread messages in this folder. | |
size_t | get_message_count () const |
Get the number of messages in this folder. | |
table & | get_contents_table () |
Get the contents table of this folder. | |
const table & | get_contents_table () const |
Search Folder object.
Search folders are different from regular folders mainly in that they do not have a hierarchy table (and thus no subfolders). The messages they "contain" are actually in other folders.
This object exists to reflect that limited interface. Eventually this object may support querying the criteria used to create the search folder.
typedef boost::transform_iterator<contact_transform_row, row_filter_iterator> fairport::search_folder::contact_iterator |
typedef boost::transform_iterator<message_transform_row, const_table_row_iter> fairport::search_folder::message_iterator |
typedef boost::transform_iterator<task_transform_row, row_filter_iterator> fairport::search_folder::task_iterator |
fairport::search_folder::search_folder | ( | const node & | n | ) | [inline] |
contact_iterator fairport::search_folder::contact_begin | ( | ) | const [inline] |
contact_iterator fairport::search_folder::contact_end | ( | ) | const [inline] |
fairport::table & fairport::search_folder::get_contents_table | ( | ) | [inline] |
const fairport::table & fairport::search_folder::get_contents_table | ( | ) | const [inline] |
size_t fairport::search_folder::get_message_count | ( | ) | const [inline] |
std::wstring fairport::search_folder::get_name | ( | ) | const [inline] |
size_t fairport::search_folder::get_unread_message_count | ( | ) | const [inline] |
message_iterator fairport::search_folder::message_begin | ( | ) | const [inline] |
message_iterator fairport::search_folder::message_end | ( | ) | const [inline] |
task_iterator fairport::search_folder::task_begin | ( | ) | const [inline] |
task_iterator fairport::search_folder::task_end | ( | ) | const [inline] |