Difference between revisions of "Plasma/Clock"

Jump to: navigation, search
(Current Implementation)
(PIM Data Interface)
Line 36: Line 36:
 
== PIM Data Interface ==
 
== PIM Data Interface ==
  
Currently PIM data is read-only and is provided via the Calendar [http://techbase.kde.org/Development/Tutorials/Plasma/DataEngines Plasma DataEngine].  To make PIM data 2-way would require the creation of a [http://techbase.kde.org/Development/Tutorials/Plasma/Services Plasma Service].  However, the Akonadi interface and the creation of PIM data in general is very complex and is not ideally suited to being mapped into a Data Engine or Service.  The API would be very big and unwieldy and a maintenance nightmare.  This is one occasion where Plasma elements requiring complex functionality will be better off directly using the Akonadi API and UI elements.  However this doesn't stop a simplified service being provided that would meet 80% of needs with the more complex requirements being left for the native apps to handle.
+
Currently PIM data is read-only and is provided via the Calendar [http://techbase.kde.org/Development/Tutorials/Plasma/DataEngines Plasma DataEngine].  To make PIM data 2-way would require the creation of a [http://techbase.kde.org/Development/Tutorials/Plasma/Services Plasma Service].  However, the Akonadi interface and the creation of PIM data in general is very complex and is not ideally suited to being mapped into a Data Engine or Service.  The API would be very big and unwieldy and a maintenance nightmare, and the complex specialised gui widgets such as Recurrence Editor would have to be recreated.  This is one occasion where Plasma elements requiring complex functionality will be better off directly using the Akonadi API and GUI elements.  However this doesn't stop a simplified service being provided that would meet 80% of needs with the more complex requirements being left for the native apps to handle.
 +
 
 +
=== Plasma DataEngine ===
 +
 
 +
The Calendar DataEngine supports queries to Akonadi for Event, Todo, and Journal data, and to the KHolidays library for Holidays data.
 +
 
 +
The data structure is documented in the [http://api.kde.org/4.x-api/kde-workspace-apidocs/plasma/generic/dataengines/html/classCalendarEngine.html Calendar DataEngine API].
  
 
=== Plasma Service Design ===
 
=== Plasma Service Design ===

Revision as of 15:18, 28 May 2012

Plasma is all about Clocks. It's an old joke, but it contains a kernel of truth. The clock is the one element of the desktop most people depend on, and it can be a valuable conduit for information they need. This page will co-ordinate all the resources around the Plasma Clock and plans for it's future.


Resources

UserBase Page

Brainstorm Suggestion

KDE Bugzilla all open Plasma Clock bugs

Plasma Tasks List for Clocks

Current Implementation

The current implementation can be found in the following locations.

Time DataEngine - Provides current Time

Calendar DataEngine - Provides Events and Holidays

Akonadi DataEngine - Provides Akonadi email

Plasma Clock Library - Common base classes for all clock/calendar Applets.

The Calendar Applet

The Digital Clock Applet

The Analog Clock Applet

The Binary Clock Applet (Addons)

The Fuzzy Clock Applet (Addons)

PIM Data Interface

Currently PIM data is read-only and is provided via the Calendar Plasma DataEngine. To make PIM data 2-way would require the creation of a Plasma Service. However, the Akonadi interface and the creation of PIM data in general is very complex and is not ideally suited to being mapped into a Data Engine or Service. The API would be very big and unwieldy and a maintenance nightmare, and the complex specialised gui widgets such as Recurrence Editor would have to be recreated. This is one occasion where Plasma elements requiring complex functionality will be better off directly using the Akonadi API and GUI elements. However this doesn't stop a simplified service being provided that would meet 80% of needs with the more complex requirements being left for the native apps to handle.

Plasma DataEngine

The Calendar DataEngine supports queries to Akonadi for Event, Todo, and Journal data, and to the KHolidays library for Holidays data.

The data structure is documented in the Calendar DataEngine API.

Plasma Service Design

An initial minimal definition for the Plasma Service has been created. The actual implementation is still required.

Akonadi Calendar Model

Currently the Calendar DataEngine contains a direct copy of the required Akonadi Calendar Model as this code was not available in kdepimlibs at the time. See the README file for full details. When this API becomes available in KCalCore then the DataEngine must be ported to use it. Until then the code must be kept in sync withe the kdepim calendarsupport code for bug fixes every release.


Content is available under Creative Commons License SA 4.0 unless otherwise noted.