#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.

Member Function Documentation

◆ addTask

virtual int KarmDCOPIface::addTask ( const TQString & 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.

◆ bookTime

virtual int KarmDCOPIface::bookTime	(	const TQString &	taskId,
		const TQString &	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 TQt::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 MainWindow, and karmPart.

◆ deletetodo

virtual TQString KarmDCOPIface::deletetodo ( )

pure virtual

delete the current item

Implemented in MainWindow, and karmPart.

◆ exportcsvfile

virtual TQString KarmDCOPIface::exportcsvfile	(	TQString	filename,
		TQString	from,
		TQString	to,
		int	type = `0`,
		bool	decimalMinutes = `true`,
		bool	allTasks = `true`,
		TQString	delimiter = `";"`,
		TQString	quote = `"'"`
	)

pure virtual

export csv history or totals file

Implemented in karmPart, and MainWindow.

◆ getError

virtual TQString 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 MainWindow, and karmPart.

◆ getpromptdelete

virtual bool KarmDCOPIface::getpromptdelete ( )

pure virtual

get if prompted on deleting a task

Implemented in MainWindow, and karmPart.

◆ importplannerfile

virtual TQString KarmDCOPIface::importplannerfile ( TQString filename )

pure virtual

import planner project file

Implemented in MainWindow, and karmPart.

◆ quit

virtual void KarmDCOPIface::quit ( )

pure virtual

Graceful shutdown.

Implemented in karmPart.

◆ save

virtual bool KarmDCOPIface::save ( )

pure virtual

save your tasks

Implemented in karmPart.

◆ setPerCentComplete

virtual TQString KarmDCOPIface::setPerCentComplete	(	const TQString &	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 MainWindow, and karmPart.

◆ setpromptdelete

virtual TQString KarmDCOPIface::setpromptdelete ( bool prompt )

pure virtual

set if prompted on deleting a task

Implemented in MainWindow, and karmPart.

◆ starttimerfor

virtual TQString KarmDCOPIface::starttimerfor ( const TQString & taskname )

pure virtual

Start timer for all tasks with the summary taskname.

Implemented in MainWindow, and karmPart.

◆ stoptimerfor

virtual TQString KarmDCOPIface::stoptimerfor ( const TQString & taskname )

pure virtual

Stop timer for all tasks with the summary taskname.

Implemented in MainWindow, and karmPart.

◆ taskIdFromName

virtual TQString KarmDCOPIface::taskIdFromName ( const TQString & taskName ) const

pure virtual

Return id of task found, empty string if no match.

Implemented in MainWindow, and karmPart.

◆ totalMinutesForTaskId

virtual int KarmDCOPIface::totalMinutesForTaskId ( const TQString & 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 MainWindow, and karmPart.

◆ version

virtual TQString KarmDCOPIface::version ( ) const

pure virtual

Return karm version.

Implemented in MainWindow, and karmPart.

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

karmdcopiface.h