View source for KTimeTracker

{|style="text-align:center"
|[[Image:Snapshot-ktimetracker-n810.jpg|thumb|265px|Ktimetracker]]|| '''ktimetracker running on the N810'''
|}


This page is for people who want to participate in the ktimetracker community. So, for (future) ktimetracker developers.

= IDE =
Please use qtcreator. Why? Quite easy: The [http://techbase.kde.org/Getting_Started/Set_up_KDE_4_for_development#Development_tasks description how to set up kdevelop with KDE] is over 200 lines long. For eclipse it is 97 and for QtCreator it is 13. So, 13 lines to read instead of 222.

= Architecture =
ktimetracker can be a kpart (class ktimetrackerpart) or a mainwindow (class mainwindow). The kpart can be used e.g. for a kontact plugin, the mainwindow as stand-alone application. Both classes display a timetrackerwidget, that is a ktabwidget containing one or more taskviews. A taskview is associated with a timetrackerstorage object that holds a calendar with todos and events. A taskview is a [http://doc.qt.nokia.com/4.7/qtreewidget.html QTreeWidget] that holds tasks. A task has a summary (name), a priority and times: the time, total time, session time and total session time. Over the QTreeWidget, a task can have subtasks. The total time is defined as the task's and all its subtasks' times.

= Roadmap to the classes =
See http://api.kde.org/4.x-api/kdepim-apidocs/ktimetracker/html/
 main -> mainwindow ------------------------                                                         -> task
                                             \                                                     /
                                              -> timetrackerwidget -(contains n>=0)-> [http://api.kde.org/4.x-api/kdepim-apidocs/ktimetracker/html/classTaskView.html taskview] -
                                             /                                                     \
 ktimetracker_plugin -> ktimetrackerpart ---                                                         -> [http://api.kde.org/4.x-api/kdepim-apidocs/ktimetracker/html/classtimetrackerstorage.html timetrackerstorage] 
 
 KTimeTrackerSettings
 

ktimetracker's program main.cpp creates '''mainwindow''', this creates a '''timetrackerpart''' this calls '''timetrackerwidget''', this calls '''taskview''', this contains a '''timetrackerstorage'''.

karmstorage stores and loads the events and tasks.
taskview displays them.
timetrackerwidget displays one or more taskviews in tabs, plus the searchWidget.
timetrackerpart can be integrated into a mainwindow or a kontact plugin.
mainwindow adds the menu.

'''MainWindow''' is the outermost layer and initializes the menus and actions, sets up the status bar, and handles many of the signal-to-slot connections. It holds a pointer to the timetrackerwidget and Preferences objects and implements the ktimetracker DBUS interface.

'''TaskView''' does most of the work in the application. This QListWidget subclass sets up the columns in the list, the idle detection timer, the auto save timer, and the desktop tracker. It starts and stops timers, handles importing and exporting and displays the edit task dialog in response to user action. TaskView holds a private pointer to Preferences and a timetrackerstorage object.

A '''Task''' is a QListViewItem subclass stores state such as the timer totals, if a timer is currently running for the task. It also defines the list view sort order and can return a pointer to a KCal::Todo object that holds the same information.

Preferences is a singleton that stores configuration options. It raises signals when options change (for example, the location where the ktimetracker data is stored) so the application can react and adjust.

'''timetrackerstorage''' is a singleton that creates an interface for storing ktimetracker data. Currently, it uses KDE Resource framework and stores data in the iCalendar format.

'''KTimeTrackerSettings''' stores ktimetracker's configuration, settings, preferences or however you call it. It is declared in the file ktimetracker.h.

= how configuration is programmed =
Configuration is also called preferences. The following files are involved:
* cfgbehavior.ui
* ui_cfgbehavior.h - automatically created from cfgbehavior.ui
* preferences.h - saves which tasks will be shown expanded and which ones collapsed
* preferences.cpp - saves which tasks will be shown expanded and which ones collapsed
* preferences.moc - automatically created from preferences.h
* ktimetracker_config_behavior.desktop
* ktimetracker_config_display.desktop
* ktimetracker_config_storage.desktop
* ktimetrackerconfigdialog.cpp
* ktimetracker.kcfgc
* ktimetracker.kcfg
* ktimetracker.h - declaring the class KTimeTrackerSettings. This file is automatically generated from ktimetracker.kcfg.
* ktimetracker.cpp - implementing the class KTimeTrackerSettings. This file is automatically generated from ktimetracker.kcfg.
* ktimetrackerconfigdialog.cpp
* ktimetrackerconfigdialog.h

= ktimetracker in the web =
If you need to update screenshots you might have to do it on the following pages:
* http://userbase.kde.org/ktimetracker
* http://community.kde.org/index.php?title=Ktimetracker
* http://kde.org/applications/utilities/ktimetracker/

= bugs =
* Find ktimetracker's open bugs (without NEEDINFO bugs) with [https://bugs.kde.org/buglist.cgi?product=ktimetracker&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=changeddate%2Cbug_severity%2Cassigned_to%2Creporter%2Cresolution%2Cvotes%2Cshort_desc this query]
* find all ktimetracker's bugs with [https://bugs.kde.org/buglist.cgi?product=ktimetracker&columnlist=changeddate%2Cbug_severity%2Cassigned_to%2Creporter%2Cresolution%2Cvotes%2Cshort_desc this query]

= coding style =
It is more important that you contribute than that you contribute with the right coding style. That having said, [[User:ThorstenStaerk|I]] prefer if you use code that is consistent with QtCreator's defaults. Opening and closing brackets and parentheses should be on the same row or column.

= git art =
 git checkout KDE/4.7
then
 git cherry-pick -x <commit>

= development direction =
There should not be any "New" and "Close". ktimetracker should contain exactly one taskview. See https://bugs.kde.org/show_bug.cgi?id=182317 and https://bugs.kde.org/show_bug.cgi?id=265085

= ktimetracker benchmark =

= The help menu =
The help menu is stupidly overloaded and I cannot do anything about it because it is somewhere hidden in the library code. Would love to simplify it. "Help" does not need subitems - you want help.

= The KPart Mess =
ktimetracker is an application displaying a kpart. On the one hand, this makes it easy to be integrated as kontact plugin. But on the other hand, I have the feeling, ktimetracker can no long be debugged so easily. Here are the reasons why dedicated applications are better:
* can be designed graphically in qtcreator
* can be edited in qtcreator having all advantages like code completion
* can be debugged step-by-step from qtcreator
* [https://bugs.kde.org/show_bug.cgi?id=182312 toolbar magic] can be done
* with a kpart, you will have to do make install to get the kpart installed(?)
* https://bugs.kde.org/show_bug.cgi?id=204203
* https://bugs.kde.org/show_bug.cgi?id=283479

= Polls =
* [http://www.doodle.com/kykdg32p3f5aqidy Do you want to be able to start several ktimetracker instances?]

= recent activity =
* [http://bugs.kde.org/188769 Ktimetracker history export and editing broken]
* [http://bugs.kde.org/270929 Store value in edit history dialog even if user does not change cell afterwards.], [http://commits.kde.org/kdepim/cbeb999d445fbf98cad927c8c70b8b8675ea1746 fix], [http://commits.kde.org/kdepim/b85b4e94dc6883e53e59c89a3070cf33c1d8ad7a backport]
* [http://Bugs.kde.org/245043 When saving to ical file, ktimetracker adds timezone info to DTSTART but not to DTEND], [http://commits.kde.org/kdepim/4bc7bb091c622a2ba1919e52b6b3c4103e9ac0be fix], [http://commits.kde.org/kdepim/99088965bc17d40a1b64463f5de05550fd615873 backport]
* [http://bugs.kde.org/282339 when I start ktimetracker for the first time, a file dialog appears], [http://quickgit.kde.org/?p=kdepim.git&a=commit&h=7b76fb740c952ffa6f7fe3105b57561962534f67 fix], [http://commits.kde.org/kdepim/c7c28fa3fb234ee58610f23df74f66ce98c0cd91 backport]
* tray icons
** [http://bugs.kde.org/272686 ktimetracker always have tray icon(s) even if configured to disable them], [http://quickgit.kde.org/?p=kdepim.git&a=commit&h=7664da2b1a72fef6c03d47cc5c6e741a85b28a65 fix]
** [http://bugs.kde.org/236566 System tray icon displayed 2 times], [http://quickgit.kde.org/?p=kdepim.git&a=commit&h=2733d0dc422fff8691a828579db372570741bb21 fix]

= Maintainer knowledge =
If you want to hand over maintainership, here is some info:

* to be allowed to change ktimetracker options in bugzilla, like adding a new version to bugzilla:
** open a request under https://bugs.kde.org/enter_sysadmin_request.cgi and ask to be added to the editcomponents group
** change ktimetracker options (e.g. add a version) under https://bugs.kde.org/editproducts.cgi?action=edit&product=ktimetracker