Fairport  v1.0.38
fairport::search_folder Class Reference

Search Folder object. More...

#include <folder.h>

+ Inheritance diagram for fairport::search_folder:
+ Collaboration diagram for fairport::search_folder:

List of all members.

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.
tableget_contents_table ()
 Get the contents table of this folder.
const tableget_contents_table () const

Detailed Description

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.

Definition at line 47 of file folder.h.


Member Typedef Documentation

typedef boost::transform_iterator<contact_transform_row, row_filter_iterator> fairport::search_folder::contact_iterator

Contact iterator type; a transform iterator over a filter iterator over a table row iterator.

Definition at line 54 of file folder.h.

Message iterator type; a transform iterator over a table row iterator.

Definition at line 52 of file folder.h.

typedef boost::transform_iterator<task_transform_row, row_filter_iterator> fairport::search_folder::task_iterator

Task iterator type; a transform iterator over a filter iterator over a table row iterator.

Definition at line 56 of file folder.h.


Constructor & Destructor Documentation

fairport::search_folder::search_folder ( const node n) [inline]

Construct a search folder object.

Parameters:
[in]nA search folder node

Definition at line 60 of file folder.h.


Member Function Documentation

contact_iterator fairport::search_folder::contact_begin ( ) const [inline]

Get an iterator to the first contact in this folder.

Returns:
an iterator positioned on the first contact in this folder

Definition at line 75 of file folder.h.

contact_iterator fairport::search_folder::contact_end ( ) const [inline]

Get the end contact iterator.

Returns:
an iterator at the end position

Definition at line 79 of file folder.h.

fairport::table & fairport::search_folder::get_contents_table ( ) [inline]

Get the contents table of this folder.

Returns:
The contents table

Definition at line 265 of file folder.h.

const fairport::table & fairport::search_folder::get_contents_table ( ) const [inline]

Get the contents table of this folder.

Returns:
The contents table

Definition at line 257 of file folder.h.

size_t fairport::search_folder::get_message_count ( ) const [inline]

Get the number of messages in this folder.

Returns:
The number of messages

Definition at line 102 of file folder.h.

std::wstring fairport::search_folder::get_name ( ) const [inline]

Get the display name of this folder.

Returns:
The name of this folder

Definition at line 94 of file folder.h.

size_t fairport::search_folder::get_unread_message_count ( ) const [inline]

Get the number of unread messages in this folder.

Returns:
The number of unread messages

Definition at line 98 of file folder.h.

message_iterator fairport::search_folder::message_begin ( ) const [inline]

Get an iterator to the first message in this folder.

Returns:
an iterator positioned on the first message in this folder

Definition at line 66 of file folder.h.

message_iterator fairport::search_folder::message_end ( ) const [inline]

Get the end message iterator.

Returns:
an iterator at the end position

Definition at line 70 of file folder.h.

task_iterator fairport::search_folder::task_begin ( ) const [inline]

Get an iterator to the first task in this folder.

Returns:
an iterator positioned on the first task in this folder

Definition at line 84 of file folder.h.

task_iterator fairport::search_folder::task_end ( ) const [inline]

Get the end contact iterator.

Returns:
an iterator at the end position

Definition at line 88 of file folder.h.


The documentation for this class was generated from the following file: