KDE TechBase - User contributions [en]

Development/Tutorials/Plasma/QML/API

2013-02-20T22:29:28Z

Sebas: typo--

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data) the local vairables are named to '''sourceName''' and '''data'''
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

You normaly wants to use '''onNewData''' (that is the aquivalent to '''dataUpdated''' in other languages). Here is sample with the time dataengine:

<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local","UTC"]
interval: 500

onNewData:{
if(sourceName== "Local"){
local.text = data.Time
}
else if(sourceName== "UTC"){
label_utc.text = data.Timezone
}
}

}
Grid{
columns: 2
spacing: 5
Text{text: dataSource.data.Local.Timezone}
Text {
id: local
text: "XX:XX:XX"
}
Text{id: label_utc; text: "XXXX"}
Text {
id: utc
text: dataSource.data.UTC.Time
}
}
}
</syntaxhighlight>

You see two different approches to get to the data:

* One is to act on ''onNewData''
* Use the ''data'' parameter from dataSource

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model. If you need all data inserted in the mode, you must explicitly request it using the regular expression ".*"
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

Theme is also used to control icon sizes, with the property '''iconSize'''. it is an Object, that has the following properties:
* int '''desktop''': size of icons suited for the workspace
* int '''toolbar''': icons to be put in a ToolBar component
* int '''small''': smallest size for still "readable" icons
* int '''dialog''': icons to be put in popup dialogs

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids. The declarative containment is responsible for layout of applets and can provide custom applet handles. The containment should listen to the plasmoid.immutability property. In order to lay out applets in your containment, you can use the AppletContainer class to access geometry information of applets.
Actions such as configure and close are available through plasmoid.actions.
You can access the plasmoid global property from containments in the same way as from declarative and javascript plasmoids. If the plasmoid is a Containment, you can get a list of actions for it. If you want to provide background rendering in your Containment yourself, read the applet.backgroundHints property and after that set applet.backgroundHints to 0 to tell the Applet that is should not render the background.

=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''Item'' '''applet''': The applet item, this property allows you to track destruction of the actual applet and update your layout.
** ''int'' '''backgroundHints''': Should the Applet be rendered on top of a background frame? 0 for no background, 1 for default background, 2 for translucent background
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.

=== ToolBox ===
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String'' '''text''': The icon belonging to this action.
** '''trigger()''': Call trigger from your action delegate to trigger the action.

<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

ToolBox is only available for Containments and new in 4.10.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally : the image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Schedules/KDE4/4.10 Feature Plan

2012-11-21T20:04:19Z

Sebas: /* kdeplasma-addons */

This is a list of planned features for the SC 4.10 release.

See also:

*[[Schedules/KDE4/4.10 Release Schedule]]
*[[Schedules/KDE4/4.9 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
|}
NO NEW FEATURES ALLOWED
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureDone|QML Containments|Making it possible to do full-featured containments in QML|sebas@kde.org|Sebastian Kügler}}
{{FeatureDone|nepomuk-indexer|New Nepomuk Indexer|me@vhanda.in|Vishesh Handa}}
{{FeatureDone|nepomukbakcup|Nepomuk Backup rewritten from scratch|me@vhanda.in|Vishesh Handa}}
{{FeatureDone|nepomukcleaner|An application to port/clean invalid/legacy data in Nepomuk|me@vhanda.in|Vishesh Handa}}
{{FeatureDone|nepomuk KCM|Rewrite the Nepomuk KCM|me@vhanda.in|Vishesh Handa}}
{{FeatureDone|nepomuk tags|Nepomuk Tags KIO Slave|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display application menu and title bar side by side for maximized windows ({{bug |102607}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt ({{bug |266596}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects ({{bug |296773}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Animate Window Maximize/Restore ({{bug |308990}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move ExtendedBorderRegion to stable API ({{bug |308994}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Support shortened titles like in bespin in all decorations ({{bug |308995}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Mouse Click effect ({{bug |309006}}, Review 105780)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Decorations not visible ({{bug |305875}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|drag-and-drop between windows by cover switch alt-tab causes apps to crash ({{bug |179077}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add a rule to select the screen ({{bug |183996}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Need Mouse navigation in flip switch mode ({{bug |244439}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org ({{bug |297634}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297635}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297637}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Allow direct rendering with fglrx ({{bug |301103}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Don't use OpenGL matrix stack in OpenGL 2 backend ({{bug |303093}}, Review 105455)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Refactor Screen/Window PaintData ({{bug |303314}}, Review 105141)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Rapid flickering in locked screen -- makes it difficult to unlock ({{bug |303579}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|double click menu to close needs GUI config ({{bug |305738}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Toplevel::windowType() needs performance improvements ({{bug |306384}}, Review 106349)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|GLPlatform should recommend either OpenGL1 or OpenGL2 compositing ({{bug |306436}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Zoom effect broken in master ({{bug |307609}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|kwin fails to build when the GLES support is disabled ({{bug |307866}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Some effect authors are listed as "Name1 & Name2" ({{bug |307928}}, Review 106880)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add screen management actions to window context menus ({{bug |269207}}, Review 106065)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Move Workspace's compositing functionality to own class Compositor ({{bug |299277}}, Review 102420)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Option to disable close on double click in Aurorae ({{bug |301327}}, Review 106160)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Remove Tiling Support From KWin ({{bug |303090}}, Review 105546)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Allow Scripts to add menus to useractions menu ({{bug |303756}}, Review 106285)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Generic QML support for Aurorae Themes ({{bug |303810}}, Review 105768)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Split out Useractions Menu from Workspace ({{bug |305832}}, Review 106085)|mgraesslin@kde.org}}


{{FeatureDone|kwin|Implement color correction|skeletk13@gmail.com|Casian Andrei}}
{{FeatureDone|oxygen decoration|Implement ExtendedBorderRegion support, to resize windows outside of their actual borders|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureDone|oxygen style|Implement BlurBehind semi-transparent tooltips when available|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureDone|plasma-wallpapers|Color wallpaper: add listview to display thumbnails for background mode|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureDone|plasma workspace|Port Notifications applet to QML|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureDone|System Tray|System tray with interface in QML|dmitry.ashkadov@gmail.com|Dmitry Ashkadov}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|systemsettings|Keyboard layout preview|amourphious1992@gmail.com|Shivam Makkar}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|powerdevil|Overhaul powerdevil notifications|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Split into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}

{{FeatureTodo|FolderView|Port to QML|ignat.semenov@blue-systems.com|Ignat Semenov}}

{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}

{{FeatureDone|Dolphin|Implement parallel sort algorithm|emmanuelpescosta099@gmail.com|Emmanuel Pescosta}}

{{FeatureDone|Dolphin|Add GUI option for the "Rename Inline" setting|frank78ac@googlemail.com|Frank Reininghaus}}

{{FeatureDone|Dolphin|Add "Icon Size" submenu to the Places Panel context menu|frank78ac@googlemail.com|Frank Reininghaus}}

{{FeatureDone|print-manager|New Print manager KCM and applet (plasmoid) replacement, using C++ |dantti12@gmail.com|Daniel Nicoletti}}

{{FeatureDone|Kate|Support for Python plugins|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Advanced gid(1) plugin using both ID files and etags|srhaque@theiet.org|Shaheed Haque}}

{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}

{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}

{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}

{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}

{{FeatureDone|Kate|Built-in quick open (Ctrl+Alt+o)|kwrite-devel@kde.org|Christoph Cullmann}}

{{FeatureDone|Kate|[http://kate-editor.org/2012/11/02/using-the-projects-plugin-in-kate/ New Project Plugin]|kwrite-devel@kde.org|Christoph Cullmann}}

{{FeatureDone|Kate Part|[http://kate-editor.org/2012/10/28/show-line-while-scrolling/ Show line while scrolling]|kwrite-devel@kde.org|D. Haumann/J. Wenninger}}

{{FeatureDone|Kate Part|[http://kate-editor.org/2012/10/27/remove-trailing-spaces/ Improved remove trailing spaces on save]|kwrite-devel@kde.org|Dominik Haumann}}

{{FeatureDone|Kate Part|[http://kate-editor.org/2012/11/07/default-color-schemas/ Predefined color schemes]|kwrite-devel@kde.org|C. Cullmann/D. Haumann}}

{{FeatureDone|Kate Part|[http://kate-editor.org/2012/11/06/kate-scripting-updates-zen-like-quick-coding/ Improved Scripting Support]|kwrite-devel@kde.org|C. Cullmann/D. Haumann}}

{{FeatureDone|Kate Part|[http://kate-editor.org/2012/11/06/passive-notifications-in-kate-part/ Passive Notification System]|kwrite-devel@kde.org|Dominik Haumann}}

{{FeatureDone|Kate Part|[http://kate-editor.org/2012/11/05/loading-remote-files/ Loading Remote File Notification]|kwrite-devel@kde.org|Christoph Cullmann}}

{{FeatureTodo|Kdialog|Add support for detailedsorry/detailederror messages|kde@privat.broulik.de|Kai Uwe Broulik}}

{{FeatureTodo|Konsole|Improve the search filter bar|francesco.cecconi@gmail.com|Francesco Cecconi}}

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}

{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

{{FeatureTodo|Konqueror|Settings for WebKit Part|sandfeld@kde.org|Allan Sandfeld}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Rocs|Improve project handling: load/save dialogs, add project journal.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Support TGF (trivial graph format) documents for import/export.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Support core features for DOT/Graphvis documents for import/export.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Add TikZ/PGF graphic export.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Main Window UI Reorganization: Editor Toolbar, dialogs, Information Panel|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Configuration Dialog Optimizations: Code-Editor, Graph Editor|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|KTouch|Ship ktouch/next|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Smart resizing of training screen with aligned vertical lines|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Prominent hint during training if the user makes repeatedly errors|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Show course descriptions in course selector|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Show a message when keyboard layout visualization isn't available due missing data|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|Analitza|New plotting framework|percy.camilo.ta@gmail.com|Percy Camilo Triveño Aucahuasi}}
{{FeatureDone|KAlgebra|Splitted the QML Components from KAlgebraMobile|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|New plotting plasmoid graphs, in QtQuick|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|Pairs|Pairs Theme editor|marco.calignano@gmail.com|Marco Calignano}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Mark right angles|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|libkdegames|[http://community.kde.org/KDE_Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes) '''Release team:''' please link to the [[Projects/Games/Porting_to_libkdegames_v5|porting instructions]] for third-party developers|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureDone|KGoldrunner|Use KGameRenderer and QGraphicsView for all graphics: the gameplay is the same as before.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Remove the status bar. All scores and status messages are in the viewport now.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Allow the displayed speed of moves to be adjusted.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Animate multi-stage moves, to make it easier for a human player to follow their progress.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Show multi-stage moves in an order that is easier to follow.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Validate the loading of saved games and report errors.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Rewrite the main AI class and make it use a true Minimax method.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Provide a choice of two AI styles, Kepler and Newton, with the possibility to add more.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add settings to choose computer player, AI style and skill level for either or both of players 1 and 2.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add board sizes 3x3 and 4x4, for simplified play.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add a simple Print facility for KSudoku puzzles.|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}
{{FeatureInProgress|okular|Tiled rendering|okular-devel@kde.org|Okular Developers}}
{{FeatureDone|Gwenview|Recursive importer|agateau@kde.org|Aurélien Gâteau}}
{{FeatureDone|Gwenview|Color profile support|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add lyrics view|martin.sandsmark@kde.org|Martin Sandsmark}}

|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KGet|Metalink/HTTP Support|dahalaishraj@gmail.com|Aish Raj Dahal}}

|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureDone|KAlarm|Add command line and D-Bus option to output list of scheduled alarms|djarvie@kde.org|David Jarvie}}
|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
{{FeatureDone|ComicStrip|Replace with QML version|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureDone|Calculator|Replace with QML version|luizromario@gmail.com|Luiz Romário Santana Rios}}
{{FeatureDone|QML Wallpapers|Make it possible to have animated wallpapers written in QtQuick technologies.|aleixpol@blue-systems.com|Aleix Pol Gonzalez}}
{{FeatureDone|Dictionary KRunner|Look up words in the dictionary by typing in 'define {word}' in krunner. [http://blog.zx2c4.com/808 Blog]|Jason@zx2c4.com|Jason A. Donenfeld}}
{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add tagged unions to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add array indices to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Umbrello|Line based diagram grid |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureTodo|Umbrello| widget resize and diagram auto resize feature |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureTodo|Umbrello|add spline based association lines to avoid autolayout widget/line overlapping (needs volunteers)|ralf.habacker@freenet.de|Ralf Habacker}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Ark|Make it possible to disable internal previewer|kde@privat.broulik.de|Kai Uwe Broulik}}
|}

Development/Tutorials/Plasma/QML/API

2012-11-21T01:59:59Z

Sebas: /* AppletContainer */

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids. The declarative containment is responsible for layout of applets and can provide custom applet handles. The containment should listen to the plasmoid.immutability property. In order to lay out applets in your containment, you can use the AppletContainer class to access geometry information of applets.
Actions such as configure and close are available through plasmoid.actions.
You can access the plasmoid global property from containments in the same way as from declarative and javascript plasmoids. If the plasmoid is a Containment, you can get a list of actions for it. If you want to provide background rendering in your Containment yourself, read the applet.backgroundHints property and after that set applet.backgroundHints to 0 to tell the Applet that is should not render the background.

=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''Item'' '''applet''': The applet item, this property allows you to track destruction of the actual applet and update your layout.
** ''int'' '''backgroundHints''': Should the Applet be rendered on top of a background frame? 0 for no background, 1 for default background, 2 for translucent background
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.

=== ToolBox ===
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String'' '''text''': The icon belonging to this action.
** '''trigger()''': Call trigger from your action delegate to trigger the action.

<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

ToolBox is only available for Containments and new in 4.10.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:58:57Z

Sebas: background hints

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids. The declarative containment is responsible for layout of applets and can provide custom applet handles. The containment should listen to the plasmoid.immutability property. In order to lay out applets in your containment, you can use the AppletContainer class to access geometry information of applets.
Actions such as configure and close are available through plasmoid.actions.
You can access the plasmoid global property from containments in the same way as from declarative and javascript plasmoids. If the plasmoid is a Containment, you can get a list of actions for it. If you want to provide background rendering in your Containment yourself, read the applet.backgroundHints property and after that set applet.backgroundHints to 0 to tell the Applet that is should not render the background.

=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''Item'' '''applet''': The applet item, this property allows you to track destruction of the actual applet and update your layout.
** ''int'' '''backgroundHints: 0 for no background, 1 for default background, 2 for translucent background
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.

=== ToolBox ===
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String'' '''text''': The icon belonging to this action.
** '''trigger()''': Call trigger from your action delegate to trigger the action.

<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

ToolBox is only available for Containments and new in 4.10.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:40:37Z

Sebas: /* ToolBox */ one level down

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids.
=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.

=== ToolBox ===
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String'' '''text''': The icon belonging to this action.
** '''trigger()''': Call trigger from your action delegate to trigger the action.

<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

ToolBox is only available for Containments and new in 4.10.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:39:48Z

Sebas: /* ToolBox */

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids.
=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.

== ToolBox ==
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String'' '''text''': The icon belonging to this action.
** '''trigger()''': Call trigger from your action delegate to trigger the action.

<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

ToolBox is only available for Containments and new in 4.10.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:39:07Z

Sebas: add import

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids.
=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.

== ToolBox ==
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String'' '''text''': The icon belonging to this action.
** ''''trigger()''': Call trigger from your action delegate to trigger the action.

<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlighting>

ToolBox is only available for Containments and new in 4.10.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:36:14Z

Sebas: import

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids.
=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.plasma.containments 0.1 as PlasmaContainments
</syntaxhighlight>

AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.

== ToolBox ==
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String' '''text''': The icon belonging to this action.
** ''''trigger()''': Call trigger from your action delegate to trigger the action.

ToolBox is only available for Containments and new in 4.10.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:34:29Z

Sebas: note about availability

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids.
=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.

== ToolBox ==
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String' '''text''': The icon belonging to this action.
** ''''trigger()''': Call trigger from your action delegate to trigger the action.

ToolBox is only available for Containments and new in 4.10.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:30:56Z

Sebas: note about availability

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids.
=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

AppletContainer is only available for Plasma/Containment packages, and only if they are loaded as containment. AppletContainer is new in 4.10.

== ToolBox ==
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String' '''text''': The icon belonging to this action.
** ''''trigger()''': Call trigger from your action delegate to trigger the action.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:29:17Z

Sebas: toolbox and actions

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids.
=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

== ToolBox ==
The ToolBox is only available through the plasmoid object, through plasmoid.toolBox(). The ToolBox is rendered as a separate item on top of the scene covering the entire containment. It is loaded from the "org.kde.toolbox" Plasma Package, if the package is not found, no ToolBox will be loaded.
The ToolBox provides a listmodel of actions that can be rendered using Repeaters or ListViews. The ''actions'' list property contains actions from the Corona and Containments. Examples for these actions are showing the add widget or activities interface, lock and unlock. The actions in the list change dynamically whenever the widgets are locked or unlocked.
Actions such as lock screen and leave can be implemented using the powermanagement dataengine's services for these functions.

ToolBox provides access to the following properties:
* ''Array(QAction)'' '''actions''': A list of actions provided by the Containment. These actions' most interesting properties are:
** ''QIcon'' '''icon''': The icon belonging to this action.
** ''String' '''text''': The icon belonging to this action.
** ''''trigger()''': Call trigger from your action delegate to trigger the action.

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:15:32Z

Sebas: more AppletContainer docs

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids.
=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum
** '''UnknownStatus''': The status is unknown
** '''PassiveStatus''': The applet is passive
** '''ActiveStatus''': The applet is active
** '''NeedsAttentionStatus''': The applet asks for attention
** '''AcceptingInputStatus''': The applet is accepting input

== ToolBox ==

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/QML/API

2012-11-21T01:12:25Z

Sebas: AppletContainer docs

= Introduction to the Plasmoid QML Declarative API =

This document provides an overview/reference of the Declarative QML API for Plasmoids. It isn't a full binding to all of Qt or KDE's libraries, but a focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the API of the Plasma specific QML components, so only the Declarative part of the API.

The QML ScriptEngine is based upon the Plasma JavaScript engine, making the API of the JavaScript part identical to the one of the JavaScript plasmoids engine.
To see the api of the global ''Plasmoid'' object, see the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#The_Global_plasmoid_Object JavaScript API] documentation.
(TODO: the JavaScript api page should probably be copied and stripped down the imperative bits not present there, it would make it harder to update tough)
The most important API for using graphical widgets is the [http://api.kde.org/4.x-api/plasma-qml-apidocs/ Plasma QtComponents API]

== What Is a Declarative Plasmoid? ==

To denote that this Plasmoid is a Declarative widget, ensure that in the metadata.desktop file there is this line:

X-Plasma-API=declarativeappletscript

What follows is a description of the Plasma declarative classes instantiable from QML.

== fetching data from the plasmoid package ==

If you have a file in your plasmoid package under contents, let's say an image, you can access it with the plasmapackage url protocol:

<syntaxhighlight lang="javascript">
Image {
source: "plasmapackage:/images/foo.png"
}
</syntaxhighlight>

The above code will load in the Image component the file foo.png located in contents/images of your plasmoid package.

<syntaxhighlight lang="javascript">
import "plasmapackage:/code/foo.js" as Foo
</syntaxhighlight>

Similarly, the above code will import a javascript file from the folder contents/code of your plasmoid package.

= Properties exported from the main QML item =
The root qml item can export some properties to influence its behavior:
* '''property int minimumWidth''': the plasmoid won't ever become narrower then that, size in pixels.
* '''property int minimumHeight''': minum height of the plasmoid, size in pixels.
* '''property Component compactRepresentation''': if the plasmoid is a popupapplet, the component in compactRepresentation will be used instead of the icon and will always be collapsed, regardless if it's in a panel or not.

= Main Plasma QML Classes =

== Data Engines ==
While it's possible to fetch data from a Plasma DataEngine in the same way as the [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API#DataEngine JavaScript API], it is preferrable to use the following declarative classes:

=== DataSource ===
DataSource is a receiver for a dataEngine and can be declared inside QML:

<syntaxhighlight lang="javascript">
import org.kde.plasma.core 0.1 as PlasmaCore

PlasmaCore.DataSource {
id: dataSource
engine: "time"
connectedSources: ["Local"]
interval: 500
}
</syntaxhighlight>

==== Properties ====
It has the following properties:
* bool '''valid''' (read only): true when the DataSource is successfully connected to a data engine
* int '''interval''': interval of polling of the dataengine, if 0 (default value, so no need to specify if you don't need it) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load, e.g. "nowplaying", etc.
* Array(string) '''connectedSources''': all the sources of the dataengine we are connected to (and whose data will appear in the '''data''' property)
* Array(string) '''sources''' (read only): all the sources available from the dataengine
* variant map '''data''' (read only): It's the most important property, it's a map of all the data available from the dataengine: its structure will be as follows:
** each key of the map will be a source name, in '''connectedSources'''
** each value will be a variant hash, so an hash with strings as keys and any variant as value
** example: dataSource.data["Local"]["Time"] indicates the '''Time''' key of the dataengine source called "Local"
* string '''sourceFilter''' it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"

==== Signals ====
It has the following signals:

Note that javascript/qml applies the 'on' prefix to signals. So the actual signal name in C++ which is e.g. '''newData'''(...) becomes '''onNewData'''(...).

* '''onNewData'''(String sourceName, Plasma::DataEngine::Data data)
* '''onSourceAdded'''(String source)
* '''onSourceRemoved'''(String source)
* '''onSourceConnected'''(String source)
* '''onSourceDisconnected'''(String source)
* '''onIntervalChanged'''()
* '''onEngineChanged'''()
* '''onDataChanged'''()
* '''onConnectedSourcesChanged'''()
* '''onSourcesChanged'''()

==== Methods ====
It has the following methods:
* StringList keysForSource(String source): lists all the keys corresponding to a certain source: for instance in the "time" dataengine, for the "Local" source, keys will be:
** "Timezone Continent"
** "Offset"
** "Timezone"
** "Time"
** "Date"
** "Timezone City"
* Service serviceForSource(String source): returns a Plasma service that corresponds a given source: see the section about services for how to use it.
* void connectSource(String source): adds to '''connectedSources''' the new source
* void disconnectSource(String source): removes that source from '''connectedSources'''

=== Service ===
Due to their imperative nature, Plasma Services are not instantiated as QML classes, but rather created out of a '''DataSource''' with the method '''serviceForSource''' and used in the JavaScript portions of the QML files.
This following example is a simplified version from the Now Playing QML widget in the kdeexamples git repository:

<syntaxhighlight lang="javascript">
var service = dataSource.serviceForSource(activeSource)
var operation = service.operationDescription("seek")
operation.seconds = 10

var job = service.startOperationCall(operation)
</syntaxhighlight>
Here dataSource is the id of a DataSource object, and activeSource is a source contained in one of its '''connectedSources'''.
The service provides an operation called "seek", with a parameter called "seconds", that can be written on it as a property of a JavaScript object.

=== ServiceJob ===
It is necessary to monitor the result of a Service operation, it's possible to connect to the '''finished''' signal provided by the job return paramenter of the '''startOperationCall''' service method.
The '''finished''' signal has the same job as parameter, from which is possible to check the variant '''result''' property, to check the result.

<syntaxhighlight lang="javascript">

var service = messagesDataSource.serviceForSource(src)
var operation = "auth";

function result(job) {
statusItem.authorizationStatus = job.result;
print("ServiceJob result: " + job.result + " op: " + job.operationName);
}

var operation = service.operationDescription(operation);
operation.user = userName;
operation.password = password;
var serviceJob = service.startOperationCall(operation);
serviceJob.finished.connect(result);

</syntaxhighlight>

=== DataModel ===
Some data engines return as their data something that can be interpreted as a list of items, rather than simple key/value pairs.
QML provides some item views such as '''ListView''', '''GridView''' and '''Repeater'''.
The '''DataModel''' QML object can provide, based on a DataSource a model suitable for those QML item views.

It has the following properties:
* DataSource '''dataSource''': the id of an existing (and connected) DataSource
* String '''sourceFilter''': it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model. To, for example, have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
* String '''keyRoleFilter''': it's a regular expression. Only data with keys that match this filter expression will be inserted in the model
* int '''count''' (read only): how many items are in the model

Example:

<syntaxhighlight lang="javascript">
ListView {
model: PlasmaCore.DataModel {
dataSource: microblogSource
keyRoleFilter: "[\\d]*"
}
delegate: Text {
text: title
}
}
</syntaxhighlight>

In the example, ''microblogSource'' is the id of a DataSource, and inserts in the model only entries that have a number as the key name (matched with [\\d]*, in this case tweets ids)

Each item in the model will have the form of a variant hash: all the keys of the hash will be registered as model role names, in the example, "title" is a role of the model containing a string (also reachable with model["title"]).

A special reserved role will always be present: '''"DataEngineSource"''': it will contain the name of the data engine source that gave origin to this item. Therefore, if you want merely the string of the current source that the model is at...do model["DataEngineSource"].

Note that view.currentItem holds the item currently selected. However, due to (http://bugreports.qt.nokia.com/browse/QTBUG-16347) this does not work in PathView. A workaround is to make your own.

=== SortFilterModel ===
SortFilterModel is a proxy model for easy sorting and/or filtering of the items in a DataModel (or any other QAbstractItemModel subclass that has been registered in QML with setContextProperty from a C++ application)
Properties:
* model '''sourceModel'''
* String '''filterRegExp'''
* String '''filterRole'''
* String '''sortRole'''
* Qt::SortOrder '''sortOrder'''
* int '''count''' (read only)

This is an example from the feed widget:
<syntaxhighlight lang="javascript">
model: PlasmaCore.SortFilterModel {
id: postTitleFilter
filterRole: "title"
sortRole: "time"
sortOrder: "DescendingOrder"
filterRegExp: toolbarFrame.searchQuery
sourceModel: PlasmaCore.SortFilterModel {
id: feedCategoryFilter
filterRole: "feed_url"
sourceModel: PlasmaCore.DataModel {
dataSource: feedSource
keyRoleFilter: "items"
}
}
}
</syntaxhighlight>

== Popup Applet ==
So you want your QML applet to be a popup applet, like the device notifier (an icon in the panel shows and expands the applet)?

Why, that's easy.

To change your plasmoid from being a regular boring one, in your '''metadata.desktop''', simply change this following line:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet
</syntaxhighlight>

To:

<syntaxhighlight lang="ini">
ServiceTypes=Plasma/Applet,Plasma/PopupApplet
</syntaxhighlight>

Then in the main QML item's Component.onCompleted, do:

<syntaxhighlight lang="javascript">
plasmoid.popupIcon = "konqueror"
</syntaxhighlight>

If you want to use other elements instead of an icon when collapsed in a panel, use the '''compactRepresentation''' property in the root Item.

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
From KDE 4.8 a Theme instance is always present given the org.kde.plasma.core plugin was imported, is not necessary to create it by hand.
It has the following properties:
* String '''themeName''' (read only)
* bool '''windowTranslucentEnabled''' (read only)
* Url '''homepage''' (read only)
* bool '''useGlobalSettings''' (read only)
* QString '''wallpaperPath''' (read only)
* color '''textColor''' (read only)
* color '''highlightColor''' (read only)
* color '''backgroundColor''' (read only)
* color '''buttonTextColor''' (read only)
* color '''buttonBackgroundColor''' (read only)
* color '''linkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''visitedLinkColor''' (read only)
* color '''buttonHoverColor''' (read only)
* color '''buttonFocusColor''' (read only)
* color '''viewTextColor''' (read only)
* color '''viewBackgroundColor''' (read only)
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (read only)
* Font '''defaultFont''' (read only)
* Font '''desktopFont''' (read only)
* Font '''smallestFont''' (read only)

Each Font element has the following properties:
* bool bold
* Capitalization '''capitalization''' (MixedCase, AllUppercase, AllLowercase, SmallCaps, Capitalize) (read only)
* String '''family''' (read only)
* bool '''italic''' (read only)
* real '''letterSpacing''' (read only)
* int '''pixelSize''' (read only)
* real '''pointSize''' (read only)
* bool '''strikeout''' (read only)
* bool '''underline''' (read only)
* Weight '''weight''' (Light, Normal, DemiBold, Bold, Black) (read only)
* real '''wordSpacing''' (read only)
* size '''mSize''' the size, width and height of an uppercase "M" in this font (read only)

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]. Make sure to strip the final extension from this string, so you should for example use <code>"dialogs/background"</code> to get the standard background.
* bool '''usingRenderingCache'''

Methods:
* QPixmap pixmap(QString elementID)
* void resize(qreal width, qreal height)
* void resize(): resets the image to its default dimension
* QSize elementSize(QString elementId)
* QRectF elementRect(QString elementId)
* bool hasElement(QString elementId)
* bool isValid(): true if valid svg file

=== FrameSvg ===
Declaring a FrameSvg element instantiates a Plasma FrameSvg instance. This class doesn't draw anything. For drawing, FrameSvgItem is used.
This is to be used when you need informations about the framesvg, such as hasElementPrefix().

Properties:
* All properties from Svg
* EnabledBorders '''enabledBorders''': flag combination of:
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder

Methods:
* All methods from Svg
* void setImagePath(QString path)
* void resizeFrame(QSize size)
* QSize frameSize()
* qreal marginSize(Plasma::MarginEdge edge)
* void getMargins(qreal left, qreal top, qreal right, qreal bottom): parameters are output, they get set with the margins from the FrameSvg
* QRectF contentsRect(): the rectangle of the center element, taking the margins into account.
* void setElementPrefix(QString prefix)
* bool hasElementPrefix(const QString prefix)
* QString prefix()
* void setCacheAllRenderedFrames(bool cache)
* bool cacheAllRenderedFrames()
* void clearCache()
* QPixmap framePixmap()

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvg {
id: myFrameSvg
imagePath: "widgets/button"
prefix: "pressed"
}
</syntaxhighlight>

=== SvgItem ===
It's a graphical element that will actually paint a Svg instance.
Properties:
* String '''elementId''': what element to render. If null, the whole svg will be rendered
* Svg '''svg''': instance of the Svg class mentioned above
* QSizeF '''naturalSize''' (read only): default size of the Svg
* bool '''smooth''': paint with antialias (default false)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.SvgItem {
id: mySvgItem
anchors {
top: parent.top
left: parent.left
}

width: 300
height: 3

svg: mySvg
elementId: "horizontal-line"
}
</syntaxhighlight>

=== FrameSvgItem ===
It's a graphical element that paints a Plasma::FrameSvg, so a rectangular image composed by 9 elements contained in a Svg file, useful for things like buttons and frames.

Flags
* EnabledBorders: combination of TopBorder | BottomBorder | LeftBorder | RightBorder, NoBorder if no border of the frame is enabled

Properties:
* String '''imagePath''': path of the file relative to the Plasma Theme, for instance "widgets/background"
* String '''prefix''': a FrameSvg can contain multiple frames, for instance a button contains "normal", "raised" and "pressed"
* Margins '''margins''' (read only): the margins of the frame, see documentation below
* EnabledBorders '''enabledBorders''': what borders are enabled

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

Sample Code:

<syntaxhighlight lang="javascript">
PlasmaCore.FrameSvgItem {
id: myFrameSvgItem
anchors.fill: parent
imagePath: "translucent/dialogs/background"
}
</syntaxhighlight>

== Top Level windows ==

=== Dialog ===
Dialog instantiates a Plasma::Dialog, it will be a Plasma themed top level window that can contain any QML component.

Properties:
* Item '''mainItem''': the Item contained in the Dialog, it can be any QML Item instance
* bool '''visible''': if the window (not the mainItem) is visible
* int '''x''': x position of the window in screen coordinates
* int '''y''': y position of the window in screen coordinates
* int '''width''' (read only): total width of the dialog, including margins
* int '''height''' (read only): total height of the dialog, including margins.
* int '''windowFlags''': Qt window flags of the Dialog
* Margins '''margins''' (read only): margins of the Dialog

{{Note|The width and height will scale with size of the main item within this Dialog component.}}

<syntaxhighlight lang="javascript">
import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
PlasmaCore.Dialog {
visible: true
mainItem: Item {
width: 500
height: 500

Text {
anchors.centerIn: parent
color: "red"
text: qsTr("text")
}
}
}
}
</syntaxhighlight>

Methods:
* QPoint popupPosition(Item item, Qt::Alignment alignment=Qt::AlignLeft): the suggested position for the Dialog if it has to be correctly placed as popup of the QML item passed as parameter.
* void setAttribute(Qt::WindowAttribute attribute, bool on): set an attribute for the dialog window

==== Margins ====
Properties:
* real '''left''' (read only)
* real '''top''' (read only)
* real '''right''' (read only)
* real '''bottom''' (read only)

=== ToolTip ===
Declaring a ToolTip instance makes it possible to use Plasma tooltips with any QML item.

Properties:
* Item '''target''': the QML item we want to show a tooltip of
* String '''mainText'''
* String '''subText'''
* String '''image''': freedesktop compliant icon name as image of the tooltip

== Containments ==
A Plasma Containment manages the position and manipulation of Plasmoids.
=== AppletContainer ===
The AppletContainer class provides access to the geometry and status of Plasmoids in this Containment.
Properties:
* ''int'' '''minimumWidth''': The minimum width of the applet
* ''int'' '''minimumHeight''': The minimum height of the applet
* ''int'' '''maximumWidth''': The maximum width of the applet
* ''int'' '''maximumHeight''': The maximum height of the applet
* ''int'' '''preferredWidth''': The preferred height of the applet
* ''int'' '''preferredHeight''': The preferred height of the applet
* ''enum'' '''status''': The status of the applet, one in the enum

== ToolBox ==

= Plasma QtComponents (4.8) =
Plasma components documentation online at [http://api.kde.org/4.x-api/plasma-qml-apidocs/ api.kde.org]

=QtExtraComponents=
The QtExtraComponents make some very convenient Qt classes usable from within QML.

They can be imported in your code with:
<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1
</syntaxhighlight>

==QPixmapItem==
This one wraps around a QPixmap class and allows you to send a QPixmap directly to QPixmapItem.

Properties:
* QPixmap '''pixmap''': The QPixmap object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode''': see below

==QImageItem==
This one wraps around a QImage class and allows you to send a QImage directly to QImageItem.

Properties:
* QImage '''image''': The QImage object.
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QImage width
* int '''nativeHeight''': (verification needed) The QImage height
* FillMode '''fillMode''': see below

==FillMode==
Both QPixmapItem and QImageItem expose a FillMode enum. This enum defines how the image is going to be used to fill the item.

For QPixmapItem, possible values are:

* QPixmapItem.Stretch: the image is scaled to fit
* QPixmapItem.PreserveAspectFit: the image is scaled uniformly to fit without cropping
* QPixmapItem.PreserveAspectCrop: the image is scaled uniformly to fill, cropping if necessary
* QPixmapItem.Tile: the image is duplicated horizontally and vertically
* QPixmapItem.TileVertically: the image is stretched horizontally and tiled vertically
* QPixmapItem.TileHorizontally :e image is stretched vertically and tiled horizontally

QImageItem defines the same values, you just need to replace QPixmapItem with QImageItem.

==QIconItem==
This one wraps around a QPixmap class and allows you to send a QIcon directly to QIconItem.

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''implicitWidth''': Default width of as set in SystemSettings->Applications Appearance->Icons
* int '''implicitHeight''': Default height of as set in SystemSettings->Applications Appearance->Icons
* State '''state''': Icon state (DefaultState, ActiveState, DisabledState)

Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject

2012-11-21T00:30:18Z

Sebas: fonts

= The Global plasmoid Object =
There is a global object available to the Plasmoid called, appropriately, "plasmoid". It has a number of useful properties (some of which are read only, but many of which are read/write), functions, constant values and callbacks. Each are enumerated below.
All of those are valid for both JavaScript and QML bindings.

= Callbacks =

See the section on Events above.

There are some events that are generated by Plasma for the Plasmoid. These can often be caught by providing a function assigned to a specific name in the plasmoid object. For instance, to get notified of form factor changes, one would provide a formFactorChanged method as follows:

<syntaxhighlight lang="javascript">
plasmoid.formFactorChanged = function() {

print("the form factor has changed to: " + plasmoid.formFactor())

}
</syntaxhighlight>

The following callbacks are used to notify the Plasmoid of changes in its running environment:

* '''configChanged()'''
* '''currentActivityChanged()'''
* '''formFactorChanged()'''
* '''immutabilityChanged()'''
* '''locationChanged()'''
* '''sizeChanged()'''

Other callbacks include:
* '''dataUpdated(String source, Map[String, Any] data)''': used to pass in DataEngine updates
* '''activate()''': called when the widget is activated by the user, e.g. by a keyboard shortcut. Useful for setting the focus on a specific input widget, for instance. (API v2)
* '''initExtenderItem(Extender extender)''': Called when an Extender should be set up. (API v2)
* '''popupEvent(boolean shown)''': called on PopupApplets when the popup is shown or hidden. (API v2)

In API v2, all of these callbacks can also be used as events. So, for instance, instead of implementing plasmoid.popupEvent, one could also write:
 
<syntaxhighlight lang="javascript">
plasmoid.addEventListener('popupEvent', function(shown) { print('shown? ' + shown) } )
</syntaxhighlight>
 
This would also suppress any calls to plasmoid.popupEvent.

Further documentation on these callbacks can be found in the relevant sections below.

= Environment =

A set of read-only properties (and in most cases notification functions) that tell the Plasmoid about its current environment:

* '''apiVersion''': the integer version of the Simplified JavaScript API in the current execution environment; can be used to change behaviour or usage of functions depending on the version number.

* '''formFactor''': one of Planar (e.g. on a desktop or in an application main view), Horizontal, Vertical or MediaCenter. When the form factor changes, the plasmoid.formFactorChanged function, if defined in the Plasmoid, is called.

* '''size''': the size of the Plasmoid, expressed in QSizeF (explained below). when it changes, plasmoid.sizeChanged() will be called.

* '''location''': one of Floating (no specific location), Desktop (on the application's main view are), FullScreen, LeftEdge, RightEdge, TopEdge or ButtomEdge. When the location changes, the plasmoid.locationChanged function, if defined in the Plasmoid, is called.

* '''immutable''': this property is set to true when the Plasmoid is set to not be movable or otherwise changeable, and false otherwise. Configuration is still usually allowed in this state. When the immutability changes, the plasmoid.immutabilityChanged function, if defined in the Plasmoid, is called.

* '''currentActivity''': the current contextual activity name. When the current activity changes, the plasmoid.currentActivityChanged function, if defined in the Plasmoid, is called.

* '''shouldConserveResources''': true if the plasmoid should not be doing anything that would create too much draw on power, e.g. when on a device with low battery power it may be a good idea not to run a computationally expensive but optional animation

* '''userConfiguring''': true if the user configuration interface is currently being displayed.

= Properties =
A set of read/write properties that allow the Plasmoid to set various visual or functional properties:

* ''AspectRatioMode'' '''aspectRatioMode''': defines how to treat the aspect ratio of a Plasmoid when resizing it. See the [[http://lxr.kde.org/source/kde/kde-runtime/plasma/scriptengines/javascript/plasmoid/appletinterface.h#120|AspectRatioMode]] documentation for values and their meaning.

* ''BackgroundHints'' '''backgroundHints''': defines how the background of the widget is rendered. See the [[#BackgroundHints|BackgroundHints]] documentation for values and their meaning.

* ''boolean'' '''busy''': set to true when the Plasmoid is currently processing or waiting for data and the user interface should be blocked while doing so; will generally show a full-Plasmoid animated overlay to denote business

* ''SizePolicy'' '''horizontalSizePolicy''': behaviour of the plasmoid in an horizontal layout such as a panel. It may be:
** ''Fixed'': The QWidget::sizeHint() is the only acceptable alternative, so the widget can never grow or shrink (e.g. the vertical direction of a push button).
** ''Minimum'': The sizeHint() is minimal, and sufficient. The widget can be expanded, but there is no advantage to it being larger (e.g. the horizontal direction of a push button). It cannot be smaller than the size provided by sizeHint().
** ''Maximum'': The sizeHint() is a maximum. The widget can be shrunk any amount without detriment if other widgets need the space (e.g. a separator line). It cannot be larger than the size provided by sizeHint().
** ''Preferred'': The sizeHint() is best, but the widget can be shrunk and still be useful. The widget can be expanded, but there is no advantage to it being larger than sizeHint() (the default QWidget policy).
** ''Expanding'': The sizeHint() is a sensible size, but the widget can be shrunk and still be useful. The widget can make use of extra space, so it should get as much space as possible (e.g. the horizontal direction of a horizontal slider).
** ''MinimumExpanding'': The sizeHint() is minimal, and sufficient. The widget can make use of extra space, so it should get as much space as possible (e.g. the horizontal direction of a horizontal slider).
** ''Ignored'': The sizeHint() is ignored. The widget will get as much space as possible.

* ''SizePolicy'' '''verticalSizePolicy''': behaviour of the plasmoid in a vertical layout such as a panel.

== PopupApplet specific ==
* ''QIcon'' '''popupIcon''': it will be used instead of the applet content when the applet is in a panel
* ''Object'' '''popupIconToolTip''': it contains the icon, mainText and subtext for the tooltip the applet will have when collapsed in an icon, properties:
** ''variant'' '''image''': the icon, it may be an icon name, an image path, a QIcon, QImage or a QPixmap
** ''String'' '''mainText''': the tooltip title
** ''String'' '''subText''': the tooltip descriptive subtext

<syntaxhighlight lang="javascript">
var data = new Object
data["image"] = "konqueror"
data["mainText"] = "ToolTip title"
data["subText"] = "ToolTip descriptive sub text"
plasmoid.popupIconToolTip = data
</syntaxhighlight>

* ''bool'' '''passivePopup''': if true when the popup is opened other windows can gain focus and the popup won't close

* ''bool'' '''popupShowing''': true when the popupapplet is iconified and its popup is open

== Containment specific ==
* ''Array(Object)'' '''applets''': List of all applets in the containment
* ''bool'' '''drawWallpaper''': Enable/disable the wallpaper painting by the containment
* ''enum'' '''containmentType''': one of
** ''DesktopContainment'': A desktop containment
** ''PanelContainment'': A desktop panel
** ''CustomContainment'': A containment that is neither a desktop nor a panel but something application specific
** ''CustomPanelContainment'': A customized desktop panel

* ''int'' '''screen''': Number of the screen this containment is in
* ''string'' '''activityName''': The name of the activity this containment belongs to.
* ''string'' '''activityId''': The id of the activity this containment belongs to.

The following API is only available from declarative containments.
* ''ToolBox'' '''toolBox()''': The toolbox of the Containment. The ToolBox is rendered as a separate item on the scene and provides access to the following properties:
** ''Array(QAction)'' '''actions''': A list of actions provided by the Containment.

= Geometry =

Read Only Properties:

* ''QRectF'' '''rect''': the current rect of the Plasmoid; note that the top left may be not be the origin point (0,0)

Functions:

* '''resize(width, height)'''
* '''setMinimumSize(width, height)'''
* '''setPreferredSize(width, height)'''
* '''setBackgroundHints(background)''' - use '''NoBackground''' as value if you want to remove the default plasmoid background box.
* '''popupIcon(QIcon("some icon"))''' - set icon to show when the plasmoid is added to the taskbar. NOTE if the plasmoid is made in QML, you MUST specify a default size for the main Item. This size will be used for the plasmoid when added to the taskbar

= Painting and Layout =

To paint directly on to the canvas, a widget may implement the paintInterface function in the plasmoid object:

<syntaxhighlight lang="javascript">
plasmoid.paintInterface = function(painter) { /* painting code goes here*/ }
</syntaxhighlight>
 
See the Painting section below for information about helpful classes and functions that can be used when implementing a paintInterface function.

Read/Write Properties:

* ''Layout'' '''layout''': the QGraphicsLayout associated with the Plasmoid for laying out top level items; this property is read-write, though the property is not usually set as one can simply do "new LinearLayout" (or one of the other layout classes provided) and it will be automatically associated with the Plasmoid.

Functions:

* '''update()''': triggers a full repaint of the Plasmoid.
* '''update(QRectF rect)''' triggers a repaint of the rect area of the Plasmoid.
* '''failedToLaunch(bool failed[, string reason])''' sets the launch status of the Plasmoid; if set to true, the script will stop executing and the reason message, if any, will be displayed to the user.

= Access To Packaged Files =

Functions:

* ''string'' '''file(string type[, string fileName])''': returns the path to a file in the Plasmoid package of the given type, optionally with a file name to match, e.g. 
<syntaxhighlight lang="javascript">var path = plasmoid.file("mainscript")</syntaxhighlight>
 
or
 
<syntaxhighlight lang="javascript">var pm = new QPixmap(plasmoid.file("images", "mypixmap.png"))</syntaxhighlight>

* ''bool'' '''include(string filename)''': attempts to include the script defined from the package's code directory

= Configuration Data =
Configuration values can be defined using [[Development/Tutorials/Using_KConfig_XT|KConfig XT]] XML files in the {{path|contents/config/}} directory of the Plasmoid's package. The default file that is looked for and used is {{path|contents/config/main.xml}}.

== Accessing Configuration Data ==
Read-write properties:
* ''String'' '''activeConfig''': The current active configuration description. For instance, setting it to "foo" would cause the Plasmoid to try and reference the {{path|contents/config/foo.xml}} KConfigXT file. Setting this to an empty string will switch to the main.xml file.

Functions:
* ''any'' '''readConfig(String key)''': reads the value from the configuration data for the given key as defined by the currently active configuration.

* '''writeConfig(String key, any value) ''': writes a value to the configuration store under the given key

== User Customization ==

User customization can be offered by providing a Qt Designer file called {{path|contents/ui/config.ui}} in the Plasmoid's package.

Callbacks:
* '''configChanged()''': callback function called when the configuration is changed external to the Plasmoid, e.g. when the user changes settings in a configuration dialog.

= Context menu =

It's possible to add some items to the popup menu of the Plasmoid.

Functions:
* '''setAction(String name, String text, String icon, String shortcut)''': adds an item to the context menu with the given text and icon;
In pure JavaScript plasmoids you need to define '''plasmoid.action_<name>''' function, where <name> is the first argument for setAction call, and this function will be called each time user clicks the item.
Similarly in QML plasmoids you must define a function '''action_<name>''' in the root qml item that will handle the action click.
* '''setActionSeparator(String name)''': (API v5) adds a separator item to the context menu
* '''removeAction(String name)''': removes the item with <name>

Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject

2012-11-21T00:29:05Z

Sebas: start toolbox docs

= The Global plasmoid Object =
There is a global object available to the Plasmoid called, appropriately, "plasmoid". It has a number of useful properties (some of which are read only, but many of which are read/write), functions, constant values and callbacks. Each are enumerated below.
All of those are valid for both JavaScript and QML bindings.

= Callbacks =

See the section on Events above.

There are some events that are generated by Plasma for the Plasmoid. These can often be caught by providing a function assigned to a specific name in the plasmoid object. For instance, to get notified of form factor changes, one would provide a formFactorChanged method as follows:

<syntaxhighlight lang="javascript">
plasmoid.formFactorChanged = function() {

print("the form factor has changed to: " + plasmoid.formFactor())

}
</syntaxhighlight>

The following callbacks are used to notify the Plasmoid of changes in its running environment:

* '''configChanged()'''
* '''currentActivityChanged()'''
* '''formFactorChanged()'''
* '''immutabilityChanged()'''
* '''locationChanged()'''
* '''sizeChanged()'''

Other callbacks include:
* '''dataUpdated(String source, Map[String, Any] data)''': used to pass in DataEngine updates
* '''activate()''': called when the widget is activated by the user, e.g. by a keyboard shortcut. Useful for setting the focus on a specific input widget, for instance. (API v2)
* '''initExtenderItem(Extender extender)''': Called when an Extender should be set up. (API v2)
* '''popupEvent(boolean shown)''': called on PopupApplets when the popup is shown or hidden. (API v2)

In API v2, all of these callbacks can also be used as events. So, for instance, instead of implementing plasmoid.popupEvent, one could also write:
 
<syntaxhighlight lang="javascript">
plasmoid.addEventListener('popupEvent', function(shown) { print('shown? ' + shown) } )
</syntaxhighlight>
 
This would also suppress any calls to plasmoid.popupEvent.

Further documentation on these callbacks can be found in the relevant sections below.

= Environment =

A set of read-only properties (and in most cases notification functions) that tell the Plasmoid about its current environment:

* '''apiVersion''': the integer version of the Simplified JavaScript API in the current execution environment; can be used to change behaviour or usage of functions depending on the version number.

* '''formFactor''': one of Planar (e.g. on a desktop or in an application main view), Horizontal, Vertical or MediaCenter. When the form factor changes, the plasmoid.formFactorChanged function, if defined in the Plasmoid, is called.

* '''size''': the size of the Plasmoid, expressed in QSizeF (explained below). when it changes, plasmoid.sizeChanged() will be called.

* '''location''': one of Floating (no specific location), Desktop (on the application's main view are), FullScreen, LeftEdge, RightEdge, TopEdge or ButtomEdge. When the location changes, the plasmoid.locationChanged function, if defined in the Plasmoid, is called.

* '''immutable''': this property is set to true when the Plasmoid is set to not be movable or otherwise changeable, and false otherwise. Configuration is still usually allowed in this state. When the immutability changes, the plasmoid.immutabilityChanged function, if defined in the Plasmoid, is called.

* '''currentActivity''': the current contextual activity name. When the current activity changes, the plasmoid.currentActivityChanged function, if defined in the Plasmoid, is called.

* '''shouldConserveResources''': true if the plasmoid should not be doing anything that would create too much draw on power, e.g. when on a device with low battery power it may be a good idea not to run a computationally expensive but optional animation

* '''userConfiguring''': true if the user configuration interface is currently being displayed.

= Properties =
A set of read/write properties that allow the Plasmoid to set various visual or functional properties:

* ''AspectRatioMode'' '''aspectRatioMode''': defines how to treat the aspect ratio of a Plasmoid when resizing it. See the [[http://lxr.kde.org/source/kde/kde-runtime/plasma/scriptengines/javascript/plasmoid/appletinterface.h#120|AspectRatioMode]] documentation for values and their meaning.

* ''BackgroundHints'' '''backgroundHints''': defines how the background of the widget is rendered. See the [[#BackgroundHints|BackgroundHints]] documentation for values and their meaning.

* ''boolean'' '''busy''': set to true when the Plasmoid is currently processing or waiting for data and the user interface should be blocked while doing so; will generally show a full-Plasmoid animated overlay to denote business

* ''SizePolicy'' '''horizontalSizePolicy''': behaviour of the plasmoid in an horizontal layout such as a panel. It may be:
** ''Fixed'': The QWidget::sizeHint() is the only acceptable alternative, so the widget can never grow or shrink (e.g. the vertical direction of a push button).
** ''Minimum'': The sizeHint() is minimal, and sufficient. The widget can be expanded, but there is no advantage to it being larger (e.g. the horizontal direction of a push button). It cannot be smaller than the size provided by sizeHint().
** ''Maximum'': The sizeHint() is a maximum. The widget can be shrunk any amount without detriment if other widgets need the space (e.g. a separator line). It cannot be larger than the size provided by sizeHint().
** ''Preferred'': The sizeHint() is best, but the widget can be shrunk and still be useful. The widget can be expanded, but there is no advantage to it being larger than sizeHint() (the default QWidget policy).
** ''Expanding'': The sizeHint() is a sensible size, but the widget can be shrunk and still be useful. The widget can make use of extra space, so it should get as much space as possible (e.g. the horizontal direction of a horizontal slider).
** ''MinimumExpanding'': The sizeHint() is minimal, and sufficient. The widget can make use of extra space, so it should get as much space as possible (e.g. the horizontal direction of a horizontal slider).
** ''Ignored'': The sizeHint() is ignored. The widget will get as much space as possible.

* ''SizePolicy'' '''verticalSizePolicy''': behaviour of the plasmoid in a vertical layout such as a panel.

== PopupApplet specific ==
* ''QIcon'' '''popupIcon''': it will be used instead of the applet content when the applet is in a panel
* ''Object'' '''popupIconToolTip''': it contains the icon, mainText and subtext for the tooltip the applet will have when collapsed in an icon, properties:
** ''variant'' '''image''': the icon, it may be an icon name, an image path, a QIcon, QImage or a QPixmap
** ''String'' '''mainText''': the tooltip title
** ''String'' '''subText''': the tooltip descriptive subtext

<syntaxhighlight lang="javascript">
var data = new Object
data["image"] = "konqueror"
data["mainText"] = "ToolTip title"
data["subText"] = "ToolTip descriptive sub text"
plasmoid.popupIconToolTip = data
</syntaxhighlight>

* ''bool'' '''passivePopup''': if true when the popup is opened other windows can gain focus and the popup won't close

* ''bool'' '''popupShowing''': true when the popupapplet is iconified and its popup is open

== Containment specific ==
* ''Array(Object)'' '''applets''': List of all applets in the containment
* ''bool'' '''drawWallpaper''': Enable/disable the wallpaper painting by the containment
* ''enum'' '''containmentType''': one of
** ''DesktopContainment'': A desktop containment
** ''PanelContainment'': A desktop panel
** ''CustomContainment'': A containment that is neither a desktop nor a panel but something application specific
** ''CustomPanelContainment'': A customized desktop panel

* ''int'' '''screen''': Number of the screen this containment is in
* ''string'' '''activityName''': The name of the activity this containment belongs to.
* ''string'' '''activityId''': The id of the activity this containment belongs to.

The following API is only available from declarative containments.
* "ToolBox" "toolBox()": The toolbox of the Containment. The ToolBox is rendered as a separate item on the scene and provides access to the following properties:
** "Array(QAction)" "actions": A list of actions provided by the Containment.

= Geometry =

Read Only Properties:

* ''QRectF'' '''rect''': the current rect of the Plasmoid; note that the top left may be not be the origin point (0,0)

Functions:

* '''resize(width, height)'''
* '''setMinimumSize(width, height)'''
* '''setPreferredSize(width, height)'''
* '''setBackgroundHints(background)''' - use '''NoBackground''' as value if you want to remove the default plasmoid background box.
* '''popupIcon(QIcon("some icon"))''' - set icon to show when the plasmoid is added to the taskbar. NOTE if the plasmoid is made in QML, you MUST specify a default size for the main Item. This size will be used for the plasmoid when added to the taskbar

= Painting and Layout =

To paint directly on to the canvas, a widget may implement the paintInterface function in the plasmoid object:

<syntaxhighlight lang="javascript">
plasmoid.paintInterface = function(painter) { /* painting code goes here*/ }
</syntaxhighlight>
 
See the Painting section below for information about helpful classes and functions that can be used when implementing a paintInterface function.

Read/Write Properties:

* ''Layout'' '''layout''': the QGraphicsLayout associated with the Plasmoid for laying out top level items; this property is read-write, though the property is not usually set as one can simply do "new LinearLayout" (or one of the other layout classes provided) and it will be automatically associated with the Plasmoid.

Functions:

* '''update()''': triggers a full repaint of the Plasmoid.
* '''update(QRectF rect)''' triggers a repaint of the rect area of the Plasmoid.
* '''failedToLaunch(bool failed[, string reason])''' sets the launch status of the Plasmoid; if set to true, the script will stop executing and the reason message, if any, will be displayed to the user.

= Access To Packaged Files =

Functions:

* ''string'' '''file(string type[, string fileName])''': returns the path to a file in the Plasmoid package of the given type, optionally with a file name to match, e.g. 
<syntaxhighlight lang="javascript">var path = plasmoid.file("mainscript")</syntaxhighlight>
 
or
 
<syntaxhighlight lang="javascript">var pm = new QPixmap(plasmoid.file("images", "mypixmap.png"))</syntaxhighlight>

* ''bool'' '''include(string filename)''': attempts to include the script defined from the package's code directory

= Configuration Data =
Configuration values can be defined using [[Development/Tutorials/Using_KConfig_XT|KConfig XT]] XML files in the {{path|contents/config/}} directory of the Plasmoid's package. The default file that is looked for and used is {{path|contents/config/main.xml}}.

== Accessing Configuration Data ==
Read-write properties:
* ''String'' '''activeConfig''': The current active configuration description. For instance, setting it to "foo" would cause the Plasmoid to try and reference the {{path|contents/config/foo.xml}} KConfigXT file. Setting this to an empty string will switch to the main.xml file.

Functions:
* ''any'' '''readConfig(String key)''': reads the value from the configuration data for the given key as defined by the currently active configuration.

* '''writeConfig(String key, any value) ''': writes a value to the configuration store under the given key

== User Customization ==

User customization can be offered by providing a Qt Designer file called {{path|contents/ui/config.ui}} in the Plasmoid's package.

Callbacks:
* '''configChanged()''': callback function called when the configuration is changed external to the Plasmoid, e.g. when the user changes settings in a configuration dialog.

= Context menu =

It's possible to add some items to the popup menu of the Plasmoid.

Functions:
* '''setAction(String name, String text, String icon, String shortcut)''': adds an item to the context menu with the given text and icon;
In pure JavaScript plasmoids you need to define '''plasmoid.action_<name>''' function, where <name> is the first argument for setAction call, and this function will be called each time user clicks the item.
Similarly in QML plasmoids you must define a function '''action_<name>''' in the root qml item that will handle the action click.
* '''setActionSeparator(String name)''': (API v5) adds a separator item to the context menu
* '''removeAction(String name)''': removes the item with <name>

Schedules/KDE4/4.10 Feature Plan

2012-11-12T16:32:28Z

Sebas: qml containments is done

This is a list of planned features for the SC 4.10 release.

See also:

*[[Schedules/KDE4/4.10 Release Schedule]]
*[[Schedules/KDE4/4.9 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
|}
NO NEW FEATURES ALLOWED
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureDone|QML Containments|Making it possible to do full-featured containments in QML|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|nepomuk-indexer|New Nepomuk Indexer|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomukbakcup|Nepomuk Backup rewritten from scratch|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomukcleaner|An application to port/clean invalid/legacy data in Nepomuk|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk KCM|Rewrite the Nepomuk KCM|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk tags|Nepomuk Tags KIO Slave|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display application menu and title bar side by side for maximized windows ({{bug |102607}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt ({{bug |266596}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects ({{bug |296773}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Animate Window Maximize/Restore ({{bug |308990}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move ExtendedBorderRegion to stable API ({{bug |308994}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Support shortened titles like in bespin in all decorations ({{bug |308995}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Mouse Click effect ({{bug |309006}}, Review 105780)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Decorations not visible ({{bug |305875}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|drag-and-drop between windows by cover switch alt-tab causes apps to crash ({{bug |179077}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add a rule to select the screen ({{bug |183996}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Need Mouse navigation in flip switch mode ({{bug |244439}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org ({{bug |297634}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297635}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297637}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Allow direct rendering with fglrx ({{bug |301103}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Don't use OpenGL matrix stack in OpenGL 2 backend ({{bug |303093}}, Review 105455)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Refactor Screen/Window PaintData ({{bug |303314}}, Review 105141)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Rapid flickering in locked screen -- makes it difficult to unlock ({{bug |303579}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|double click menu to close needs GUI config ({{bug |305738}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Toplevel::windowType() needs performance improvements ({{bug |306384}}, Review 106349)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|GLPlatform should recommend either OpenGL1 or OpenGL2 compositing ({{bug |306436}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Zoom effect broken in master ({{bug |307609}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|kwin fails to build when the GLES support is disabled ({{bug |307866}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Some effect authors are listed as "Name1 & Name2" ({{bug |307928}}, Review 106880)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add screen management actions to window context menus ({{bug |269207}}, Review 106065)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Move Workspace's compositing functionality to own class Compositor ({{bug |299277}}, Review 102420)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Option to disable close on double click in Aurorae ({{bug |301327}}, Review 106160)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Remove Tiling Support From KWin ({{bug |303090}}, Review 105546)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Allow Scripts to add menus to useractions menu ({{bug |303756}}, Review 106285)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Generic QML support for Aurorae Themes ({{bug |303810}}, Review 105768)|mgraesslin@kde.org}}
{{FeatureDone|kwin|Split out Useractions Menu from Workspace ({{bug |305832}}, Review 106085)|mgraesslin@kde.org}}


{{FeatureInProgress|kwin|Implement color correction (Review 106141)|skeletk13@gmail.com|Casian Andrei}}
{{FeatureDone|oxygen decoration|Implement ExtendedBorderRegion support, to resize windows outside of their actual borders|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureDone|oxygen style|Implement BlurBehind semi-transparent tooltips when available|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureDone|plasma-wallpapers|Color wallpaper: add listview to display thumbnails for background mode|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureInProgress|plasma workspace|Port Notifications applet to QML|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureInProgress|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureDone|System Tray|System tray with interface in QML|dmitry.ashkadov@gmail.com|Dmitry Ashkadov}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|systemsettings|Keyboard layout preview|amourphious1992@gmail.com|Shivam Makkar}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Split into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}

{{FeatureTodo|FolderView|Port to QML|ignat.semenov@blue-systems.com|Ignat Semenov}}

{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}

{{FeatureDone|Dolphin|Implement parallel sort algorithm|emmanuelpescosta099@gmail.com|Emmanuel Pescosta}}

{{FeatureDone|Dolphin|Add GUI option for the "Rename Inline" setting|frank78ac@googlemail.com|Frank Reininghaus}}

{{FeatureDone|Dolphin|Add "Icon Size" submenu to the Places Panel context menu|frank78ac@googlemail.com|Frank Reininghaus}}

{{FeatureDone|print-manager|New Print manager KCM and applet (plasmoid) replacement, using C++ |dantti12@gmail.com|Daniel Nicoletti}}

{{FeatureDone|Kate|Support for Python plugins|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Advanced gid(1) plugin using both ID files and etags|srhaque@theiet.org|Shaheed Haque}}

{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}

{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}

{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}

{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}

{{FeatureTodo|Kdialog|Add support for detailedsorry/detailederror messages|kde@privat.broulik.de|Kai Uwe Broulik}}

{{FeatureTodo|Konsole|Improve the search filter bar|francesco.cecconi@gmail.com|Francesco Cecconi}}

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}

{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Rocs|Journal files for projects.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Revisit graph export/import functionality to fully support: TGF, DOT, GML, GraphML|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Main Window UI Reorganization: Editor Toolbar, dialogs, Information Panel|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Edit Menu|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Configuration Dialog Optimizations: Code-Editor, Graph Editor|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|KTouch|Ship ktouch/next|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Smart resizing of training screen with aligned vertical lines|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Prominent hint during training if the user makes repeatedly errors|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Show course descriptions in course selector|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KTouch|Show a message when keyboard layout visualization isn't available due missing data|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|Analitza|New plotting framework|percy.camilo.ta@gmail.com|Percy Camilo Triveño Aucahuasi}}
{{FeatureDone|KAlgebra|Splitted the QML Components from KAlgebraMobile|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|New plotting plasmoid graphs, in QtQuick|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|Pairs|Pairs Theme editor|marco.calignano@gmail.com|Marco Calignano}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Mark right angles|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkdegames|[http://community.kde.org/KDE_Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes) '''Release team:''' please link to the [[Projects/Games/Porting_to_libkdegames_v5|porting instructions]] for third-party developers|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureDone|KGoldrunner|Use KGameRenderer and QGraphicsView for all graphics: the gameplay is the same as before.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Remove the status bar. All scores and status messages are in the viewport now.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Allow the displayed speed of moves to be adjusted.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Animate multi-stage moves, to make it easier for a human player to follow their progress.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Show multi-stage moves in an order that is easier to follow.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Validate the loading of saved games and report errors.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Rewrite the main AI class and make it use a true Minimax method.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Provide a choice of two AI styles, Kepler and Newton, with the possibility to add more.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add settings to choose computer player, AI style and skill level for either or both of players 1 and 2.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add board sizes 3x3 and 4x4, for simplified play.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add a simple Print facility for KSudoku puzzles.|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}
{{FeatureInProgress|okular|Tiled rendering|okular-devel@kde.org|Okular Developers}}
{{FeatureInProgress|Gwenview|Recursive importer|agateau@kde.org|Aurélien Gâteau}}
{{FeatureInProgress|Gwenview|Color profile support|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add lyrics view|martin.sandsmark@kde.org|Martin Sandsmark}}

|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KGet|Metalink/HTTP Support|dahalaishraj@gmail.com|Aish Raj Dahal}}

|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
{{FeatureInProgress|ComicStrip|Replace with QML version|rshah0385@kireihana.com|Reza Fatahilah Shah}}
{{FeatureDone|Calculator|Replace with QML version|luizromario@gmail.com|Luiz Romário Santana Rios}}
{{FeatureDone|QML Wallpapers|Make it possible to have animated wallpapers written in QtQuick technologies.|aleixpol@blue-systems.com|Aleix Pol Gonzalez}}
{{FeatureDone|Dictionary KRunner|Look up words in the dictionary by typing in 'define {word}' in krunner.|Jason@zx2c4.com|Jason A. Donenfeld}}
{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add tagged unions to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add array indices to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Umbrello|Line based diagram grid |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureTodo|Umbrello| widget resize and diagram auto resize feature |ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureTodo|Umbrello|add spline based association lines to avoid autolayout widget/line overlapping (needs volunteers)|ralf.habacker@freenet.de|Ralf Habacker}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Ark|Make it possible to disable internal previewer|kde@privat.broulik.de|Kai Uwe Broulik}}
|}

Schedules/KDE4/4.10 Feature Plan

2012-10-24T10:58:19Z

Sebas: add QML containment

Schedules/KDE4/4.9 Feature Plan

2012-05-03T17:39:15Z

Sebas: thumbnails done

This is a list of planned features for the SC 4.9 release.

See also:

*[[Schedules/KDE4/4.9 Release Schedule]]
*[[Schedules/KDE4/4.8 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|KGlobalSettings|Make KGlobalSettings reread locale settings before calling settingsChanged().|lamarque@kde.org|Lamarque V. Souza}}
|}
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Thumbnail|fix for bookmarks|sebas@kde.org|Sebastian Kügler}}

|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|ksmserver|Port shutdown dialog to QML|lamarque@kde.org|Lamarque V. Souza}}
{{FeatureInProgress|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma|MPRIS2 dataengine|alex.merry@kdemail.net|Alex Merry}}

{{FeatureTodo|kwin|"Move" command should allow off-screen window moving same as Alt + click trick (Bug 229942)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Quick Tile shortcuts should be toggle buttons (Bug 263755)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display application menu and title bar side by side for maximized windows (Bug 102607)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Insufficient stacking order handling for deleted windows (Bug 158262)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|No reason given why some desktop effects cannot be activated (Bug 209213)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt (Bug 266596)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Placement Policy 'under mouse' (Bug 272162)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Kill helper should be out of process (Bug 295940)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Decoration KCM should show comment for decoration (Bug 296041)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Lanczos Filter broken after screen size changes (Bug 296065)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|DesktopThumbnailItem for QML (Bug 296067)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Packages for Desktop Switching Layouts (Bug 296068)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Walk Through Desktop layout rendering desktop previews (Bug 296069)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move ThumbnailBar from BoxSwitch to CoverSwitch (Bug 296070)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Drop BoxSwitch effect (Bug 296071)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Different binary name for KWin Active (Bug 296084)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab (Bug 296772)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects (Bug 296773)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for KWin Scripts (Bug 296774)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|KConf Update Script for KWin 4.9 (Bug 296775)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Long caption in Thumbnail layout overlaps box for only one item (Bug 297028)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org (Bug 297634)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org (Bug 297635)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Window Switching Layouts (Bug 297636)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org (Bug 297637)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Update Documentation for Window Switcher Layouts (Bug 297638)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Switcher KCM needs to be reworked (Bug 297639)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Document global JavaScript methods in KWin Scripting API documentation (Bug 297640)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Partial port to xcb|fredrik@kde.org}}
{{FeatureDone|kwin|JJ: kwin fulscreen / un-fullscreen system notifications (Bug 124612)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Use arrow keys to control cover switch. (Bug 178595)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Change title of menu item "Configure window behaviour..." (Bug 249486)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Task switcher message when no windows looks ugly with stars (Bug 260938)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Synchronize Show Desktop wording in all tabbox effects (Bug 273478)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window Specific Settings dialog has no help function (Bug 286783)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add "Present Windows - Window Class" to "Screen Edges" functions (Bug 288960)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Select next window with arrow key in Alt+Tab (Bug 291916)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Synchronize user actions menu with libtaskmanager (Bug 296056)|kwin-bugs-null@kde.org}}

|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Refactor into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}
{{FeatureDone|Dolphin|Allow to show any kind of metadata like ratings, tags, comments, image-sizes, music-artist, ... beside each item of the view.|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Use KMessageWidget for information- and error-messages (see http://agateau.com/2011/04/21/kde-ux-2011/ for details)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Optionally remember the column-widths of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to disable the expandable folders of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Implement inline renaming for the new view-engine|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to optionally set a maximum number of lines for the icons-view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}
{{FeatureTodo|Konsole|Add command line options for controlling the visibility of menubar and tabbar|adaptee@gmail.com|Jekyll Wu}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Android|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Extend graph data structure to support overlay graphs|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Stepped execution of algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|General unit test cleanup and overhauling|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|New Project Wizard - guided creation based on loaded plugins|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Project journal files|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|New Add-Node/Add-Link Toolbar for data types and pointer types|rocs-devel@kde.org|Rocs Developers}}
{{FeatureTodo|Kig|Improve Cancel Construction and Undo actions|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkdegames|[http://community.kde.org/Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes)|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureTodo|Granatier|improve config UI for player and arena selection|m-hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Kajongg|tooltips giving playings hints|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|new config option: propose what to do|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|make it possible to replay a game from a screen shot (for better debugging)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|improve Robot AI|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Add default voices|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Players can chat with each other from within kajongg|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Define a central game server, making it easier to play over the internet (no more tweaking of firewalls for the server side)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureInProgress|Kajongg|Add support for other rule variants, starting with Classical Chinese variants|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Print rulesets, also more than one in parallel for comparisons|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Add the Gold Rush II championship game (20 levels), contributed by Gabriel Miltschitzky|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add solution files to some KGoldrunner games, possibly using Get Hot New Stuff|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Simplify the XML descriptions of puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for seven new two-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for three new three-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Improve the quality and relevance of KSudoku hints|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make Load and Save work correctly for all puzzle types, including display of small markers/notes and restart of the puzzle clock from a saved value|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Integrate the new generator/solver and the old KSudoku code more closely|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make puzzle features easier to see and use by improving highlighting, control and settings in both 2-D and 3-D puzzles and adding keyboard input to 3-D puzzles|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Gwenview|Fullscreen browse|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|JuK|last.fm scrobbling|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|JuK|cover-fetching from last.fm|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureInProgress|JuK|MPRIS2 support|alex.merry@kmail.net|Alex Merry}}
|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|Kopete|Add option to group all offline users into a "Offline Users" group|kopete-devel@kde.org|Kopete Developers}}
{{FeatureDone|Kopete|Show contact's status change in chat window|igor.poboiko@gmail.com|Igor Poboiko}}
{{FeatureDone|Kopete|Add context option "rename" to contacts and allow changing custom display name inline.|kopete-devel@kde.org|Kopete Developers}}
|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Akonadi Google Resources|Move contacts and calendars resources from Akonadi Google project to kdepim-runtime|dan@progdan.cz|Dan Vratil}}

{{FeatureDone|KTnef|Bring back KTnef from the KDE3 days. KTnef is a standalone TNEF attachment viewer|winter@kde.org|Allen Winter}}

{{FeatureTodo|Akonadi Kolab Resources|Kolab resource using the Kolab libraries to kdepim-runtime|chrigi_1@fastmail.fm|Christian Mollekopf}}

{{FeatureTodo|Extend Akonotes Format|Extend the akonotes format to support features required by zanshin and kolab|chrigi_1@fastmail.fm|Christian Mollekopf}}

|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Now Playing|replace with QML version|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Lokalize|Optimize TM fuzzy searching||Nick Shaforostoff}}
{{FeatureDone|Lokalize|File search tab||Nick Shaforostoff}}
{{FeatureTodo|Lokalize|.ts support||Nick Shaforostoff}}
{{FeatureInProgress|Umbrello|diagram auto layout support|ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureInProgress|Umbrello|diagram graphviz dot export |ralf.habacker@freenet.de|Ralf Habacker}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

|}

Schedules/KDE4/4.9 Feature Plan

2012-05-03T11:09:48Z

Sebas: add boookmarks thumbs

This is a list of planned features for the SC 4.9 release.

See also:

*[[Schedules/KDE4/4.9 Release Schedule]]
*[[Schedules/KDE4/4.8 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|KGlobalSettings|Make KGlobalSettings reread locale settings before calling settingsChanged().|lamarque@kde.org|Lamarque V. Souza}}
|}
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Thumbnail|fix for bookmarks|sebas@kde.org|Sebastian Kügler}}

|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|ksmserver|Port shutdown dialog to QML|lamarque@kde.org|Lamarque V. Souza}}
{{FeatureInProgress|plasma|MPRIS2 dataengine|alex.merry@kdemail.net|Alex Merry}}

{{FeatureTodo|kwin|"Move" command should allow off-screen window moving same as Alt + click trick (Bug 229942)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Quick Tile shortcuts should be toggle buttons (Bug 263755)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display application menu and title bar side by side for maximized windows (Bug 102607)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Insufficient stacking order handling for deleted windows (Bug 158262)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|No reason given why some desktop effects cannot be activated (Bug 209213)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt (Bug 266596)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Placement Policy 'under mouse' (Bug 272162)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Kill helper should be out of process (Bug 295940)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Decoration KCM should show comment for decoration (Bug 296041)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Lanczos Filter broken after screen size changes (Bug 296065)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|DesktopThumbnailItem for QML (Bug 296067)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Packages for Desktop Switching Layouts (Bug 296068)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Walk Through Desktop layout rendering desktop previews (Bug 296069)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move ThumbnailBar from BoxSwitch to CoverSwitch (Bug 296070)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Drop BoxSwitch effect (Bug 296071)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Different binary name for KWin Active (Bug 296084)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab (Bug 296772)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects (Bug 296773)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for KWin Scripts (Bug 296774)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|KConf Update Script for KWin 4.9 (Bug 296775)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Long caption in Thumbnail layout overlaps box for only one item (Bug 297028)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org (Bug 297634)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org (Bug 297635)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Window Switching Layouts (Bug 297636)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org (Bug 297637)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Update Documentation for Window Switcher Layouts (Bug 297638)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Switcher KCM needs to be reworked (Bug 297639)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Document global JavaScript methods in KWin Scripting API documentation (Bug 297640)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: kwin fulscreen / un-fullscreen system notifications (Bug 124612)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Use arrow keys to control cover switch. (Bug 178595)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Change title of menu item "Configure window behaviour..." (Bug 249486)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Task switcher message when no windows looks ugly with stars (Bug 260938)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Synchronize Show Desktop wording in all tabbox effects (Bug 273478)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window Specific Settings dialog has no help function (Bug 286783)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add "Present Windows - Window Class" to "Screen Edges" functions (Bug 288960)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Select next window with arrow key in Alt+Tab (Bug 291916)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Synchronize user actions menu with libtaskmanager (Bug 296056)|kwin-bugs-null@kde.org}}

|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Refactor into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}
{{FeatureInProgress|Dolphin|Allow to show any kind of metadata like ratings, tags, comments, image-sizes, music-artist, ... beside each item of the view.|peter.penz19@gmail.com|Peter Penz}}
{{FeatureInProgress|Dolphin|Use KMessageWidget for information- and error-messages (see http://agateau.com/2011/04/21/kde-ux-2011/ for details)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Optionally remember the column-widths of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to disable the expandable folders of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Dolphin|Implement inline renaming for the new view-engine|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to optionally set a maximum number of lines for the icons-view|peter.penz19@gmail.com|Peter Penz}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Android|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Extend graph data structure to support overlay graphs|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Stepped execution of algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|General unit test cleanup and overhauling|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|New Project Wizard - guided creation based on loaded plugins|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Project journal files|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|New Add-Node/Add-Link Toolbar for data types and pointer types|rocs-devel@kde.org|Rocs Developers}}
{{FeatureTodo|Kig|Improve Cancel Construction and Undo actions|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkdegames|[http://community.kde.org/Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes)|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureTodo|Granatier|improve config UI for player and arena selection|m-hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Kajongg|tooltips giving playings hints|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|new config option: propose what to do|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|make it possible to replay a game from a screen shot (for better debugging)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|improve Robot AI|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Add default voices|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Players can chat with each other from within kajongg|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Define a central game server, making it easier to play over the internet (no more tweaking of firewalls for the server side)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureInProgress|Kajongg|Add support for other rule variants, starting with Classical Chinese variants|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Print rulesets, also more than one in parallel for comparisons|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Add the Gold Rush II championship game (20 levels), contributed by Gabriel Miltschitzky|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add solution files to some KGoldrunner games, possibly using Get Hot New Stuff|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Simplify the XML descriptions of puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for seven new two-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for three new three-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Improve the quality and relevance of KSudoku hints|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make Load and Save work correctly for all puzzle types, including display of small markers/notes and restart of the puzzle clock from a saved value|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Integrate the new generator/solver and the old KSudoku code more closely|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make puzzle features easier to see and use by improving highlighting, control and settings in both 2-D and 3-D puzzles and adding keyboard input to 3-D puzzles|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Gwenview|Fullscreen browse|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|JuK|last.fm scrobbling|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|JuK|cover-fetching from last.fm|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureInProgress|JuK|MPRIS2 support|alex.merry@kmail.net|Alex Merry}}
|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|Kopete|Add option to group all offline users into a "Offline Users" group|kopete-devel@kde.org|Kopete Developers}}
{{FeatureDone|Kopete|Show contact's status change in chat window|igor.poboiko@gmail.com|Igor Poboiko}}
{{FeatureDone|Kopete|Add context option "rename" to contacts and allow changing custom display name inline.|kopete-devel@kde.org|Kopete Developers}}
|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Akonadi Google Resources|Move contacts and calendars resources from Akonadi Google project to kdepim-runtime|dan@progdan.cz|Dan Vratil}}

{{FeatureDone|KTnef|Bring back KTnef from the KDE3 days. KTnef is a standalone TNEF attachment viewer|winter@kde.org|Allen Winter}}

{{FeatureTodo|Akonadi Kolab Resources|Kolab resource using the Kolab libraries to kdepim-runtime|chrigi_1@fastmail.fm|Christian Mollekopf}}

{{FeatureTodo|Extend Akonotes Format|Extend the akonotes format to support features required by zanshin and kolab|chrigi_1@fastmail.fm|Christian Mollekopf}}

|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Now Playing|replace with QML version|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}

|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Lokalize|Optimize TM fuzzy searching||Nick Shaforostoff}}
{{FeatureDone|Lokalize|File search tab||Nick Shaforostoff}}
{{FeatureTodo|Lokalize|.ts support||Nick Shaforostoff}}
{{FeatureInProgress|Umbrello|diagram auto layout support|ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureInProgress|Umbrello|diagram graphviz dot export |ralf.habacker@freenet.de|Ralf Habacker}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

|}

Schedules/KDE4/4.9 Feature Plan

2012-05-03T11:08:45Z

Sebas: add microblog qml

This is a list of planned features for the SC 4.9 release.

See also:

*[[Schedules/KDE4/4.9 Release Schedule]]
*[[Schedules/KDE4/4.8 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|KGlobalSettings|Make KGlobalSettings reread locale settings before calling settingsChanged().|lamarque@kde.org|Lamarque V. Souza}}
|}
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

|}
 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|ksmserver|Port shutdown dialog to QML|lamarque@kde.org|Lamarque V. Souza}}
{{FeatureInProgress|plasma|MPRIS2 dataengine|alex.merry@kdemail.net|Alex Merry}}

{{FeatureTodo|kwin|"Move" command should allow off-screen window moving same as Alt + click trick (Bug 229942)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Quick Tile shortcuts should be toggle buttons (Bug 263755)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display application menu and title bar side by side for maximized windows (Bug 102607)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Insufficient stacking order handling for deleted windows (Bug 158262)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|No reason given why some desktop effects cannot be activated (Bug 209213)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt (Bug 266596)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Placement Policy 'under mouse' (Bug 272162)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Kill helper should be out of process (Bug 295940)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Decoration KCM should show comment for decoration (Bug 296041)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Lanczos Filter broken after screen size changes (Bug 296065)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|DesktopThumbnailItem for QML (Bug 296067)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Packages for Desktop Switching Layouts (Bug 296068)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Walk Through Desktop layout rendering desktop previews (Bug 296069)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move ThumbnailBar from BoxSwitch to CoverSwitch (Bug 296070)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Drop BoxSwitch effect (Bug 296071)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Different binary name for KWin Active (Bug 296084)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab (Bug 296772)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects (Bug 296773)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for KWin Scripts (Bug 296774)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|KConf Update Script for KWin 4.9 (Bug 296775)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Long caption in Thumbnail layout overlaps box for only one item (Bug 297028)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org (Bug 297634)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org (Bug 297635)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Window Switching Layouts (Bug 297636)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org (Bug 297637)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Update Documentation for Window Switcher Layouts (Bug 297638)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Switcher KCM needs to be reworked (Bug 297639)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Document global JavaScript methods in KWin Scripting API documentation (Bug 297640)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: kwin fulscreen / un-fullscreen system notifications (Bug 124612)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Use arrow keys to control cover switch. (Bug 178595)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Change title of menu item "Configure window behaviour..." (Bug 249486)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Task switcher message when no windows looks ugly with stars (Bug 260938)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Synchronize Show Desktop wording in all tabbox effects (Bug 273478)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window Specific Settings dialog has no help function (Bug 286783)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add "Present Windows - Window Class" to "Screen Edges" functions (Bug 288960)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Select next window with arrow key in Alt+Tab (Bug 291916)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Synchronize user actions menu with libtaskmanager (Bug 296056)|kwin-bugs-null@kde.org}}

|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Refactor into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}
{{FeatureInProgress|Dolphin|Allow to show any kind of metadata like ratings, tags, comments, image-sizes, music-artist, ... beside each item of the view.|peter.penz19@gmail.com|Peter Penz}}
{{FeatureInProgress|Dolphin|Use KMessageWidget for information- and error-messages (see http://agateau.com/2011/04/21/kde-ux-2011/ for details)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Optionally remember the column-widths of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to disable the expandable folders of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Dolphin|Implement inline renaming for the new view-engine|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to optionally set a maximum number of lines for the icons-view|peter.penz19@gmail.com|Peter Penz}}

|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Android|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Extend graph data structure to support overlay graphs|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Stepped execution of algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|General unit test cleanup and overhauling|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|New Project Wizard - guided creation based on loaded plugins|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Project journal files|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|New Add-Node/Add-Link Toolbar for data types and pointer types|rocs-devel@kde.org|Rocs Developers}}
{{FeatureTodo|Kig|Improve Cancel Construction and Undo actions|david.narvaez@computer.org|David E. Narváez}}
|}
 

= kdegames=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkdegames|[http://community.kde.org/Games/API_cleanup Major cleanup and rewrite] (done, except for the new highscore classes)|stefan.majewsky@googlemail.com|Stefan Majewsky}}
{{FeatureTodo|Granatier|improve config UI for player and arena selection|m-hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Kajongg|tooltips giving playings hints|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|new config option: propose what to do|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|make it possible to replay a game from a screen shot (for better debugging)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|improve Robot AI|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Add default voices|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Players can chat with each other from within kajongg|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Define a central game server, making it easier to play over the internet (no more tweaking of firewalls for the server side)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureInProgress|Kajongg|Add support for other rule variants, starting with Classical Chinese variants|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Print rulesets, also more than one in parallel for comparisons|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Add the Gold Rush II championship game (20 levels), contributed by Gabriel Miltschitzky|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add solution files to some KGoldrunner games, possibly using Get Hot New Stuff|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Simplify the XML descriptions of puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for seven new two-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for three new three-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Improve the quality and relevance of KSudoku hints|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make Load and Save work correctly for all puzzle types, including display of small markers/notes and restart of the puzzle clock from a saved value|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Integrate the new generator/solver and the old KSudoku code more closely|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make puzzle features easier to see and use by improving highlighting, control and settings in both 2-D and 3-D puzzles and adding keyboard input to 3-D puzzles|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo|Gwenview|Fullscreen browse|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|JuK|last.fm scrobbling|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|JuK|cover-fetching from last.fm|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureInProgress|JuK|MPRIS2 support|alex.merry@kmail.net|Alex Merry}}
|}
 

= kdenetwork=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureDone|Kopete|Add option to group all offline users into a "Offline Users" group|kopete-devel@kde.org|Kopete Developers}}
{{FeatureDone|Kopete|Show contact's status change in chat window|igor.poboiko@gmail.com|Igor Poboiko}}
{{FeatureDone|Kopete|Add context option "rename" to contacts and allow changing custom display name inline.|kopete-devel@kde.org|Kopete Developers}}
|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Akonadi Google Resources|Move contacts and calendars resources from Akonadi Google project to kdepim-runtime|dan@progdan.cz|Dan Vratil}}

{{FeatureDone|KTnef|Bring back KTnef from the KDE3 days. KTnef is a standalone TNEF attachment viewer|winter@kde.org|Allen Winter}}

{{FeatureTodo|Akonadi Kolab Resources|Kolab resource using the Kolab libraries to kdepim-runtime|chrigi_1@fastmail.fm|Christian Mollekopf}}

{{FeatureTodo|Extend Akonotes Format|Extend the akonotes format to support features required by zanshin and kolab|chrigi_1@fastmail.fm|Christian Mollekopf}}

|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Now Playing|replace with QML version|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}

|}
 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureDone|Lokalize|Optimize TM fuzzy searching||Nick Shaforostoff}}
{{FeatureDone|Lokalize|File search tab||Nick Shaforostoff}}
{{FeatureTodo|Lokalize|.ts support||Nick Shaforostoff}}
{{FeatureInProgress|Umbrello|diagram auto layout support|ralf.habacker@freenet.de|Ralf Habacker}}
{{FeatureInProgress|Umbrello|diagram graphviz dot export |ralf.habacker@freenet.de|Ralf Habacker}}
|}

 

= kdeutils=

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

|}

Development/Tutorials/Plasma/QML/API

2012-04-12T22:03:31Z

Sebas: add code example for async operations

Projects/PIM/Akonadi

2012-03-14T12:36:07Z

Sebas: details about email workspace integration

== Akonadi TODO ==
The following list contains the things which need to be done for Akonadi.

Note: The person noted in the "Contact" column is not necessarily the one implementing that feature, but the one who can tell you what to do and how to help, i.e. you can also contribute to those tasks ;-)

There is also a more detailed page about bugs and missing features of things that are currently ported [[Projects/PIM/Akonadi/PortingStatus|here]].

=== Core ===

==== KDE 4.1 / Akonadi 1.0 ====

Urgent tasks that need to be finished for the KDE 4.1 release ('''May 19th'''):

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureDone|Item streaming in ItemSync/ResourceBase|As discussed in Osnabrueck|Tom/Volker}}
{{FeatureDone|Payload serialization format versioning|see below
tokoe@kde.org|Tobias}}
{{FeatureDone|API for additional item parts|As discussed in Osnabruck|Volker/Tobias}}
{{FeatureDone|Infrastructure for showing additional dialogs from agents/resources|As discussed in Osnabrueck|Tom}}
{{FeatureDone|Allow to limit ItemFetchJob to current cache content|Prevents search index feeder agents from downloading all remote data|vkrause@kde.org|Volker}}
{{FeatureDone|Fix API for item/collection modifications|See Osnabrueck meeting notes for details|vkrause@kde.org|Volker}}
{{FeatureDone|Plugin Versioning|For serializer plugins, also check using Qt plugin stuff instead of the libkdepim plugin framework|tokoe@kde.org|Tobias}}
{{FeatureDone|Tray app|small app to control the server and have a something that can report errors|tomalbers@kde.nl|Toma}}
{{FeatureDone|Backup support|Dump & Restore database contents, also useful when upgrading to a newer database version|tomalbers@kde.nl}}
{{FeatureDone|Akonadi Artwork|Icon for the tray app|tomalbers@kde.nl|Toma}}
|}

==== KDE 4.2 / Akonadi 1.1 ====

That's the stuff we want to have in 4.2, very roughly ordered by priority. Releases are scheduled for early January 2009.

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureDone|Server error reporting|Helpful error message when the server cannot be started or if there is some other problem communicating with it.|vkrause@kde.org|Volker}}
{{FeatureDone|KResource migration tool|For KABC and KCal resources, setting up Akonadi <-> KResource bridges where needed|Volker}}
{{FeatureDone|KResource bridges|Basically finished, needs more testing|Kevin}}
{{FeatureDone|Distribution Lists|Serializer Plugin and resource support|Tobias,Kevin}}
{{FeatureDone|Complete iCal resource|error handling, robustness, legacy formats, file montitoring|Volker}}
{{FeatureDone|Complete vCard resource|same as iCal + binary legacy format|Bertjan}}
{{FeatureDone|Item size|Needed by Mailody|toma@kde.org}}
{{FeatureDone|LINK/UNLINK commands|Managing item references in virtual collections|vkrause@kde.org|Volker}}
{{FeatureDone|Akonadi Testrunner|Running tests in a self contained Akonadi setup|igor_trindade@yahoo.com.br|Igor}}
{{FeatureDone|Remote file support for iCal/vCard resources|Replaces net/remote KRes resources|Bertjan}}
{{FeatureDone|Solid integration|Switch online/offline state in ResourceBase automatically|Bertjan}}
|}

==== KDE 4.3 / Akonadi 1.2 ====

Stuff that went into KDE 4.3 and Akonadi server 1.2.

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureDone|Fix unit tests|Make unittests work without destroying the production database|Igor/Volker}}
{{FeatureDone|Filesystem Backend|Store content data in files instead of the database, transfer filehandles instead of data to the client|Andras}}
{{FeatureDone|IMAP resource||Kevin}}
{{FeatureDone|Kolab proxy resource||Andras}}
{{FeatureDone|RID based operations|Item/collection retrieval and modification based on remote identifiers|Volker}}
{{FeatureDone|Microblog Support|Type library, serializer plugin, identi.ca/twitter resources|Tom}}
{{FeatureDone|ResourceBase::collectionsRetrievalDone is missing|I'm working around by calling collectionsRetrievedIncremental() with empty collection lists|Volker}}
|}

==== KDE 4.4 / Akonadi 1.3 ====

The following is being worked on for KDE 4.4 and Akonadi server 1.3.

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureDone|Port KAddressBook|Replace with KContactManager|Tobias}}
{{FeatureDone|Resource testing framework|Automated, shareable tests for resources|Igor/Volker}}
{{FeatureInProgress|Review change notifications|See the various discussions about shortcomings in that area|Volker,Steve}}
{{FeatureDone|Collection statistics for sub-trees|Provide a CollectionStatus object covering the full sub-tree in the model, allowing accumulated unread counts etc.|Kevin}}
{{FeatureDone|Favorite Folder Model|see current KMail|Kevin}}
{{FeatureDone|Batch jobs for modifying/deleting collections/items|it would be great to have jobs which perform operations on several entities in one go|Volker}}
{{FeatureDone|Collection streaming support in ResourceBase/CollectionSync|Similar to what is available for items already|Volker}}
{{FeatureDone|MBox resource||Bertjan}}
|}

==== Scheduled for KDE 4.5 / Akonadi 1.4 ====

Stuff that is planned for inclusion in 4.5, partly already available in the akonadi-ports branch.

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureInProgress|Port KOrganizer|Port from KResource to Akonadi|Frank/Sebastian}}
{{FeatureDone|Account creation wizard|as discussed in Berlin, see below|Volker,Laurent,Tom}}
{{FeatureInProgress|KMail port|KMail using Akonadi|everyone}}
{{FeatureInProgress|Remote Search|Delegating searches to resources, see below|Volker}}
|}

==== Post KDE 4.5 /Akonadi 1.4 ====

This stuff is currently not considered for 4.5 due to lack of resources. Of course it will be added nevertheless if someone implements it. The list is completely unsorted.

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureTodo|Error reporting|Akonadi::Job basically has only one error code: Unknown|Tobias}}
{{FeatureInProgress|Port KNotes|File resource, serializer plugin, KNotes application, Kontact plugin|}}
{{FeatureTodo|Batch job to retrieve a set of items from Akonadi|Those items don't belong to the same collection, rather they are located in different collections|}}
{{FeatureTodo|CollectionFetchJob/ItemFetchJob should be able to retrieve entities by flags/mimetype|
This is problematic with change notifications, as they have to know about the filtering with the \Seen flag as well.
This type of filtering would be possible with full Nepomuk interface though. We don't want yet another query language here. The plan is to fix the nepomuk agent and use that as semi-public interface for now.|}}
{{FeatureTodo|Nepomuk integration|Generic Item tag/rate/comment, etc.|Tom}}
{{FeatureTodo|Sync collection tree after creating setting up a resource|see AgentInstanceCreateJob|}}
{{FeatureTodo|Support standard commands for QUndo framework||}}
{{FeatureTodo|Conflict detection in resources|See Osnabrueck meeting notes for details|}}
{{FeatureInProgress|Action framework|see below|vkrause@kde.org|Volker}}
{{FeatureInProgress|Fix API docs|The libakonadi move as well as the huge API changes following it broke lots of the docs technical and content-wise, see below|Tobias}}
{{FeatureInProgress|Migration|Data and settings from pre-Akonadi times, see below|}}
{{FeatureInProgress|Extended notifications|Item change notification do not yet include their source collections (real and virtual)|}}
{{FeatureTodo|Alternative for Akonadi::ResourceBase|Not using the scheduler to avoid the serialization of operations, see RSS resource. (This will get very complicated. Maybe use a proxy ResourceBase for this, which is thread-pooled?)|}}
|}

=== Supported Types ===

Overview on the current state of support for various types:

{|
|-
! Type !! Serializer !! Multipart Support !! Models !! Views !! Resources !! Notes
|-
|Email||yes||partial||MessageModel, MessageCollectionModel, threading proxy model||?||maildir, IMAP||threading agent
|-
|News||yes (1)||partial (1)||(1)||(1)||NNTP||
|-
|Contact||yes||no||ContactModel||-||vCard, facebook, KRes||
|-
|Events||yes||no||EventModel||-||iCal, KRes||
|-
|Notes||no||no||-||-||-||not started yet
|-
|Feeds||yes||no||Feeds, Items||?||OPML||GSoC in playground/pim
|-
|Bookmarks||yes||no||-||-||local bookmarks, del.icio.us||
|}

(1) see Email

=== Mail specific extensions ===

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureTodo|Share mail flag code|Standard actions, standard flag enum/constants, Nepomuk interaction|}}
|}

=== Event/Todo/Journal specific extensions ===

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureTodo|Todo proxy model|See KOrganizers To-Do view|Bruno?}}
{{FeatureDone|Subtype identification|See discussion on kde-pim mailinglist|Kevin}}
{{FeatureInProgress|Agenda view|KOrganizer agenda view based on Akonadi|Sergio,Kevin}}
{{FeatureTodo|Month view|KOrganizer month view based on Akonadi|Bruno?}}
{{FeatureTodo|Timeline view|KOrganizer timeline view based on Akonadi|}}
|}

=== Resources, Agents and others ===

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureDone|KResource Akonadi bridge|for applications using KCal or KABC|kevin.krammer@gmx.at|Kevin}}
{{FeatureDone|Akonadi KResource bridge|for data accessed through KCal or KABC resources|kevin.krammer@gmx.at|Kevin}}
{{FeatureTodo|Expire Agent||}}
{{FeatureDone|MBOX Resource||Bertjan}}
{{FeatureDone|Extend IMAP Resource||Kevin/Andras}}
{{FeatureInProgress|POP3 Resource||Thomas}}
{{FeatureInProgress|RSS Resource|in akonadi-ports branch ([[Projects/PIM/RSS_framework_for_Akonadi|Details]])|Dmitry/Frank}}
{{FeatureInProgress|Filter Agent||Szymon}}
{{FeatureTodo|Search||}}
{{FeatureTodo| History resource||}}
{{FeatureInProgress|Filter Rule GUI|Used by filters and searches|Szymon}}
|}

Resource status overview (this should list all resources existing in KDE3 or already under development for Akonadi):

{|
|-
! Resource !! Retrieve Collections !! Retrieve Items !! Change Collections !! Change Items !! Configuration !! Notes
|-
|iCal||yes (4)||yes (1) (2)||no||yes||yes||remote file support, file watching with conflict handling
|-
|vCard||yes (4)||yes (1) (2)||no||yes||yes||remote file support, file watching with conflict handling
|-
|maildir||yes (1) (4)||yes (1) (2)||?||?||yes||
|-
|mbox||no||no||no||no||no||not started yet, code exists in KMail
|-
|IMAP||yes (1) (4)?||yes (1) (2)||no||no||no||code exists in kio_imap4 and Mailody, support for extensions: quota, ACL, annotations missing, what about Kolab and Scalix?
|-
|NNTP||yes (4)||yes (2)||n/a||n/a||yes||Needs support for local collection names and collection hierarchy
|-
|Local Bookmarks||?||?||?||?||(3)||Code in akonadi/resources
|-
|OpenChange||?||?||?||?||?||Code in akonadi/resources
|-
|Facebook||?||?||?||?||?||Code in playground/pim
|-
|del.icio.us||?||?||?||yes||no||Code in playground/pim
|-
|KABC||yes(6)||yes||no||yes||yes||
|-
|KCal||yes(6)||yes||yes(7)||yes||yes||
|}

# only full sync supported currently, need optimization
# does not yet honor cache policy
# still relies on QSettings for configuration and/or doesn't provide configuration over D-Bus
# does not yet provide correct access control settings
# only adding new items, not changing existing ones
# availability of child collections depend on whether the KResource plugin has subresources
# child collections can be added or removed if the KCal plugin can have subresources

=== KResource Migration Status ===

Everything without migration support is implicitly converted to use the compat bridge currently.

[[Image:Akonadi-Kres.png]]

==== KABC migration status ====

{|
|-
! KResource !! Feature equivalent agent !! Migration support !! Notes
|-
|directory|| || ||vCard dir in development
|-
|file||vCard file||4.2||binary format no longer supported, migrated to compat bridge instead
|-
|groupdav||||||
|-
|groupwise||||||
|-
|kolab||||||
|-
|ldapkio||||||
|-
|net||vCard file||TODO||
|-
|scalix||||||
|-
|slox||||||
|-
|xmlrpc||||||
|}

==== KCal Migration Status ====

{|
|-
! KResource !! Feature equivalent agent !! Migration support !! Notes
|-
|blog||||||
|-
|bugzilla||||||
|-
|groupdav||||||
|-
|groupwise||||||
|-
|kabc (birthday)||birthdays||4.3||
|-
|kolab||||||
|-
|localdir||||||
|-
|local||iCal file||4.2||
|-
|remote||iCal file||TODO||remote supports different URLs for upload and download, the iCal file agent doesn't, is this needed at all?
|-
|featureplan||||||probably obsolete since we don't use the XML featureplan anymore
|-
|scalix||||||
|-
|slox||||||
|-
|xmlrpc||||||
|}

== Akonadi Braindump ==
Ideas/notes etc. on various open issues in Akonadi.

=== Akonadi Standard Actions ===

Idea: Have something like KStandardAction for Akonadi that not only includes the representation of the action but also its state management and the actual operations. Like libakonadi that should be splitted into a generic, type-independent part and be extensible for type-specific actions. This will enable code sharing among many applications and guarantee consistent actions everywhere.

State management: watch selection models of a collection and/or item model.

Use KXMLGUI for context menus in standard views to allow easy extensibility with custom actions.

Generic actions:
* new collection [done]
* new virtual collection
* delete collection [done for single selection]
* copy collection [done]
* cut collection
* paste collection [done]
* synchronize collection [done for single selection]
* synchronize resource
* synchronize everything
* show collection properties dialog [done]
* delete item(s) [done]
* copy item(s) [done]
* cut item(s)
* paste item(s) [done]
* paste native data
* tag item(s)
* comment item
* rate item(s)
* configure resource
* add resource? (would need a type parameter, etc.)
* delete resource
* manage local subscriptions [done]
* move to submenu
* copy to submenu

The list is definitely long enough to make this worthwhile.

=== Collection Model / Collection View ===

Ideas/missing features/bugs of the collection model/view:

* Enable/disable status columns
* Show status after the name (see KMail)
* <s>Size column</s>
* Save/restore layout
* <s>Custom collection icons (see KMail, also needed for resource defined special folders (eg. Inbox)</s>
* Status tooltips (see KMail in 3.5.9) [still missing quota info]
* Quick search
* <s>Favorite folder view as proxy model on top of the normal collection model (FlatCollectionProxyModel might be helpful for there)</s>
* Accumulated statistics (unread, total, size)
* Fix dnd: move/copy/cancel menu always shows up and never has any effect

=== Compatibility ===

Notes on how to keep long-term protocol, source and binary compatibility.

* <s>Detect server version in Akonadi::Session, might be useful in case of protocol extensions/changes</s>
* What about database server version updates?
* <s>Versioning or any other kind of serialization format meta data, we'll need that in case of changes in serialization formats (see eg. Robert's compression patch where this is needed)</s>
* <s>We currently use 32 bit ids, probably hard to change later on, is that enough?</s>
* <s>Plugin versioning</s>

=== Resource API issues ===

Notes/ideas/complaints about the Akonadi::ResourceBase API:

* Extremely error prone:
** Scheduler dead-locks when a requested operation is not correctly announced as finished, esp. a problem in error cases.
** Using the result methods multiple times or when not requested asserts
* <s>Item streaming is missing, requiring all data to be in memory at once</s>
* Non-incremental updates need to know the results of ItemSync to not have to provide all data, even for already existing/unchanged items.

=== API / BC issues ===

Smaller stuff that should be fixed before the ABI freeze and is not yet listed above:

* Cleanup the D-Bus format used by NotificationMessage
* No mentioning of "IMAP" in the public API, we are not using IMAP
* Naming and installed location of libraries, headers and executables (see discussion on kde-pim ML)
* <s>Payload part labels are QStrings, attribute types are QByteArray</s>

=== Deployment issues ===

* Multiple access: Should multiple Akonadi instances' mysqlds access a single set of data files the mysql will likely corrupt the data. This can happen in any NFS+YP installation where users can log onto any machine and access shared homes. MySQL relies on filesystem locking to prevent multiple access. [http://dev.mysql.com/doc/refman/6.0/en/multiple-servers.html MySQL multiple instance docu].
* [http://dev.mysql.com/doc/refman/6.0/en/innodb-restrictions.html InnoDB tables should not be used on NFS].
* NFS speed: MySQL documentation recommends against locating its data files on network shares.
* AppArmor: Distros' AppArmor profiles prevent MySQL from writing outside its defined data directory (usually /var/lib/mysql). This is a problem at least with *buntu and openSUSE. These will need to be adapted. It is possible to daisy-chain profiles so that MySQL started by Akonadi receives a different profile to MySQL running standalone. An empty profile has all rights. Another possibility is to adapt the general MySQL profile so it can write to ${XDG_DATA_HOME}/akonadi(usually ${HOME/}.local/share/akonadi). Both support for profile chaining and ${HOME} may depend on the version of AppArmor installed. What about SELinux?
* Backup: MySQL data files should not be backed up without telling the mysqld process, otherwise a corrupt backup will be made. LOCK TABLES and FLUSH TABLES at the least. A dump can be made or mysqlhotbackup may be used in some circumstances. We should consider sysadmins' backup techniques when planning/promoting Akonadi, as a simple rsync cronjob with running Akonadi will not work. [http://dev.mysql.com/doc/refman/6.0/en/backup.html MySQL backup advice].

=== Account Creation Wizard ===

Notes on the resource configuration wizard discussion.

* WizardBase class
* Wizard discovery via .desktop files
* A wizard can configure multiple resources (eg. IMAP + LDAP for Kolab) and non-resources (mailtransport)
* Optionally hide resources completely covered by wizards in the Add Account dialog
* List wizards in the Add Account dialog
* Store Account -> Resources information to offer deletion of depending resources

=== PostgreSQL Support ===

Has been merged for Akonadi server 1.3. We still need a volunteer for continuous testing and maintenance though.

=== Documentation ===

* Avoid examples using KJob::exec() due to its problematic side-effects.
* Examples in the ItemCreateJob docs (and maybe others) operate on items in the root collection which does not work at all
* Resurrect the server API docs (now at http://api.kde.org/kdesupport-api/kdesupport-apidocs/akonadi/server/html/index.html ).

=== Migration of pre-Akonadi data and settings ===

* KCal/KABC
** switch KRes resources to Akonadi KRes compat resources, use KRes Akonadi compat resource, basically injecting Akonadi inbetween
** Replace Akonadi KRes compat resources with their ported equivalent
** Application side does not need migration code, "only" port to Akonadi
* KMail
** Should migrate to one resource per account + one for previous local folders
** Problem: local folders are mixed mbox/maildir
*** Dedicated KMail compat resource?
*** Convert everything to maildir first?
** Flags are stored in proprietary binary format
* KNode
** Migrate every account to NNTP resource
** Local flags should be preserved, stored in proprietary binary format
** Local subscription state should be preserved (where is that stored?)
** Local folders using MBOX format + proprietary binary index
* Akregator

=== Search & Virtual Collections ===

Got their own page by now:
* [[Projects/PIM/Akonadi/VirtualCollections]]
* [[Projects/PIM/Akonadi/SearchInfrastructure]]

=== Workspace integration ===

* Email notifier, based on UI of LionMail [[http://vizzzion.org/blog/2010/09/getting-email-done-the-stack-and-the-heap-of-lion-mail/]], in more detail:
** Write (or lend from Kontact Touch) ProxyModels to display email collections: new / unread and important, combination thereof
** Plasma Quick widgets for individual emails and collections
** UI integration
*** Konfiguration
*** Drag and Drop (from Collection onto desktop)
*** Theming / Animations
*** Streamlined notifications (MUST NOT get in the way)
** Activity support (notify off for certain activities, only selected folders for a given activity, etc)
The current Lion Mail code uses a dataengine to retrieve data from AKonadi. This needs to be ported to using one of the AKonadi models which are also used in Kontact Touch.

* Agent monitoring and control
* Enable/disable logging?
* Plasma applet for notes / sticky notes
* Resource progress, e.g. like KIO progress
* Drag&Drop of Akonadi items: drop target should be able to retrieve payload

== KMail Breakdown Plan ==
The current plan is to put some parts of KMail into a stand-alone
library, independent of KMail. This increases code reuse (for example, the message composer could be shared with Mailody) and makes the code a lot easier to maintain and to port to Akonadi.

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureTodo|Bodypart formatters||}}
{{FeatureDone|Reader Window||Andris}}
{{FeatureDone|Composer: Message Composer||Constantin,Leo}}
{{FeatureInProgress|Composer: GUI Window||Constantin}}
{{FeatureDone|Queue Manager for mailtransport||Constantin}}
{{FeatureInProgress|Templates: Core||Leo}}
{{FeatureTodo|Templates: GUI||}}
{{FeatureTodo|Port KMCommands||}}
{{FeatureDone|Port away from KMMessage and KMFolder* everywhere it is left|An idea might be: wrap KMMsgBase/KMMessage inside a reference counted Message class. Insulate everything else from it by wrapper functions. KMFolder should be easier...|all}}
{{FeatureInProgress|Migration application for index and other config||Casey}}
{{FeatureTodo|Port MDNs||}}
|}

== The Road to World Domination ==

Sort of related so the stuff above but with a scope for all of KDE PIM and beyond.

{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Item !! Description !! Contact
{{FeatureTodo|Share identity config GUI parts|eg. the signature configuration widget|}}
{{FeatureDone|Mailtransport Agent|Global shared outbox, central mail sending instance|Constantin}}
{{FeatureTodo|Recently sent to support in mailtransport|related to above, based on Akonadi/Nepomuk|}}
{{FeatureInProgress|Composer engine|Shared stuff for KMail/KNode/Mailody: Crypto, editor, editor actions, attachment model, message assembly, etc.|Constantin,Leo}}
|}

== Akonadi FAQ ==

This FAQ primarily deals with technical and design questions, if you have questions about using Akonadi (such as "I get error X when starting Akonadi"), please refer to [http://userbase.kde.org/Akonadi userbase.kde.org/Akonadi].

=== Where do I find the Akonadi config files? ===

''~/.config/akonadi/''

=== Where does Akonadi store my data? ===

Akonadi merely acts as a cache for your data, the actual content stays where it has always been, .ics/.vcf/MBOX files, local maildirs, IMAP- and groupware servers. There is only a limited amount of data stored exclusively in Akonadi:
* Data not supported by the corresponding backends, such as email flags in case of maildir/mbox. This is comparable to KMail's binary index files stored alongside these files in pre-Akonadi times.
* Internal meta-data used by application or resources, such as information about the last synchronization with a backend or translated folder names.
* Data that has been changed while the corresponding backend has been offline and has not yet been uploaded.

=== Where can I find the Akonadi database? ===

''~/.local/share/akonadi/''

=== Where can I find the source code? ===

There are three different parts of source code:
* The Akonadi server, which is KDE-independent. Currently, the code can be found at [http://websvn.kde.org/trunk/kdesupport/akonadi/ kdesupport/akonadi]. The server code will likely move to the [http://www.freedesktop.org/wiki/ freedesktop.org project] in the future, the move has already been [https://bugs.freedesktop.org/show_bug.cgi?id=15711 requested].
* The Akonadi KDE client libraries are in [http://websvn.kde.org/trunk/KDE/kdepimlibs/akonadi/ kdepimlibs/akonadi].
* Various agents, resources, the Akonadi console and much other misc stuff is in [http://websvn.kde.org/trunk/KDE/kdepim/akonadi/ kdepim/akonadi]

=== Where can I find documentation? ===

The documentation is mainly in the code itself, in the form of doxygen comments.
You can find the generated documentation on [api.kde.org api.kde.org], for example:

* General documentation, including a design overview, is [http://api.kde.org/kdesupport-api/kdesupport-apidocs/akonadi-git/html/ here]

: Note that some links in the above documentation which point to the server or the KDE client libraries are currently broken, use the links below to access that documentation.
* Documentation for the KDE Akonadi client library is [http://api.kde.org/4.x-api/kdepimlibs-apidocs/akonadi/html/index.html here]
* Documentation about the server is [http://api.kde.org/kdesupport-api/kdesupport-apidocs/akonadi-git/html/ here]

=== Which DBMS does Akonadi use? ===

So far only MySQL. There is some work on PostgreSQL support going on though. Basically, every database that is supported by QtSQL can be used, requiring minimal changes in the code at most. However, not all of them provide the features needed by Akonadi (see next two questions).

=== Why not use sqlite? ===

We tried. Really. It just can't handle the concurrent access very well.

Please refer to [http://techbase.kde.org/Projects/PIM/Akonadi/Database#Sqlite] for more information on this subject.

=== Why not use MySQL/Embedded? ===

We tried that as well, there are two reasons for not using it: No support for the InnoDB engine (which we need for transaction support) and poor availability (only OpenSUSE provided usable packages, needed a patched QSQL driver).

=== Do I need a running MySQL server? ===

No. Akonadi starts its own local MySQL server (unless configured otherwise, see next question). All you need is having the 'mysqld' binary installed at runtime (usually found in the mysql-server package of your distribution).

=== Can Akonadi use a normal MySQL server running on my system? ===

Yes, it can. You find the corresponding settings in ''~/.config/akonadi/akonadiserverrc''.

=== Can I connect multiple Akonadi instances to the same database to share my data between different machines? ===

That does not work unfortunately. Akonadi does not store all relevant data in the database but also uses the file system for configuration and large payload data for example. Also, there is no mechanism to ensure multiple instances have exactly the same version and exactly the same agents and plug-ins installed etc., all of which would be necessary to work on the same database. Finally, there is no notification system to inform the other instances about changes which endangers consistency since the Akonadi server contains internal caches of data in the database. If you want multiple instances to synchronize, use a groupware server (not as bad as it sounds, Kolab for example works with many normal IMAP servers).

If you try this despite the warnings, be aware that there is no safety mechanism in place to prevent you from doing that and you will likely mess up your data in funny ways.

=== I don't like a database server because of backups/running on NFS/etc. ===

See section "Deployment Issues" above, we are aware of that and working on it. Some of these, like backup/restore are already implemented. But please be aware that most of this issues also existed before (eg. with KMail's custom binary indexes).

=== Can a single Akonadi instance be used by multiple users? ===

No. There has to be one Akonadi server instance per user. However, it is possible to use a shared database server.

=== Can I access the Akonadi server on a remote machine? ===
No. Akonadi is not a groupware server. It's a local cache only.

=== What's the differences between Akonadi and EDS? ===
EDS (Evolution Data Server) is limited to contacts and calendar data, Akonadi is type-independent. Especially, Akonadi is designed to also handle high-volume data such as email. Akonadi and EDS also differ largely in their access protocol on a technical level (Corba/D-Bus vs. local socket with IMAP-like protocol/D-Bus) and also on a protocol level (type specific vs. generic).

=== How do I create a collection? ===

From the developers point of view, there is Akonadi::CollectionCreateJob for that, from the users point of view, most applications allow that, eg. Mailody or akonadiconsole.

However, there is one limitation: Top-level collections can only be created by resources, not by normal applications. The reason for that is that every object (collection or item) is supposed to have an owning resource, that is a resource that is responsible for storing and retrieving that object. There is an ongoing discussion to remove this restriction though.

So, if you want to create a collection eg. for testing purposes, add a resource first. Most Akonadi applications offer an option to do that, a module for KControl is planned as well.

=== How do I disable automatic migration from KDE's traditional framework? ===

The migration tool is controlled by standard KDE configuration file called ''kres-migratorrc''.

Distributors or system administrators wanting to disable the automatism will probably want to that globally, e.g. by editing the installed default configuration file, or by using KDE's configuration hierachy and using a profile config between that and the user level.

The quickest way to deactivate it for one user account only is to use KDE's ''kwriteconfig'' tool to set the respective configration value with a simple copy&paste of the following command:

''kwriteconfig --file kres-migratorrc --group Migration --key Enabled --type bool false''

Please note that at some point KDE applications such as Kontact, KOrganizer, KMail will be using Akonadi directly, at which point migration either has to be enabled or performed manually.

As of KDE 4.4 (and its development releases and when building from SVN trunk) this already applies to KAddressBook and KMail's address book access.

=== How do I completely disable Akonadi startup? ===

{{warning|If you already have applications natively using Akonadi, you of course can't disable Akonadi startup. KAddressBook (as of KDE 4.4 and its test versions), Mailody, KMail (as of KDE 4.4 and its test versions for address book related things) and KPilot are applications that are already based on Akonadi.}}

Other applications, like KOrganizer, are not based on Akonadi yet, at the time of writing. Instead, they use the old KResource framework for storing contacts, calendars and notes.
During the KDE 4.2 beta time, these KResources were automatically migrated to Akonadi-based KResources, the so-called Akonadi compatibility resources. Therefore, applications like KOrganizer would use Akonadi indirectly through KResources, and therefore would start the Akonadi server when being started.

If Akonadi doesn't start up correctly for you, the following should help you to disable Akonadi startup and use your old KResources again.

First, disable automatic migration like described in the above FAQ entry.
Then, open System Settings, go to the Advanced tab and open the KDE Resources config panel. There, you can configure which type of KResources are used for contacts, calendars and notes. If the migration to Akonadi was successful, you'll probably only see the Akonadi Compatibility Resource as an active resource, and all others disabled.

To disable Akonadi startup, enable your old resources again, then disable and delete the Akonadi compatibility resource.

=== What is the relation between Akonadi and OpenSync? ===

Akonadi and OpenSync focus on different aspects and complement each other. Akonadi provides a unified way to access PIM data for applications and a framework to implement powerful connectors to varies data sources. OpenSync focus is on syncing two sets of PIM data.

An Akonadi plugin for OpenSync is currently under development, allowing to sync PIM data available through Akonadi with any other system supported by OpenSync, especially mobile phones.

=== When should I use Akonadi? ===

More precisely, when should you use for your application specific data instead of eg. just using a local file directly.

Akonadi is especially useful when you need one the following:

* Different backends for your data, like eg. a local file and a remote server. Akonadi provides a unified interface for application developers to access your data independent of the actual backend.
* Caching and change replay of remote data. Akonadi has support for that built in, giving you free offline support for any remote backend.
* Desktop-wide sharing of your data. As soon as more than one application (say your main applications and a plasmoid) accesses the same data you need to deal with locking, conflict detection, change notifications, etc. - or let Akonadi do that for you.

However, if you are just looking for a simple way to store your application data without needing one of the above, using Akonadi usually means more implementation work for relatively little gain.

=== Akonadi needs too much space in my home directory! ===

An empty, unused Akonadi database needs about 100 Mb of disk space. This is due to the MySQL InnoDB log files which work similar to a journal in a modern file system. These files are constant in size and independent of the actual data stored in Akonadi. The default size is optimized for performance on average desktop hardware where the use of 100 Mb of disk space is no problem. In other cases, such as multi-user systems or embedded devices, this default might not be optimal though.

The default size can be configured, globally or per-user. The global configuration file can be found in $PREFIX/share/config/akonadi/mysql-global.conf, the per-user file is in ~/.config/akonadi/mysql-local.conf and overwrites settings of the global file. In any of these files, you can change the settings '''innodb_log_file_size''' and assign it a smaller value than the default (64M).

For this setting to take effect you need to restart Akonadi. With older Akonadi versions (<=1.1.1) you might need to manually remove the InnoDB log files from ~/.local/share/akonadi/db_data for this change to take effect. The log files do not contain data after a clean shutdown and thus can safely be removed while Akonadi is not running.

An alternative approach especially for multi-user systems might be the use of a single, global MySQL server instance.

=== My Akonadi resource seems to randomly hang/stop working! ===

A very common problem of resources based on Akonadi::ResourceBase are "unguarded exit paths" from one of the methods you have reimplemented there. See the following example:

<syntaxhighlight lang="cpp">
void MyResource::retrieveItems( const Collection &collection )
{
if ( someError )
return;
itemsRetrieved( myItems );
}
</syntaxhighlight>

In case of an error you leave retrieveItems() without telling Akonadi::ResourceBase that you are done with the task. Therefore, it is assumed the requested item retrieval takes a bit longer (which is not uncommon for resources for remote backends, results typically come in in a result slot connected to a job class for example) and waits until you announce the task is finished.

The following example does it correctly:

<syntaxhighlight lang="cpp">
void MyResource::itemAdded( const Akonadi::Item &item, const Akonadi::Collection &parent )
{
if ( noNetwork ) { // transient error
deferTask( i18n( "Offline, will retry later." ) );
} else if ( item_not_valid ) { // permanent error
cancelTaks( i18n( "Got invalid crap, can't store that." ) );
} else {
// store the item here
Item newItem( item );
newItem.setRemoteId( my_new_remote_id );
changeCommitted( newItem );
}
}
</syntaxhighlight>

The following methods require explicit notification that a task has been completed:
* retrieveX
* any method indicating changes, ie. itemAdded|Changed|Moved|Removed(), collectionAdded|Changed|Moved|Removed()
* any custom task scheduled with ResourceBase::scheduleCustomTask()

Refer to the API documentation of Akonadi::ResourceBase for the various ways to do that correctly, there are a few different ways, depending on the current task:
* Successful completion with convenience features, eg. changeCommitted(), itemsRetrieved() etc.
* Error cases with convenience features, eg. cancelTask(), deferTask()
* Only indicate completion, with everything else done manually, eg. changeProcessed(), taskDone()

To confirm a resource is affected by this problem, the "Resource Schedulers" tab of akonadiconsole is very useful (needs to be enabled in the context menu first, causes too much slowdown otherwise). It shows the state of the internal task scheduler of your resource, allowing you to spot stuck tasks.

== Information for Developers using Akonadi ==

References to information for developers using or extending Akonadi.

=== Tutorials ===
* [[Development/Tutorials/Akonadi/Application|Application Development]]
* [[Development/Tutorials/Akonadi/Resources|Resource Development]]
* [[Development/Tutorials/Akonadi/SerializerPlugin|Serializer Plugin Development]]
* [[Development/Tutorials/Akonadi/CreatingAccountWizardPackages|Creating accountwizard packages]]
* [[Development/AkonadiPorting|Application Porting]]

=== Documentation ===

* [[Projects/PIM/Akonadi/Testing|Akonadi Testing Framework]]
* [[Projects/PIM/Akonadi/Development_Tools|Akonadi Development Tools]]
* [[Projects/PIM/Akonadi/Firstrun|Akonadi Firstrun]]
* [[Projects/PIM/Akonadi/Trashhandling|Akonadi Trashhandling]]
* [[Projects/PIM/Akonadi/Debug_IMAP|Debugging Akonadi IMAP Resource]]
* [http://api.kde.org/4.x-api/kdepimlibs-apidocs/akonadi/html/index.html Client Library API documentation]

=== Projects ===

* [[Projects/PIM/Akonadi/Bookmarks|Bookmark support based on Akonadi]]
* [[Projects/PIM/Akonadi/PortingStatus|Akonadi Port - List of Bugs and Features]]

=== Contact & Getting Involved ===

* #akonadi IRC channel on freenode
* kde-pim@kde.org mailing-list
* Google Summer of Code
** [[Projects/Summer of Code/2009/Ideas#KDE_PIM|Google Summer of Code 2009 Ideas]]
** TODO: add links for other years

=== Links ===

* [http://pim.kde.org/akonadi/ http://pim.kde.org/akonadi/]

== Akonadi Internals ==

References to information for developers of Akonadi itself (the above section is of course also relevant for you).

=== Documentation ===

* [[Projects/PIM/Akonadi/Release_Howto|Akonadi Release Howto]]
* [[Projects/PIM/Akonadi/Database|Akonadi Database Internals]]
* [http://api.kde.org/kdesupport-api/kdesupport-apidocs/akonadi/html/ Akonadi Server API documentation]

=== Meeting Notes ===

* [[Projects/PIM/Akonadi/Meeting2008-11|Halloween Sprint 2008]]
* [http://community.kde.org/KDE_PIM/Meetings/Osnabrueck_7 Osnabrueck 7]
* [[Projects/PIM/Akonadi/Meeting2009-04|Akonadi April Sprint 2009]]
* [[Projects/PIM/Meetings/GCDS_2009|GCDS/aKademy 2009]]
* [[Projects/PIM/Akonadi/Meeting2009-10|Akonadi October Sprint 2009]]
* [http://community.kde.org/KDE_PIM/Meetings/Osnabrueck_8 Osnabrueck 8]
* [http://community.kde.org/KDE_PIM/Meetings/Akonadi-2010-05 Akonadi/KDE PIM pre45 sprint 2010]

[[Category:PIM]]

Development/Tutorials/Plasma/QML/ActiveSettings

2012-01-01T17:23:13Z

Sebas: /* Extending your Settings Module with with C++ */

This tutorial teaches you how you can load Active settings modules into your app, and create your own modules.

= Introduction =
Active Settings is an app, much like Plasma Desktop's kcmshell that shows and loads configuration modules. These configuration modules are plugins providing a QML package and an optional C++-plugin which exports custom-written configuration objects as QObject to the declarative environment.

You can query available modules using the --list argument to active-settings:

<pre>
$ active-settings --list
org.kde.active.settings.web Settings for history, caching, etc.
org.kde.active.settings.configtest Test Module for the Config Bindings
org.kde.active.settings.time Settings for timezone and date display
</pre>

You can load an individual module by supplying its plugin name as argument to active-settings:
<pre>
active-settings org.kde.active.settings.time
</pre>
will open the active-settings app and load the "Time and Date" module on startup.

= Architecture =
The Active Settings app consists of a number of parts, an Active App, which loads a QML package providing the chrome for active-settings, a set of Declarative components which encapsulate loading settings modules and a set of settings modules, which provide the UI and backend code for a specific settings domain (i.e. Time and Date, Browser settings, etc.).

= Integrating a Settings Module into an App =
In order to integrate a settings module "inline" into your app, you can use the SettingsItem component, which comes with the ActiveSettings declarative plugin. SettingsItem provides a PageStack (from PlasmaComponents) with a bit of additional API, the module property. Creating an Item with a settings module is as easy as:

<pre>

import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: webSettingsItem
module: "org.kde.active.settings.time"
anchors { ... }
}
</pre>

In order to speed up loading your app, you will want to lazy-load the settings module. This is very easy by using the PageStack features that SettingsItem encapsulates:
<pre>
import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: settingsItem
initialPage: someOtherItem
anchors { [...] }
}

PlasmaComponents.Button {
// This button toggles the settings item and someOtherPage
[...]
onClicked: {
if (settingsItem.module != "org.kde.active.settings.web") {
settingsItem.module = "org.kde.active.settings.web"
} else {
// Switching back...
settingsItem.replace(someOtherItem);
}
}
}

Item {
id: someOtherItem
/* this guy is shown before any module is loaded */
}
</pre>

= Creating Your Own Settings Module =

== Simple, QML-only Module ==
Writing a basic ActiveSettings configuration module is as simple as creating a Plasma Package, using the X-KDE-ServiceTypes "Active/SettingsModule". The service type registers your package as settings module, so active-settings will find (and list) it, and so it can be loaded using the SettingsItem QML binding. A simple active settings package will look like this:
<pre>
├── CMakeLists.txt
├── contents
│ └── ui
│ └── Web.qml
└── metadata.desktop
</pre>
The metadata.desktop file holds the plugin information, which script to load from the plugin initially, and a bunch of metadata, just like normal Plasma Packages. A simple metadata.desktop file will look like this:
<pre>
[Desktop Entry]
Name=Web and Browser
Comment=Settings for history, caching, etc.
Encoding=UTF-8
Type=Service
Icon=preferences-system-network
X-KDE-ServiceTypes=Active/SettingsModule
X-KDE-PluginInfo-Author=Sebastian Kügler
X-KDE-PluginInfo-Email=sebas@kde.org
X-KDE-PluginInfo-Name=org.kde.active.settings.web
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma-active.org
X-KDE-PluginInfo-Category=Online Services
X-KDE-PluginInfo-License=GPL
X-Plasma-MainScript=ui/Web.qml
</pre>
The interesting bits, specific to active-settings are the plugin name, the package name and the mainscript. The plugin name is used to find the package, and will translates to the "module" property of SettingsItem.
Web.qml points to a normal Item { [...] } in a file, normal rules apply here.

The CMakeLists.txt file takes care of proper installation and will be needed in order to install and package your settings module. It looks like this:
<pre>
install(DIRECTORY web/ DESTINATION \
${DATA_INSTALL_DIR}/plasma/packages/org.kde.active.settings.web)
install(FILES web/metadata.desktop \
DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-package-org.kde.active.settings.web.desktop)
</pre>
Make sure the names of the .desktop files in CMakeLists.txt are correct, since incorrect names lead to problems finding and loading your package, or even to conflicts between different modules. In case of doubt check active-settings --list for already installed modules.
After you installed the plugin (or changed its metadata) you'll need to run "kbuildsycoca4" in order to update the plugin metainformation cache.

== KConfig Bindings ==
Active Settings provides declarative bindings for KConfigGroup. This means that you can instantiate KConfig objects in your QML code, read and write settings. For many basic use-cases, this provides enough flexibility to do everything that's needed. The browser settings module uses this mechanism:
<pre>
import org.kde.plasma.components 0.1 as PlasmaComponents
import org.kde.active.settings 0.1 as ActiveSettings

[...]
ActiveSettings.ConfigModel {
id: adblockConfig
file: "active-webbrowserrc"
group: "adblock"
}
[...]
PlasmaComponents.Switch {
[...]
onClicked: adblockConfig.writeEntry("adBlockEnabled", checked);
Component.onCompleted: checked = adblockConfig.readEntry("adBlockEnabled");
}
</pre>
This corresponds to the following snippet in you active-webbrowserrc config file (for example i ~/.kde4/share/config/):
<pre>
[adblock]
adBlockEnabled=true
</pre>
ConfigModel will sync() the config file 5 seconds after a writeEntry(...) call, or on destruction of the module (for example by loading another module or page into the SettingsItem.

If you find yourself needing more advanced features from C++ code, you can extend your settings module using a C++ plugin. Of course you can choose to use both, the already provided KConfig bindings, and an additional plugin.

== Extending your Settings Module with with C++ ==
In some cases, you will find a pure declarative settings module too limited. By extending a settings module with C++ functionality, you can implement functionality in a C++ plugin, which gets automatically loaded with your C++ plugin. This loading is done in the SettingsComponent item provided by the ActiveSettings import. You will usually want to use a SettingsItem in your code, like in the above example. SettingsItem encapsulates the module loading mechanism and provides a PageStack interface. When a new settings module is loaded in the UI (by setting SettingsItem "module" property, the .desktop file is checked for an X-KDE-Library entry (X-KDE-Library=active_settings_time in the Time and Date example).

This loads a small plugin, consisting of two classes:
* A QObject based class, which registers one or more additional Object to the declarative runtime:
<pre>
K_PLUGIN_FACTORY(TimeSettingsFactory, registerPlugin<TimeSettingsPlugin>();)
K_EXPORT_PLUGIN(TimeSettingsFactory("active_settings_time"))

TimeSettingsPlugin::TimeSettingsPlugin(QObject *parent, const QVariantList &list)
: QObject(parent)
{
qmlRegisterType<TimeSettings>();
qmlRegisterType<TimeZone>();
qmlRegisterType<TimeSettings>("org.kde.active.settings", 0, 1, "TimeSettings");
}
</pre>
The name provided as second argument to K_EXPORT_PLUGIN macro is the one you specify in you metadata.desktop file as X-KDE-Library.

* One or more QObject-derived classes which export domain specific settings using QProperties, getters and setters.
<pre>
class TimeSettings : public QObject
{
Q_OBJECT

[...]
Q_PROPERTY(bool twentyFour READ twentyFour WRITE setTwentyFour NOTIFY twentyFourChanged)

public:
TimeSettings();
virtual ~TimeSettings();

[...]
bool twentyFour();

public Q_SLOTS:
[...]
void setTwentyFour(bool t);

Q_SIGNALS:
[...]
void twentyFourChanged();

private:
TimeSettingsPrivate* d;
};

</pre>
The types are basically reimplemented QObjects, which expose settings to the QML parts of your settings module. [http://doc.qt.nokia.com/4.8-snapshot/qml-extending.html Qt's documentation] has more information on how this works exactly.

In your declarative code, you can then import and instantiate these objects.
<pre>
import org.kde.active.settings 0.1

TimeSettings {
id: timeSettings
}

[...]

PlasmaComponents.Switch {
id: twentyFourSwitch
checked: timeSettings.twentyFour
onClicked : timeSettings.twentyFour = checked
}
</pre>
You will typically want to put code for reading the property in the ctor or getter, and code for writing options, or updating other parts of the UI, but of course more complex constructions are also entirely possible, since the settings plugins can basically provide any kind of QML extensions. When writing to configuration files, you should not forget to sync(); your KConfigObject, and to make sure that apps pick up the changed setting, for example by monitoring the configuration file for changes (watch for the "created()" signal, not for the changed signal, as KConfig doesn't directly write to the config file, but to a temorary file and then atomically moves them.) The plugin has minimal build dependencies, so that providing a settings plugin along with your app is very easy.

You can have a look into the [http://quickgit.kde.org/?p=plasma-mobile.git&a=tree&h=d61c20d2697a06205134b9a4361382270068c55e&hb=afaeda27367ca0701efea14c0c292c6079d34882&f=applications/settings/modules modules] directory of Active Settings to get some inspiration, or a functioning base for modules to play around with.

Development/Tutorials/Plasma/QML/ActiveSettings

2012-01-01T17:19:05Z

Sebas: /* Extending your Settings Module with with C++ */

Development/Tutorials/Plasma/QML/ActiveSettings

2012-01-01T17:15:58Z

Sebas: /* KConfig Bindings */

This tutorial teaches you how you can load Active settings modules into your app, and create your own modules.

= Introduction =
Active Settings is an app, much like Plasma Desktop's kcmshell that shows and loads configuration modules. These configuration modules are plugins providing a QML package and an optional C++-plugin which exports custom-written configuration objects as QObject to the declarative environment.

You can query available modules using the --list argument to active-settings:

<pre>
$ active-settings --list
org.kde.active.settings.web Settings for history, caching, etc.
org.kde.active.settings.configtest Test Module for the Config Bindings
org.kde.active.settings.time Settings for timezone and date display
</pre>

You can load an individual module by supplying its plugin name as argument to active-settings:
<pre>
active-settings org.kde.active.settings.time
</pre>
will open the active-settings app and load the "Time and Date" module on startup.

= Architecture =
The Active Settings app consists of a number of parts, an Active App, which loads a QML package providing the chrome for active-settings, a set of Declarative components which encapsulate loading settings modules and a set of settings modules, which provide the UI and backend code for a specific settings domain (i.e. Time and Date, Browser settings, etc.).

= Integrating a Settings Module into an App =
In order to integrate a settings module "inline" into your app, you can use the SettingsItem component, which comes with the ActiveSettings declarative plugin. SettingsItem provides a PageStack (from PlasmaComponents) with a bit of additional API, the module property. Creating an Item with a settings module is as easy as:

<pre>

import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: webSettingsItem
module: "org.kde.active.settings.time"
anchors { ... }
}
</pre>

In order to speed up loading your app, you will want to lazy-load the settings module. This is very easy by using the PageStack features that SettingsItem encapsulates:
<pre>
import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: settingsItem
initialPage: someOtherItem
anchors { [...] }
}

PlasmaComponents.Button {
// This button toggles the settings item and someOtherPage
[...]
onClicked: {
if (settingsItem.module != "org.kde.active.settings.web") {
settingsItem.module = "org.kde.active.settings.web"
} else {
// Switching back...
settingsItem.replace(someOtherItem);
}
}
}

Item {
id: someOtherItem
/* this guy is shown before any module is loaded */
}
</pre>

= Creating Your Own Settings Module =

== Simple, QML-only Module ==
Writing a basic ActiveSettings configuration module is as simple as creating a Plasma Package, using the X-KDE-ServiceTypes "Active/SettingsModule". The service type registers your package as settings module, so active-settings will find (and list) it, and so it can be loaded using the SettingsItem QML binding. A simple active settings package will look like this:
<pre>
├── CMakeLists.txt
├── contents
│ └── ui
│ └── Web.qml
└── metadata.desktop
</pre>
The metadata.desktop file holds the plugin information, which script to load from the plugin initially, and a bunch of metadata, just like normal Plasma Packages. A simple metadata.desktop file will look like this:
<pre>
[Desktop Entry]
Name=Web and Browser
Comment=Settings for history, caching, etc.
Encoding=UTF-8
Type=Service
Icon=preferences-system-network
X-KDE-ServiceTypes=Active/SettingsModule
X-KDE-PluginInfo-Author=Sebastian Kügler
X-KDE-PluginInfo-Email=sebas@kde.org
X-KDE-PluginInfo-Name=org.kde.active.settings.web
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma-active.org
X-KDE-PluginInfo-Category=Online Services
X-KDE-PluginInfo-License=GPL
X-Plasma-MainScript=ui/Web.qml
</pre>
The interesting bits, specific to active-settings are the plugin name, the package name and the mainscript. The plugin name is used to find the package, and will translates to the "module" property of SettingsItem.
Web.qml points to a normal Item { [...] } in a file, normal rules apply here.

The CMakeLists.txt file takes care of proper installation and will be needed in order to install and package your settings module. It looks like this:
<pre>
install(DIRECTORY web/ DESTINATION \
${DATA_INSTALL_DIR}/plasma/packages/org.kde.active.settings.web)
install(FILES web/metadata.desktop \
DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-package-org.kde.active.settings.web.desktop)
</pre>
Make sure the names of the .desktop files in CMakeLists.txt are correct, since incorrect names lead to problems finding and loading your package, or even to conflicts between different modules. In case of doubt check active-settings --list for already installed modules.
After you installed the plugin (or changed its metadata) you'll need to run "kbuildsycoca4" in order to update the plugin metainformation cache.

== KConfig Bindings ==
Active Settings provides declarative bindings for KConfigGroup. This means that you can instantiate KConfig objects in your QML code, read and write settings. For many basic use-cases, this provides enough flexibility to do everything that's needed. The browser settings module uses this mechanism:
<pre>
import org.kde.plasma.components 0.1 as PlasmaComponents
import org.kde.active.settings 0.1 as ActiveSettings

[...]
ActiveSettings.ConfigModel {
id: adblockConfig
file: "active-webbrowserrc"
group: "adblock"
}
[...]
PlasmaComponents.Switch {
[...]
onClicked: adblockConfig.writeEntry("adBlockEnabled", checked);
Component.onCompleted: checked = adblockConfig.readEntry("adBlockEnabled");
}
</pre>
This corresponds to the following snippet in you active-webbrowserrc config file (for example i ~/.kde4/share/config/):
<pre>
[adblock]
adBlockEnabled=true
</pre>
ConfigModel will sync() the config file 5 seconds after a writeEntry(...) call, or on destruction of the module (for example by loading another module or page into the SettingsItem.

If you find yourself needing more advanced features from C++ code, you can extend your settings module using a C++ plugin. Of course you can choose to use both, the already provided KConfig bindings, and an additional plugin.

== Extending your Settings Module with with C++ ==
In some cases, you will find a pure declarative settings module too limited. By extending a settings module with C++ functionality, you can implement functionality in a C++ plugin, which gets automatically loaded with your C++ plugin. This loading is done in the SettingsComponent item provided by the ActiveSettings import. You will usually want to use a SettingsItem in your code, like in the above example. SettingsItem encapsulates the module loading mechanism and provides a PageStack interface. When a new settings module is loaded in the UI (by setting SettingsItem "module" property, the .desktop file is checked for an X-KDE-Library entry (X-KDE-Library=active_settings_time in the Time and Date example).

This loads a small plugin, consisting of two classes:
* A QObject based class, which registers one or more additional Object to the declarative runtime:
<pre>
TimeSettingsPlugin::TimeSettingsPlugin(QObject *parent, const QVariantList &list)
: QObject(parent)
{
qmlRegisterType<TimeSettings>();
qmlRegisterType<TimeZone>();
qmlRegisterType<TimeSettings>("org.kde.active.settings", 0, 1, "TimeSettings");
}
</pre>
* One or more QObject-derived classes which export domain specific settings using QProperties, getters and setters.
<pre>
class TimeSettings : public QObject
{
Q_OBJECT

[...]
Q_PROPERTY(bool twentyFour READ twentyFour WRITE setTwentyFour NOTIFY twentyFourChanged)

public:
TimeSettings();
virtual ~TimeSettings();

[...]
bool twentyFour();

public Q_SLOTS:
[...]
void setTwentyFour(bool t);

Q_SIGNALS:
[...]
void twentyFourChanged();

private:
TimeSettingsPrivate* d;
};

</pre>
The types are basically reimplemented QObjects, which expose settings to the QML parts of your settings module. [http://doc.qt.nokia.com/4.8-snapshot/qml-extending.html Qt's documentation] has more information on how this works exactly.

In your declarative code, you can then import and instantiate these objects.
<pre>
import org.kde.active.settings 0.1

TimeSettings {
id: timeSettings
}

[...]

PlasmaComponents.Switch {
id: twentyFourSwitch
checked: timeSettings.twentyFour
onClicked : timeSettings.twentyFour = checked
}
</pre>
You will typically want to put code for reading the property in the ctor or getter, and code for writing options, or updating other parts of the UI, but of course more complex constructions are also entirely possible, since the settings plugins can basically provide any kind of QML extensions. When writing to configuration files, you should not forget to sync(); your KConfigObject, and to make sure that apps pick up the changed setting, for example by monitoring the configuration file for changes (watch for the "created()" signal, not for the changed signal, as KConfig doesn't directly write to the config file, but to a temorary file and then atomically moves them.) The plugin has minimal build dependencies, so that providing a settings plugin along with your app is very easy.

Development/Tutorials/Plasma/QML/ActiveSettings

2012-01-01T17:14:29Z

Sebas: /* KConfig Bindings */

This tutorial teaches you how you can load Active settings modules into your app, and create your own modules.

= Introduction =
Active Settings is an app, much like Plasma Desktop's kcmshell that shows and loads configuration modules. These configuration modules are plugins providing a QML package and an optional C++-plugin which exports custom-written configuration objects as QObject to the declarative environment.

You can query available modules using the --list argument to active-settings:

<pre>
$ active-settings --list
org.kde.active.settings.web Settings for history, caching, etc.
org.kde.active.settings.configtest Test Module for the Config Bindings
org.kde.active.settings.time Settings for timezone and date display
</pre>

You can load an individual module by supplying its plugin name as argument to active-settings:
<pre>
active-settings org.kde.active.settings.time
</pre>
will open the active-settings app and load the "Time and Date" module on startup.

= Architecture =
The Active Settings app consists of a number of parts, an Active App, which loads a QML package providing the chrome for active-settings, a set of Declarative components which encapsulate loading settings modules and a set of settings modules, which provide the UI and backend code for a specific settings domain (i.e. Time and Date, Browser settings, etc.).

= Integrating a Settings Module into an App =
In order to integrate a settings module "inline" into your app, you can use the SettingsItem component, which comes with the ActiveSettings declarative plugin. SettingsItem provides a PageStack (from PlasmaComponents) with a bit of additional API, the module property. Creating an Item with a settings module is as easy as:

<pre>

import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: webSettingsItem
module: "org.kde.active.settings.time"
anchors { ... }
}
</pre>

In order to speed up loading your app, you will want to lazy-load the settings module. This is very easy by using the PageStack features that SettingsItem encapsulates:
<pre>
import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: settingsItem
initialPage: someOtherItem
anchors { [...] }
}

PlasmaComponents.Button {
// This button toggles the settings item and someOtherPage
[...]
onClicked: {
if (settingsItem.module != "org.kde.active.settings.web") {
settingsItem.module = "org.kde.active.settings.web"
} else {
// Switching back...
settingsItem.replace(someOtherItem);
}
}
}

Item {
id: someOtherItem
/* this guy is shown before any module is loaded */
}
</pre>

= Creating Your Own Settings Module =

== Simple, QML-only Module ==
Writing a basic ActiveSettings configuration module is as simple as creating a Plasma Package, using the X-KDE-ServiceTypes "Active/SettingsModule". The service type registers your package as settings module, so active-settings will find (and list) it, and so it can be loaded using the SettingsItem QML binding. A simple active settings package will look like this:
<pre>
├── CMakeLists.txt
├── contents
│ └── ui
│ └── Web.qml
└── metadata.desktop
</pre>
The metadata.desktop file holds the plugin information, which script to load from the plugin initially, and a bunch of metadata, just like normal Plasma Packages. A simple metadata.desktop file will look like this:
<pre>
[Desktop Entry]
Name=Web and Browser
Comment=Settings for history, caching, etc.
Encoding=UTF-8
Type=Service
Icon=preferences-system-network
X-KDE-ServiceTypes=Active/SettingsModule
X-KDE-PluginInfo-Author=Sebastian Kügler
X-KDE-PluginInfo-Email=sebas@kde.org
X-KDE-PluginInfo-Name=org.kde.active.settings.web
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma-active.org
X-KDE-PluginInfo-Category=Online Services
X-KDE-PluginInfo-License=GPL
X-Plasma-MainScript=ui/Web.qml
</pre>
The interesting bits, specific to active-settings are the plugin name, the package name and the mainscript. The plugin name is used to find the package, and will translates to the "module" property of SettingsItem.
Web.qml points to a normal Item { [...] } in a file, normal rules apply here.

The CMakeLists.txt file takes care of proper installation and will be needed in order to install and package your settings module. It looks like this:
<pre>
install(DIRECTORY web/ DESTINATION \
${DATA_INSTALL_DIR}/plasma/packages/org.kde.active.settings.web)
install(FILES web/metadata.desktop \
DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-package-org.kde.active.settings.web.desktop)
</pre>
Make sure the names of the .desktop files in CMakeLists.txt are correct, since incorrect names lead to problems finding and loading your package, or even to conflicts between different modules. In case of doubt check active-settings --list for already installed modules.
After you installed the plugin (or changed its metadata) you'll need to run "kbuildsycoca4" in order to update the plugin metainformation cache.

== KConfig Bindings ==
Active Settings provides declarative bindings for KConfigGroup. This means that you can instantiate KConfig objects in your QML code, read and write settings. For many basic use-cases, this provides enough flexibility to do everything that's needed. The browser settings module uses this mechanism:
<pre>
import org.kde.plasma.components 0.1 as PlasmaComponents
import org.kde.active.settings 0.1 as ActiveSettings

[...]
ActiveSettings.ConfigModel {
id: adblockConfig
file: "active-webbrowserrc"
group: "adblock"
}
[...]
PlasmaComponents.Switch {
[...]
onClicked: adblockConfig.writeEntry("adBlockEnabled", checked);
Component.onCompleted: checked = adblockConfig.readEntry("adBlockEnabled");
}
</pre>
This corresponds to the following snippet in you active-webbrowserrc config file (for example i ~/.kde4/share/config/):
<pre>
[adblock]
adBlockEnabled=true
</pre>
If you find yourself needing more advanced features from C++ code, you can extend your settings module using a C++ plugin. Of course you can choose to use both, the already provided KConfig bindings, and an additional plugin.

== Extending your Settings Module with with C++ ==
In some cases, you will find a pure declarative settings module too limited. By extending a settings module with C++ functionality, you can implement functionality in a C++ plugin, which gets automatically loaded with your C++ plugin. This loading is done in the SettingsComponent item provided by the ActiveSettings import. You will usually want to use a SettingsItem in your code, like in the above example. SettingsItem encapsulates the module loading mechanism and provides a PageStack interface. When a new settings module is loaded in the UI (by setting SettingsItem "module" property, the .desktop file is checked for an X-KDE-Library entry (X-KDE-Library=active_settings_time in the Time and Date example).

This loads a small plugin, consisting of two classes:
* A QObject based class, which registers one or more additional Object to the declarative runtime:
<pre>
TimeSettingsPlugin::TimeSettingsPlugin(QObject *parent, const QVariantList &list)
: QObject(parent)
{
qmlRegisterType<TimeSettings>();
qmlRegisterType<TimeZone>();
qmlRegisterType<TimeSettings>("org.kde.active.settings", 0, 1, "TimeSettings");
}
</pre>
* One or more QObject-derived classes which export domain specific settings using QProperties, getters and setters.
<pre>
class TimeSettings : public QObject
{
Q_OBJECT

[...]
Q_PROPERTY(bool twentyFour READ twentyFour WRITE setTwentyFour NOTIFY twentyFourChanged)

public:
TimeSettings();
virtual ~TimeSettings();

[...]
bool twentyFour();

public Q_SLOTS:
[...]
void setTwentyFour(bool t);

Q_SIGNALS:
[...]
void twentyFourChanged();

private:
TimeSettingsPrivate* d;
};

</pre>
The types are basically reimplemented QObjects, which expose settings to the QML parts of your settings module. [http://doc.qt.nokia.com/4.8-snapshot/qml-extending.html Qt's documentation] has more information on how this works exactly.

In your declarative code, you can then import and instantiate these objects.
<pre>
import org.kde.active.settings 0.1

TimeSettings {
id: timeSettings
}

[...]

PlasmaComponents.Switch {
id: twentyFourSwitch
checked: timeSettings.twentyFour
onClicked : timeSettings.twentyFour = checked
}
</pre>
You will typically want to put code for reading the property in the ctor or getter, and code for writing options, or updating other parts of the UI, but of course more complex constructions are also entirely possible, since the settings plugins can basically provide any kind of QML extensions. When writing to configuration files, you should not forget to sync(); your KConfigObject, and to make sure that apps pick up the changed setting, for example by monitoring the configuration file for changes (watch for the "created()" signal, not for the changed signal, as KConfig doesn't directly write to the config file, but to a temorary file and then atomically moves them.) The plugin has minimal build dependencies, so that providing a settings plugin along with your app is very easy.

Development/Tutorials/Plasma/QML/ActiveSettings

2012-01-01T17:12:41Z

Sebas: /* KConfig Bindings */

This tutorial teaches you how you can load Active settings modules into your app, and create your own modules.

= Introduction =
Active Settings is an app, much like Plasma Desktop's kcmshell that shows and loads configuration modules. These configuration modules are plugins providing a QML package and an optional C++-plugin which exports custom-written configuration objects as QObject to the declarative environment.

You can query available modules using the --list argument to active-settings:

<pre>
$ active-settings --list
org.kde.active.settings.web Settings for history, caching, etc.
org.kde.active.settings.configtest Test Module for the Config Bindings
org.kde.active.settings.time Settings for timezone and date display
</pre>

You can load an individual module by supplying its plugin name as argument to active-settings:
<pre>
active-settings org.kde.active.settings.time
</pre>
will open the active-settings app and load the "Time and Date" module on startup.

= Architecture =
The Active Settings app consists of a number of parts, an Active App, which loads a QML package providing the chrome for active-settings, a set of Declarative components which encapsulate loading settings modules and a set of settings modules, which provide the UI and backend code for a specific settings domain (i.e. Time and Date, Browser settings, etc.).

= Integrating a Settings Module into an App =
In order to integrate a settings module "inline" into your app, you can use the SettingsItem component, which comes with the ActiveSettings declarative plugin. SettingsItem provides a PageStack (from PlasmaComponents) with a bit of additional API, the module property. Creating an Item with a settings module is as easy as:

<pre>

import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: webSettingsItem
module: "org.kde.active.settings.time"
anchors { ... }
}
</pre>

In order to speed up loading your app, you will want to lazy-load the settings module. This is very easy by using the PageStack features that SettingsItem encapsulates:
<pre>
import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: settingsItem
initialPage: someOtherItem
anchors { [...] }
}

PlasmaComponents.Button {
// This button toggles the settings item and someOtherPage
[...]
onClicked: {
if (settingsItem.module != "org.kde.active.settings.web") {
settingsItem.module = "org.kde.active.settings.web"
} else {
// Switching back...
settingsItem.replace(someOtherItem);
}
}
}

Item {
id: someOtherItem
/* this guy is shown before any module is loaded */
}
</pre>

= Creating Your Own Settings Module =

== Simple, QML-only Module ==
Writing a basic ActiveSettings configuration module is as simple as creating a Plasma Package, using the X-KDE-ServiceTypes "Active/SettingsModule". The service type registers your package as settings module, so active-settings will find (and list) it, and so it can be loaded using the SettingsItem QML binding. A simple active settings package will look like this:
<pre>
├── CMakeLists.txt
├── contents
│ └── ui
│ └── Web.qml
└── metadata.desktop
</pre>
The metadata.desktop file holds the plugin information, which script to load from the plugin initially, and a bunch of metadata, just like normal Plasma Packages. A simple metadata.desktop file will look like this:
<pre>
[Desktop Entry]
Name=Web and Browser
Comment=Settings for history, caching, etc.
Encoding=UTF-8
Type=Service
Icon=preferences-system-network
X-KDE-ServiceTypes=Active/SettingsModule
X-KDE-PluginInfo-Author=Sebastian Kügler
X-KDE-PluginInfo-Email=sebas@kde.org
X-KDE-PluginInfo-Name=org.kde.active.settings.web
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma-active.org
X-KDE-PluginInfo-Category=Online Services
X-KDE-PluginInfo-License=GPL
X-Plasma-MainScript=ui/Web.qml
</pre>
The interesting bits, specific to active-settings are the plugin name, the package name and the mainscript. The plugin name is used to find the package, and will translates to the "module" property of SettingsItem.
Web.qml points to a normal Item { [...] } in a file, normal rules apply here.

The CMakeLists.txt file takes care of proper installation and will be needed in order to install and package your settings module. It looks like this:
<pre>
install(DIRECTORY web/ DESTINATION \
${DATA_INSTALL_DIR}/plasma/packages/org.kde.active.settings.web)
install(FILES web/metadata.desktop \
DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-package-org.kde.active.settings.web.desktop)
</pre>
Make sure the names of the .desktop files in CMakeLists.txt are correct, since incorrect names lead to problems finding and loading your package, or even to conflicts between different modules. In case of doubt check active-settings --list for already installed modules.
After you installed the plugin (or changed its metadata) you'll need to run "kbuildsycoca4" in order to update the plugin metainformation cache.

== KConfig Bindings ==
Active Settings provides declarative bindings for KConfigGroup. This means that you can instantiate KConfig objects in your QML code, read and write settings. For many basic use-cases, this provides enough flexibility to do everything that's needed. The browser settings module uses this mechanism:
<pre>
import org.kde.plasma.components 0.1 as PlasmaComponents
import org.kde.active.settings 0.1 as ActiveSettings

[...]
ActiveSettings.ConfigModel {
id: adblockConfig
file: "active-webbrowserrc"
group: "adblock"
}
[...]
PlasmaComponents.Switch {
[...]
onClicked: adblockConfig.writeEntry("adBlockEnabled", checked);
Component.onCompleted: checked = adblockConfig.readEntry("adBlockEnabled");
}
</pre>

If you find yourself needing more advanced features from C++ code, you can extend your settings module using a C++ plugin. Of course you can choose to use both, the already provided KConfig bindings, and an additional plugin.

== Extending your Settings Module with with C++ ==
In some cases, you will find a pure declarative settings module too limited. By extending a settings module with C++ functionality, you can implement functionality in a C++ plugin, which gets automatically loaded with your C++ plugin. This loading is done in the SettingsComponent item provided by the ActiveSettings import. You will usually want to use a SettingsItem in your code, like in the above example. SettingsItem encapsulates the module loading mechanism and provides a PageStack interface. When a new settings module is loaded in the UI (by setting SettingsItem "module" property, the .desktop file is checked for an X-KDE-Library entry (X-KDE-Library=active_settings_time in the Time and Date example).

This loads a small plugin, consisting of two classes:
* A QObject based class, which registers one or more additional Object to the declarative runtime:
<pre>
TimeSettingsPlugin::TimeSettingsPlugin(QObject *parent, const QVariantList &list)
: QObject(parent)
{
qmlRegisterType<TimeSettings>();
qmlRegisterType<TimeZone>();
qmlRegisterType<TimeSettings>("org.kde.active.settings", 0, 1, "TimeSettings");
}
</pre>
* One or more QObject-derived classes which export domain specific settings using QProperties, getters and setters.
<pre>
class TimeSettings : public QObject
{
Q_OBJECT

[...]
Q_PROPERTY(bool twentyFour READ twentyFour WRITE setTwentyFour NOTIFY twentyFourChanged)

public:
TimeSettings();
virtual ~TimeSettings();

[...]
bool twentyFour();

public Q_SLOTS:
[...]
void setTwentyFour(bool t);

Q_SIGNALS:
[...]
void twentyFourChanged();

private:
TimeSettingsPrivate* d;
};

</pre>
The types are basically reimplemented QObjects, which expose settings to the QML parts of your settings module. [http://doc.qt.nokia.com/4.8-snapshot/qml-extending.html Qt's documentation] has more information on how this works exactly.

In your declarative code, you can then import and instantiate these objects.
<pre>
import org.kde.active.settings 0.1

TimeSettings {
id: timeSettings
}

[...]

PlasmaComponents.Switch {
id: twentyFourSwitch
checked: timeSettings.twentyFour
onClicked : timeSettings.twentyFour = checked
}
</pre>
You will typically want to put code for reading the property in the ctor or getter, and code for writing options, or updating other parts of the UI, but of course more complex constructions are also entirely possible, since the settings plugins can basically provide any kind of QML extensions. When writing to configuration files, you should not forget to sync(); your KConfigObject, and to make sure that apps pick up the changed setting, for example by monitoring the configuration file for changes (watch for the "created()" signal, not for the changed signal, as KConfig doesn't directly write to the config file, but to a temorary file and then atomically moves them.) The plugin has minimal build dependencies, so that providing a settings plugin along with your app is very easy.

Development/Tutorials/Plasma/QML/ActiveSettings

2012-01-01T17:04:57Z

Sebas: /* Extending your Settings Module with with C++ */

This tutorial teaches you how you can load Active settings modules into your app, and create your own modules.

= Introduction =
Active Settings is an app, much like Plasma Desktop's kcmshell that shows and loads configuration modules. These configuration modules are plugins providing a QML package and an optional C++-plugin which exports custom-written configuration objects as QObject to the declarative environment.

You can query available modules using the --list argument to active-settings:

<pre>
$ active-settings --list
org.kde.active.settings.web Settings for history, caching, etc.
org.kde.active.settings.configtest Test Module for the Config Bindings
org.kde.active.settings.time Settings for timezone and date display
</pre>

You can load an individual module by supplying its plugin name as argument to active-settings:
<pre>
active-settings org.kde.active.settings.time
</pre>
will open the active-settings app and load the "Time and Date" module on startup.

= Architecture =
The Active Settings app consists of a number of parts, an Active App, which loads a QML package providing the chrome for active-settings, a set of Declarative components which encapsulate loading settings modules and a set of settings modules, which provide the UI and backend code for a specific settings domain (i.e. Time and Date, Browser settings, etc.).

= Integrating a Settings Module into an App =
In order to integrate a settings module "inline" into your app, you can use the SettingsItem component, which comes with the ActiveSettings declarative plugin. SettingsItem provides a PageStack (from PlasmaComponents) with a bit of additional API, the module property. Creating an Item with a settings module is as easy as:

<pre>

import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: webSettingsItem
module: "org.kde.active.settings.time"
anchors { ... }
}
</pre>

In order to speed up loading your app, you will want to lazy-load the settings module. This is very easy by using the PageStack features that SettingsItem encapsulates:
<pre>
import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: settingsItem
initialPage: someOtherItem
anchors { [...] }
}

PlasmaComponents.Button {
// This button toggles the settings item and someOtherPage
[...]
onClicked: {
if (settingsItem.module != "org.kde.active.settings.web") {
settingsItem.module = "org.kde.active.settings.web"
} else {
// Switching back...
settingsItem.replace(someOtherItem);
}
}
}

Item {
id: someOtherItem
/* this guy is shown before any module is loaded */
}
</pre>

= Creating Your Own Settings Module =

== Simple, QML-only Module ==
Writing a basic ActiveSettings configuration module is as simple as creating a Plasma Package, using the X-KDE-ServiceTypes "Active/SettingsModule". The service type registers your package as settings module, so active-settings will find (and list) it, and so it can be loaded using the SettingsItem QML binding. A simple active settings package will look like this:
<pre>
├── CMakeLists.txt
├── contents
│ └── ui
│ └── Web.qml
└── metadata.desktop
</pre>
The metadata.desktop file holds the plugin information, which script to load from the plugin initially, and a bunch of metadata, just like normal Plasma Packages. A simple metadata.desktop file will look like this:
<pre>
[Desktop Entry]
Name=Web and Browser
Comment=Settings for history, caching, etc.
Encoding=UTF-8
Type=Service
Icon=preferences-system-network
X-KDE-ServiceTypes=Active/SettingsModule
X-KDE-PluginInfo-Author=Sebastian Kügler
X-KDE-PluginInfo-Email=sebas@kde.org
X-KDE-PluginInfo-Name=org.kde.active.settings.web
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma-active.org
X-KDE-PluginInfo-Category=Online Services
X-KDE-PluginInfo-License=GPL
X-Plasma-MainScript=ui/Web.qml
</pre>
The interesting bits, specific to active-settings are the plugin name, the package name and the mainscript. The plugin name is used to find the package, and will translates to the "module" property of SettingsItem.
Web.qml points to a normal Item { [...] } in a file, normal rules apply here.

The CMakeLists.txt file takes care of proper installation and will be needed in order to install and package your settings module. It looks like this:
<pre>
install(DIRECTORY web/ DESTINATION \
${DATA_INSTALL_DIR}/plasma/packages/org.kde.active.settings.web)
install(FILES web/metadata.desktop \
DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-package-org.kde.active.settings.web.desktop)
</pre>
Make sure the names of the .desktop files in CMakeLists.txt are correct, since incorrect names lead to problems finding and loading your package, or even to conflicts between different modules. In case of doubt check active-settings --list for already installed modules.
After you installed the plugin (or changed its metadata) you'll need to run "kbuildsycoca4" in order to update the plugin metainformation cache.

== KConfig Bindings ==

== Extending your Settings Module with with C++ ==
In some cases, you will find a pure declarative settings module too limited. By extending a settings module with C++ functionality, you can implement functionality in a C++ plugin, which gets automatically loaded with your C++ plugin. This loading is done in the SettingsComponent item provided by the ActiveSettings import. You will usually want to use a SettingsItem in your code, like in the above example. SettingsItem encapsulates the module loading mechanism and provides a PageStack interface. When a new settings module is loaded in the UI (by setting SettingsItem "module" property, the .desktop file is checked for an X-KDE-Library entry (X-KDE-Library=active_settings_time in the Time and Date example).

This loads a small plugin, consisting of two classes:
* A QObject based class, which registers one or more additional Object to the declarative runtime:
<pre>
TimeSettingsPlugin::TimeSettingsPlugin(QObject *parent, const QVariantList &list)
: QObject(parent)
{
qmlRegisterType<TimeSettings>();
qmlRegisterType<TimeZone>();
qmlRegisterType<TimeSettings>("org.kde.active.settings", 0, 1, "TimeSettings");
}
</pre>
* One or more QObject-derived classes which export domain specific settings using QProperties, getters and setters.
<pre>
class TimeSettings : public QObject
{
Q_OBJECT

[...]
Q_PROPERTY(bool twentyFour READ twentyFour WRITE setTwentyFour NOTIFY twentyFourChanged)

public:
TimeSettings();
virtual ~TimeSettings();

[...]
bool twentyFour();

public Q_SLOTS:
[...]
void setTwentyFour(bool t);

Q_SIGNALS:
[...]
void twentyFourChanged();

private:
TimeSettingsPrivate* d;
};

</pre>
The types are basically reimplemented QObjects, which expose settings to the QML parts of your settings module. [http://doc.qt.nokia.com/4.8-snapshot/qml-extending.html Qt's documentation] has more information on how this works exactly.

In your declarative code, you can then import and instantiate these objects.
<pre>
import org.kde.active.settings 0.1

TimeSettings {
id: timeSettings
}

[...]

PlasmaComponents.Switch {
id: twentyFourSwitch
checked: timeSettings.twentyFour
onClicked : timeSettings.twentyFour = checked
}
</pre>
You will typically want to put code for reading the property in the ctor or getter, and code for writing options, or updating other parts of the UI, but of course more complex constructions are also entirely possible, since the settings plugins can basically provide any kind of QML extensions. When writing to configuration files, you should not forget to sync(); your KConfigObject, and to make sure that apps pick up the changed setting, for example by monitoring the configuration file for changes (watch for the "created()" signal, not for the changed signal, as KConfig doesn't directly write to the config file, but to a temorary file and then atomically moves them.) The plugin has minimal build dependencies, so that providing a settings plugin along with your app is very easy.

Development/Tutorials/Plasma/QML/ActiveSettings

2012-01-01T16:55:09Z

Sebas: /* Extending your Settings Module with with C++ */

This tutorial teaches you how you can load Active settings modules into your app, and create your own modules.

= Introduction =
Active Settings is an app, much like Plasma Desktop's kcmshell that shows and loads configuration modules. These configuration modules are plugins providing a QML package and an optional C++-plugin which exports custom-written configuration objects as QObject to the declarative environment.

You can query available modules using the --list argument to active-settings:

<pre>
$ active-settings --list
org.kde.active.settings.web Settings for history, caching, etc.
org.kde.active.settings.configtest Test Module for the Config Bindings
org.kde.active.settings.time Settings for timezone and date display
</pre>

You can load an individual module by supplying its plugin name as argument to active-settings:
<pre>
active-settings org.kde.active.settings.time
</pre>
will open the active-settings app and load the "Time and Date" module on startup.

= Architecture =
The Active Settings app consists of a number of parts, an Active App, which loads a QML package providing the chrome for active-settings, a set of Declarative components which encapsulate loading settings modules and a set of settings modules, which provide the UI and backend code for a specific settings domain (i.e. Time and Date, Browser settings, etc.).

= Integrating a Settings Module into an App =
In order to integrate a settings module "inline" into your app, you can use the SettingsItem component, which comes with the ActiveSettings declarative plugin. SettingsItem provides a PageStack (from PlasmaComponents) with a bit of additional API, the module property. Creating an Item with a settings module is as easy as:

<pre>

import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: webSettingsItem
module: "org.kde.active.settings.time"
anchors { ... }
}
</pre>

In order to speed up loading your app, you will want to lazy-load the settings module. This is very easy by using the PageStack features that SettingsItem encapsulates:
<pre>
import org.kde.active.settings 0.1 as ActiveSettings
[...]
ActiveSettings.SettingsItem {
id: settingsItem
initialPage: someOtherItem
anchors { [...] }
}

PlasmaComponents.Button {
// This button toggles the settings item and someOtherPage
[...]
onClicked: {
if (settingsItem.module != "org.kde.active.settings.web") {
settingsItem.module = "org.kde.active.settings.web"
} else {
// Switching back...
settingsItem.replace(someOtherItem);
}
}
}

Item {
id: someOtherItem
/* this guy is shown before any module is loaded */
}
</pre>

= Creating Your Own Settings Module =

== Simple, QML-only Module ==
Writing a basic ActiveSettings configuration module is as simple as creating a Plasma Package, using the X-KDE-ServiceTypes "Active/SettingsModule". The service type registers your package as settings module, so active-settings will find (and list) it, and so it can be loaded using the SettingsItem QML binding. A simple active settings package will look like this:
<pre>
├── CMakeLists.txt
├── contents
│ └── ui
│ └── Web.qml
└── metadata.desktop
</pre>
The metadata.desktop file holds the plugin information, which script to load from the plugin initially, and a bunch of metadata, just like normal Plasma Packages. A simple metadata.desktop file will look like this:
<pre>
[Desktop Entry]
Name=Web and Browser
Comment=Settings for history, caching, etc.
Encoding=UTF-8
Type=Service
Icon=preferences-system-network
X-KDE-ServiceTypes=Active/SettingsModule
X-KDE-PluginInfo-Author=Sebastian Kügler
X-KDE-PluginInfo-Email=sebas@kde.org
X-KDE-PluginInfo-Name=org.kde.active.settings.web
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma-active.org
X-KDE-PluginInfo-Category=Online Services
X-KDE-PluginInfo-License=GPL
X-Plasma-MainScript=ui/Web.qml
</pre>
The interesting bits, specific to active-settings are the plugin name, the package name and the mainscript. The plugin name is used to find the package, and will translates to the "module" property of SettingsItem.
Web.qml points to a normal Item { [...] } in a file, normal rules apply here.

The CMakeLists.txt file takes care of proper installation and will be needed in order to install and package your settings module. It looks like this:
<pre>
install(DIRECTORY web/ DESTINATION \
${DATA_INSTALL_DIR}/plasma/packages/org.kde.active.settings.web)
install(FILES web/metadata.desktop \
DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-package-org.kde.active.settings.web.desktop)
</pre>
Make sure the names of the .desktop files in CMakeLists.txt are correct, since incorrect names lead to problems finding and loading your package, or even to conflicts between different modules. In case of doubt check active-settings --list for already installed modules.
After you installed the plugin (or changed its metadata) you'll need to run "kbuildsycoca4" in order to update the plugin metainformation cache.

== KConfig Bindings ==

== Extending your Settings Module with with C++ ==
In some cases, you will find a pure declarative settings module too limited. By extending a settings module with C++ functionality, you can implement functionality in a C++ plugin, which gets automatically loaded with your C++ plugin. This loading is done in the SettingsComponent item provided by the ActiveSettings import. You will usually want to use a SettingsItem in your code, like in the above example. SettingsItem encapsulates the module loading mechanism and provides a PageStack interface. When a new settings module is loaded in the UI (by setting SettingsItem "module" property, the .desktop file is checked for an X-KDE-Library entry (X-KDE-Library=active_settings_time in the Time and Date example).

This loads a small plugin, consisting of two classes:
* A QObject based class, which registers one or more additional Object to the declarative runtime:
<pre>
TimeSettingsPlugin::TimeSettingsPlugin(QObject *parent, const QVariantList &list)
: QObject(parent)
{
qmlRegisterType<TimeSettings>();
qmlRegisterType<TimeZone>();
qmlRegisterType<TimeSettings>("org.kde.active.settings", 0, 1, "TimeSettings");
}
</pre>
The types are basically reimplemented QObjects, which expose settings to the QML parts of your settings module.

<pre>
import org.kde.active.settings 0.1

TimeSettings {
id: timeSettings
}

[...]

PlasmaComponents.Switch {
id: twentyFourSwitch
checked: timeSettings.twentyFour
onClicked : timeSettings.twentyFour = checked
}
</pre>
You will typically want to put code for reading the property in the ctor or getter, and code for writing options, or updating other parts of the UI, but of course more complex constructions are also entirely possible, since the settings plugins can basically provide any kind of QML extensions. The plugin has minimal build dependencies, so that providing a settings plugin along with your app is very easy.

Development/Tutorials/Plasma/QML/ActiveSettings

2011-12-30T17:22:30Z

Sebas: moah installation

Development/Tutorials/Plasma/QML/ActiveSettings

2011-12-30T17:19:57Z

Sebas: installation

Development/Tutorials/Plasma/QML/ActiveSettings

2011-12-30T17:04:40Z

Sebas: /* Integrating a Settings Module into an App */

Development/Tutorials/Plasma/QML/ActiveSettings

2011-12-30T16:58:18Z

Sebas: example for inlining a settings module

Development/Tutorials/Plasma/QML/ActiveSettings

2011-12-30T16:53:40Z

Sebas: a bit of structure to fill

Development/Tutorials/Plasma/QML/ActiveSettings

2011-12-30T16:49:07Z

Sebas: /* Architecture */

This tutorial teaches you how you can load Active settings modules into your app, and create your own modules.

= Architecture =
Active Settings is an app, much like Plasma Desktop's kcmshell that shows and loads configuration modules. These configuration modules are plugins providing a QML package and an optional C++-plugin which exports custom-written configuration objects as QObject to the declarative environment.

You can query available modules using the --list argument to active-settings:

<pre>
$ active-settings --list
org.kde.active.settings.web Settings for history, caching, etc.
org.kde.active.settings.configtest Test Module for the Config Bindings
org.kde.active.settings.time Settings for timezone and date display
</pre>

You can load an individual module by supplying its plugin name as argument to active-settings:
<pre>
active-settings org.kde.active.settings.time
</pre>
will open the active-settings app and load the "Time and Date" module on startup.

Development/Tutorials/Plasma/QML/ActiveSettings

2011-12-30T16:47:54Z

Sebas:

This tutorial teaches you how you can load Active settings modules into your app, and create your own modules.

= Architecture =
Active Settings is an app, much like Plasma Desktop's kcmshell that shows and loads configuration modules. These configuration modules are plugins providing a QML package and an optional C++-plugin which exports custom-written configuration objects as QObject to the declarative environment.

You can query available modules using the --list argument to active-settings:

<pre>
$ active-settings --list org.kde.active.settings.web Settings for history, caching, etc.
org.kde.active.settings.configtest Test Module for the Config Bindings
org.kde.active.settings.time Settings for timezone and date display
</pre>

You can load an individual module by supplying its plugin name as argument to active-settings:
<nowiki>
active-settings org.kde.active.settings.time
</nowiki>
will open the active-settings app and load the "Time and Date" module on startup.

Development/Tutorials/Plasma/QML/ActiveSettings

2011-12-30T16:36:32Z

Sebas: start active-settings docu

This tutorial teaches you how you can load Active settings modules into your app, and create your own modules.

= Architecture =
Active Settings is an app, much like Plasma Desktop's kcmshell that shows and loads configuration modules. These configuration modules are plugins providing a QML package and an optional C++-plugin which exports custom-written configuration objects as QObject to the declarative environment.

You can query available modules using the --list argument to active-settings:

<nowiki>
$ active-settings --list org.kde.active.settings.web Settings for history, caching, etc.
org.kde.active.settings.configtest Test Module for the Config Bindings
org.kde.active.settings.time Settings for timezone and date display
</nowiki>

You can load an individual module by supplying its plugin name as argument to active-settings:
<nowiki>
active-settings org.kde.active.settings.time
</nowiki>
will open the active-settings app and load the "Time and Date" module on startup.

Schedules/KDE4/4.8 Feature Plan

2011-10-25T09:42:37Z

Sebas: webthumbnails

This is a list of planned features for the SC 4.8 release.

See also:

*[[Schedules/KDE4/4.8 Release Schedule]]
*[[Schedules/KDE4/4.8 Release Goals]]
*[[Schedules/KDE4/4.7 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|KCM|make mouse cursor size configurable (http://git.reviewboard.kde.org/r/101701/)|SommerLuk@gmail.com|Lukas Sommer}}
{{FeatureDone|powerdevil|Remove Desktop Effects Management|drf@kde.org|Dario Freddi}}
{{FeatureInProgress|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureInProgress|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
{{FeatureTodo|Plasma|Add MPRIS2 support to nowplaying|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|Plasma|Allow task grouping on the taskbar to work together with kwin window tabbing|akreuzkamp@web.de|Anton Kreuzkamp}}
|}
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|ksecretsserviced|KSecretsService daemon implementing the freedesktop.org secrets API. KDE applications will want to use the related kdelibs API (see below)|kde@rusu.info|Valentin Rusu}}

{{FeatureInProgress|DrKonqi|Better duplicate detection|mat69@gmx.net|Matthias Fuchs}}
{{FeatureInProgress|KIO Thumbnails|webthumbnails plugin|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|DrKonqi|Scripting support|mat69@gmx.net|Matthias Fuchs}}
|}
 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Kate Part|Line modification system|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|Kate Part|Modeline Editor|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|Kate Part|Reliable code folding|adrian.lungu89@gmail.com|Adrian Lungu}}
{{FeatureDone|Kate Part|Improved vi input mode|svatoslav1@gmail.com|Svyatoslav Kuzmich}}
{{FeatureInProgress|KIO|PreviewJob supports URLs|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|kdeui|KSecretsService API addition|kde@rusu.info|Valentin Rusu}}
{{FeatureInProgress|kdeui/util|Connect KWallet class to KSecretsService client API|kde@rusu.info|Valentin Rusu}}
|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Dolphin|Implement new view-engine for Dolphin 2.0 (see http://ppenz.blogspot.com/2011/08/introducing-dolphin-20.html)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Dolphin|Implement support for back/forward mouse buttons|sebasti@n-doerner.de|Sebastian Dörner}}
{{FeatureDone|Kate|Search & Replace in files plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Make GDB target selection behave like the build plugin |kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Add convenience options for remote debugging|kare.sars@iki.fi|Kåre Särs}}
|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KTouch|New organisation of keyboard and lecture files according to languages|peter.ruethemann@gmail.com|Rüthemann Peter}}
{{FeatureInProgress|KTouch|New organisation of menu system: Training, Statistic, Settings|peter.ruethemann@gmail.com|Rüthemann Peter}}
{{FeatureTodo|KTouch|End of lecture statistics|peter.ruethemann@gmail.com|Rüthemann Peter}}
{{FeatureDone|Rocs|Alignment Actions to minimize crossing graph edges|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Stepped Execution of Algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureDone|Marble|Marble Runner plugins for Parsing files|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|(GSoC) OSM file rendering|oblaukhov.konstantin@gmail.com|Konstantin Oblaukhov}}
{{FeatureDone|Marble|Marble Graphics Scene (Performance of Vector Drawing)|oblaukhov.konstantin@gmail.com|Konstantin Oblaukhov}}
{{FeatureDone|Marble|Gps Info Plugin|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Improve LatLonEdit to allow input as Radian and DM|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureInProgress|Marble|Routing API|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Adjustable Map Orientation (Rotation in Screen Plane)|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureInProgress|Marble|Speedometer Plugin|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureInProgress|Marble|Plasma Runner for geo coords and Marble bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureInProgress|Marble|Make bookmark editor support editing the lonlat coordinates|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Fix GeoDataCoordinates parsing from a QString|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|KTurtle|Add modulo command|nielsslot@gmaildotcom|Niels Slot}}
|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo
|attachment:/ kio-slave
|Implement kio-slave to access (email) attachments in Akonadi
|kossebau@kde.org|Friedrich W. H. Kossebau}}

{{FeatureInProgress|KAlarm|Port to Akonadi|djarvie@kde.org|David Jarvie}}

{{FeatureTodo
|sieve: implement wizard
|Implement wizard to help user to create sieve script
|montel@kde.org|Montel Laurent}}

{{FeatureInProgress
|HTML Replies
|Give messagecomposer (especially for KMail) the ability to compose replies in HTML
|nyblom@kde.org|Torgny Nyblom}}
|}

 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add Flags Datatype to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|dolphin-plugins|Mercurial plugin for Dolphin|vishesh3y@gmail.com|Vishesh Yadav}}
|}

 

= kdegames=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|Libkdegames|Improve graphics performance in all games by standardizing on the use of Qt Raster Graphics.|stefan.majewsky@googlemail.com|Stefan Majewsky}}{{FeatureInProgress|KSudoku|Add a new generator and solver to KSudoku, based on published algorithms. This will provide a full range of puzzle difficulties, rather than mainly easy puzzles, and will address bug 217925 and its duplicates 228614 and 237262 (now nearly two years old).|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KSudoku|Re-implement the puzzle-symmetry feature.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KSudoku|Re-order the puzzle types on the welcome screen. Use KDE Games Difficulty combo-box instead of a slider. Save user's choices of puzzle between sessions. Do minor tidy-ups of the user interface.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KGoldrunner|Add the championship level "Gold Rush" game, with Traditional rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KGoldrunner|Add the championship level "Jail Break" game, with KGoldrunner rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}|}
 

= kdegraphics=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|Okular|Reset Form Action support|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|agateau@kde.org|Aurélien Gâteau}}
|}
 

= kdeutils=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|ksecrets|A suite of tools related to the KSecretsService infrastructure|kde@rusu.info|Valentin Rusu}}
|}
 

= kdenetwork=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|KGet|Better interaction for torrents if they are seeding and other downloads stopped because of that|mat69@gmx.net|Matthias Fuchs}}
{{FeatureInProgress|KGet|Class that handles deleting files|mat69@gmx.net|Matthias Fuchs}}
|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Kimpanel|Port kimpanel to DataEngine based one|wengxt@gmail.com|Xuetian Weng}}
|}

Schedules/KDE4/4.8 Feature Plan

2011-10-25T09:41:43Z

Sebas: previewjob urls

This is a list of planned features for the SC 4.8 release.

See also:

*[[Schedules/KDE4/4.8 Release Schedule]]
*[[Schedules/KDE4/4.8 Release Goals]]
*[[Schedules/KDE4/4.7 Feature Plan]] (previous major release)

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kde-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|KCM|make mouse cursor size configurable (http://git.reviewboard.kde.org/r/101701/)|SommerLuk@gmail.com|Lukas Sommer}}
{{FeatureDone|powerdevil|Remove Desktop Effects Management|drf@kde.org|Dario Freddi}}
{{FeatureInProgress|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureInProgress|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
{{FeatureTodo|Plasma|Add MPRIS2 support to nowplaying|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|Plasma|Allow task grouping on the taskbar to work together with kwin window tabbing|akreuzkamp@web.de|Anton Kreuzkamp}}
|}
 

= kde-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|ksecretsserviced|KSecretsService daemon implementing the freedesktop.org secrets API. KDE applications will want to use the related kdelibs API (see below)|kde@rusu.info|Valentin Rusu}}

{{FeatureInProgress|DrKonqi|Better duplicate detection|mat69@gmx.net|Matthias Fuchs}}
{{FeatureInProgress|DrKonqi|Scripting support|mat69@gmx.net|Matthias Fuchs}}
|}
 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureDone|Kate Part|Line modification system|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|Kate Part|Modeline Editor|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|Kate Part|Reliable code folding|adrian.lungu89@gmail.com|Adrian Lungu}}
{{FeatureDone|Kate Part|Improved vi input mode|svatoslav1@gmail.com|Svyatoslav Kuzmich}}
{{FeatureInProgress|KIO|PreviewJob supports URLs|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|kdeui|KSecretsService API addition|kde@rusu.info|Valentin Rusu}}
{{FeatureInProgress|kdeui/util|Connect KWallet class to KSecretsService client API|kde@rusu.info|Valentin Rusu}}
|}
 

= kde-baseapps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Dolphin|Implement new view-engine for Dolphin 2.0 (see http://ppenz.blogspot.com/2011/08/introducing-dolphin-20.html)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Dolphin|Implement support for back/forward mouse buttons|sebasti@n-doerner.de|Sebastian Dörner}}
{{FeatureDone|Kate|Search & Replace in files plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Make GDB target selection behave like the build plugin |kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Add convenience options for remote debugging|kare.sars@iki.fi|Kåre Särs}}
|}
 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KTouch|New organisation of keyboard and lecture files according to languages|peter.ruethemann@gmail.com|Rüthemann Peter}}
{{FeatureInProgress|KTouch|New organisation of menu system: Training, Statistic, Settings|peter.ruethemann@gmail.com|Rüthemann Peter}}
{{FeatureTodo|KTouch|End of lecture statistics|peter.ruethemann@gmail.com|Rüthemann Peter}}
{{FeatureDone|Rocs|Alignment Actions to minimize crossing graph edges|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Stepped Execution of Algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureDone|Marble|Marble Runner plugins for Parsing files|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|(GSoC) OSM file rendering|oblaukhov.konstantin@gmail.com|Konstantin Oblaukhov}}
{{FeatureDone|Marble|Marble Graphics Scene (Performance of Vector Drawing)|oblaukhov.konstantin@gmail.com|Konstantin Oblaukhov}}
{{FeatureDone|Marble|Gps Info Plugin|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Improve LatLonEdit to allow input as Radian and DM|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureInProgress|Marble|Routing API|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Adjustable Map Orientation (Rotation in Screen Plane)|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureInProgress|Marble|Speedometer Plugin|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureInProgress|Marble|Plasma Runner for geo coords and Marble bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureInProgress|Marble|Make bookmark editor support editing the lonlat coordinates|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Fix GeoDataCoordinates parsing from a QString|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|KTurtle|Add modulo command|nielsslot@gmaildotcom|Niels Slot}}
|}
 

= kdepim =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureTodo
|attachment:/ kio-slave
|Implement kio-slave to access (email) attachments in Akonadi
|kossebau@kde.org|Friedrich W. H. Kossebau}}

{{FeatureInProgress|KAlarm|Port to Akonadi|djarvie@kde.org|David Jarvie}}

{{FeatureTodo
|sieve: implement wizard
|Implement wizard to help user to create sieve script
|montel@kde.org|Montel Laurent}}

{{FeatureInProgress
|HTML Replies
|Give messagecomposer (especially for KMail) the ability to compose replies in HTML
|nyblom@kde.org|Torgny Nyblom}}
|}

 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add Flags Datatype to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|dolphin-plugins|Mercurial plugin for Dolphin|vishesh3y@gmail.com|Vishesh Yadav}}
|}

 

= kdegames=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|Libkdegames|Improve graphics performance in all games by standardizing on the use of Qt Raster Graphics.|stefan.majewsky@googlemail.com|Stefan Majewsky}}{{FeatureInProgress|KSudoku|Add a new generator and solver to KSudoku, based on published algorithms. This will provide a full range of puzzle difficulties, rather than mainly easy puzzles, and will address bug 217925 and its duplicates 228614 and 237262 (now nearly two years old).|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KSudoku|Re-implement the puzzle-symmetry feature.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KSudoku|Re-order the puzzle types on the welcome screen. Use KDE Games Difficulty combo-box instead of a slider. Save user's choices of puzzle between sessions. Do minor tidy-ups of the user interface.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KGoldrunner|Add the championship level "Gold Rush" game, with Traditional rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KGoldrunner|Add the championship level "Jail Break" game, with KGoldrunner rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}|}
 

= kdegraphics=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|Okular|Reset Form Action support|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|agateau@kde.org|Aurélien Gâteau}}
|}
 

= kdeutils=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|ksecrets|A suite of tools related to the KSecretsService infrastructure|kde@rusu.info|Valentin Rusu}}
|}
 

= kdenetwork=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|KGet|Better interaction for torrents if they are seeding and other downloads stopped because of that|mat69@gmx.net|Matthias Fuchs}}
{{FeatureInProgress|KGet|Class that handles deleting files|mat69@gmx.net|Matthias Fuchs}}
|}
 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Kimpanel|Port kimpanel to DataEngine based one|wengxt@gmail.com|Xuetian Weng}}
|}

Development/Review Board

2011-03-21T12:11:40Z

Sebas: added note where to download post-review

= KDE Review Board =

KDE currently uses the [http://www.reviewboard.org/ Review Board] software for performing reviews on code changes.

There are separate versions of Review Board for use with Git and Subversion:
* [http://git.reviewboard.kde.org KDE Git Review Board]
* [http://svn.reviewboard.kde.org KDE Subversion Review Board]

Note that currently http://reviewboard.kde.org/ defaults to the Subversion version but this is scheduled to change so it is recommended to always use the git or svn prefix to be sure.

== Using ReviewBoard and post-review with Git ==

Every Git Project repository has its own entry on the KDE Git Review Board.

=== Creating your changeset ===

To create your changeset, you probably want to work in a separate branch - or even in your clone. This is actually suggested and the proper way to do changesets in Git. You can create any number of commits, amend them, and do whatever you want to do - it won't affect the next steps, as you will submit the whole branch for review.

Before proceeding it is good practice to rebase your branch onto the branch you want to target for the merge. So, supposing you want to target <tt>master</tt>, make sure it is up-to-date with the remote and then run, and want to publish a review for a local branch:

git rebase master

If you want to post a review for merging a non local branch, you might want to run the following:

git merge master

=== Using post-review to post changes for review ===

Once you are done with the above, it is time to post the changes to ReviewBoard. The easiest and most comfortable way to do that is <tt>[http://www.reviewboard.org/docs/manual/dev/users/tools/post-review/ post-review]</tt>, a handy command line tool which takes care of creating review requests for you. (You can find a package for openSUSE [https://build.opensuse.org/package/binary?arch=i586&filename=rbtools-0.8-5.1.i586.rpm&package=rbtools&project=home%3Aflavio_castelli&repository=openSUSE_11.4 here], note that it is built for i586 but works on other arches, too. It's a python script.)

==== Prerequisites ====

The following has to be done only once to make your local clone fit for use with <tt>post-review</tt>.

First of all, you have to tell it about the ReviewBoard server. If your project does not ship with a <tt>.reviewboardrc</tt> file (encourage the project manager to add one!), the first thing you have to run is:

git config reviewboard.url https://git.reviewboard.kde.org

ReviewBoard currently only knows the project repositories by their git:// URLs, making it necessary to have a remote using the git:// URL in your clone. If your <tt>origin</tt> remote is already using the git:// URL, you are all set. If not you need to add another remote now.

Let's suppose you are looking to have some changes to [https://projects.kde.org/projects/extragear/multimedia/amarok Amarok] reviewed, and the URL of your <tt>origin</tt> remote is <tt>git@git.kde.org:amarok</tt>. To add another remote using the git:// URL you might run:

git remote add anonupstream git://anongit.kde.org/amarok
git fetch anonupstream

If your <tt>origin</tt> remote was already using the git:// url, substitute <tt>anonupstream</tt> with <tt>origin</tt> throughout the rest of this tutorial.

==== Creating the review request ====

You are now ready to create the review request. The <tt>post-review</tt> command should look something like this:

post-review --parent=master --tracking-branch=anonupstream/master

This command tells <tt>post-review</tt> that your branch is based upon <tt>master</tt>, and it is set to track the remote branch <tt>anonupstream/master</tt>. You can also give <tt>post-review</tt> some more arguments to avoid using the web interface later - have a look at the [http://www.reviewboard.org/docs/manual/dev/users/tools/post-review/ user manual] for more on that.

After the command has been run a web address will be shown in the terminal, pointing at your review request.

==== Updating a review request ====

If you need to update an existing review request you can invoke <tt>post-review</tt> with an additional <tt>-r</tt> argument, which should be the numeric id of the review request you want to update. Supposing you want to update review request 54, you would run:

post-review --parent=master --tracking-branch=anonupstream/master -r 54

==== Creating a ReviewBoard-compatible diff ====

In some rare cases you simply want to generate a diff and submit it to ReviewBoard later. You can do that by running:

post-review --parent=master -n > your-patch.patch

=== Closing a review request ===

To close a review request, you can either use the ReviewBoard web interface or more conveniently, right in a commit. This is done by using the REVIEW keyword followed by the review ID you want to close. For example, to close review 54, you would put

REVIEW: 54

in your commit. A message will also be posted to ReviewBoard indicating the commit SHA1 that closed the request.

== Using Review Board With Subversion ==

Not all KDE Subversion projects use Review Board so first you need to check if the project you've created the patch for is actually using reviewboard. For this, go to the [http://svn.reviewboard.kde.org/groups/ groups section] and see if the project's group is listed there. If it is listed there, you should use the reviewboard, otherwise send the patch by other means.

For sending a patch, you first need to register. Then simply click ''[http://svn.reviewboard.kde.org/r/new/ New Review Request]'' and fill out the form. The most important parts of the form are:

* '''The actual patch'''. You need to upload the patch you've created earlier here
* '''The SVN base path'''. This is needed for the inline patch display to work. This can be a bit tricky, if you are unfamiliar with KDE's SVN layout, check [http://websvn.kde.org WebSVN]. For example, if you're ''svn diff'ing'' from <tt>/path/to/your/copy/of/kdelibs/cmake/modules</tt>, the base path should be <tt>/trunk/KDE/kdelibs/cmake/modules</tt>. If you still don't know the correct base path, ask a developer on IRC. You can also edit the review request later.
* '''A summary of the patch'''. This should be short, it will show up as subject of the notification emails.
* '''A description of the patch'''. This can be longer.
* '''The group(s)'''. Make sure you enter the correct group '''ID''' here, as seen earlier on the [http://reviewboard.kde.org/groups/ groups page].

After you completed the form, a notification mail will be sent to the developers and they will answer you.

/!\ You need to use svn diff in english, if your system is not english, please do LC_ALL=C svn diff

Development/Tutorials/Plasma/QML/GettingStarted

2011-03-16T15:45:15Z

Sebas: add anchor part of QML howto

== Abstract ==

Writing a plasma applet in QML is very easy, in fact, with KDE 4.6 and Qt 4.7 it just works.

== QML Basics ==

=== Layouts ===

==== Row and Column ====

==== Anchors ====
Anchor layouts offer a nice way of grouping UI elements nicely together. The idea is that you connect edges or corners of one element to the edge or corner of another widget.
Some examples:
<nowiki>

import Qt 4.7
import org.kde.plasma.graphicswidgets 0.1 as PlasmaWidgets
import org.kde.plasma.core 0.1 as PlasmaCore
import org.kde.plasma.graphicslayouts 4.7 as GraphicsLayouts

QGraphicsWidget {
preferredSize: "200x300"

Text {
id: first
text: i18n("1st line")
anchors { top: parent.top;
left: parent.left;
right: parent.right;
}
}
Text {
id: second
text: i18n("2nd line")
anchors { top: first.bottom;
left: parent.left;
right: parent.right;
bottom: parent.bottom;
}
}
}
</nowiki>

=== Buttons ===

=== Animations ===

== Package Structure ==

You create a .desktop file and the .qml file. They have to be in the usual plasma package structure.

plasmoid-qml/metadata.desktop
plasmoid-qml/contents/ui/main.qml

=== <tt>metadata.desktop</tt> ===
<code ini>
[Desktop Entry]
Name=Hello QML
Comment=A hello world widget in QML
Icon=chronometer

X-Plasma-API=declarativeappletscript
X-Plasma-MainScript=ui/main.qml
X-Plasma-DefaultSize=200,100

X-KDE-PluginInfo-Author=Frederik Gladhorn
X-KDE-PluginInfo-Email=gladhorn@kde.org
X-KDE-PluginInfo-Website=http://plasma.kde.org/
X-KDE-PluginInfo-Category=Examples
X-KDE-PluginInfo-Name=org.kde.hello-qml
X-KDE-PluginInfo-Version=0.0

X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
X-KDE-ServiceTypes=Plasma/Applet
Type=Service
</code>

=== <tt>main.qml</tt> ===
<code javascript>
import Qt 4.7

Text {
text: "Hello world!";
}
</code>

== Installing ==
You can install your plasmoid:
plasmapkg --install plasmoid-qml

== plasmoidviewer ==
You can run it in plasmoidviewer as usual:
plasmoidviewer plasmoid-qml

== qmlviewer ==
It's possible to use Plasma specific imports in qml files loaded by qmlviewer:

qmlviewer -I /usr/lib/kde4/imports/ plasmoid-qml/contents/qml/main.qml

Where the -I is the path to the plasma plugin for qml. Try to look for the path of
/usr/lib/kde4/imports/org/kde/plasma/graphicswidgets/libgraphicswidgetsbindingsplugin.so
and use everything up to org of that path.

Hovewer it's '''strongly discouraged''' to use qmlviewer to develop plasmoids, because some features won't be available there:
* localization with i18n()
* access to the global ''plasmoid'' object
* device specific qml files imported with plasmapackage:// urls
* bindings for qicons, KJobs, services and KConfig

= Features only available in Plasma widgets =
In order to have a better integration with the KDE platform and to reach an higher degree of expressivity, the stock features of QML have been expanded with the following features, that strictly follow the Plasmoid JavaScript API:

== Plasmoid object ==
Every QML plasmoid will have an object called ''plasmoid'', that will give access to the configuration, the formfactor, immutability and so on. It offers the same api as the object with the same name in the Javascript API.

== Localization ==
It's possible to localize strings with the usual i18n(), i18nc(), i18np() global functions

== Extra types ==
Some extra types are available from withing JavaScript, namely

* KConfigGroup: it's an object with its cnfig keys readable and writable as properties
* QIcon: can be constructed with QIcon("fdo name") such as QIcon("konqueror")
* KJob
* Plasma Service api

= Plasma specific imports =
To use some Plasma specific features is necessary to use some particular QML imports.

== Plasma Core ==
org.kde.plasma.core
This is the import that lets you access to the most important Plasma Core features.

=== DataSource ===
Used to connect to a dataengine

=== DataModel ===
Attaches to a DataSource, makes possible to use a dataengine as a model for a QML ListView, GridView, PathView and so on

=== Svg ===
Loads a Plasma Svg, it's not the visual item

=== SvgItem ===
Visual item that paints a Svg

=== FrameSvg ===
Loads a Plasma FrameSvg, it's not the visual item.

=== FrameSvgItem ===
Visual item that displays a Plasma FrameSvg

== Extra Qt features ==
org.kde.qtextraimports

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use plasma widgets, you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
Those widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents.

<code javascript>
import Qt 4.7
import org.kde.plasma.graphicswidgets 0.1 as PlasmaWidgets

Item {
width: 64
height: 64
PlasmaWidgets.IconWidget {
id: icon
Component.onCompleted: setIcon("flag-red")
anchors.centerIn: parent
}
}
</code>

Projects/Silk/Selkie

2011-01-19T11:28:30Z

Sebas: /* Where is the code? */

= Selkie - Standalone Web Application =
== What is Selkie? ==

Selkie is a standalone web application shell. With Selkie, you can use Web Applications as first-class citizens on your desktop. Selkie WebApps appear as full applications in your desktop. Entries of these web applications are added to the start menu, then can be found in KRunner on the KDE desktop, they appear as their own entry in the taskbar and window-switching machinery.

Selkie allows you to create customized web application. You can add actions to Selkie applications that can be triggered from the toolbar, or on loading webpages. With these actions, you can "inject" Javascript and run them in the context of the website. This allows you to manipulate the contents and behavior of your web application at runtime. Selkie plugins do not contain any "compiled" or native code. The plugins are simple .desktop files that contain the information about a specific webapp. Likewise, actions are .desktop Files as well. They either contain a JavaScript one-liner or point to a Javascript file which is then executed "inside" your web application. From these scripts, you can also access functions Silk offers you, such as triggering notifications on the desktop, or logging to the console.

Selkie is built using WebKit and makes use of KDE's plugin system and Toolbar / Action system. Selkie can load and execute greasemonkey scripts as well, so there are literally hundreds of actions available.


== How does Selkie work? ==
Selkie has four main components. Selkie itself is the application that can run a number of web applications ("WebApps"). Those WebApps are plugins that can be loaded into Silk. The WebApp plugins contain meta information about the web application (icon, name, comment, plugin name). The plugins also contain information about the WebApp itself, such as at which page to start, or which URLs should be opened in the WebApp itself. This allows for sand-boxing the web application and opening external URLs in the default web browser.

== Where is the code? ==
Selkie is developed inside the Project Silk git repository on Gitorious.org. You need a recent Qt (>=4.5) and KDE development tools and headers installed (4.3.x should do).
*[[ssh://git@git.kde.org/silk|Project Silk on Gitorious]]

== Is it stable? ==
Not at all. It eats kittens and babies. Selkie is not feature-complete, nor widely tested either, it is in a proof-of-concept stage. The code is currently in a "proof-of-concept" stage, but not feature-complete. You can already create WebApps and actions for them, filtering based on URLs and wildcards has been implemented.

== Creating Web Applications ==
Creating WebApps by adapting the .desktop files by hand is possible, an editor for WebApps is in its very early beginnings.

=== Setting up the Selkie Web Application ===
WebApps consist of configuration settings and Actions. The settings for a webapp are read from a .desktop file.

Usually, a webapp will create on, two or more desktop files:

* A .desktop file to launch the webapplication, for example from the Menu and from Krunner:
** Needs to be of type Application
** Should have the webapps Name, GenericName and Comment
** An Icon for the webapp

A file could look like this:
<pre>
[Desktop Entry]
Name=ReviewBoard
GenericName=KDE's ReviewBoard
Comment=KDE's ReviewBoard Instance
Exec=selkie reviewboard
Icon=kstars
Type=Application
</pre>

* A .desktop file describing the plugin, holding site-specific settings:
** Has to be of Type=Service
** startUrl, AllowedBases
** KPluginInfo metadata, most importantly: X-KDE-PluginInfo-Name, which is used as parameter to selkie
** config options, starting with: X-Silk- (These config options are defined in services/silk-webapp.desktop, which is the ServiceType for Silk/Webapp

The plugin .desktop file typically looks like:
<pre>
[Desktop Entry]
Name=Review Board
Comment=KDE's ReviewBoard Instance
Icon=kstars
Type=Service

X-KDE-ServiceTypes=Silk/WebApp

X-KDE-PluginInfo-Author=Sebastian Kügler
X-KDE-PluginInfo-Email=sebas@kde.org
X-KDE-PluginInfo-Name=reviewboard
X-KDE-PluginInfo-Version=0.01
X-KDE-PluginInfo-Website=http://kde.org/
X-KDE-PluginInfo-Category=Development
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true

X-Silk-StartUrl=http://reviewboard.kde.org/r/
X-Silk-AllowedBases=http://reviewboard.kde.org/
</pre>

The StartUrl is the initial URL to show when the application starts. All activated links (through clicks, or redirects) that have their basePath in X-Silk-AllowedBases. This option can contain a list of URLs, separated by "," (a comma). For some sites, adding the address as https:// makes sense as well, possibly also other subdomains.

=== Defining Actions ===
Actions apply to a specific site, and within this site to a URL. Actions can be shown for some URLs and hidden for others. An action can be triggered by the user, and will execute a piece of JavaScript in the website's context. This way, you can "inject" JavaScript into the running website, for example to hide certain elements or trigger functions. to invoke an action in the website's own JavaScript API.
The webapplication, after starting the service-specific plugin, scans for plugins of the type Silk/WebApp/Action, and creates Actions from the .desktop files. An action plugin can provide a JavaScript one-liner to run (window.location = 'http://that.domain/some_page' to jump to a location). It's also possible to provide a JavaScript file for more complex things. An example for this is the togglesidebar.js script in the silk service directory.
<pre>
[Desktop Entry]
Comment=Toggle the Chrome in Gitorious Interface
Icon=view-sidetree
Name=Toggle Chrome
Type=Service

X-KDE-PluginInfo-Name=silk-commitlog
X-KDE-ServiceTypes=Silk/WebApp/Action

X-Silk-ScriptFile=togglesidebar.js
X-Silk-ShowOnUrl=http://gitorious.org/
X-Silk-TriggerOnUrl=http://gitorious.org/
X-Silk-WebApp=silk
</pre>

The KPluginInfo entries are needed to identify the plugin from there on (X-KDE-PluginInfo-Name), and to retrieve this action (X-KDE-ServiceTypes). Not setting the ServiceType of your plugin correctly means that the plugin won't be found.

Actions in a nutshell:
** You need one silk-webapp-myplugin-myaction.desktop file per action, containing name, icon and options for triggering and enabling the action
** Possibly a script if you're using the X-Silk-ScriptFile option
** or a one-line in the form of <pre>X-Silk-Script=window.location = 'http://mail.google.com/mail/?view=cm&fs=1&tf=1'</pre> (if both options are given, the one-liner will be preferred, the file will be ignored). Note: this should be changed to run the one-liner after the script has been included.
** every files needs to be installed via CMakeLists.txt

=== Installation of WebApps and Actions ===

In CMakeLists.txt, you need to add the .desktop files.
<pre>
install( FILES selkie-test.desktop DESTINATION ${XDG_APPS_INSTALL_DIR} )
install( FILES silk-webapp-test.desktop DESTINATION ${SERVICES_INSTALL_DIR})

install( FILES silk-webapp-test-toolbar.desktop DESTINATION ${SERVICES_INSTALL_DIR})
install(FILES toolbaraction.js DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/)

install( FILES silk-webapp-test-trigger.desktop DESTINATION ${SERVICES_INSTALL_DIR})
install(FILES triggeraction.js DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/)

install( FILES silk-webapp-test-wildcard.desktop DESTINATION ${SERVICES_INSTALL_DIR})
</pre>

An action will have 1 entry for the desktop file, and one optionally for a .js file, if you're using the ScriptFile option. Make sure you install the .desktop files into their respective locations: the apps directory for the launcher, the service directory for your site plugin, and your additional files into the data install dir. Every plugin should install into a subdirectory called /silk-webapp/myplugin -- if you don't install it there, it won't be found by the application.
Also, after changing an installed .desktop file, you'll usually want to run 'kbuildsycoca4' to refresh the cached services, often your changes won't have effect immediately if you don't refresh the database.

=== Creating Local WebApps ===
You can also create local applications with Silk, by just providing a bunch of HTML files, image data and a start location. For pure client side apps, this can be enough to create simply local standalone webapps.
Install these files like this:
<pre>
# Install the test sites files
install(FILES testsite/mountain.html DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/testsite/)
install(FILES testsite/selkie.html DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/testsite/)
install(FILES testsite/beach.html DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/testsite/)
install(FILES testsite/default.css DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/testsite/)
install(FILES testsite/randa-view.jpg DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/testsite/)
install(FILES testsite/recife.jpg DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/testsite/)
</pre>

The start, and action urls can be speficifed by relative paths, i.e. in the below case silk-webapp-testsite.desktop
<pre>
X-Silk-StartUrl=testsite/selkie.html
X-Silk-AllowedBases=testsite/
</pre>

In the Selkie service directory, you can find more examples how to build custom web applications. Have a look at "selkie test" for a demo.

= Status / TODO =
*loading plugins as actions works for simple cases
* loading javascript files from plugins works
* showing and hiding action button (parenturls + wildcards matching, works)
* triggering (parenturls and wildcards work)
* actions should have a "persistant" flag to execute them on every new page load, within a context
* some way of automating the creation of those things (apps + actions) (webappeditor, in progress)

Projects/Silk

2011-01-19T11:28:04Z

Sebas: s/gitorious/git.kde.org

{{Template:I18n/Language Navigation Bar|Projects/Silk}}

==== Project Silk ====

The following is based on notes from meeting 9 July 2009.

The basic aim of project silk is to deeply integrate online content and communication into the user experience.

== Goal and Concept ==
The goal of Project Silk is deep coupling of the web with the user experience while overcoming limitations of the browser. "Freeing the Web From the Browser", so to say. Project Silk takes the opposite direction of Google's Chrome OS, instead of making the browser the Operating System, we integrate the content and the communication deeply into the desktop and application

Slogan: "Freeing the Web from the Browser", "A New User Interface (Face) for the Web"

== What the user gets ==
* the Social Desktop, have your friends on the desktop
* Public transport See [http://www.kde-look.org/content/show.php/PublicTransport?content=106175] for example
* Online news
* Online shopping (Amazon API，TaoBao Open Platform API)
* Geoweb: Where are we?
* Bookmarked synched across devices
** What's here? Categories: Culture, shopping, food and drink, friends near here, weather forecast, public transport, translation, wikitravel, localphone, ATM, hotels (with booking), local phone numbers (taxi, police, doctors, tourist info, sports (passive, active), social activities (local church, etc.) nearby internet access.
*** Food support could know of dietry requirements
** Opening times: Shows your current location (using geolocation dataengine and marble / openstreetmap) and shops of an interesting category (supermarkets, for example). Opening times are visualized using colours, for example green means: open for at least two more hours, blue for "open for at least 30 minutes, orange: closes in 10 minutes, red: closed. Makes it easy to find a suitable shop. Unsolved: where to get the info about shops / opening times.
** Local translations
* All this with the ability to feedback
* I'm going to visit XYZ, cache me all the data I need and create a printable overview.
* Mobile phone tarrifs, dialing prefixes
* Local prices - what does hotel, food, travel etc. cost here?
* libocs (my location, nearby etc.)
* CIA world fact book
* the newspaper containment in our plasma-netbook shell
* Travel help: an small application that asks where you're going, and then pulls in information from various locations, much like a dynamic travel guide. This information is then cached (you might not find an Internet connection directly!). Pieces of information that would be useful: maps of the city you're visiting (thanks openstreetmap), phone numbers (the local country code, taxis, doctors, hotels, restaurants, ...) As a bonus, there would be the option to compile a three page summary pdf to print so you don't have to open up your netbook / laptop all the time.

== Components ==
* a webkit-based Konqueror
* libweb
* Silk integration for existing technologies
* applications and applets integrating web content
* new concepts of remixing content from the web

== webkit-based Konqueror ==
During Akademy, there was much discussion and also already some code to make the webkit kpart ready for prime-time. A fully working, modern and integrated browser is one of the most important pillars of Project Silk. Konqueror will be using webkit, making it fully working with all major websites. Info about webkit in Konqueror:
http://techbase.kde.org/Projects/WebKit

== libweb ==

libweb provides the plumbing for applications to easily integrate content from the web by offering a KDE-style API. Think of Solid or Phonon, but for the web. libweb is not so much one library, but a collection of reusable components and sublibraries. It will be a library containing utility classes for integrating online content and services into KDE. Here are some ideas of things it could contain:

* MediaWiki Query class (done)
* webslices, individual parts of webpages as Q(Graphics)Widgets
* webpage thumbnailer (done)
* webpage metadata class with previews
* standalone webapps
* bookmarks with update notification ("this webpage has changed since your last visit") (in progress as SoC?)
* Base class for implementing REST apis with site-specific implementations (much like Cornelius OCS lib that's used in the opendesktop dataengine)
* online news / RSS lib (done)
* libgeoweb, combining geolocation with webservices to retrieve data relevant to your current location, or to where you're travelling to)
* social web API, plugging into different social networks (openDesktop, facebook, linkedIn) (in progress)
* public transport API (standardized way of getting at this information, different backends to get at the data)
* online shopping API (+ different backends)
* online multimedia content (streaming audio, video, music store): see Amarok
** Useful info on the youtube api http://techblog.ironfroggy.com/2009/07/how-to-use-youtube-data-api.html
* SOAP API (useful for corporate web apis)
* Monitor webpages + change notifications
* See Kevin's work on QtJolie
** http://www.grancanariadesktopsummit.org/node/132
** http://www.jolie-lang.org

The challenge for libweb is to keep it smooth and well-structured. It would be too easy to just dump everything web-related in there, we need to think about how the whole thing should look like for developers.

Backends for the service APIs (public transport, online shopping, ...) we offer in libweb should be written in scripting languages for so far possible, so we can easily distribute and update them through GHNS, much like the comic plasma applet does with its per-site comic scriptlets.

== Silk integration components ==
* tagging and indexing of visited webpages in the desktop search / nepomuk
* akonadi resources for interesting services (google contacts, del.icious bookmarks, linkedin and facebook contacts, ...)
* wikipedia runner for KRunner (done :-))
* web identity configuration (central openID config, easy configuration of webservices (think of a button for GMail which then creates an akonadi resource, pulls in email and shows that in Lion Mail on the desktop, or similar, instead of pointing the IMAP config to the GMail server), controls the settings for microblogging, blogging, facebook, google.
* a flickr (or rather web-gallery) browser
* a standalone web video viewer [[http://flavio.tordini.org/minitube||Minitube]] looks interesting (alediaferia is working a dataengine for video)
* microblogging app / applet (done)
* Plasma dataengines and applets
* [[Projects/Silk/Selkie|Selkie]], a sitespecific browser, offering an interface customized for running standalone webapps, uses site-specific bookmarks, offers toolbar actions matching a specific site, instead of location bars and back/forward buttons. (in progress)

== Why is Silk better than a webbrowser ==
* offline usage and caching, even if limited
* richer UI (usage of modern graphics capabilities)
* most webpages only work on a full computer and maybe on a netbook), smaller devices often suffer there
* we can optimize content for small and large screen sizes
* we can make things compatible for different input devices (ever tried google maps on a touchscreen?)
* coherent theming
* full product thinking (hi Aaron!) by integrating interesting services by default)
* better development platform (not bound to JavaScript / Ajax)

== Research Topics ==
* What does already exist, where?
* In how far can we make use of existing API, existing service protocols?
* How do we promote Freedom with Silk?
* What business models does it allow?
* Where can we get corporate buy-in?
* Where does real-time collaboration stand here?

== How do we tackle Project Silk ==
The idea is to fly under the public radar for some time.
Once we have the first bits in place, we announce it as the next multi-year vision for KDE and try to get everybody on board with a big PR splash. (Flying under the radar for a bit will help -- announcing vapourware wouldn't be cool, if we show that we've already some momentum, it'll work much better. Silk is very much a movement towards deep integration, not a one-off or a single application. We have the technologies in place to keep an edge over competitors, and we have the developer community in place to create small plugins to support a wide variety of (even local and niche) services.

== Where's the Code? ==
Silk components are hosted in the Project Silk repository on git.kde.org. Keep in mind that many applications that make the desktop "silk" are integrated into the applications or Plasma already. This git repo collects the bits that aren't (yet).
* [[ssh://git@git.kde.org/silk|Project Silk on git.kde.org]]
The code is highly experimental, it eats kittens alive. You've been warned.

== How can we get people on board? ==
* Blog about the concepts
* Invite interested developers to a mailinglist
* Organize a Silk developer sprint
* Contact people who have been working on "webby" stuff in KDE (done, in progress)
* Divide libweb and the SIL (Silk Integration Layer) into small subtasks
* Provide a git repo with the bits and pieces to get cracking (done)

== Mailinglist and IRC ==
* kde-silk mailinglist: [https://mail.kde.org/mailman/listinfo/kde-silk subscribe] [http://kde.markmail.org/search/?q=kde-silk Archive]
* #kde-silk on Freenode.net

== Why Silk? ==
(Spider)webs are made of it.

Projects/Silk

2010-07-09T11:24:14Z

Sebas: opening times

{{Template:I18n/Language Navigation Bar|Projects/Silk}}

==== Project Silk ====

The following is based on notes from meeting 9 July 2009.

The basic aim of project silk is to deeply integrate online content and communication into the user experience.

== Goal and Concept ==
The goal of Project Silk is deep coupling of the web with the user experience while overcoming limitations of the browser. "Freeing the Web From the Browser", so to say. Project Silk takes the opposite direction of Google's Chrome OS, instead of making the browser the Operating System, we integrate the content and the communication deeply into the desktop and application

Slogan: "Freeing the Web from the Browser", "A New User Interface (Face) for the Web"

== What the user gets ==
* the Social Desktop, have your friends on the desktop
* Public transport See [http://www.kde-look.org/content/show.php/PublicTransport?content=106175] for example
* Online news
* Online shopping (Amazon API，TaoBao Open Platform API)
* Geoweb: Where are we?
* Bookmarked synched across devices
** What's here? Categories: Culture, shopping, food and drink, friends near here, weather forecast, public transport, translation, wikitravel, localphone, ATM, hotels (with booking), local phone numbers (taxi, police, doctors, tourist info, sports (passive, active), social activities (local church, etc.) nearby internet access.
*** Food support could know of dietry requirements
** Opening times: Shows your current location (using geolocation dataengine and marble / openstreetmap) and shops of an interesting category (supermarkets, for example). Opening times are visualized using colours, for example green means: open for at least two more hours, blue for "open for at least 30 minutes, orange: closes in 10 minutes, red: closed. Makes it easy to find a suitable shop. Unsolved: where to get the info about shops / opening times.
** Local translations
* All this with the ability to feedback
* I'm going to visit XYZ, cache me all the data I need and create a printable overview.
* Mobile phone tarrifs, dialing prefixes
* Local prices - what does hotel, food, travel etc. cost here?
* libocs (my location, nearby etc.)
* CIA world fact book
* the newspaper containment in our plasma-netbook shell
* Travel help: an small application that asks where you're going, and then pulls in information from various locations, much like a dynamic travel guide. This information is then cached (you might not find an Internet connection directly!). Pieces of information that would be useful: maps of the city you're visiting (thanks openstreetmap), phone numbers (the local country code, taxis, doctors, hotels, restaurants, ...) As a bonus, there would be the option to compile a three page summary pdf to print so you don't have to open up your netbook / laptop all the time.

== Components ==
* a webkit-based Konqueror
* libweb
* Silk integration for existing technologies
* applications and applets integrating web content
* new concepts of remixing content from the web

== webkit-based Konqueror ==
During Akademy, there was much discussion and also already some code to make the webkit kpart ready for prime-time. A fully working, modern and integrated browser is one of the most important pillars of Project Silk. Konqueror will be using webkit, making it fully working with all major websites. Info about webkit in Konqueror:
http://techbase.kde.org/Projects/WebKit

== libweb ==

libweb provides the plumbing for applications to easily integrate content from the web by offering a KDE-style API. Think of Solid or Phonon, but for the web. libweb is not so much one library, but a collection of reusable components and sublibraries. It will be a library containing utility classes for integrating online content and services into KDE. Here are some ideas of things it could contain:

* MediaWiki Query class (done)
* webslices, individual parts of webpages as Q(Graphics)Widgets
* webpage thumbnailer (done)
* webpage metadata class with previews
* standalone webapps
* bookmarks with update notification ("this webpage has changed since your last visit") (in progress as SoC?)
* Base class for implementing REST apis with site-specific implementations (much like Cornelius OCS lib that's used in the opendesktop dataengine)
* online news / RSS lib (done)
* libgeoweb, combining geolocation with webservices to retrieve data relevant to your current location, or to where you're travelling to)
* social web API, plugging into different social networks (openDesktop, facebook, linkedIn) (in progress)
* public transport API (standardized way of getting at this information, different backends to get at the data)
* online shopping API (+ different backends)
* online multimedia content (streaming audio, video, music store): see Amarok
** Useful info on the youtube api http://techblog.ironfroggy.com/2009/07/how-to-use-youtube-data-api.html
* SOAP API (useful for corporate web apis)
* Monitor webpages + change notifications
* See Kevin's work on QtJolie
** http://www.grancanariadesktopsummit.org/node/132
** http://www.jolie-lang.org

The challenge for libweb is to keep it smooth and well-structured. It would be too easy to just dump everything web-related in there, we need to think about how the whole thing should look like for developers.

Backends for the service APIs (public transport, online shopping, ...) we offer in libweb should be written in scripting languages for so far possible, so we can easily distribute and update them through GHNS, much like the comic plasma applet does with its per-site comic scriptlets.

== Silk integration components ==
* tagging and indexing of visited webpages in the desktop search / nepomuk
* akonadi resources for interesting services (google contacts, del.icious bookmarks, linkedin and facebook contacts, ...)
* wikipedia runner for KRunner (done :-))
* web identity configuration (central openID config, easy configuration of webservices (think of a button for GMail which then creates an akonadi resource, pulls in email and shows that in Lion Mail on the desktop, or similar, instead of pointing the IMAP config to the GMail server), controls the settings for microblogging, blogging, facebook, google.
* a flickr (or rather web-gallery) browser
* a standalone web video viewer [[http://flavio.tordini.org/minitube||Minitube]] looks interesting (alediaferia is working a dataengine for video)
* microblogging app / applet (done)
* Plasma dataengines and applets
* [[Projects/Silk/Selkie|Selkie]], a sitespecific browser, offering an interface customized for running standalone webapps, uses site-specific bookmarks, offers toolbar actions matching a specific site, instead of location bars and back/forward buttons. (in progress)

== Why is Silk better than a webbrowser ==
* offline usage and caching, even if limited
* richer UI (usage of modern graphics capabilities)
* most webpages only work on a full computer and maybe on a netbook), smaller devices often suffer there
* we can optimize content for small and large screen sizes
* we can make things compatible for differnet input devices (ever tried google maps on a touchscreen?)
* coherent theming
* full product thinking (hi Aaron!) by integrating interesting services by default)
* better development platform (not bound to JavaScript / Ajax)

== Research Topics ==
* What does already exist, where?
* In how far can we make use of existing API, existing service protocols?
* How do we promote Freedom with Silk?
* What business models does it allow?
* Where can we get corporate buy-in?
* Where does real-time collaboration stand here?

== How do we tackle Project Silk ==
The idea is to fly under the public radar for some time.
Once we have the first bits in place, we announce it as the next multi-year vision for KDE and try to get everybody on board with a big PR splash. (Flying under the radar for a bit will help -- announcing vapourware wouldn't be cool, if we show that we've already some momentum, it'll work much better. Silk is very much a movement towards deep integration, not a one-off or a single application. We have the technologies in place to keep an edge over competitors, and we have the developer community in place to create small plugins to support a wide variety of (even local and niche) services.

== Where's the Code? ==
Silk components are hosted in the Project Silk repository on Gitorius. Keep in mind that many applications that make the desktop "silk" are integrated into the applications or Plasma already. This git repo collects the bits that aren't (yet).
* [[http://gitorious.org/project-silk|Project Silk on Gitorious]]
The code is highly experimental, it eats kittens alive. You've been warned.

== How can we get people on board? ==
* Blog about the concepts
* Invite interested developers to a mailinglist
* Organize a Silk developer sprint
* Contact people who have been working on "webby" stuff in KDE (done, in progress)
* Divide libweb and the SIL (Silk Integration Layer) into small subtasks
* Provide a git repo with the bits and pieces to get cracking (done)

== Mailinglist and IRC ==
* kde-silk mailinglist: [https://mail.kde.org/mailman/listinfo/kde-silk subscribe] [http://kde.markmail.org/search/?q=kde-silk Archive]
* #kde-silk on Freenode.net

== Why Silk? ==
(Spider)webs are made of it.

Projects/Silk

2010-05-20T13:58:52Z

Sebas: added bookmarks

{{Template:I18n/Language Navigation Bar|Projects/Silk}}

==== Project Silk ====

The following is based on notes from meeting 9 July 2009.

The basic aim of project silk is to deeply integrate online content and communication into the user experience.

== Goal and Concept ==
The goal of Project Silk is deep coupling of the web with the user experience while overcoming limitations of the browser. "Freeing the Web From the Browser", so to say. Project Silk takes the opposite direction of Google's Chrome OS, instead of making the browser the Operating System, we integrate the content and the communication deeply into the desktop and application

Slogan: "Freeing the Web from the Browser", "A New User Interface (Face) for the Web"

== What the user gets ==
* the Social Desktop, have your friends on the desktop
* Public transport See [http://www.kde-look.org/content/show.php/PublicTransport?content=106175] for example
* Online news
* Online shopping (Amazon API，TaoBao Open Platform API)
* Geoweb: Where are we?
* Bookmarked synched across devices
** What's here? Categories: Culture, shopping, food and drink, friends near here, weather forecast, public transport, translation, wikitravel, localphone, ATM, hotels (with booking), local phone numbers (taxi, police, doctors, tourist info, sports (passive, active), social activities (local church, etc.) nearby internet access.
*** Food support could know of dietry requirements
** Local translations
* All this with the ability to feedback
* I'm going to visit XYZ, cache me all the data I need and create a printable overview.
* Mobile phone tarrifs, dialing prefixes
* Local prices - what does hotel, food, travel etc. cost here?
* libocs (my location, nearby etc.)
* CIA world fact book
* the newspaper containment in our plasma-netbook shell
* Travel help: an small application that asks where you're going, and then pulls in information from various locations, much like a dynamic travel guide. This information is then cached (you might not find an Internet connection directly!). Pieces of information that would be useful: maps of the city you're visiting (thanks openstreetmap), phone numbers (the local country code, taxis, doctors, hotels, restaurants, ...) As a bonus, there would be the option to compile a three page summary pdf to print so you don't have to open up your netbook / laptop all the time.

== Components ==
* a webkit-based Konqueror
* libweb
* Silk integration for existing technologies
* applications and applets integrating web content
* new concepts of remixing content from the web

== webkit-based Konqueror ==
During Akademy, there was much discussion and also already some code to make the webkit kpart ready for prime-time. A fully working, modern and integrated browser is one of the most important pillars of Project Silk. Konqueror will be using webkit, making it fully working with all major websites. Info about webkit in Konqueror:
http://techbase.kde.org/Projects/WebKit

== libweb ==

libweb provides the plumbing for applications to easily integrate content from the web by offering a KDE-style API. Think of Solid or Phonon, but for the web. libweb is not so much one library, but a collection of reusable components and sublibraries. It will be a library containing utility classes for integrating online content and services into KDE. Here are some ideas of things it could contain:

* MediaWiki Query class (done)
* webslices, individual parts of webpages as Q(Graphics)Widgets
* webpage thumbnailer (done)
* webpage metadata class with previews
* standalone webapps
* bookmarks with update notification ("this webpage has changed since your last visit") (in progress as SoC?)
* Base class for implementing REST apis with site-specific implementations (much like Cornelius OCS lib that's used in the opendesktop dataengine)
* online news / RSS lib (done)
* libgeoweb, combining geolocation with webservices to retrieve data relevant to your current location, or to where you're travelling to)
* social web API, plugging into different social networks (openDesktop, facebook, linkedIn) (in progress)
* public transport API (standardized way of getting at this information, different backends to get at the data)
* online shopping API (+ different backends)
* online multimedia content (streaming audio, video, music store): see Amarok
** Useful info on the youtube api http://techblog.ironfroggy.com/2009/07/how-to-use-youtube-data-api.html
* SOAP API (useful for corporate web apis)
* Monitor webpages + change notifications
* See Kevin's work on QtJolie
** http://www.grancanariadesktopsummit.org/node/132
** http://www.jolie-lang.org

The challenge for libweb is to keep it smooth and well-structured. It would be too easy to just dump everything web-related in there, we need to think about how the whole thing should look like for developers.

Backends for the service APIs (public transport, online shopping, ...) we offer in libweb should be written in scripting languages for so far possible, so we can easily distribute and update them through GHNS, much like the comic plasma applet does with its per-site comic scriptlets.

== Silk integration components ==
* tagging and indexing of visited webpages in the desktop search / nepomuk
* akonadi resources for interesting services (google contacts, del.icious bookmarks, linkedin and facebook contacts, ...)
* wikipedia runner for KRunner (done :-))
* web identity configuration (central openID config, easy configuration of webservices (think of a button for GMail which then creates an akonadi resource, pulls in email and shows that in Lion Mail on the desktop, or similar, instead of pointing the IMAP config to the GMail server), controls the settings for microblogging, blogging, facebook, google.
* a flickr (or rather web-gallery) browser
* a standalone web video viewer [[http://flavio.tordini.org/minitube||Minitube]] looks interesting (alediaferia is working a dataengine for video)
* microblogging app / applet (done)
* Plasma dataengines and applets
* [[Projects/Silk/Selkie|Selkie]], a sitespecific browser, offering an interface customized for running standalone webapps, uses site-specific bookmarks, offers toolbar actions matching a specific site, instead of location bars and back/forward buttons. (in progress)

== Why is Silk better than a webbrowser ==
* offline usage and caching, even if limited
* richer UI (usage of modern graphics capabilities)
* most webpages only work on a full computer and maybe on a netbook), smaller devices often suffer there
* we can optimize content for small and large screen sizes
* we can make things compatible for differnet input devices (ever tried google maps on a touchscreen?)
* coherent theming
* full product thinking (hi Aaron!) by integrating interesting services by default)
* better development platform (not bound to JavaScript / Ajax)

== Research Topics ==
* What does already exist, where?
* In how far can we make use of existing API, existing service protocols?
* How do we promote Freedom with Silk?
* What business models does it allow?
* Where can we get corporate buy-in?
* Where does real-time collaboration stand here?

== How do we tackle Project Silk ==
The idea is to fly under the public radar for some time.
Once we have the first bits in place, we announce it as the next multi-year vision for KDE and try to get everybody on board with a big PR splash. (Flying under the radar for a bit will help -- announcing vapourware wouldn't be cool, if we show that we've already some momentum, it'll work much better. Silk is very much a movement towards deep integration, not a one-off or a single application. We have the technologies in place to keep an edge over competitors, and we have the developer community in place to create small plugins to support a wide variety of (even local and niche) services.

== Where's the Code? ==
Silk components are hosted in the Project Silk repository on Gitorius. Keep in mind that many applications that make the desktop "silk" are integrated into the applications or Plasma already. This git repo collects the bits that aren't (yet).
* [[http://gitorious.org/project-silk|Project Silk on Gitorious]]
The code is highly experimental, it eats kittens alive. You've been warned.

== How can we get people on board? ==
* Blog about the concepts
* Invite interested developers to a mailinglist
* Organize a Silk developer sprint
* Contact people who have been working on "webby" stuff in KDE (done, in progress)
* Divide libweb and the SIL (Silk Integration Layer) into small subtasks
* Provide a git repo with the bits and pieces to get cracking (done)

== Mailinglist and IRC ==
* kde-silk mailinglist: [https://mail.kde.org/mailman/listinfo/kde-silk subscribe] [http://kde.markmail.org/search/?q=kde-silk Archive]
* #kde-silk on Freenode.net

== Why Silk? ==
(Spider)webs are made of it.

Schedules/KDE4/4.5 Feature Plan

2010-04-25T15:50:25Z

Sebas: add nm plasmoid

This is a list of planned features for the SC 4.5 release.

See also:

*[[Schedules/KDE4/4.5 Release Schedule]]
*[[Schedules/KDE4/4.5 Release Goals]]
*[[Schedules/KDE4/4.4 Feature Plan]]

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdeadmin =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|system-config-printer-kde|Restore feature parity with KDEPrint3 where possible.||Jonathan Riddell, John Layt}}

|}

 

= kdeartwork =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
|}

 

= kdebase-apps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Konqueror|Improvements in session-management|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureTodo|Konqueror|Improvements in tab-bar widget|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureInProgress|Konqueror|New Konqueror bookmarks using Akonadi and Nepomuk, awesome bar|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureInProgress|Konsole|Finish implementing tab context menu|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureInProgress|Konsole|Allow setting tab profile from file on command-line|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureInProgress|Konsole|Adds support for SHELL_SESSION_ID|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureInProgress|Konsole|Modernize menu layout|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureInProgress|Konsole|Move to KTabWidget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureInProgress|print-manager|New Print manager KCM and applet replacement, using C++|dantti85-pk@yahoo.com.br|Daniel Nicoletti}}
{{FeatureDone|Dolphin|Drag and drop on tabs|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|Dolphin|Make view sub-menus available as toolbar buttons|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|Dolphin|Smooth scrolling|fredrik@kde.org|Fredrik Höglund}}
|}

 

= kdebase-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|KWallet|Single Sign On using PAM|lemma@confuego.org|Michael Leupold}}
{{FeatureTodo|network kioslave|Backend for LISa|kossebau@kde.org|Friedrich Kossebau}}
{{FeatureTodo|network kioslave|Backend for SMB|kossebau@kde.org|Friedrich Kossebau}}
{{FeatureTodo|network kioslave|Integrate with remote and zeroconf kioslaves|kossebau@kde.org|Friedrich Kossebau}}
{{FeatureTodo|Locale KCM|Add support for new KLocale features (see kdelibs section) including Digit Groups, AM/PM, etc. Improvements to usability of existing money display options.|john@layt.net|John Layt}}
{{FeatureInProgress|network kioslave|Backend for UPnP|kossebau@kde.org|Friedrich Kossebau}}
{{FeatureTodo|network kioslave| Backend to discover bluetooth devices and they services |edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureInProgress|bluetooth kioslave|Backend to browse bluetooth devices|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureDone|Nepomuk|Monitor file system changes via inotify|trueg@kde.org|Sebastian Trueg}}
|}
{{FeatureTodo|KNotify|Route solid errors via knotify to the device notifier|wilderkde@gmail.com|Jacopo De Simoi}}

 

= kdebase-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
|-
! style="text-align: center;" colspan="4" | Non-Plasma, Non-KWin
{{FeatureTodo|Icons KCM|More configurable icon sizes|christoph@maxiom.de|Christoph Feck}}
{{FeatureTodo|Fonts KCM|More configurable fonts|christoph@maxiom.de|Christoph Feck}}
{{FeatureTodo|Solid|Write a new Bluetooth backend |alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|Screenedges|Screenedges handling outside of kwin/plasma|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|Oxygen style|Move window using left-mouse button on windows' empty areas|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureInProgress|Oxygen configuration|Oxygen style and decoration standalone expert configuration tool|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureInProgress|Free Space Notifier Daemon|Small daemon that warns you when your home has almost no space left|knuckles@gmail.com|Ivo Anjo}}
{{FeatureInProgress|Activities Daemons|Daemons to handle info about activities (kded daemon and a nepomuk service)|ivan.cukic@kde.org|Ivan Cukic}}
{{FeatureInProgress|Systemsettings|driconf KCM|fredrik@kde.org|Fredrik Höglund}}
|-
! style="text-align: center;" colspan="4" | Plasma
{{FeatureInProgress|systemtray/taskmanager|port the systray and tasks applet to windows|windows@kde.org|kde windows}}
{{FeatureInProgress|systemtray|monochrome statusnotifier based systray icons support|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|systemtray|sort icons by category|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|systemtray|put hidden icons in a popup menu|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|tasks dataengine|export all informations needed to build an applet comparable to the current one|matthieu_gallien@yahoo.fr|Matthieu Gallien}}
{{FeatureDone|notifications|split systemtray and notifications applet|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|notifications|new look and behaviour for notifications|notmart@gmail.com|Marco Martin}}
{{FeatureDone|notifications|support for remote applets for notifications|notmart@gmail.com|Marco Martin}}
{{FeatureDone|netbook/SAL|use QStandardModels|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|netbook/SAL|support for drag and drop of items|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|netbook/SAL|package manager invocation from the toolbox|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|netbook/Workspace KCM|New default options for KWin: tabbox as present windows, that will be set as regular grid|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|libplasma/extenders|put extendergroups in scrollwidgets|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|libplasma/extenders|possibility to detach exteneritems as standalone windows|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|libplasma/theme|more transparent dialogs when the blur effect is enabled|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|libplasma/desktop|Activity Manager UI|chani@kde.org|Chani}}
{{FeatureTodo|accounts applet|a plasma widget that is a central place to add accounts to social sites like identica and opendesktop, optimized for the netbook shell|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|libplasma|Improvements to Calendar/Clock widgets. Improved config ui. Allow multiple holidays on same day. Allow multiple Holiday Regions. Weekends. etc.|john@layt.net|John Layt}}
{{FeatureTodo|folderview|"Open folder" icon to open folder into pop-up at request instead of automatically.|bigras.bruno@gmail.com|Bruno Bigras}}
{{FeatureTodo|folderview|Extend the configuration UI for nepomuksearch|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|Extend Calendar DataEngine with Akonadi calendar incidents|Allows to query calendar events/todos from Akonadi in Plasma|gladhornKDEorg|Frederik Gladhorn}}
{{FeatureDone|calculator|Added optional libqalculate support in the calculator runner|agostinelli@gmail.com|Matteo Agostinelli}}
{{FeatureInProgress|KRunner|Add some advanced sorting to KRunner using Nepomuk|l.appelhans@gmx.de|Lukas Appelhans}}
{{FeatureTodo|KRunner|Improve keyboard navigation & command history interaction|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureInProgress|device-notifier|Route all solid error notifications via knotify to the device notifier|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureInProgress|device-notifier|Detailed (HAL) error notifications in the device notifier|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureInProgress|Plasma::Theme|Themed CSS support|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|battery|Weighted charge information for multiple batteries|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|crystal|New desktop search widget|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|networkmanagement|Network management Plasmoid|sebas@kde.org|Sebastian Kügler}}

|-
! style="text-align: center;" colspan="4" | KWin
{{FeatureTodo|Tiling|Merge window tiling branch|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|KWin|New flag to exclude windows from switchers|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|KCM Decoration|New decoration kcm with previews and GHNS|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Aurorae|Port Aurorae to GraphicsView and KDecoration|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|Aurorae|Better themeing support|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Aurorae|Window tabbing support|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Aurorae|Decorations on window sides|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Aurorae|Autohiding decoration for maximized windows|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|kwin|hide windows from other activities|chani@kde.org|Chani}}
{{FeatureTodo|Effects|Move features from present windows to libkwineffects to make them available in desktop grid|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Effects|Add close window button to each window in present windows/desktop grid|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Window Tabbing/libtaskmanager|Announce window groups to be used for grouping in tasks applet|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|KWin/plasma|New window type for Plasma dashboard|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Effects|New blur effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|Effects|High quality scaling shader for the taskbar thumbnails|fredrik@kde.org|Fredrik Höglund}}
{{FeatureTodo|KWin|Hint for defining the window snap rect|fredrik@kde.org|Fredrik Höglund}}
|}

 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|KStars|Display Comet Magnitudes whenever possible|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Information links in-place for each technical term|akarshsimha@gmail.com|Akarsh Simha}} {{FeatureTodo|KStars|Tool to suggest star-hopping techniques???|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Extend conjunction tool to have one object unspecified, but have a genre of objects specified instead|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Simulate Lunar Eclipses|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Simulate Satellites and Iridium Flares|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Social and Geographical Integration for KStars|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Marble widget for Geolocation tool|mboquien@free.fr|Médéric Boquien}}
{{FeatureTodo|KStars|Better printed star charts|kstars@30doradus.org|Jason Harris}}
{{FeatureTodo|KStars|Better rendering of comets/asteroids|kstars@30doradus.org|Jason Harris}}
{{FeatureTodo|KStars|Texture mapping of the skymap???|kstars@30doradus.org|Jason Harris}}
{{FeatureTodo|Marble|Add proper support for GPX waypoints, tracks and routes display|anders@alweb.dk|Anders Lund}}
{{FeatureTodo|Marble|Export map to MxN pixel bitmap|inge@lysator.liu.se|Inge Wallin}}
{{FeatureTodo|Marble|Map Contents translation|tackat@kde.org|Torsten Rahn}}
{{FeatureTodo|Kalzium|Port Kalzium to use QGV based periodic table widget|mhanwell@kde.org|Marcus D. Hanwell}}
{{FeatureDone|Marble|Support OpenStreetMap Nominatim as search backend (MarbleRunner)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Generalized Animations with GeoDataLookAt support|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Online-Routing|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|GPS improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Maemo Support|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|GeoGraphicsScene for Online Service Plugins|bastianholst@gmx.de|Bastian Holst}}
{{FeatureInProgress|Marble|Download region|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureInProgress|Marble|Implement sun locator blendings as derived classes of Marble::Blending|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureInProgress|Marble|Configurable texture layer blending|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureInProgress|Marble|Import geonames city data|sonu.itbhu@gmail.com|Harshit Jain}}
{{FeatureInProgress|Marble|Add new icons for online services|gabrieljoel@gmail.com|Gabriel Joel Perez}}
{{FeatureInProgress|Marble|Download Progressbar in Qt-only version|akssps011@gmail.com|Siddharth Srivastava}}
{{FeatureInProgress|Marble|Bookmark support|anik.varshney@gmail.com|Kumar Anik Varshney}}
{{FeatureInProgress|Marble|Various Marble speed improvements|rahn@kde.org|Torsten Rahn, Ariya Hidayat}}
{{FeatureDone|KAlgebra|Type checker for expressions to statically detect errors|aleixpol@kde.org|Aleix Pol}}
{{FeatureInProgress|KAlgebra|Support for drawing implicit curves|percy.camilo.ta@gmail.com|Percy Camilo Triveño Aucahuasi}}
{{FeatureInProgress|Parley|Parley practice mode rewritten|gladhornKDEorg|Daniel Laidig, Frederik Gladhorn}}
{{FeatureTodo|Cantor|import and polish Qalculate! backend|mail@milianw.de|Milian Wolff}}
{{FeatureInProgress|KTurtle|Implement GHNS download support|nielsslot@gmail.com|Niels Slot}}
{{FeatureTodo|KTurtle|Implement GHNS upload support|nielsslot@gmail.com|Niels Slot}}
{{FeatureDone|Rocs|Node beautification in SVG|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureDone|Rocs|Threads for not blocking the UI|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureDone|Rocs|Redesigned the UI for better usability|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureDone|Rocs|Plugin System|wiglot@gmail.com|Wagner Reck}}
{{FeatureDone|Rocs|Small plugins as examples|wiglot@gmail.com|Wagner Reck}}
{{FeatureDone|Rocs|Multiple Script support|tcanabrava@kde.org|Tomaz Canabrava}}
|}
 

= kdegames =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|KBounce|Difficulty levels|ascherfy@gmail.com|Andreas Scherf}}
{{FeatureDone|KBounce|Random images as background|ascherfy@gmail.com|Andreas Scherf}}
{{FeatureTodo|KBreakOut|Level Sets|fela.kde@gmail.com|Fela Winkelmolen}} {{FeatureTodo|KBreakOut|Sound|fela.kde@gmail.com|Fela Winkelmolen}} {{FeatureTodo|KGoldrunner|Add the Demolition game (20 levels)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureTodo|Kolf|Replace with Kolf 2 (help on coding and artwork desired)|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|KsirK|rewrite AI code or at least correct most problems related in bug #170777. Volunteers wanted!|kleag@free.fr|Gaël de Chalendar}}
{{FeatureTodo|KsirK|Boost playing over Jabber|kleag@free.fr|Gaël de Chalendar}}
{{FeatureTodo|KSquares|Re-write computer player, make it act faster and more intelligent|ewoerner@kde.org|Eckhart Wörner}}
{{FeatureTodo|KSquares|Add more types of boards: hexagonal, triangular|ewoerner@kde.org|Eckhart Wörner}}
{{FeatureTodo|KSudoku|Import new engine|joselb@gmx.net|Johannes Bergmeier}}
{{FeatureTodo|KSudoku|Port game to new engine|joselb@gmx.net|Johannes Bergmeier}}
{{FeatureTodo|KSudoku|Adapt view to show information provided by engine|joselb@gmx.net|Johannes Bergmeier}}
{{FeatureTodo|KSudoku|Add new actions to GUI|joselb@gmx.net|Johannes Bergmeier}}
{{FeatureTodo|Granatier|Arena Editor|k.hias@gmx.de|Mathias Kraus}}
{{FeatureInProgress|Kajongg|New traditional Mahjongg for four players|wolfgang@rohdewald.de|Wolfang Rohdewald}}
{{FeatureTodo|Kajongg|Default voices for computer players|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Make playing against computer suspendable/resumable|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kigo|Load SGF games from command line and register to mimetype 'application/x-go-sgf'|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureInProgress|Kigo|Fix KNewStuff provider issues|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureInProgress|KTuberling|A new "fast switch" between playgrounds|alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}233784 Optimize size of puzzle files in default collection]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}211859 Recieve new puzzles over KNewStuff]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}211861 Introduce handicap as a means to configure difficulty]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}211866 Implement puzzle piles to organize pieces]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}212814 Quick piece grouping]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}213774 Add magnifying glass]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureDone|Palapeli|Rewrite puzzle table mouse interaction stack|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureDone|Palapeli|Cleanup config dialog code|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Konquest|Merge the patch by Sean D'Epagnier to implement many features like map editing|pinaraf@pinaraf.info|Pierre Ducroquet}}
|}

 

= kdegraphics =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|libkdcraw|Make color management options more flexible|marcel.wiesweg@gmx.de|Marcel Wiesweg}}
{{FeatureDone|libksane|Improve auto-selection|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|libksane|Highlight scanned area|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|libksane|Add public API for available devices|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|gwenview|Show Nepomuk info in image meta info|agateau@kde.org|Aurelien Gateau}}
{{FeatureTodo|gwenview|Persistent changes|agateau@kde.org|Aurelien Gateau}}
{{FeatureTodo|okular|Thumb creators via Okular Core|harsh@harshj.com|Harsh J}}

|}

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|katepart|Add visual block mode and make the basic commands support it|ehambergαgmail.com|Erlend Hamberg}}
{{FeatureTodo|katepart|context dependent indenters|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|scripting configuration, esp. for indenters|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|list of available scripts and indenters|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|GHNS for scripts/indenters|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|easier writing of indenters, esp. by automatically reloading them when changed|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|extend list of available default styles for highlighting, remove hardcoded colors from existing XML files|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|improve AutoBrace plugin|mail@milianw.de|Milian Wolff}}
{{FeatureInProgress|katepart/ktexteditor|defaultvalues, regular expressions, mirroring master, scripting of templates|jowenn(you_know)kde(here_too)org|Joseph Wenninger}}
{{FeatureInProgress|ktexteditor plugin|InsaneHTML_LE (zencoding like selector input (light edition)|jowenn(you_know)kde(here_too)org|Joseph Wenninger}}
{{FeatureTodo|katepart|replace smart cursor/ranges API|cullmann@kde.org|Christoph Cullmann}}
{{FeatureTodo|kdeui|API to integrate KStatusNotifierItem and KNotification: both as class api and DBus specification API|davide.bettio@kdemail.net|Davide Bettio}}
{{FeatureTodo|KCalendarSystem|Add new astronomical calculation support classes to be used in kdelibs to build new astronomically based calendar systems, and in kdepim to build new version of libkholiday.|john@layt.net|John Layt}}
{{FeatureTodo|KCalendarSystem|Add new calendar systems: Bahaii, Coptic, Ethiopean, Chinese, Japanese, Buddhist, etc.|john@layt.net|John Layt}}
{{FeatureTodo|kdecore|Group policy (Windows) backend for KAuth|drf@kde.org|Dario Freddi}}
{{FeatureTodo|KDEPrint|If no file printing support in Qt4.5, migrate FilePrinter class from Okular to enable file printing for all apps via QPrinter. To be discussed on k-c-d first.|john@layt.net|John Layt}}
{{FeatureTodo|KDEPrint|Add framework for standard actions for 'Send to...' for e-mail, fax, etc by printing to PDF/PS.|john@layt.net|John Layt}}
{{FeatureTodo|kdeui|Implement caps-lock warning for password entry widgets|lemma@confuego.org|Michael Leupold}}
{{FeatureTodo|KLocale|Implement support for number grouping other than thousands using LC_NUMERIC and LC_MONETARY formats, e.g. India 00 00 000 and China 0000 0000.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Add configuration for AM/PM symbols.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Full POSIX compliant format support for date, time, numbers and money.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Implement more 'named' date/time formats, e.g. ISO, UnixTimestamp, RFC3339, etc.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Add Full date format in addition to existing short and long.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Add default colour to optionally display negative numbers.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Implement separate backends for each supported platform/desktop to use platform localisation in place of KDE locale.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Implement support for additional Country Code standards: ISO Alpha 3, ISO Numeric 3, FIPS-10.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Implement support for Country Code sub-regions, i.e. States/Provinces/etc. Needed for new KHolidays.|john@layt.net|John Layt}}
{{FeatureTodo|kdeui|Improvements to KDatePicker/KDateTable for feature parity with Plasma Calendar widget, i.e. holiday support, select calendar system, etc.|john@layt.net|John Layt}}
{{FeatureTodo|kdeui|DBus interface in StatusNotifierItem to connect it with freedesktop notifications instances|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|Khtml|Improvements in kwallet integration|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureTodo|Khtml|Basic audio/video tag support|germain@ebooksfrance.org|Michael Howell and Germain Garand}}
{{FeatureTodo|Khtml|Implement more of DOM3's CSSOM View module|germain@ebooksfrance.org|Germain Garand}}
{{FeatureDone|KNewStuff|Improved Download Dialog, multiple previews, better integration of details, changelog is displayed|gladhornKDEorg|Frederik Gladhorn}}
{{FeatureInProgress|KNewStuff|Icon view mode|gladhornKDEorg|Reza Shah, Frederik Gladhorn}}
{{FeatureDone|KNewStuff|Upload dialog rewritten: It now supports updating of old uploads, previews, most data that can be entered on the website and allows direct login to the account|gladhornKDEorg|Frederik Gladhorn}}
{{FeatureTodo|kdeui|Social About Dialog|teo@kde.org|Téo Mrnjavac}}
{{FeatureTodo|kdeui|Generic find bar widget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureTodo|kio|SSL client certificate support|ahartmetz@gmail.com|Andreas Hartmetz}}
{{FeatureTodo|kio|SSL root certificate list GUI + backend|ahartmetz@gmail.com|Andreas Hartmetz}}
{{FeatureDone|kio|Add "apply to all" checkbox in renamedialog and allow for automatic renaming|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kio|Port renamedialog to KFileMetaDataWidget|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kio|Don't select extension in renamedialog|toddrme2178@gmail.com|Todd}}
{{FeatureDone|kio|Better listing of applications in file "open with" context menu|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kio|Context menu entry to open all files in their default applications|toddrme2178@gmail.com|Todd}}
{{FeatureDone|kfile|Scroll wheel support for breadcrumb bar|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kfile|Show all sub-folders in breadcrumb bar|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kfile|Middle-click on subfolder in the breadcrumb bar to open in a new tab|toddrme2178@gmail.com|Todd}}
{{FeatureTodo|kfile|Easier access to protocols in breadcrumb bar|toddrme2178@gmail.com|Todd}}
{{FeatureTodo|kfile|Show sub-sub-folders (and so on) in breadcrumb bar|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kdecore|Generic shared-memory cache|mpyne@kde.org|Michael Pyne}}
{{FeatureInProgress|kdeui|Redesigned icon cache|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|kdeui|Support alpha channel in KColor classes|christoph@maxiom.de|Christoph Feck}}
{{FeatureDone|nepomuk|Redesigned Nepomuk::TagWidget which can now actually be used by applications|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|kio|Remember downloads via Nepomuk|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|solid|Broadcast mount/unmount messages across processes|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureTodo|solid|Add parent matching to predicate parsing|wilderkde@gmail.com|Jacopo De Simoi}}
|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|JuK|Remove Qt/KDE3 support lib requirements -- will move to KDE 4.5 feature plan|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Allow setting covers directly from URLs supported by KIO - drag/drop already allows this however -- will move to KDE 4.5 feature plan|mpyne.org|Michael Pyne}}

|}

 

= kdenetwork =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Kopete|UPnp Support|mattr@kde.org|Matt Rogers}}
{{FeatureTodo|Kopete|Jabber Jingle video support|detlev.casanova@gmail.com|Detlev Casanova}}
{{FeatureTodo|Kopete|Jabber Jingle ICE support|detlev.casanova@gmail.com|Detlev Casanova}}
{{FeatureTodo|Kopete|Add support for urls to Bonjour plugin|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Kopete|Rich text support for ICQ|kedgedev@gmail.com|Roman Jarosz}}
{{FeatureDone|Kopete|Extended video controls|fschaefer.oss(at)googlemail.com|Frank Schaefer}}
{{FeatureTodo|Krdc|Connection status screen and reconnect|murraytony@gmail.com|Tony Murray}}
{{FeatureDone|Krdc|Much improved new connection screen: more info, sortable, interactive, and better use of space|murraytony@gmail.com|Tony Murray}}
{{FeatureInProgress|KGet|Use plasma notifications to show the progress|mat69@gmx.net|Matthias Fuchs}}
{{FeatureDone|KGet|Refaktor Torrent-Plugin to base on the newly created libktorrent from extragear|l.appelhans@gmx.de|Lukas Appelhans}}
{{FeatureInProgress|KGet|Better error handling|l.appelhans@gmx.de|Lukas Appelhans}}
|}

 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|knowledgebase|port knowledgebase plasmoid to new engine|ewoerner@kde.org|Eckhart Wörner}}
{{FeatureTodo|knowledgebase|Add categories|ewoerner@kde.org|Eckhart Wörner}}
{{FeatureDone|Bookmarks widget|New|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Mandelbrot Wallpaper|Performance improvements|jacob.benoit.1@gmail.com|Benoit Jacob}}
{{FeatureDone|Mandelbrot Wallpaper|Rendering improvements (through dithering, extra iterations, and better/simpler formulas)|jacob.benoit.1@gmail.com|Benoit Jacob}}
{{FeatureDone|Mandelbrot Wallpaper|Allow to import/export parameters and to export to PNG images|jacob.benoit.1@gmail.com|Benoit Jacob}}
{{FeatureDone|Comic Applet|Add option to show "text", "icons" or both "text and icons" for tabs|mat69@gmx.net|Matthias Fuchs}}
{{FeatureDone|Comic Applet|Prefetch next and previous comic strip (thx to Miha Cancula)|mat69@gmx.net|Matthias Fuchs}}
{{FeatureDone|Character Runner|New|akreuzkamp@web.de|Anton Kreuzkamp}}
{{FeatureInProgress|KDE Observatory|Performance improvements, new data engine|sandroandrade@kde.org|Sandro Andrade}}
|}

 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Lokalize|Integrate snowball stemmer for glossary|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Continue implementing XLIFF spec|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Segmentation [editing] functionality|shafff@NOSPAMukr.net |Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Remote translation memories|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Integrate with nepomuk (fast stats retrieval, tag cloud - incl sharing!)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureInProgress|Kate|Replace old snippet plugin through TNG plugin and enhance the usability of the new plugin|jowenn(you_know)kde(here_too)org|Joseph Wenninger}}
{{FeatureInProgress|Kate|Port the old XML completion plugin (xmltools)|tomastrnka@gmx.com|Tomáš Trnka}}
{{FeatureInProgress|Umbrello|Add a code importing wizzard|andi.fischer@NOSPAMhispeed.ch|Andi Fischer}}
|}

 

= kdeutils =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Ark|Add an options dialog (maybe)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Simplify Kerfuffle's API (jobs, interfaces etc) and try to make it stable|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Support for custom options from the compression interface (eg. a slider for selecting compression level for rar files)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Add feedback for the latest operation in the status bar|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Try multiple plugins for each archive type before failing|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make the internal previewer optional|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Add a "Preview with..." context menu item|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make Kerfuffle really thread-safe (and use threads in less places)|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Get rid of the Observer code in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make error reporting work as expected in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|KGpg|Make keyserver actions possible to use on multiple keyservers at once|kde@opensource.sf-tec.de|Rolf Eike Beer}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add KNewStuff support to the structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureTodo|printer-applet|Restore feature parity with KDEPrint3 where possible.||Jonathon Riddell, John Layt}}
{{FeatureDone|kdelirc/kremotecontrol|Transition from KDELirc to KRemoteControl|michael_zanetti@gmx.net|Michael Zanetti}}
{{FeatureInProgress|KGpg|Add "caff" mode for keysigning|kde@opensource.sf-tec.de|Rolf Eike Beer}}
{{FeatureInProgress|Okteta|Allow writing structure definitions in JavaScript|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add possibility to set count of bytes per line/group|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Okteta|new export formats: S-Record, Intel Hex, Base32, Ascii85, Uuencoding, Xxencoding|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Okteta|add QIODevice for AbstractByteArrayModel and make mimetype detection use this instead of only filename |kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Okteta|Refactor mouse input to controllers for the bytearray widget|kossebau@kde.org|Friedrich W. H. Kossebau}}
|}

 

= Other =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact

|}

Schedules/KDE4/4.5 Feature Plan

2010-04-25T15:48:42Z

Sebas: added my 4.5 plans

This is a list of planned features for the SC 4.5 release.

See also:

*[[Schedules/KDE4/4.5 Release Schedule]]
*[[Schedules/KDE4/4.5 Release Goals]]
*[[Schedules/KDE4/4.4 Feature Plan]]

 Legend:

*todo => not started yet
*in-progress => started, but not completed yet
*done => completed

__TOC__

 

= kdeadmin =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|system-config-printer-kde|Restore feature parity with KDEPrint3 where possible.||Jonathan Riddell, John Layt}}

|}

 

= kdeartwork =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
|}

 

= kdebase-apps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Konqueror|Improvements in session-management|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureTodo|Konqueror|Improvements in tab-bar widget|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureInProgress|Konqueror|New Konqueror bookmarks using Akonadi and Nepomuk, awesome bar|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureInProgress|Konsole|Finish implementing tab context menu|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureInProgress|Konsole|Allow setting tab profile from file on command-line|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureInProgress|Konsole|Adds support for SHELL_SESSION_ID|kurt.hindenburg@gmail.com|Kurt Hindenburg}}
{{FeatureInProgress|Konsole|Modernize menu layout|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureInProgress|Konsole|Move to KTabWidget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureInProgress|print-manager|New Print manager KCM and applet replacement, using C++|dantti85-pk@yahoo.com.br|Daniel Nicoletti}}
{{FeatureDone|Dolphin|Drag and drop on tabs|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|Dolphin|Make view sub-menus available as toolbar buttons|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|Dolphin|Smooth scrolling|fredrik@kde.org|Fredrik Höglund}}
|}

 

= kdebase-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|KWallet|Single Sign On using PAM|lemma@confuego.org|Michael Leupold}}
{{FeatureTodo|network kioslave|Backend for LISa|kossebau@kde.org|Friedrich Kossebau}}
{{FeatureTodo|network kioslave|Backend for SMB|kossebau@kde.org|Friedrich Kossebau}}
{{FeatureTodo|network kioslave|Integrate with remote and zeroconf kioslaves|kossebau@kde.org|Friedrich Kossebau}}
{{FeatureTodo|Locale KCM|Add support for new KLocale features (see kdelibs section) including Digit Groups, AM/PM, etc. Improvements to usability of existing money display options.|john@layt.net|John Layt}}
{{FeatureInProgress|network kioslave|Backend for UPnP|kossebau@kde.org|Friedrich Kossebau}}
{{FeatureTodo|network kioslave| Backend to discover bluetooth devices and they services |edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureInProgress|bluetooth kioslave|Backend to browse bluetooth devices|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureDone|Nepomuk|Monitor file system changes via inotify|trueg@kde.org|Sebastian Trueg}}
|}
{{FeatureTodo|KNotify|Route solid errors via knotify to the device notifier|wilderkde@gmail.com|Jacopo De Simoi}}

 

= kdebase-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
|-
! style="text-align: center;" colspan="4" | Non-Plasma, Non-KWin
{{FeatureTodo|Icons KCM|More configurable icon sizes|christoph@maxiom.de|Christoph Feck}}
{{FeatureTodo|Fonts KCM|More configurable fonts|christoph@maxiom.de|Christoph Feck}}
{{FeatureTodo|Solid|Write a new Bluetooth backend |alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|Screenedges|Screenedges handling outside of kwin/plasma|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|Oxygen style|Move window using left-mouse button on windows' empty areas|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureInProgress|Oxygen configuration|Oxygen style and decoration standalone expert configuration tool|hugo@oxygen-icons.org|Hugo Pereira Da Costa}}
{{FeatureInProgress|Free Space Notifier Daemon|Small daemon that warns you when your home has almost no space left|knuckles@gmail.com|Ivo Anjo}}
{{FeatureInProgress|Activities Daemons|Daemons to handle info about activities (kded daemon and a nepomuk service)|ivan.cukic@kde.org|Ivan Cukic}}
{{FeatureInProgress|Systemsettings|driconf KCM|fredrik@kde.org|Fredrik Höglund}}
|-
! style="text-align: center;" colspan="4" | Plasma
{{FeatureInProgress|systemtray/taskmanager|port the systray and tasks applet to windows|windows@kde.org|kde windows}}
{{FeatureInProgress|systemtray|monochrome statusnotifier based systray icons support|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|systemtray|sort icons by category|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|systemtray|put hidden icons in a popup menu|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|tasks dataengine|export all informations needed to build an applet comparable to the current one|matthieu_gallien@yahoo.fr|Matthieu Gallien}}
{{FeatureDone|notifications|split systemtray and notifications applet|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|notifications|new look and behaviour for notifications|notmart@gmail.com|Marco Martin}}
{{FeatureDone|notifications|support for remote applets for notifications|notmart@gmail.com|Marco Martin}}
{{FeatureDone|netbook/SAL|use QStandardModels|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|netbook/SAL|support for drag and drop of items|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|netbook/SAL|package manager invocation from the toolbox|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|netbook/Workspace KCM|New default options for KWin: tabbox as present windows, that will be set as regular grid|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|libplasma/extenders|put extendergroups in scrollwidgets|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|libplasma/extenders|possibility to detach exteneritems as standalone windows|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|libplasma/theme|more transparent dialogs when the blur effect is enabled|notmart@gmail.com|Marco Martin}}
{{FeatureInProgress|libplasma/desktop|Activity Manager UI|chani@kde.org|Chani}}
{{FeatureTodo|accounts applet|a plasma widget that is a central place to add accounts to social sites like identica and opendesktop, optimized for the netbook shell|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|libplasma|Improvements to Calendar/Clock widgets. Improved config ui. Allow multiple holidays on same day. Allow multiple Holiday Regions. Weekends. etc.|john@layt.net|John Layt}}
{{FeatureTodo|folderview|"Open folder" icon to open folder into pop-up at request instead of automatically.|bigras.bruno@gmail.com|Bruno Bigras}}
{{FeatureTodo|folderview|Extend the configuration UI for nepomuksearch|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|Extend Calendar DataEngine with Akonadi calendar incidents|Allows to query calendar events/todos from Akonadi in Plasma|gladhornKDEorg|Frederik Gladhorn}}
{{FeatureDone|calculator|Added optional libqalculate support in the calculator runner|agostinelli@gmail.com|Matteo Agostinelli}}
{{FeatureInProgress|KRunner|Add some advanced sorting to KRunner using Nepomuk|l.appelhans@gmx.de|Lukas Appelhans}}
{{FeatureTodo|KRunner|Improve keyboard navigation & command history interaction|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureInProgress|device-notifier|Route all solid error notifications via knotify to the device notifier|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureInProgress|device-notifier|Detailed (HAL) error notifications in the device notifier|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureInProgress|Plasma::Theme|Themed CSS support|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|battery|Weighted charge information for multiple batteries|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|crystal|New desktop search widget|sebas@kde.org|Sebastian Kügler}}

|-
! style="text-align: center;" colspan="4" | KWin
{{FeatureTodo|Tiling|Merge window tiling branch|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|KWin|New flag to exclude windows from switchers|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|KCM Decoration|New decoration kcm with previews and GHNS|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Aurorae|Port Aurorae to GraphicsView and KDecoration|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|Aurorae|Better themeing support|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Aurorae|Window tabbing support|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Aurorae|Decorations on window sides|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Aurorae|Autohiding decoration for maximized windows|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|kwin|hide windows from other activities|chani@kde.org|Chani}}
{{FeatureTodo|Effects|Move features from present windows to libkwineffects to make them available in desktop grid|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Effects|Add close window button to each window in present windows/desktop grid|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|Window Tabbing/libtaskmanager|Announce window groups to be used for grouping in tasks applet|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|KWin/plasma|New window type for Plasma dashboard|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Effects|New blur effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|Effects|High quality scaling shader for the taskbar thumbnails|fredrik@kde.org|Fredrik Höglund}}
{{FeatureTodo|KWin|Hint for defining the window snap rect|fredrik@kde.org|Fredrik Höglund}}
|}

 

= kdeedu =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|KStars|Display Comet Magnitudes whenever possible|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Information links in-place for each technical term|akarshsimha@gmail.com|Akarsh Simha}} {{FeatureTodo|KStars|Tool to suggest star-hopping techniques???|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Extend conjunction tool to have one object unspecified, but have a genre of objects specified instead|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Simulate Lunar Eclipses|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Simulate Satellites and Iridium Flares|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Social and Geographical Integration for KStars|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureTodo|KStars|Marble widget for Geolocation tool|mboquien@free.fr|Médéric Boquien}}
{{FeatureTodo|KStars|Better printed star charts|kstars@30doradus.org|Jason Harris}}
{{FeatureTodo|KStars|Better rendering of comets/asteroids|kstars@30doradus.org|Jason Harris}}
{{FeatureTodo|KStars|Texture mapping of the skymap???|kstars@30doradus.org|Jason Harris}}
{{FeatureTodo|Marble|Add proper support for GPX waypoints, tracks and routes display|anders@alweb.dk|Anders Lund}}
{{FeatureTodo|Marble|Export map to MxN pixel bitmap|inge@lysator.liu.se|Inge Wallin}}
{{FeatureTodo|Marble|Map Contents translation|tackat@kde.org|Torsten Rahn}}
{{FeatureTodo|Kalzium|Port Kalzium to use QGV based periodic table widget|mhanwell@kde.org|Marcus D. Hanwell}}
{{FeatureDone|Marble|Support OpenStreetMap Nominatim as search backend (MarbleRunner)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Generalized Animations with GeoDataLookAt support|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Online-Routing|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|GPS improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Maemo Support|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|GeoGraphicsScene for Online Service Plugins|bastianholst@gmx.de|Bastian Holst}}
{{FeatureInProgress|Marble|Download region|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureInProgress|Marble|Implement sun locator blendings as derived classes of Marble::Blending|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureInProgress|Marble|Configurable texture layer blending|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureInProgress|Marble|Import geonames city data|sonu.itbhu@gmail.com|Harshit Jain}}
{{FeatureInProgress|Marble|Add new icons for online services|gabrieljoel@gmail.com|Gabriel Joel Perez}}
{{FeatureInProgress|Marble|Download Progressbar in Qt-only version|akssps011@gmail.com|Siddharth Srivastava}}
{{FeatureInProgress|Marble|Bookmark support|anik.varshney@gmail.com|Kumar Anik Varshney}}
{{FeatureInProgress|Marble|Various Marble speed improvements|rahn@kde.org|Torsten Rahn, Ariya Hidayat}}
{{FeatureDone|KAlgebra|Type checker for expressions to statically detect errors|aleixpol@kde.org|Aleix Pol}}
{{FeatureInProgress|KAlgebra|Support for drawing implicit curves|percy.camilo.ta@gmail.com|Percy Camilo Triveño Aucahuasi}}
{{FeatureInProgress|Parley|Parley practice mode rewritten|gladhornKDEorg|Daniel Laidig, Frederik Gladhorn}}
{{FeatureTodo|Cantor|import and polish Qalculate! backend|mail@milianw.de|Milian Wolff}}
{{FeatureInProgress|KTurtle|Implement GHNS download support|nielsslot@gmail.com|Niels Slot}}
{{FeatureTodo|KTurtle|Implement GHNS upload support|nielsslot@gmail.com|Niels Slot}}
{{FeatureDone|Rocs|Node beautification in SVG|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureDone|Rocs|Threads for not blocking the UI|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureDone|Rocs|Redesigned the UI for better usability|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureDone|Rocs|Plugin System|wiglot@gmail.com|Wagner Reck}}
{{FeatureDone|Rocs|Small plugins as examples|wiglot@gmail.com|Wagner Reck}}
{{FeatureDone|Rocs|Multiple Script support|tcanabrava@kde.org|Tomaz Canabrava}}
|}
 

= kdegames =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|KBounce|Difficulty levels|ascherfy@gmail.com|Andreas Scherf}}
{{FeatureDone|KBounce|Random images as background|ascherfy@gmail.com|Andreas Scherf}}
{{FeatureTodo|KBreakOut|Level Sets|fela.kde@gmail.com|Fela Winkelmolen}} {{FeatureTodo|KBreakOut|Sound|fela.kde@gmail.com|Fela Winkelmolen}} {{FeatureTodo|KGoldrunner|Add the Demolition game (20 levels)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureTodo|Kolf|Replace with Kolf 2 (help on coding and artwork desired)|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|KsirK|rewrite AI code or at least correct most problems related in bug #170777. Volunteers wanted!|kleag@free.fr|Gaël de Chalendar}}
{{FeatureTodo|KsirK|Boost playing over Jabber|kleag@free.fr|Gaël de Chalendar}}
{{FeatureTodo|KSquares|Re-write computer player, make it act faster and more intelligent|ewoerner@kde.org|Eckhart Wörner}}
{{FeatureTodo|KSquares|Add more types of boards: hexagonal, triangular|ewoerner@kde.org|Eckhart Wörner}}
{{FeatureTodo|KSudoku|Import new engine|joselb@gmx.net|Johannes Bergmeier}}
{{FeatureTodo|KSudoku|Port game to new engine|joselb@gmx.net|Johannes Bergmeier}}
{{FeatureTodo|KSudoku|Adapt view to show information provided by engine|joselb@gmx.net|Johannes Bergmeier}}
{{FeatureTodo|KSudoku|Add new actions to GUI|joselb@gmx.net|Johannes Bergmeier}}
{{FeatureTodo|Granatier|Arena Editor|k.hias@gmx.de|Mathias Kraus}}
{{FeatureInProgress|Kajongg|New traditional Mahjongg for four players|wolfgang@rohdewald.de|Wolfang Rohdewald}}
{{FeatureTodo|Kajongg|Default voices for computer players|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Make playing against computer suspendable/resumable|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kigo|Load SGF games from command line and register to mimetype 'application/x-go-sgf'|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureInProgress|Kigo|Fix KNewStuff provider issues|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureInProgress|KTuberling|A new "fast switch" between playgrounds|alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}233784 Optimize size of puzzle files in default collection]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}211859 Recieve new puzzles over KNewStuff]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}211861 Introduce handicap as a means to configure difficulty]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}211866 Implement puzzle piles to organize pieces]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}212814 Quick piece grouping]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Palapeli|[https://bugs.kde.org/show_bug.cgi?id{{=}}213774 Add magnifying glass]|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureDone|Palapeli|Rewrite puzzle table mouse interaction stack|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureDone|Palapeli|Cleanup config dialog code|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|Konquest|Merge the patch by Sean D'Epagnier to implement many features like map editing|pinaraf@pinaraf.info|Pierre Ducroquet}}
|}

 

= kdegraphics =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|libkdcraw|Make color management options more flexible|marcel.wiesweg@gmx.de|Marcel Wiesweg}}
{{FeatureDone|libksane|Improve auto-selection|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|libksane|Highlight scanned area|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|libksane|Add public API for available devices|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|gwenview|Show Nepomuk info in image meta info|agateau@kde.org|Aurelien Gateau}}
{{FeatureTodo|gwenview|Persistent changes|agateau@kde.org|Aurelien Gateau}}
{{FeatureTodo|okular|Thumb creators via Okular Core|harsh@harshj.com|Harsh J}}

|}

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|katepart|Add visual block mode and make the basic commands support it|ehambergαgmail.com|Erlend Hamberg}}
{{FeatureTodo|katepart|context dependent indenters|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|scripting configuration, esp. for indenters|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|list of available scripts and indenters|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|GHNS for scripts/indenters|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|easier writing of indenters, esp. by automatically reloading them when changed|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|extend list of available default styles for highlighting, remove hardcoded colors from existing XML files|mail@milianw.de|Milian Wolff}}
{{FeatureTodo|katepart|improve AutoBrace plugin|mail@milianw.de|Milian Wolff}}
{{FeatureInProgress|katepart/ktexteditor|defaultvalues, regular expressions, mirroring master, scripting of templates|jowenn(you_know)kde(here_too)org|Joseph Wenninger}}
{{FeatureInProgress|ktexteditor plugin|InsaneHTML_LE (zencoding like selector input (light edition)|jowenn(you_know)kde(here_too)org|Joseph Wenninger}}
{{FeatureTodo|katepart|replace smart cursor/ranges API|cullmann@kde.org|Christoph Cullmann}}
{{FeatureTodo|kdeui|API to integrate KStatusNotifierItem and KNotification: both as class api and DBus specification API|davide.bettio@kdemail.net|Davide Bettio}}
{{FeatureTodo|KCalendarSystem|Add new astronomical calculation support classes to be used in kdelibs to build new astronomically based calendar systems, and in kdepim to build new version of libkholiday.|john@layt.net|John Layt}}
{{FeatureTodo|KCalendarSystem|Add new calendar systems: Bahaii, Coptic, Ethiopean, Chinese, Japanese, Buddhist, etc.|john@layt.net|John Layt}}
{{FeatureTodo|kdecore|Group policy (Windows) backend for KAuth|drf@kde.org|Dario Freddi}}
{{FeatureTodo|KDEPrint|If no file printing support in Qt4.5, migrate FilePrinter class from Okular to enable file printing for all apps via QPrinter. To be discussed on k-c-d first.|john@layt.net|John Layt}}
{{FeatureTodo|KDEPrint|Add framework for standard actions for 'Send to...' for e-mail, fax, etc by printing to PDF/PS.|john@layt.net|John Layt}}
{{FeatureTodo|kdeui|Implement caps-lock warning for password entry widgets|lemma@confuego.org|Michael Leupold}}
{{FeatureTodo|KLocale|Implement support for number grouping other than thousands using LC_NUMERIC and LC_MONETARY formats, e.g. India 00 00 000 and China 0000 0000.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Add configuration for AM/PM symbols.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Full POSIX compliant format support for date, time, numbers and money.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Implement more 'named' date/time formats, e.g. ISO, UnixTimestamp, RFC3339, etc.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Add Full date format in addition to existing short and long.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Add default colour to optionally display negative numbers.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Implement separate backends for each supported platform/desktop to use platform localisation in place of KDE locale.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Implement support for additional Country Code standards: ISO Alpha 3, ISO Numeric 3, FIPS-10.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Implement support for Country Code sub-regions, i.e. States/Provinces/etc. Needed for new KHolidays.|john@layt.net|John Layt}}
{{FeatureTodo|kdeui|Improvements to KDatePicker/KDateTable for feature parity with Plasma Calendar widget, i.e. holiday support, select calendar system, etc.|john@layt.net|John Layt}}
{{FeatureTodo|kdeui|DBus interface in StatusNotifierItem to connect it with freedesktop notifications instances|notmart@gmail.com|Marco Martin}}
{{FeatureTodo|Khtml|Improvements in kwallet integration|edulix@gmail.com|Eduardo Robles Elvira}}
{{FeatureTodo|Khtml|Basic audio/video tag support|germain@ebooksfrance.org|Michael Howell and Germain Garand}}
{{FeatureTodo|Khtml|Implement more of DOM3's CSSOM View module|germain@ebooksfrance.org|Germain Garand}}
{{FeatureDone|KNewStuff|Improved Download Dialog, multiple previews, better integration of details, changelog is displayed|gladhornKDEorg|Frederik Gladhorn}}
{{FeatureInProgress|KNewStuff|Icon view mode|gladhornKDEorg|Reza Shah, Frederik Gladhorn}}
{{FeatureDone|KNewStuff|Upload dialog rewritten: It now supports updating of old uploads, previews, most data that can be entered on the website and allows direct login to the account|gladhornKDEorg|Frederik Gladhorn}}
{{FeatureTodo|kdeui|Social About Dialog|teo@kde.org|Téo Mrnjavac}}
{{FeatureTodo|kdeui|Generic find bar widget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureTodo|kio|SSL client certificate support|ahartmetz@gmail.com|Andreas Hartmetz}}
{{FeatureTodo|kio|SSL root certificate list GUI + backend|ahartmetz@gmail.com|Andreas Hartmetz}}
{{FeatureDone|kio|Add "apply to all" checkbox in renamedialog and allow for automatic renaming|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kio|Port renamedialog to KFileMetaDataWidget|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kio|Don't select extension in renamedialog|toddrme2178@gmail.com|Todd}}
{{FeatureDone|kio|Better listing of applications in file "open with" context menu|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kio|Context menu entry to open all files in their default applications|toddrme2178@gmail.com|Todd}}
{{FeatureDone|kfile|Scroll wheel support for breadcrumb bar|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kfile|Show all sub-folders in breadcrumb bar|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kfile|Middle-click on subfolder in the breadcrumb bar to open in a new tab|toddrme2178@gmail.com|Todd}}
{{FeatureTodo|kfile|Easier access to protocols in breadcrumb bar|toddrme2178@gmail.com|Todd}}
{{FeatureTodo|kfile|Show sub-sub-folders (and so on) in breadcrumb bar|toddrme2178@gmail.com|Todd}}
{{FeatureInProgress|kdecore|Generic shared-memory cache|mpyne@kde.org|Michael Pyne}}
{{FeatureInProgress|kdeui|Redesigned icon cache|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|kdeui|Support alpha channel in KColor classes|christoph@maxiom.de|Christoph Feck}}
{{FeatureDone|nepomuk|Redesigned Nepomuk::TagWidget which can now actually be used by applications|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|kio|Remember downloads via Nepomuk|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|solid|Broadcast mount/unmount messages across processes|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureTodo|solid|Add parent matching to predicate parsing|wilderkde@gmail.com|Jacopo De Simoi}}
|}
 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|JuK|Remove Qt/KDE3 support lib requirements -- will move to KDE 4.5 feature plan|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Allow setting covers directly from URLs supported by KIO - drag/drop already allows this however -- will move to KDE 4.5 feature plan|mpyne.org|Michael Pyne}}

|}

 

= kdenetwork =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Kopete|UPnp Support|mattr@kde.org|Matt Rogers}}
{{FeatureTodo|Kopete|Jabber Jingle video support|detlev.casanova@gmail.com|Detlev Casanova}}
{{FeatureTodo|Kopete|Jabber Jingle ICE support|detlev.casanova@gmail.com|Detlev Casanova}}
{{FeatureTodo|Kopete|Add support for urls to Bonjour plugin|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Kopete|Rich text support for ICQ|kedgedev@gmail.com|Roman Jarosz}}
{{FeatureDone|Kopete|Extended video controls|fschaefer.oss(at)googlemail.com|Frank Schaefer}}
{{FeatureTodo|Krdc|Connection status screen and reconnect|murraytony@gmail.com|Tony Murray}}
{{FeatureDone|Krdc|Much improved new connection screen: more info, sortable, interactive, and better use of space|murraytony@gmail.com|Tony Murray}}
{{FeatureInProgress|KGet|Use plasma notifications to show the progress|mat69@gmx.net|Matthias Fuchs}}
{{FeatureDone|KGet|Refaktor Torrent-Plugin to base on the newly created libktorrent from extragear|l.appelhans@gmx.de|Lukas Appelhans}}
{{FeatureInProgress|KGet|Better error handling|l.appelhans@gmx.de|Lukas Appelhans}}
|}

 

= kdeplasma-addons =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|knowledgebase|port knowledgebase plasmoid to new engine|ewoerner@kde.org|Eckhart Wörner}}
{{FeatureTodo|knowledgebase|Add categories|ewoerner@kde.org|Eckhart Wörner}}
{{FeatureDone|Bookmarks widget|New|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Mandelbrot Wallpaper|Performance improvements|jacob.benoit.1@gmail.com|Benoit Jacob}}
{{FeatureDone|Mandelbrot Wallpaper|Rendering improvements (through dithering, extra iterations, and better/simpler formulas)|jacob.benoit.1@gmail.com|Benoit Jacob}}
{{FeatureDone|Mandelbrot Wallpaper|Allow to import/export parameters and to export to PNG images|jacob.benoit.1@gmail.com|Benoit Jacob}}
{{FeatureDone|Comic Applet|Add option to show "text", "icons" or both "text and icons" for tabs|mat69@gmx.net|Matthias Fuchs}}
{{FeatureDone|Comic Applet|Prefetch next and previous comic strip (thx to Miha Cancula)|mat69@gmx.net|Matthias Fuchs}}
{{FeatureDone|Character Runner|New|akreuzkamp@web.de|Anton Kreuzkamp}}
{{FeatureInProgress|KDE Observatory|Performance improvements, new data engine|sandroandrade@kde.org|Sandro Andrade}}
|}

 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Lokalize|Integrate snowball stemmer for glossary|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Continue implementing XLIFF spec|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Segmentation [editing] functionality|shafff@NOSPAMukr.net |Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Remote translation memories|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Integrate with nepomuk (fast stats retrieval, tag cloud - incl sharing!)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureInProgress|Kate|Replace old snippet plugin through TNG plugin and enhance the usability of the new plugin|jowenn(you_know)kde(here_too)org|Joseph Wenninger}}
{{FeatureInProgress|Kate|Port the old XML completion plugin (xmltools)|tomastrnka@gmx.com|Tomáš Trnka}}
{{FeatureInProgress|Umbrello|Add a code importing wizzard|andi.fischer@NOSPAMhispeed.ch|Andi Fischer}}
|}

 

= kdeutils =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Ark|Add an options dialog (maybe)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Simplify Kerfuffle's API (jobs, interfaces etc) and try to make it stable|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Support for custom options from the compression interface (eg. a slider for selecting compression level for rar files)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Add feedback for the latest operation in the status bar|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Try multiple plugins for each archive type before failing|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make the internal previewer optional|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Add a "Preview with..." context menu item|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make Kerfuffle really thread-safe (and use threads in less places)|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Get rid of the Observer code in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make error reporting work as expected in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|KGpg|Make keyserver actions possible to use on multiple keyservers at once|kde@opensource.sf-tec.de|Rolf Eike Beer}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add KNewStuff support to the structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureTodo|printer-applet|Restore feature parity with KDEPrint3 where possible.||Jonathon Riddell, John Layt}}
{{FeatureDone|kdelirc/kremotecontrol|Transition from KDELirc to KRemoteControl|michael_zanetti@gmx.net|Michael Zanetti}}
{{FeatureInProgress|KGpg|Add "caff" mode for keysigning|kde@opensource.sf-tec.de|Rolf Eike Beer}}
{{FeatureInProgress|Okteta|Allow writing structure definitions in JavaScript|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Okteta|Add possibility to set count of bytes per line/group|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Okteta|new export formats: S-Record, Intel Hex, Base32, Ascii85, Uuencoding, Xxencoding|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Okteta|add QIODevice for AbstractByteArrayModel and make mimetype detection use this instead of only filename |kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Okteta|Refactor mouse input to controllers for the bytearray widget|kossebau@kde.org|Friedrich W. H. Kossebau}}
|}

 

= Other =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact

|}

Projects/Plasma/Tokamak4

2010-02-18T18:07:25Z

Sebas: added silk presentation, network management breakout

==Tokamak 4 Oxygen 3 2010==

The fourth Tokamak Plasma Meeting and the third Oxygen Gathering will take place in Nuremberg, Germany on February 19th to 26th.

===Location===

We will be hosted by Novell in the openSUSE offices in Nuremberg. The community space includes a large meeting room with AV infrastructure, a cafe-style area and a hacking bar. And of course you benefit from being only metres away from the KDE SVN server.

SUSE Linux Products GmbH 
Maxfeldstr. 5 
90409 Nuernberg 
Germany 

The tram stop is where it says 'Pirckheimer Straße':

http://barcampnuernberg.pbworks.com/f/1163943919/karte_nuremberg_detail.jpg

===Accomodation===

Accommodation has been organised in the Berufsförderungswerk Nuernberg (Nuremberg Professional Training College) and the youth hostel in the historic Imperial Stables in Nuremberg's castle! Echoes of Nove Hrady...

====Accommodation Friday + Saturday====
(change to #2/depart on Sunday)

Kossebau Friedrich 
Gladhorn Fredrik 
Appelhans Lukas 
Gräßlin Martin 
Kügler Sebastian 
Cavalcanti Adenilson 

are staying in

Hotel Astoria 
Weidenkellerstraße 4 
D - 90443 Nürnberg 
Tel. +49 (0) 911 - 208505 
Fax +49 (0) 911 - 243670 
Email: info@hotel-astoria-nuernberg.de 
http://www.hotel-astoria-nuernberg.de 

Everyone else is in

Berufsförderungswerk Nürnberg
gemeinnützige GmbH 
Schleswiger Str. 101 
90427 Nürnberg 
phone +49 911 938-6 
http://www.bfw-nuernberg.de

You can check in at any time, and there is free wifi in the reception area and most rooms.

====Accommodation Sunday to Friday====
Jugendherberge Nürnberg 
Burg 2 
90403 Nürnberg 
phone +49 911 230936-12 
http://www.jugendherberge.de/jh/bayern/nuernberg/ 

===Map===
[http://maps.google.com/maps/ms?ie=UTF&msa=0&msid=101167196505765855700.00047e0f3db239908f72f Tokamak 4 Location Map] shows where things are. Note that the accommodation for the first 2 nights (Friday and Saturday) is not the same as for the rest of the week.

===Travelling===

Nuremberg is easily reachable by air or by train. The nearest airports for intercontinental flights are Frankfurt and Munich, and Nuremberg is served from other European hubs such as Paris Charles De Gaulle and Amsterdam. Nuremberg is only a few hours by train from most of the rest of central Europe.

You can reach the SUSE office in 6 minutes by tram from the rail station by taking the number 8 tram towards 'Thon' from the tram interchange in front of the railway station, follow the square 'Tram' signs. Alight at 'Maxfeldstr' as shown on the signs inside the tram and go to the SUSE office at Maxfeldstr. 5.

From the airport, a taxi will cost 10-14 EUR and takes about 10 minutes. Alternatively, take the U2 metro from outside Arrivals (any train), alight at 'Rennweg', leave the station by the south exit (in the direction of travel, go to the tram stop in the middle of the road on your right as you exit the metro, and get the number 8 tram towards 'Thon' as above.

===Public Transport===
Nuernberg has a pretty good general public transport information site that covers bus, tram, local trains and underground/metro with some info in English: [http://vgn.de Nuernberg public transport information]. A single journey costs 2EUR, a 10er strip costs 9.20EUR. Buy tickets from multilingual touchscreen vending machines before you get on the bus/tram/underground, and single tickets are already validates. A 10er strip needs stamping, 2 units per single journey for an adult.

====Airport -> BFW====
You probably don't want to do this if you are tired after a long flight. Although it is short and easy you have to find the right stop for the 26 at the interchange at Thon. A taxi cab will be under 10EUR. About every half an hour until midnight:

Get the 32 bus towards Thon, get off at Thon (last stop). Then get the 26 bus towards Berufsförderungswerk (last stop). This drops you at the entrance to the BFW, take the side entrance to the Gaestehaus.

====BFW -> Airport====
Get the 26 bus towards Thon, get off at Thon (last stop). Then get the 32 bus towards Flughafen (the airport, the last stop).

====BFW -> SUSE====
Get the 26 bus towards Thon, get off at Thon (last stop). Then get the 9 tram towards Doku-Zentrum. Get off at Maxfeldstr. The SUSE building is the large blue building on the right.

====BFW -> Rail station====
Get the 26 bus towards Thon, get off at Thon (last stop). Then get the 9 tram towards Doku-Zentrum. Get off at Maxfeldstr. The SUSE building is the large blue building on the right.

====SUSE (or Rail station) -> BFW====
Get the 9 Tram towards Thon, get off at Thon (last stop). Then get the 26 bus towards Berufsförderungswerk (last stop). This drops you at the entrance to the BFW, take the side entrance to the Gaestehaus.

====Airport -> Hotel Astoria====
Get the U2 Underground (only one direction, Röthenbach). Get off at Opernhaus. Walk to Weidenkellerstr. 4 (see map above and hotel website).

====Hotel Astoria -> Airport====
Walk to Opernhaus underground, get the U2 Underground toward Flughafen (every 2nd train goes to the airport and have an aeroplane symbol on the destination board).

====Astoria -> SUSE====
Either print out the map and address, and walk through the city center (about 10 minutes), or get the U2 toward Flughafen or Ziegelstein, get off at Hauptbahnhof, follow the signs towards Tram at street level, get the 9 Tram towards Thon, get off at Maxfeldstr. The SUSE building is the large blue building on the right. (every 7 or 15 minutes until midnight, about 20 minutes)

====SUSE -> Astoria====
Get the 9 Tram towards Doku-Zentrum, change at Hauptbahnhof, get the U2 towards Röthenbach, get off at Opernhaus.

===By Car===
You have a navi, right? Or see the [http://www.novell.com/de-de/company/contact/gs-nuernberg/index.html Novell directions]. Address above, you can park in the basement garage, we'll get you a guest pass if you come to the office within opening hours, otherwise let Will know in advance.

==Participants==
=== Participants ===
{| class="wikitable" border="1"
!Name
!Email
!Arrival
!Depart
!Cost
!Sponsor?
!Hotel?
!Food
!Work
!Airport
!Flights
|-
|Aaron Seigo
|aseigo@kde.org
|TBD
|TBD
|~$1300?
|yes
|yes
|vegetarian
|Overall facilitation
|In LH 924 14:15 / Out LH 921 07:00
|-
|Marco Martin
|notmart@gmail.com
|19
|26
|93€
|yes
|yes
|whatever
|whatever coding and else, Plasma mobile
|Nuremberg (NUE)
|In ABB8403 19:20 / Out ABB8403 08:35
|-
|Ivan Čukić
|ivan.cukic@kde.org
|19.2
|26.2
|approx €250
|yes
|yes
|whatever
|nepomuk activities merging, libfavorite...
|Nuremberg (NUE)
|In LH3405, LH938 12:05 / Out LH943, LH3402 12:45
|-
|Artur de Souza
|asouza@kde.org
|20
|26
|~1000 euros
|yes
|yes
|whatever
|coding, mobile, bug fixing, etc...
|-
|Nuno Pinheiro
|nuno@oxygen-icons.org
|19
|24
|aprox 250€
|yes
|yes
|whatever
|whatever artwork, mobile, planing, etc....
|-
|Chani
|chani@kde.org
|19 (20:16)
|26 (11:25)
|~$1300
|yes
|yes
|vegetarian
|activity management / js / random bugs
|In: train. Out: NUE
|Out: Delta 9500
|-
|Martin Gräßlin
|kde@martin-graesslin.com
|19.
|21.
|0
|no
|yes
|
|KWin on embedded devices
|-
|Lukas Appelhans
|l.appelhans@gmx.de
|19. - 18:24
|21. - 17:33
|~150€
|yes
|yes
|whatever
|Quicklaunch-Applet, KGet-Applets, Shaman/Aqpm-Applets, Raptor?
|-
|Frank Karlitschek
|karlitschek@kde.org
|19
|26
|50EUR
|yes
|yes
|whatever
|Social Desktop
|-
|Dario Freddi
|drf@kde.org
|19
|22
|~150€
|yes
|yes
|whatever
|stuff that nobody wants to do, as usual
|Nuremberg (NUE)
|In ABB8403 19:20 / Out ABB8404 16:55
|-
|Riccardo Iaconelli
|riccardo@kde.org
|19
|21
|TBD, I suppose ~150-200€
|yes
|yes
|whatever
|plasmoids, art, ideas, fun :-)
|-
|Sebastian Kügler
|sebas@kde.org
|19th
|26th
|~100€
|yes
|yes
|whatever
|Power- and networkmanagement, web integration, PIM stuff
|-
|Davide Bettio
|davide.bettio@kdemail.net
|TBD, probably 19th
|TBD, I don't know
|TBD, I suppose ~150-200€
|yes
|yes
|whatever
|TBD
|-
|Will Stephenson
|wstephenson@kde.org
|Local
|Local
|0
|no
|no
|whatever
|Keeping everyone else happy, networkmanagement
|N/A
|I can see the venue from my kitchen
|-
|Eugene Trounev
|eugene.trouenv@gmail.com
|19-11:15
|26-11:50
|$1,126.97 CAD
|yes
|yes
|no meat. fish, eggs, and milk are OK
|various artowrk (like wallpapers), designs and more
|Nuremberg(NUE)
|In AC9268/Out AC9195
|-
|Igor Trindade Oliveira
|igor_trindade@yahoo.com.br
|18
|26
|900 euros
|yes
|yes
|whatever
|coding, animations, netbook etc...
|Frankfurt
|In JJ8070, arrival 14hs
|-
|Frederik Gladhorn
|gladhorn@kde.org
|19.2.
|26.2.
|~50 euros
|yes
|yes
|whatever
|opendesktop integration
|-
|Martin Zilz
|oore.mofux@gmx.de
|TBD (20.?)
|TBD (24.?)
|~150 euros
|no
|yes
|whatever
|arts, ux, freaky out of the box stuff
|-
|Luboš Luňák
|l.lunak@suse.cz
|19
|23
|~100 euros
|no
|yes
|whatever
|KWin
|-
|Alexis Menard
|menard@kde.org
|19
|26
|Approved by Nokia -> 0
|no
|yes
|whatever
|Plasma-Mobile and Qt
|Nuremberg(NUE)
|-
|Friedrich Kossebau
|kossebau@kde.org
|19. - 16:28 (train)
|26. - 16:33 (train)
|max. 100 EUR
|yes
|yes
|whatever
|Plasmoids (one of): Timeline, Khalkhi (Porting to KDE4), Network devices
|-
|Adenilson Cavalcanti
|cavalcantii@gmail.com
|18
|26
|900 euros
|yes
|yes
|carnivorous
|coding, animations, etc
|Frankfurt
|In JJ8070, arrival 14hs
|-
|Richard Moore
|rich@kde.org
|19
|24
|I'll pay for flight
| accommodation only
|yes
|yes please
|silky stuff, api review etc.
| NUE
| In LH4869, LH 0938. Out LH0939, LH4864
|-
|Sandro Andrade
|sandroandrade@kde.org
|20th 1825
|27th 0955
|~1000 euros
|yes
|yes
|preferably vegetarian
|plasmoids, data engines, and plasmate interest
|Nuremberg (NUE)
|In TP7784 / Out TP7795
|-
|Kevin Ottens
|ervin@kde.org
|19
|26
|~200 euros
|yes
|yes
|no seafood
|mobile, api review, solid if times permit
|Nuremberg (NUE)
|In LH946 22:10 / Out LH929 14:45
|-
|Harald Fernengel
|harry@kdevelop.org
|20
|20
|0 euros
|yes
|no
|
|Qt on Maemo Q&A
|Train
|
|}

==Special Needs==
* Laptop/desktop for hacking with KDE trunk on it for: Lukas Appelhans
* Helpful for hacking on the 3 Intel devices (not vital, but would preed thing up especially the ethernet adaptor):
** usb hub (preferably powered)
** usb-to-ethernet adaptor (unreliable drivers for the internal wifi)
** extra storage/file transfer can be done with the ethernet adaptor of with microsd/thumbdrives
** usb keyboards and mice would ease things a bit too since it supports them
* For presentations a video camera would be nice, preferably with a remote microphone. (available in openSuse offices?). (It would be wonderful for those of us that cannot attend, so don't please don't forget us ;-) -sreich).

==Topics==

We will be focusing on the KDE SC 4.5 release of Plasma, with a particular attention on feature completion, polishing and quality improvements across the code base. Activities and Plasma Mobile will also be topics of interest.

Oxygen, finishing it up for 4.5 plans for the future.

===Opening Day Presentations===
* Plasma mobile: State of art (Alexis)
* Plasma netbook: State and road ahead - most important work still to be done (Marco Martin)

* Context: [Details later] (Chani and Ivan)
* Shaman - Bringing software management into the workspace and into 2010 [if time permits] (Dario and Lukas)
* Oxygen what it was, what it will be?
* Silk - Freeing the Web from the Browser

===Development Topics===
* ZUI replacement in plasma-desktop
* Plasma Mobile
* Plasma Netbook
* Plasma Media Center
* Plasmate
* Applet handles as plugins?
* Moving the toolboxes out of libplasma
* Plasma::Storage (data, passwords, ..?)
* Dataengines caching
* Plasma wallpaper scripting
* Focus and drag&drop issues
* Store/load containment layouts
* RTL
* use of configChanged() in widgets
* reusable widgets for groups of iconized items (like the entries in the taskbar)
* guidelines (with code support) for consistent looking rows of different widgets (e.g. like with bars on the top of the screen, as known from mobiles' UI or the Mac UI)
* Plasma OSD service
* GSoC
* http://techbase.kde.org/Projects/Plasma/Plasmoid-Issues
* application dashboards using View/Corona/Newspaper
* window types, focus styles
* screen edge management
* Containment, Wallpaper, Mouse Action scripting?
* welcome plasmoid, finally?
* website authentication
* continuing on with dejargonizing (inc kwin, with the use of "compositing" instead of "Desktop Efects", e.g.)
* javascript test coverage

=== Breakout Groups ===
Starting on day two we will split up into small groups to focus on specific topics and challenges. The breakout group tracks will start with short presentations designed to share important information about the topic of interest to get everybody up to speed. A schedule for each of the presentations will be posted closer to the start of Tokamak 4.

Some people will stay with a specific track for the duration of Tokamak 4, but everyone is welcome to drift between the different breakout groups to bring their needs and ideas to bear.

==== Plasma Mobile ====
;Topic
:Plasma shells on devices with small screens and designed for mobility. The focus use case will be touch screen driven smartphones.

;Duration
:All week

;Facilitator
:Marco/Kevin

;Presentations
:Moblin SDK, Marco, Day 2
:Maemo SDK, Alexis, Day 2

;Participants
:Marco
:Alexis
:Aaron
:Nuno Pinheiro
:Kevin
:Artur
:Aaron Seigo
:Eugene Trounev [it-s]
:Chani
:Sandro
:Dario

==== Context and Activities ====
;Topic
:The behind-the-scenes orchestration of environment-wide Context as well as the UI presentation of them (and/or their activities?) to the user

;Duration
:

;Facilitator
:

;Presentations
:

;Participants
:Ivan Čukić
: Chani
: Marco (as much as the mobile one permits)
:Aaron Seigo

==== Oxygen ====
;Topic
:Desktop themes, widgets styles, window decorations, icons, coherent branding, sites, Plasma panels, how can we clean them?
:What is next? Helium? Fixing kde app's UI's one by one?

;Duration
:All week

;Facilitator
:Nuno Pinheiro (19-24)

;Presentations
:

;Participants
:Nuno Pinheiro
:Marco (as much as the mobile one permits)
:Aaron Seigo
:Eugene Trounev [it-s]

==== KWin ====
;Topic
:The present and future of the window manager component of the KDE Workspace.

;Duration
:All week

;Facilitator
:

;Presentations
:Areas In Which Plasma Desktop Should Get Out of the Way and KWin Should Step In, Aaron, Day ?

;Participants
:Nuno Pinheiro
:Marco
:Aaron Seigo
:Eugene Trounev [it-s]

==== Application Menus ====
;Topic
:Sharing Application Menu specific code, Nepomuk integration, new menu structure (TOM?)

;Duration
:Half-day

;Facilitator
:Lukas

;Presentations
:

;Participants
:Lukas
:Ivan Čukić
:Riccardo
:Dario
:Nuno Pinheiro
:Eugene Trounev [it-s]

==== Network Management ====
;Topic
:Finishing the Network Management component in Plasma

;Goal
:Get very close to a first releasable version, make it ready for move into a released module

;Duration
: 4 days (?!?)

;Facilitator
: sebas

;Participants
:Will
:Kevin
:Aurelien (remote)
:Shantanu (remote)
:sebas

===Socials===
Saturday - thai buffet?

On Tuesday there will be a dinner sponsored by openSUSE at Herr Lenz restaurant

Thursday - End of Tokamak party at Downtown?

=== Open Tokamak ===
On Saturday we'll also plan the presentations, If there will be enough interests some talks could be redone/improvised for the public.

On Monday, we'll have an Open Evening at Tokamak. Visitors are welcome to join us that evening for presentations. See [http://news.opensuse.org/2010/02/11/meet-the-kde-plasma-developers-at-suse-feb-22 openSUSE News] for details.

Projects/Plasma/Tokamak4

2010-01-05T11:10:15Z

Sebas: add open day stuff

==Tokamak 4 Oxygen 3 2010==

The fourth Tokamak Plasma Meeting and the third Oxygen Gathering will take place in Nuremberg, Germany on February 19th to 26th.

===Location===

We will be hosted by Novell in the OpenSuse community space in Nuremberg. Details forthcoming.

===Accomodation===

TBD

===Traveling===

==Participants==
=== Participants ===
{| class="wikitable" border="1"
!Name
!Email
!Arrival
!Depart
!Cost
!Sponsor?
!Hotel?
!Food
!Work
!Airport
!Flights
|-
|Aaron Seigo
|aseigo@kde.org
|TBD
|TBD
|~$1300?
|yes
|yes
|vegetarian
|Overall facilitation
|-
|Marco Martin
|notmart@gmail.com
|TBD
|TBD
|~100€
|yes
|yes
|whatever
|whatever coding and else
|-
|Ivan Cukic
|ivan.cukic@kde.org
|19.2
|26.2
|approx €250
|yes
|yes
|whatever
|whatever coding and else
|-
|Artur de Souza
|asouza@kde.org
|TBD
|TBD
|~1000 euros
|yes
|yes
|whatever
|coding, mobile, bug fixing, etc...
|-
|Nuno Pinheiro
|nuno@oxygen-icons.org
|19
|24
|aprox 250€
|yes
|yes
|whatever
|whatever artwork, mobile, planing, etc....
|-
|Chani
|chani@kde.org
|TBD
|TBD
|~$1300
|yes
|yes
|vegetarian
|activity management / js / random bugs
|-
|Martin Gräßlin
|kde@martin-graesslin.com
|19.
|21.
|0
|no
|yes
|
|KWin on embedded devices
|-
|Lukas Appelhans
|l.appelhans@gmx.de
|19.
|TBD but maybe 21.
|~150€
|yes
|yes
|whatever
|Quicklaunch-Applet, KGet-Applets, Shaman/Aqpm-Applets, Raptor?
|-
|Frank Karlitschek
|karlitschek@kde.org
|TBD
|TBD
|TBD
|yes
|yes
|whatever
|Social Desktop
|-
|Dario Freddi
|drf@kde.org
|19
|TBD, probably 21-22
|TBD, I suppose ~150-200€
|yes
|yes
|whatever
|stuff that nobody wants to do, as usual
|-
|Riccardo Iaconelli
|riccardo@kde.org
|TBD, very probably 19
|TBD, probably 24? (depends on school)
|TBD, I suppose ~150-200€
|yes
|yes
|whatever
|plasmoids, art, ideas, fun :-)
|-
|Sebastian Kügler
|sebas@kde.org
|19th
|probably 27th
|~100€
|yes
|yes
|whatever
|Power- and networkmanagement, web integration, PIM stuff
|-
|Davide Bettio
|davide.bettio@kdemail.net
|TBD, probably 19th
|TBD, I don't know
|TBD, I suppose ~150-200€
|yes
|yes
|whatever
|TBD
|-
|Will Stephenson
|wstephenson@kde.org
|Local
|Local
|0
|no
|no
|whatever
|Keeping everyone else happy, networkmanagement
|N/A
|I can see the venue from my kitchen
|-
|Eugene Trounev
|eugene.trouenv@gmail.com
|19-11:15
|26-11:50
|$1,126.97 CAD
|yes
|yes
|no meat. fish, eggs, and milk are OK
|various artowrk (like wallpapers), designs and more
|Nuremberg(NUE)
|In AC9268/Out AC9195
|-
|Hugo Pereira Da Costa
|hugo@oxygen-icons.org
|TBD
|TBD
|Plain ticket, from NY. Not checked yet
|yes
|yes
|wathever
|Meeting people, drinking beers with Nuno, hacking||
|-
|Igor Trindade Oliveira
|igor_trindade@yahoo.com.br
|TBD
|TBD
|~800 euros
|yes
|yes
|whatever
|coding, animations, netbook etc...
|-
|Frederik Gladhorn
|gladhorn@kde.org
|19.2.
|26.2.
|~50 euros
|yes
|yes
|whatever
|opendesktop integration
|-
|Martin Zilz
|oore.mofux@gmx.de
|TBD
|TBD
|~100 euros
|no
|yes
|whatever
|arts, ux, freaky out of the box stuff
|}

==Special Needs==
* Laptop/desktop for hacking with KDE trunk on it for: Lukas Appelhans

==Topics==

We will be focusing on the KDE SC 4.5 release of Plasma, with a particular attention on feature completion, polishing and quality improvements across the code base. Activities and Plasma Mobile will also be topics of interest.

Oxygen, finishing it up for 4.5 plans for the future.

===Opening Day Presentations===

===Development Topics===
* ZUI replacement in plasma-desktop
* Plasma Mobile
* Plasma Media Center
* Plasmate
* Applet handles as plugins?
* Moving the toolboxes out of libplasma
* Plasma::Storage
* Plasma wallpaper scripting

===Socials===

=== Open Tokamak ===
On Saturday, we'll have an Open Day at Tokamak. Visitors are welcome to join us that day, and possibly for evening/night-time activities. On Saturday we'll also plan the presentations.

Schedules/KDE4/4.4 Release Goals

2009-12-03T01:36:07Z

Sebas: /* PIM / Groupware */

This page reflects the changelog of KDE Software Compilation 4.4.

= Plasma Workspace =
== Basic Functionality and Work-flow ==
* Storage devices can now automatically be mounted
* Widgets can be published on the network and be accessed remotely
* Desktop configuration is now scriptable using JavaScript
* Browsing through recent notifications
* Work-flow and layout improvements in the device manager widget
* System tray items can now be automatically shown or hidden
* New Plasma Netbook shell (Technology Preview)
* Applets can now be associated to an application (e.g. picture frame with gwenview, etc.) Makes it possible to open the associated application using an icon on the hover bar
* Mouse action plugins allow flexible interaction configuration
* New widget explorer improves the work-flow of adding widgets to the desktop
* Plasma widgets can now be added to the system tray
* Wallpapers can now be set using drag&drop
** Support for dropping remote content to use as wallpapers or create a desktop widget
* KNetworkmanager: new Network Management frontend
** Additionally, a richer Plasma widget as technology preview

== User Interface ==
* Kinetic scrolling
* Taskbar entries, window buttons and other elements of the Plasma interface now have sublte animations
* Animation of popups uses OpenGL for animations
* Improved KMix on-screen display
* Improved layout for the battery widget's popup
* Taskbar previews are now clickable
* Desktop theme configuration has been moved to System Settings -> Style
* Plasma's default Air theme has been further polished and improved

== Window & Compositing Manager ==
* New: Window maximizing and tiling by snapping to the screen-edges ("Aero Snap")
* Native window tabs: Arbitrary windows can be grouped in tabs
* Window Management Plugin for KRunner
* Subtle animations in the window decoration, and other options to customize the window behavior
* Alt+Tab window switching improvements
* Improvements in present windows, flip switch, logout effect

== Other widgets and addons ==
===Widgets===
* NEW Blackboard: a simple paint canvas, it's possible to paint with the mouse or with multitouch events on platforms that supports them
* NEW KDE Observatory: keep track of the development of your favorite KDE projects
* NEW KIMPanel: KDE Input Method Panel for multibyte input
* NEW Knowledge Base: query the knowledgebase of opendesktop.org
* NEW On-screen keyboard
* NEW OpenDesktop.org Activities: activity infomration from opendesktop.org
* NEW Qalculate math expression evaluator, based on libqalculate
* NEW Spellcheck: a quick spell checking area
* NEW Webslice: a plasmoid displaying a part of a web page
* NEW Window list
* Battery: Improved layout, better support for bigger fonts
* Device notifier
** Visual revamp to make it look and feel more Plasma
** Supports non-removable volumes
** Can show/hide devices from the interface
** Popup autohides after 10s of inactivity
* Picture Frame: now supports loading and displaying of remote images
* Microblog: can view replies and direct messages
* Quicklaunch: ascending and descending sort for applications in quicklaunch applet.
* SystemTray
** Now can embed other Plasma widgets
** Supports the finalized version of the StatusNotifier specification
** Old notifications remains accessible for a while, separated by application name, browseable with a tabbar widget
* Tasks
** Clicking on a window preview now activates that window
** Mouse over on a window preview highlights the window if the highlight windows KWin effect is activated
** Control+click on a window group launches the KWin present windows effect if activated
** New taskbar animations
* Weather widget now supports wetter.com

=== KRunner ===
* NEW audioplayercontrol: control any MPRIS enabled audio application (amarok is the default)
* NEW plasma-desktop: "desktop console [script file]" triggers the interactive scripting window
* NEW solid: devices and hotplug support using Solid
* NEW mediawiki: generic mediawiki searching with .desktop files for wikipedia, techbase, wikitravel and userbase by default
* NEW windows: switch between and control windows and desktops
* Service runner: a query on a freedesktop application category, like "network" will show all applications of that category
* Bookmarks runner:
** The query "bookmarks" (or its translation) lists all the bookmarks
** Also supports Firefox' bookmarks
* Contacts runner: the query "contacts" shows all contacts

===Other===
* NEW Pastebin dataengine
* DataEngines can now also be written in JavaScript
* Image wallpaper combobox has been replaced with a nicer view.
* Image wallpaper offers 'Next Wallpaper Image' contextual action in slide-show mode.

= KDE Development Platform =
* KAuth: Authorization framework, harnesses PolicyKit, currently used in Font installer and System Activity
* Multitouch resize, rotate and move on platforms that support multitouch
* New high-level animation API in Plasma, based on Qt Kinetic
* Nepomuk Semantic Desktop:
** New Virtuoso storage backend, significantly faster and more scalable
** Nepomuk: KIO slave for querying Nepomuk resources
** Nepomuk is now able to search on non-mounted media
* libksane (scanner library): basic scanner support for Windows
* Improved exiv2 support in libkexiv2
* Printing: Add Odd/Even page selection and server-side page selection when using CUPS
* KDE integration of QtWebKit (cookies, proxies, etc. but not KPart)
* Thumbnail previews for Comicbook format
* New calendar systems: Indian Civil (Saka), Pure Julian, Pure Gregorian

= KDE Applications =
== Basic ==
* Dolphin File Manager:
** Integrated searching
** Version control integration
** New timeline view, accessible as timeline:/, showing files by modification date
* Gwenview Image Viewer
** Image thumbnails on Folders
** Reworked start page
** New picture importing tool

== PIM / Groupware ==
* KAddressbook now uses Akonadi for storing contacts
* KMail:
** Archiving of emails
** Improved recipient picker
** Searching by tag
** Clickable HTML statusbar
** Collapsible recipient fields
** Error messages are now passive, less disturbant to workflow
** Templating improvements for e.g. signatures

== Accessibility ==
* KDE's text-to-speach subsystem now uses Speech Dispatcher for synthesis

== Educational & Games ==
* New Edu app: Cantor
* New Edu app: Rocs
* New game: Granatier (bomberman game)
* New game: Palapeli (puzzle game)
* KStars: new observation plan manager
* KAlgebra
** Support for lists
** Better MathML presentation support, lambda expressions, jump detections
** New 2d parametric function plotting

== Network ==
* Kopete: Create avatars from a webcam
* KRDC Remote Desktop Client:
** Telepathy Tubes support
** Full screen switching
* KGet Download Manager:
** better support for verification of downloaded files
** Broken downloads can be repaired
** Support for adding mirrors, moving and renaming files while downloading
** New assistant to create metalinks

== Utilities ==
* Okteta Hex Editor:
** NEW Analyzing/Editing with user-defineable data structure templates
** NEW Editing of values in the decoding table now possible
** NEW Split views
** NEW Storing of bookmarks

Schedules/KDE4/4.4 Release Goals

2009-12-03T01:35:15Z

Sebas: add gwenview

This page reflects the changelog of KDE Software Compilation 4.4.

= Plasma Workspace =
== Basic Functionality and Work-flow ==
* Storage devices can now automatically be mounted
* Widgets can be published on the network and be accessed remotely
* Desktop configuration is now scriptable using JavaScript
* Browsing through recent notifications
* Work-flow and layout improvements in the device manager widget
* System tray items can now be automatically shown or hidden
* New Plasma Netbook shell (Technology Preview)
* Applets can now be associated to an application (e.g. picture frame with gwenview, etc.) Makes it possible to open the associated application using an icon on the hover bar
* Mouse action plugins allow flexible interaction configuration
* New widget explorer improves the work-flow of adding widgets to the desktop
* Plasma widgets can now be added to the system tray
* Wallpapers can now be set using drag&drop
** Support for dropping remote content to use as wallpapers or create a desktop widget
* KNetworkmanager: new Network Management frontend
** Additionally, a richer Plasma widget as technology preview

== User Interface ==
* Kinetic scrolling
* Taskbar entries, window buttons and other elements of the Plasma interface now have sublte animations
* Animation of popups uses OpenGL for animations
* Improved KMix on-screen display
* Improved layout for the battery widget's popup
* Taskbar previews are now clickable
* Desktop theme configuration has been moved to System Settings -> Style
* Plasma's default Air theme has been further polished and improved

== Window & Compositing Manager ==
* New: Window maximizing and tiling by snapping to the screen-edges ("Aero Snap")
* Native window tabs: Arbitrary windows can be grouped in tabs
* Window Management Plugin for KRunner
* Subtle animations in the window decoration, and other options to customize the window behavior
* Alt+Tab window switching improvements
* Improvements in present windows, flip switch, logout effect

== Other widgets and addons ==
===Widgets===
* NEW Blackboard: a simple paint canvas, it's possible to paint with the mouse or with multitouch events on platforms that supports them
* NEW KDE Observatory: keep track of the development of your favorite KDE projects
* NEW KIMPanel: KDE Input Method Panel for multibyte input
* NEW Knowledge Base: query the knowledgebase of opendesktop.org
* NEW On-screen keyboard
* NEW OpenDesktop.org Activities: activity infomration from opendesktop.org
* NEW Qalculate math expression evaluator, based on libqalculate
* NEW Spellcheck: a quick spell checking area
* NEW Webslice: a plasmoid displaying a part of a web page
* NEW Window list
* Battery: Improved layout, better support for bigger fonts
* Device notifier
** Visual revamp to make it look and feel more Plasma
** Supports non-removable volumes
** Can show/hide devices from the interface
** Popup autohides after 10s of inactivity
* Picture Frame: now supports loading and displaying of remote images
* Microblog: can view replies and direct messages
* Quicklaunch: ascending and descending sort for applications in quicklaunch applet.
* SystemTray
** Now can embed other Plasma widgets
** Supports the finalized version of the StatusNotifier specification
** Old notifications remains accessible for a while, separated by application name, browseable with a tabbar widget
* Tasks
** Clicking on a window preview now activates that window
** Mouse over on a window preview highlights the window if the highlight windows KWin effect is activated
** Control+click on a window group launches the KWin present windows effect if activated
** New taskbar animations
* Weather widget now supports wetter.com

=== KRunner ===
* NEW audioplayercontrol: control any MPRIS enabled audio application (amarok is the default)
* NEW plasma-desktop: "desktop console [script file]" triggers the interactive scripting window
* NEW solid: devices and hotplug support using Solid
* NEW mediawiki: generic mediawiki searching with .desktop files for wikipedia, techbase, wikitravel and userbase by default
* NEW windows: switch between and control windows and desktops
* Service runner: a query on a freedesktop application category, like "network" will show all applications of that category
* Bookmarks runner:
** The query "bookmarks" (or its translation) lists all the bookmarks
** Also supports Firefox' bookmarks
* Contacts runner: the query "contacts" shows all contacts

===Other===
* NEW Pastebin dataengine
* DataEngines can now also be written in JavaScript
* Image wallpaper combobox has been replaced with a nicer view.
* Image wallpaper offers 'Next Wallpaper Image' contextual action in slide-show mode.

= KDE Development Platform =
* KAuth: Authorization framework, harnesses PolicyKit, currently used in Font installer and System Activity
* Multitouch resize, rotate and move on platforms that support multitouch
* New high-level animation API in Plasma, based on Qt Kinetic
* Nepomuk Semantic Desktop:
** New Virtuoso storage backend, significantly faster and more scalable
** Nepomuk: KIO slave for querying Nepomuk resources
** Nepomuk is now able to search on non-mounted media
* libksane (scanner library): basic scanner support for Windows
* Improved exiv2 support in libkexiv2
* Printing: Add Odd/Even page selection and server-side page selection when using CUPS
* KDE integration of QtWebKit (cookies, proxies, etc. but not KPart)
* Thumbnail previews for Comicbook format
* New calendar systems: Indian Civil (Saka), Pure Julian, Pure Gregorian

= KDE Applications =
== Basic ==
* Dolphin File Manager:
** Integrated searching
** Version control integration
** New timeline view, accessible as timeline:/, showing files by modification date
* Gwenview Image Viewer
** Image thumbnails on Folders
** Reworked start page
** New picture importing tool

== PIM / Groupware ==
* New: KAddressbook rewritten using Akonadi
* KMail:
** Archiving of emails
** Improved recipient picker
** searching by tag
** Clickable HTML statusbar
** Collapsible recipient fields
** Error messages are now passive, less disturbant to workflow
** Templating improvements for e.g. signatures

== Accessibility ==
* KDE's text-to-speach subsystem now uses Speech Dispatcher for synthesis

== Educational & Games ==
* New Edu app: Cantor
* New Edu app: Rocs
* New game: Granatier (bomberman game)
* New game: Palapeli (puzzle game)
* KStars: new observation plan manager
* KAlgebra
** Support for lists
** Better MathML presentation support, lambda expressions, jump detections
** New 2d parametric function plotting

== Network ==
* Kopete: Create avatars from a webcam
* KRDC Remote Desktop Client:
** Telepathy Tubes support
** Full screen switching
* KGet Download Manager:
** better support for verification of downloaded files
** Broken downloads can be repaired
** Support for adding mirrors, moving and renaming files while downloading
** New assistant to create metalinks

== Utilities ==
* Okteta Hex Editor:
** NEW Analyzing/Editing with user-defineable data structure templates
** NEW Editing of values in the decoding table now possible
** NEW Split views
** NEW Storing of bookmarks