Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

OTodoAccess Class Reference

#include </home/clem/local/src/opie/noncore/unsupported/libopie/pim/otodoaccess.h>

Inheritance diagram for OTodoAccess:

Inheritance graph
[legend]
Collaboration diagram for OTodoAccess:

Collaboration graph
[legend]
List of all members.

Public Types

enum  SortOrder { Completed = 0, Priority, Description, Deadline }
enum  SortFilter { Category = 1, OnlyOverDue = 2, DoNotShowCompleted = 4 }

Signals

void changed (const OTodoAccess *)
void changed (const OTodoAccess *, int uid)
void added (const OTodoAccess *, int uid)
void removed (const OTodoAccess *, int uid)

Public Member Functions

 OTodoAccess (OTodoAccessBackend *=0l, enum Access acc=Random)
 ~OTodoAccess ()
List effectiveToDos (const QDate &start, const QDate &end, bool includeNoDates=true)
List effectiveToDos (const QDate &start, bool includeNoDates=true)
List overDue ()
List sorted (bool ascending, int sortOrder, int sortFilter, int cat)
void mergeWith (const QValueList< OTodo > &)
void removeAllCompleted ()
QBitArray backendSupport (const QString &backend=QString::null) const
bool backendSupports (int attr, const QString &backend=QString::null) const

Private Attributes

int m_cat
OTodoAccessBackendm_todoBackEnd
OTodoAccessPrivate * d

Detailed Description

OTodoAccess the class to get access to the todolist

Definition at line 17 of file otodoaccess.h.


Member Enumeration Documentation

enum OTodoAccess::SortFilter
 

Enumeration values:
Category 
OnlyOverDue 
DoNotShowCompleted 

Definition at line 24 of file otodoaccess.h.

enum OTodoAccess::SortOrder
 

Enumeration values:
Completed 
Priority 
Description 
Deadline 

Definition at line 20 of file otodoaccess.h.


Constructor & Destructor Documentation

OTodoAccess::OTodoAccess OTodoAccessBackend = 0l,
enum Access  acc = Random
 

if you use 0l the default resource will be picked up

Definition at line 9 of file otodoaccess.cpp.

References OBackendFactory< T >::Default(), l, m_todoBackEnd, QString::null, and OPimAccessTemplate< OTodo >::setBackEnd().

OTodoAccess::~OTodoAccess  ) 
 

Definition at line 21 of file otodoaccess.cpp.


Member Function Documentation

void OTodoAccess::added const OTodoAccess ,
int  uid
[signal]
 

QBitArray OTodoAccess::backendSupport const QString backend = QString::null  )  const
 

request information about what a backend supports. Supports in the sense of beeing able to store. This is related to the enum in OTodo

Parameters:
backend Will be used in the future when we support multiple backend

Definition at line 57 of file otodoaccess.cpp.

References m_todoBackEnd, and OTodoAccessBackend::supports().

Referenced by backendSupports().

bool OTodoAccess::backendSupports int  attr,
const QString backend = QString::null
const
 

see above but for a specefic attribute. This method was added for convience

Parameters:
attr The attribute to be queried for
backend Will be used in the future when we support multiple backends

Definition at line 60 of file otodoaccess.cpp.

References backendSupport().

void OTodoAccess::changed const OTodoAccess ,
int  uid
[signal]
 

void OTodoAccess::changed const OTodoAccess  )  [signal]
 

if the OTodoAccess was changed

OTodoAccess::List OTodoAccess::effectiveToDos const QDate start,
bool  includeNoDates = true
 

start end date taken from the currentDate()

Definition at line 38 of file otodoaccess.cpp.

References QDate::currentDate(), and effectiveToDos().

OTodoAccess::List OTodoAccess::effectiveToDos const QDate start,
const QDate end,
bool  includeNoDates = true
 

include todos from start to end includeNoDates whether or not to include events with no dates

Definition at line 30 of file otodoaccess.cpp.

References OTodoAccessBackend::effectiveToDos(), and m_todoBackEnd.

Referenced by effectiveToDos().

void OTodoAccess::mergeWith const QValueList< OTodo > &   ) 
 

merge a list of OTodos into the resource

Definition at line 24 of file otodoaccess.cpp.

References QValueList< T >::begin(), QValueList< T >::end(), and OPimAccessTemplate< OTodo >::replace().

OTodoAccess::List OTodoAccess::overDue  ) 
 

return overdue OTodos

Definition at line 43 of file otodoaccess.cpp.

References m_todoBackEnd, and OTodoAccessBackend::overDue().

void OTodoAccess::removeAllCompleted  ) 
 

delete all already completed items

Definition at line 54 of file otodoaccess.cpp.

References m_todoBackEnd, and OTodoAccessBackend::removeAllCompleted().

void OTodoAccess::removed const OTodoAccess ,
int  uid
[signal]
 

OTodoAccess::List OTodoAccess::sorted bool  ascending,
int  sortOrder,
int  sortFilter,
int  cat
 

Definition at line 48 of file otodoaccess.cpp.

References list, m_todoBackEnd, and OTodoAccessBackend::sorted().


Member Data Documentation

OTodoAccessPrivate* OTodoAccess::d [private]
 

Reimplemented from OPimAccessTemplate< OTodo >.

Definition at line 101 of file otodoaccess.h.

int OTodoAccess::m_cat [private]
 

Definition at line 99 of file otodoaccess.h.

OTodoAccessBackend* OTodoAccess::m_todoBackEnd [private]
 

Definition at line 100 of file otodoaccess.h.

Referenced by backendSupport(), effectiveToDos(), OTodoAccess(), overDue(), removeAllCompleted(), and sorted().


The documentation for this class was generated from the following files:
Generated on Sat Nov 5 17:43:48 2005 for OPIE by  doxygen 1.4.2