libopie PIM API Documentation
	Overview Class Hierarchy Classes Classes (annotated) Members Source Files Todo

OTodoAccess Class Reference

OTodoAccess the class to get access to the todolist. More...

#include <otodoaccess.h>

Inheritance diagram for OTodoAccess:

[legend]Collaboration diagram for OTodoAccess:

[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 *)
	if the OTodoAccess was changed
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)
	if you use 0l the default resource will be picked up
	~OTodoAccess ()
List	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
List	effectiveToDos (const QDate &start, bool includeNoDates=true)
	start end date taken from the currentDate()
List	overDue ()
	return overdue OTodos
List	sorted (bool ascending, int sortOrder, int sortFilter, int cat)
void	mergeWith (const QValueList< OTodo > &)
	merge a list of OTodos into the resource
void	removeAllCompleted ()
	delete all already completed items
QBitArray	backendSupport (const QString &backend=QString::null) const
	request information about what a backend supports.
bool	backendSupports (int attr, const QString &backend=QString::null) const
	see above but for a specefic attribute.

---

Detailed Description

OTodoAccess the class to get access to the todolist.

Definition at line 17 of file otodoaccess.h.

---

Member Enumeration Documentation

enum OTodoAccess::SortOrder

Enumeration values: Completed  Priority  Description  Deadline  Definition at line 20 of file otodoaccess.h.

enum OTodoAccess::SortFilter

Enumeration values: Category  OnlyOverDue  DoNotShowCompleted  Definition at line 24 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(), and OPimAccessTemplate< OTodo >::setBackEnd().

OTodoAccess::~OTodoAccess (   )

Definition at line 21 of file otodoaccess.cpp.

---

Member Function Documentation

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(). Referenced by effectiveToDos().

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 effectiveToDos().

OTodoAccess::List OTodoAccess::overDue (   )

return overdue OTodos Definition at line 43 of file otodoaccess.cpp. References OTodoAccessBackend::overDue().

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

Definition at line 48 of file otodoaccess.cpp. References OTodoAccessBackend::sorted().

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

merge a list of OTodos into the resource Definition at line 24 of file otodoaccess.cpp. References QValueList::begin(), QValueList::end(), and OPimAccessTemplate< OTodo >::replace().

void OTodoAccess::removeAllCompleted (   )

delete all already completed items Definition at line 54 of file otodoaccess.cpp. References OTodoAccessBackend::removeAllCompleted().

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 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(), and QBitArray::testBit().

void OTodoAccess::changed (  const OTodoAccess *   )  [signal]

if the OTodoAccess was changed

void OTodoAccess::changed (  const OTodoAccess *  , int  uid )  [signal]

void OTodoAccess::added (  const OTodoAccess *  , int  uid )  [signal]

void OTodoAccess::removed (  const OTodoAccess *  , int  uid )  [signal]

---

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

• otodoaccess.h
• otodoaccess.cpp

This file is part of the documentation for OPIE Version 1.1.

Documentation copyright © 1997-2003 the KDE developers. 2003 OPIE developers
Generated on Tue Feb 10 20:26:29 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001