karm
KarmDCOPIface Class Reference
#include <karmdcopiface.h>
Inheritance diagram for KarmDCOPIface:

Detailed Description
Define DCOP interface to karm.Methods implemented in MainWindow
Definition at line 27 of file karmdcopiface.h.
DCOP Member Functions | |
virtual QString | version () const=0 |
virtual QString | taskIdFromName (const QString &taskName) const=0 |
virtual int | addTask (const QString &taskName)=0 |
virtual QString | setPerCentComplete (const QString &taskName, int perCent)=0 |
virtual int | bookTime (const QString &taskId, const QString &iso8601StartDateTime, long durationInMinutes)=0 |
virtual QString | getError (int karmErrorNumber) const =0 |
virtual int | totalMinutesForTaskId (const QString &taskId)=0 |
virtual QString | starttimerfor (const QString &taskname)=0 |
virtual QString | stoptimerfor (const QString &taskname)=0 |
virtual QString | deletetodo ()=0 |
virtual QString | setpromptdelete (bool prompt)=0 |
virtual bool | getpromptdelete ()=0 |
virtual QString | exportcsvfile (QString filename, QString from, QString to, int type=0, bool decimalMinutes=true, bool allTasks=true, QString delimiter=";", QString quote="'")=0 |
virtual QString | importplannerfile (QString filename)=0 |
virtual bool | save ()=0 |
virtual void | quit ()=0 |
Member Function Documentation
virtual QString KarmDCOPIface::version | ( | ) | const [pure virtual] |
virtual QString KarmDCOPIface::taskIdFromName | ( | const QString & | taskName | ) | const [pure virtual] |
virtual int KarmDCOPIface::addTask | ( | const QString & | taskName | ) | [pure virtual] |
Add a new top-level task.
A top-level task is one that has no parent tasks.
- Parameters:
-
taskName Name of new task.
- Returns:
- 0 on success, error number on failure.
Implemented in karmPart, and MainWindow.
virtual QString KarmDCOPIface::setPerCentComplete | ( | const QString & | taskName, | |
int | perCent | |||
) | [pure virtual] |
Set percent complete to a task.
- Parameters:
-
taskName Name of new task. perCent percent, e.g. 99
- Returns:
- "" on success, error msg on failure.
Implemented in karmPart, and MainWindow.
virtual int KarmDCOPIface::bookTime | ( | const QString & | taskId, | |
const QString & | iso8601StartDateTime, | |||
long | durationInMinutes | |||
) | [pure virtual] |
Add time to a task.
The GUI will be non-responsive until this method returns.
- Returns:
- 0 on success, error number on failure.
- Parameters:
-
taskId Unique ID of task to add time to iso8601StartDateTime Date and time the booking starts, in extended ISO-8601 format; for example, YYYY-MM-DDTHH:MI:SS format (see Qt::ISODate). No timezone support--time is interpreted as the local time. If just the date is passed in (i.e., YYYY-MM-DD) , then the time is set to noon. durationInMinutes The amount of time to book against the taskId.
Implemented in karmPart, and MainWindow.
virtual QString KarmDCOPIface::getError | ( | int | karmErrorNumber | ) | const [pure virtual] |
Return error string associated with karm error number.
- Parameters:
-
karmErrorNumber An integer error number.
- Returns:
- String associated with error number. These strings are internationalized. An unknown error number produces an empty string as the return value.
Implemented in karmPart, and MainWindow.
virtual int KarmDCOPIface::totalMinutesForTaskId | ( | const QString & | taskId | ) | [pure virtual] |
Total time currently associated with a task.
A task has two counters: the total session time and the total time. Note that th euser can reset both counters.
- Parameters:
-
taskId Unique ID of task to lookup bookings for.
Implemented in karmPart, and MainWindow.
virtual QString KarmDCOPIface::starttimerfor | ( | const QString & | taskname | ) | [pure virtual] |
virtual QString KarmDCOPIface::stoptimerfor | ( | const QString & | taskname | ) | [pure virtual] |
virtual QString KarmDCOPIface::deletetodo | ( | ) | [pure virtual] |
virtual QString KarmDCOPIface::setpromptdelete | ( | bool | prompt | ) | [pure virtual] |
virtual bool KarmDCOPIface::getpromptdelete | ( | ) | [pure virtual] |
virtual QString KarmDCOPIface::exportcsvfile | ( | QString | filename, | |
QString | from, | |||
QString | to, | |||
int | type = 0 , |
|||
bool | decimalMinutes = true , |
|||
bool | allTasks = true , |
|||
QString | delimiter = ";" , |
|||
QString | quote = "'" | |||
) | [pure virtual] |
virtual QString KarmDCOPIface::importplannerfile | ( | QString | filename | ) | [pure virtual] |
virtual bool KarmDCOPIface::save | ( | ) | [pure virtual] |
virtual void KarmDCOPIface::quit | ( | ) | [pure virtual] |
The documentation for this class was generated from the following file: