KDE TechBase - User contributions [en]

Thread:Talk:Policies/Licensing Policy/license comparison online website

2012-12-02T23:12:37Z

Sreich: New thread: license comparison online website

I'm linking this here, though i'd prefer to see it on the main page, because i think it gives a good breakdown of what can and can't be done with licenses, etc.

http://www.tldrlegal.com/

and i also don't want to lose this website link ;)

Development/Tutorials/Plasma

2012-05-05T03:49:33Z

Sreich: /* QML */

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== QML ==
Plasmoids that use the QML (aka QtQuick) declarative language to describe their user interface while having the logic of the applet, in JavaScript (QML is essentially a forge between CSS and JavaScript).

This is now the '''recommended''' method of creating plasmoids, where possible. The plasmoid, or applet serves as the visualization for the data which a Plasma::DataEngine contains.

It allows easily the declaring of an interface and to easily create things like ListViews with native Plasma theming. It is what Plasma is leaning the most towards, especially in the Mobile, MediaCenter shells.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/Basic_ListView|Basic List Plasmoid]]
:''Make a QML ListView which displays basic text objects as items. Utilizes native Plasma theming and animations.''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''

== C++ ==

=== Plasmoids ===
;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

=== DataEngines ===

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

=== PackageStructures ===

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

=== Runners ===

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

=== Wallpapers ===

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/WallpaperDoubleBuffer|Wallpaper Tutorial 3]]
:''This tutorial improves the wallpaper by using the so-called 'double buffer' technique.''

=== Plasma Shells ===

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

== JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Python ==

=== Plasmoids ===
;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

=== DataEngines ===

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

=== Runners ===

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Ruby ==

=== Plasmoids ===

;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

=== DataEngines ===

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

== Web Technologies (HTML/JS/CSS) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration for applications ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Packages ==

;[[Development/Tutorials/Plasma/PackageOverview|Plasma Packages]]
:''An overview of what makes up a Plasma Package and what they are and can be used for.''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Pluginin C++]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

== Themes ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Templates ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject

2012-01-15T00:26:52Z

Sreich: /* Properties */

= 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

= 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; 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
* '''setActionSeparator(String name)''': (API v5) adds a separator item to the context menu
* '''removeAction(String name)''': removes the item with <name>

User:Sreich

2012-01-09T20:52:56Z

Sreich: Created page with "{{FeatureInProgress|Plasma|Create hard disk activity plasmoid (to monitor I/O a la cpu, net)|shaun.reich@kdemail.net|Shaun Reich}} {{FeatureTodo|Kate|Port sessions plasma applet..."

{{FeatureInProgress|Plasma|Create hard disk activity plasmoid (to monitor I/O a la cpu, net)|shaun.reich@kdemail.net|Shaun Reich}}

{{FeatureTodo|Kate|Port sessions plasma applet to QML|shaun.reich@kdemail.net|Shaun Reich}}

{{FeatureDone|Konqueror Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|Konsole Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureTodo|KDevelop Sessions Applet|Create/Port to QML|shaun.reich@kdemail.net|Shaun Reich}}

Schedules/KDE4/4.8 Feature Plan

2012-01-09T20:51:14Z

Sreich: oops..added stuff to this 4.8 schedule, yet they're items only planned for 4.8/master, since 4.8 is frozen

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__

 

= 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}}
{{FeatureInProgress|kcookiejar|New domain specific cookie policy based on patch provided in bug#54300|adawit@kde.org|Dawit A.}}
|}
 

= 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}}
{{FeatureInProgress|Plasma|Plasma QML QtComponents|mart@kde.org|Marco Martin}}
|}
 

= 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
{{FeatureTodo|KWin|Activity switcher|wstephenson@kde.org|Will Stephenson}}
{{FeatureTodo|Plasma|Activity UI improvements|wstephenson@kde.org|Will Stephenson}}
{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureDone|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}}
{{FeatureDone|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureDone|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
{{FeatureDone|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}}
{{FeatureInProgress|Plasma|Merge the QML version of the device notifier|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Merge the QML version of the battery applet|mart@kde.org|Marco Martin}}
{{FeatureDone|KWin|QML based Window switcher (Tabbox)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Texture Rectangle ARB support in Shaders|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|No Compositor restart on screen change|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Initial Wayland support|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Support for thumbnails in QML|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Add AnimationEffect class|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Option to prefer the mouse position over the focus chain|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureDone|KWin|More cleanup in the window rules kcm|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Trade 1 frame lag for deterministic framerate|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Improved resizing of windows with thin or no borders|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|KWin|Move Workspace's compositing functionality to own class Compositor|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|KWin|Introduce class DecorationPaintRedirector for decoration handling when Compositing is active|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|Screenlocker|New Screenlocker and daemon|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|Plasma|Merge IconTask's taskmanager changes|craig@kde.org|Craig Drummond}}
{{FeatureDone|KCM|Allow flag and label in keyboard layout indicator|arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|KSplash|QML based ksplash|mart@kde.org|Marco Martin/Ivan Čukić}}
|}
 

= 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}}
{{FeatureDone|Settings|Improve proxy configuration dialog|adawit@kde.org|Dawit Alemayehu}}
|}
 

= 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}}
{{FeatureDone|Rocs|Context menu for graph scene|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureInProgress|Cantor|Add Scilab backend|filip.saraiva@gmail.com|Filipe Saraiva}}
{{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|Marble Touch (GSoC, Marble on MeeGo/N9)|earthwings@gentoo.org|Daniel Marth, Dennis Nienhüser}}
{{FeatureDone|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}}
{{FeatureDone|Marble|Speedometer Plugin|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureDone|Marble|Plasma Runner for geo coords and Marble bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Make bookmark editor support editing the lonlat coordinates|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Fix GeoDataCoordinates parsing from a QString|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|OsmNominatim improved display|tgridel@freedorfr|Thibaut Gridel}}
{{FeatureTodo|Marble|Create New Marble About Dialog|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Add Float Item Management|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|New Search|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Make API more QML-friendly|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureTodo|KTurtle|Add modulo command|nielsslot@gmaildotcom|Niels Slot}}
{{FeatureDone|KGeography|Merge stuff from the cherry_field branch|aacid@kde.org|Albert Astals Cid}}
|}
 

= 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}}
{{FeatureDone|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}}
{{FeatureDone|KSudoku|Re-implement the puzzle-symmetry feature.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|KGoldrunner|Add the championship level "Gold Rush" game, with Traditional rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|Okular|Viewer Mode & Interface.|michel.ludwig@kdemail.net|Michel Ludwig}}
{{FeatureDone|Okular|Table selection tool improvements|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|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

{{FeatureTodo|JuK|MPRIS2 support|alex.merry@kdemail.net|Alex Merry}}
|}
 

= 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}}
{{FeatureInProgress|Kopete|Akonadi History Plugin |roideuniverse@gmail.com|Kaushik Saurabh}}
|}
 

= 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}}

{{FeatureDone
|HTML Replies
|Give messagecomposer (especially for KMail) the ability to compose replies in HTML
|nyblom@kde.org|Torgny Nyblom}}

{{FeatureInProgress|KMail import|KMail1 setup import instead of migration|krammer@kde.org|Kevin Krammer}}

{{FeatureInProgress|Agent control workspace integration|Monitoring and control of Akonadi agents through Plasma workspace facilitites|krammer@kde.org|Kevin Krammer}}

|}

 

= 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}}
{{FeatureDone|IconTasks|Import IconTasks|craig@kde.org|Craig Drummond}}
|}
 

= 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|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}}
{{FeatureDone|KCachegrind|Upgrade interface to Callgrind (use callgrind_control instead of writing a command file, for > VG 3.7.x)|Josef.Weidendorfer@gmx.de|Josef Weidendorfer}}
|}

 

= 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
{{FeatureDone|ark|Allow Ark to be used as a KPart again|rakuco@FreeBSD.org|Raphael Kubo da Costa}}
{{FeatureInProgress|ksecrets|A suite of tools related to the KSecretsService infrastructure|kde@rusu.info|Valentin Rusu}}
|}

Schedules/KDE4/4.8 Feature Plan

2012-01-09T20:47:13Z

Sreich: /* kde-baseapps */

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__

 

= 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}}
{{FeatureInProgress|kcookiejar|New domain specific cookie policy based on patch provided in bug#54300|adawit@kde.org|Dawit A.}}
|}
 

= 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}}
{{FeatureInProgress|Plasma|Plasma QML QtComponents|mart@kde.org|Marco Martin}}
|}
 

= 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
{{FeatureTodo|KWin|Activity switcher|wstephenson@kde.org|Will Stephenson}}
{{FeatureTodo|Plasma|Activity UI improvements|wstephenson@kde.org|Will Stephenson}}
{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureDone|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}}
{{FeatureDone|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureDone|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
{{FeatureDone|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}}
{{FeatureInProgress|Plasma|Merge the QML version of the device notifier|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Merge the QML version of the battery applet|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Create hard disk activity plasmoid (to monitor I/O a la cpu, net)|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|KWin|QML based Window switcher (Tabbox)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Texture Rectangle ARB support in Shaders|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|No Compositor restart on screen change|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Initial Wayland support|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Support for thumbnails in QML|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Add AnimationEffect class|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Option to prefer the mouse position over the focus chain|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureDone|KWin|More cleanup in the window rules kcm|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Trade 1 frame lag for deterministic framerate|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Improved resizing of windows with thin or no borders|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|KWin|Move Workspace's compositing functionality to own class Compositor|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|KWin|Introduce class DecorationPaintRedirector for decoration handling when Compositing is active|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|Screenlocker|New Screenlocker and daemon|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|Plasma|Merge IconTask's taskmanager changes|craig@kde.org|Craig Drummond}}
{{FeatureDone|KCM|Allow flag and label in keyboard layout indicator|arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|KSplash|QML based ksplash|mart@kde.org|Marco Martin/Ivan Čukić}}
|}
 

= 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}}
{{FeatureDone|Settings|Improve proxy configuration dialog|adawit@kde.org|Dawit Alemayehu}}
{{FeatureTodo|Kate|Port sessions plasma applet to QML|shaun.reich@kdemail.net|Shaun Reich}}
|}
 

= 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}}
{{FeatureDone|Rocs|Context menu for graph scene|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureInProgress|Cantor|Add Scilab backend|filip.saraiva@gmail.com|Filipe Saraiva}}
{{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|Marble Touch (GSoC, Marble on MeeGo/N9)|earthwings@gentoo.org|Daniel Marth, Dennis Nienhüser}}
{{FeatureDone|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}}
{{FeatureDone|Marble|Speedometer Plugin|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureDone|Marble|Plasma Runner for geo coords and Marble bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Make bookmark editor support editing the lonlat coordinates|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Fix GeoDataCoordinates parsing from a QString|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|OsmNominatim improved display|tgridel@freedorfr|Thibaut Gridel}}
{{FeatureTodo|Marble|Create New Marble About Dialog|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Add Float Item Management|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|New Search|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Make API more QML-friendly|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureTodo|KTurtle|Add modulo command|nielsslot@gmaildotcom|Niels Slot}}
{{FeatureDone|KGeography|Merge stuff from the cherry_field branch|aacid@kde.org|Albert Astals Cid}}
|}
 

= 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}}
{{FeatureDone|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}}
{{FeatureDone|KSudoku|Re-implement the puzzle-symmetry feature.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|KGoldrunner|Add the championship level "Gold Rush" game, with Traditional rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|Okular|Viewer Mode & Interface.|michel.ludwig@kdemail.net|Michel Ludwig}}
{{FeatureDone|Okular|Table selection tool improvements|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|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

{{FeatureTodo|JuK|MPRIS2 support|alex.merry@kdemail.net|Alex Merry}}
|}
 

= 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}}
{{FeatureInProgress|Kopete|Akonadi History Plugin |roideuniverse@gmail.com|Kaushik Saurabh}}
|}
 

= 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}}

{{FeatureDone
|HTML Replies
|Give messagecomposer (especially for KMail) the ability to compose replies in HTML
|nyblom@kde.org|Torgny Nyblom}}

{{FeatureInProgress|KMail import|KMail1 setup import instead of migration|krammer@kde.org|Kevin Krammer}}

{{FeatureInProgress|Agent control workspace integration|Monitoring and control of Akonadi agents through Plasma workspace facilitites|krammer@kde.org|Kevin Krammer}}

|}

 

= 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}}
{{FeatureDone|IconTasks|Import IconTasks|craig@kde.org|Craig Drummond}}
{{FeatureDone|Konqueror Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|Konsole Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureTodo|KDevelop Sessions Applet|Create/Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
|}
 

= 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|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}}
{{FeatureDone|KCachegrind|Upgrade interface to Callgrind (use callgrind_control instead of writing a command file, for > VG 3.7.x)|Josef.Weidendorfer@gmx.de|Josef Weidendorfer}}
|}

 

= 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
{{FeatureDone|ark|Allow Ark to be used as a KPart again|rakuco@FreeBSD.org|Raphael Kubo da Costa}}
{{FeatureInProgress|ksecrets|A suite of tools related to the KSecretsService infrastructure|kde@rusu.info|Valentin Rusu}}
|}

Schedules/KDE4/4.8 Feature Plan

2012-01-09T20:47:02Z

Sreich: /* kdeplasma-addons */

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__

 

= 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}}
{{FeatureInProgress|kcookiejar|New domain specific cookie policy based on patch provided in bug#54300|adawit@kde.org|Dawit A.}}
|}
 

= 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}}
{{FeatureInProgress|Plasma|Plasma QML QtComponents|mart@kde.org|Marco Martin}}
|}
 

= 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
{{FeatureTodo|KWin|Activity switcher|wstephenson@kde.org|Will Stephenson}}
{{FeatureTodo|Plasma|Activity UI improvements|wstephenson@kde.org|Will Stephenson}}
{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureDone|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}}
{{FeatureDone|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureDone|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
{{FeatureDone|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}}
{{FeatureInProgress|Plasma|Merge the QML version of the device notifier|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Merge the QML version of the battery applet|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Create hard disk activity plasmoid (to monitor I/O a la cpu, net)|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|KWin|QML based Window switcher (Tabbox)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Texture Rectangle ARB support in Shaders|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|No Compositor restart on screen change|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Initial Wayland support|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Support for thumbnails in QML|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Add AnimationEffect class|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Option to prefer the mouse position over the focus chain|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureDone|KWin|More cleanup in the window rules kcm|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Trade 1 frame lag for deterministic framerate|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Improved resizing of windows with thin or no borders|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|KWin|Move Workspace's compositing functionality to own class Compositor|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|KWin|Introduce class DecorationPaintRedirector for decoration handling when Compositing is active|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|Screenlocker|New Screenlocker and daemon|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|Plasma|Merge IconTask's taskmanager changes|craig@kde.org|Craig Drummond}}
{{FeatureDone|KCM|Allow flag and label in keyboard layout indicator|arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|KSplash|QML based ksplash|mart@kde.org|Marco Martin/Ivan Čukić}}
|}
 

= 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}}
{{FeatureDone|Settings|Improve proxy configuration dialog|adawit@kde.org|Dawit Alemayehu}}
{{FeatureToDo|Kate|Port sessions plasma applet to QML|shaun.reich@kdemail.net|Shaun Reich}}
|}
 

= 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}}
{{FeatureDone|Rocs|Context menu for graph scene|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureInProgress|Cantor|Add Scilab backend|filip.saraiva@gmail.com|Filipe Saraiva}}
{{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|Marble Touch (GSoC, Marble on MeeGo/N9)|earthwings@gentoo.org|Daniel Marth, Dennis Nienhüser}}
{{FeatureDone|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}}
{{FeatureDone|Marble|Speedometer Plugin|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureDone|Marble|Plasma Runner for geo coords and Marble bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Make bookmark editor support editing the lonlat coordinates|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Fix GeoDataCoordinates parsing from a QString|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|OsmNominatim improved display|tgridel@freedorfr|Thibaut Gridel}}
{{FeatureTodo|Marble|Create New Marble About Dialog|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Add Float Item Management|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|New Search|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Make API more QML-friendly|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureTodo|KTurtle|Add modulo command|nielsslot@gmaildotcom|Niels Slot}}
{{FeatureDone|KGeography|Merge stuff from the cherry_field branch|aacid@kde.org|Albert Astals Cid}}
|}
 

= 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}}
{{FeatureDone|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}}
{{FeatureDone|KSudoku|Re-implement the puzzle-symmetry feature.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|KGoldrunner|Add the championship level "Gold Rush" game, with Traditional rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|Okular|Viewer Mode & Interface.|michel.ludwig@kdemail.net|Michel Ludwig}}
{{FeatureDone|Okular|Table selection tool improvements|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|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

{{FeatureTodo|JuK|MPRIS2 support|alex.merry@kdemail.net|Alex Merry}}
|}
 

= 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}}
{{FeatureInProgress|Kopete|Akonadi History Plugin |roideuniverse@gmail.com|Kaushik Saurabh}}
|}
 

= 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}}

{{FeatureDone
|HTML Replies
|Give messagecomposer (especially for KMail) the ability to compose replies in HTML
|nyblom@kde.org|Torgny Nyblom}}

{{FeatureInProgress|KMail import|KMail1 setup import instead of migration|krammer@kde.org|Kevin Krammer}}

{{FeatureInProgress|Agent control workspace integration|Monitoring and control of Akonadi agents through Plasma workspace facilitites|krammer@kde.org|Kevin Krammer}}

|}

 

= 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}}
{{FeatureDone|IconTasks|Import IconTasks|craig@kde.org|Craig Drummond}}
{{FeatureDone|Konqueror Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|Konsole Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureTodo|KDevelop Sessions Applet|Create/Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
|}
 

= 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|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}}
{{FeatureDone|KCachegrind|Upgrade interface to Callgrind (use callgrind_control instead of writing a command file, for > VG 3.7.x)|Josef.Weidendorfer@gmx.de|Josef Weidendorfer}}
|}

 

= 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
{{FeatureDone|ark|Allow Ark to be used as a KPart again|rakuco@FreeBSD.org|Raphael Kubo da Costa}}
{{FeatureInProgress|ksecrets|A suite of tools related to the KSecretsService infrastructure|kde@rusu.info|Valentin Rusu}}
|}

Schedules/KDE4/4.8 Feature Plan

2012-01-09T20:45:12Z

Sreich: /* kdeplasma-addons */

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__

 

= 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}}
{{FeatureInProgress|kcookiejar|New domain specific cookie policy based on patch provided in bug#54300|adawit@kde.org|Dawit A.}}
|}
 

= 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}}
{{FeatureInProgress|Plasma|Plasma QML QtComponents|mart@kde.org|Marco Martin}}
|}
 

= 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
{{FeatureTodo|KWin|Activity switcher|wstephenson@kde.org|Will Stephenson}}
{{FeatureTodo|Plasma|Activity UI improvements|wstephenson@kde.org|Will Stephenson}}
{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureDone|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}}
{{FeatureDone|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureDone|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
{{FeatureDone|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}}
{{FeatureInProgress|Plasma|Merge the QML version of the device notifier|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Merge the QML version of the battery applet|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Create hard disk activity plasmoid (to monitor I/O a la cpu, net)|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|KWin|QML based Window switcher (Tabbox)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Texture Rectangle ARB support in Shaders|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|No Compositor restart on screen change|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Initial Wayland support|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Support for thumbnails in QML|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Add AnimationEffect class|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Option to prefer the mouse position over the focus chain|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureDone|KWin|More cleanup in the window rules kcm|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Trade 1 frame lag for deterministic framerate|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Improved resizing of windows with thin or no borders|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|KWin|Move Workspace's compositing functionality to own class Compositor|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|KWin|Introduce class DecorationPaintRedirector for decoration handling when Compositing is active|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|Screenlocker|New Screenlocker and daemon|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|Plasma|Merge IconTask's taskmanager changes|craig@kde.org|Craig Drummond}}
{{FeatureDone|KCM|Allow flag and label in keyboard layout indicator|arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|KSplash|QML based ksplash|mart@kde.org|Marco Martin/Ivan Čukić}}
|}
 

= 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}}
{{FeatureDone|Settings|Improve proxy configuration dialog|adawit@kde.org|Dawit Alemayehu}}
{{FeatureToDo|Kate|Port sessions plasma applet to QML|shaun.reich@kdemail.net|Shaun Reich}}
|}
 

= 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}}
{{FeatureDone|Rocs|Context menu for graph scene|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureInProgress|Cantor|Add Scilab backend|filip.saraiva@gmail.com|Filipe Saraiva}}
{{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|Marble Touch (GSoC, Marble on MeeGo/N9)|earthwings@gentoo.org|Daniel Marth, Dennis Nienhüser}}
{{FeatureDone|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}}
{{FeatureDone|Marble|Speedometer Plugin|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureDone|Marble|Plasma Runner for geo coords and Marble bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Make bookmark editor support editing the lonlat coordinates|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Fix GeoDataCoordinates parsing from a QString|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|OsmNominatim improved display|tgridel@freedorfr|Thibaut Gridel}}
{{FeatureTodo|Marble|Create New Marble About Dialog|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Add Float Item Management|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|New Search|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Make API more QML-friendly|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureTodo|KTurtle|Add modulo command|nielsslot@gmaildotcom|Niels Slot}}
{{FeatureDone|KGeography|Merge stuff from the cherry_field branch|aacid@kde.org|Albert Astals Cid}}
|}
 

= 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}}
{{FeatureDone|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}}
{{FeatureDone|KSudoku|Re-implement the puzzle-symmetry feature.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|KGoldrunner|Add the championship level "Gold Rush" game, with Traditional rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|Okular|Viewer Mode & Interface.|michel.ludwig@kdemail.net|Michel Ludwig}}
{{FeatureDone|Okular|Table selection tool improvements|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|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

{{FeatureTodo|JuK|MPRIS2 support|alex.merry@kdemail.net|Alex Merry}}
|}
 

= 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}}
{{FeatureInProgress|Kopete|Akonadi History Plugin |roideuniverse@gmail.com|Kaushik Saurabh}}
|}
 

= 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}}

{{FeatureDone
|HTML Replies
|Give messagecomposer (especially for KMail) the ability to compose replies in HTML
|nyblom@kde.org|Torgny Nyblom}}

{{FeatureInProgress|KMail import|KMail1 setup import instead of migration|krammer@kde.org|Kevin Krammer}}

{{FeatureInProgress|Agent control workspace integration|Monitoring and control of Akonadi agents through Plasma workspace facilitites|krammer@kde.org|Kevin Krammer}}

|}

 

= 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}}
{{FeatureDone|IconTasks|Import IconTasks|craig@kde.org|Craig Drummond}}
{{FeatureDone|Konqueror Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|Konsole Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureToDo|KDevelop Sessions Applet|Create/Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
|}
 

= 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|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}}
{{FeatureDone|KCachegrind|Upgrade interface to Callgrind (use callgrind_control instead of writing a command file, for > VG 3.7.x)|Josef.Weidendorfer@gmx.de|Josef Weidendorfer}}
|}

 

= 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
{{FeatureDone|ark|Allow Ark to be used as a KPart again|rakuco@FreeBSD.org|Raphael Kubo da Costa}}
{{FeatureInProgress|ksecrets|A suite of tools related to the KSecretsService infrastructure|kde@rusu.info|Valentin Rusu}}
|}

Schedules/KDE4/4.8 Feature Plan

2012-01-09T20:44:35Z

Sreich: /* kde-baseapps */

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__

 

= 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}}
{{FeatureInProgress|kcookiejar|New domain specific cookie policy based on patch provided in bug#54300|adawit@kde.org|Dawit A.}}
|}
 

= 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}}
{{FeatureInProgress|Plasma|Plasma QML QtComponents|mart@kde.org|Marco Martin}}
|}
 

= 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
{{FeatureTodo|KWin|Activity switcher|wstephenson@kde.org|Will Stephenson}}
{{FeatureTodo|Plasma|Activity UI improvements|wstephenson@kde.org|Will Stephenson}}
{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureDone|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}}
{{FeatureDone|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureDone|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
{{FeatureDone|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}}
{{FeatureInProgress|Plasma|Merge the QML version of the device notifier|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Merge the QML version of the battery applet|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Create hard disk activity plasmoid (to monitor I/O a la cpu, net)|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|KWin|QML based Window switcher (Tabbox)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Texture Rectangle ARB support in Shaders|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|No Compositor restart on screen change|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Initial Wayland support|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Support for thumbnails in QML|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Add AnimationEffect class|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Option to prefer the mouse position over the focus chain|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureDone|KWin|More cleanup in the window rules kcm|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Trade 1 frame lag for deterministic framerate|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Improved resizing of windows with thin or no borders|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|KWin|Move Workspace's compositing functionality to own class Compositor|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|KWin|Introduce class DecorationPaintRedirector for decoration handling when Compositing is active|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|Screenlocker|New Screenlocker and daemon|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|Plasma|Merge IconTask's taskmanager changes|craig@kde.org|Craig Drummond}}
{{FeatureDone|KCM|Allow flag and label in keyboard layout indicator|arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|KSplash|QML based ksplash|mart@kde.org|Marco Martin/Ivan Čukić}}
|}
 

= 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}}
{{FeatureDone|Settings|Improve proxy configuration dialog|adawit@kde.org|Dawit Alemayehu}}
{{FeatureToDo|Kate|Port sessions plasma applet to QML|shaun.reich@kdemail.net|Shaun Reich}}
|}
 

= 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}}
{{FeatureDone|Rocs|Context menu for graph scene|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureInProgress|Cantor|Add Scilab backend|filip.saraiva@gmail.com|Filipe Saraiva}}
{{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|Marble Touch (GSoC, Marble on MeeGo/N9)|earthwings@gentoo.org|Daniel Marth, Dennis Nienhüser}}
{{FeatureDone|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}}
{{FeatureDone|Marble|Speedometer Plugin|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureDone|Marble|Plasma Runner for geo coords and Marble bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Make bookmark editor support editing the lonlat coordinates|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Fix GeoDataCoordinates parsing from a QString|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|OsmNominatim improved display|tgridel@freedorfr|Thibaut Gridel}}
{{FeatureTodo|Marble|Create New Marble About Dialog|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Add Float Item Management|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|New Search|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Make API more QML-friendly|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureTodo|KTurtle|Add modulo command|nielsslot@gmaildotcom|Niels Slot}}
{{FeatureDone|KGeography|Merge stuff from the cherry_field branch|aacid@kde.org|Albert Astals Cid}}
|}
 

= 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}}
{{FeatureDone|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}}
{{FeatureDone|KSudoku|Re-implement the puzzle-symmetry feature.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|KGoldrunner|Add the championship level "Gold Rush" game, with Traditional rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|Okular|Viewer Mode & Interface.|michel.ludwig@kdemail.net|Michel Ludwig}}
{{FeatureDone|Okular|Table selection tool improvements|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|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

{{FeatureTodo|JuK|MPRIS2 support|alex.merry@kdemail.net|Alex Merry}}
|}
 

= 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}}
{{FeatureInProgress|Kopete|Akonadi History Plugin |roideuniverse@gmail.com|Kaushik Saurabh}}
|}
 

= 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}}

{{FeatureDone
|HTML Replies
|Give messagecomposer (especially for KMail) the ability to compose replies in HTML
|nyblom@kde.org|Torgny Nyblom}}

{{FeatureInProgress|KMail import|KMail1 setup import instead of migration|krammer@kde.org|Kevin Krammer}}

{{FeatureInProgress|Agent control workspace integration|Monitoring and control of Akonadi agents through Plasma workspace facilitites|krammer@kde.org|Kevin Krammer}}

|}

 

= 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}}
{{FeatureDone|IconTasks|Import IconTasks|craig@kde.org|Craig Drummond}}
{{FeatureDone|Konqueror Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|Konsole Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
|}
 

= 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|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}}
{{FeatureDone|KCachegrind|Upgrade interface to Callgrind (use callgrind_control instead of writing a command file, for > VG 3.7.x)|Josef.Weidendorfer@gmx.de|Josef Weidendorfer}}
|}

 

= 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
{{FeatureDone|ark|Allow Ark to be used as a KPart again|rakuco@FreeBSD.org|Raphael Kubo da Costa}}
{{FeatureInProgress|ksecrets|A suite of tools related to the KSecretsService infrastructure|kde@rusu.info|Valentin Rusu}}
|}

Schedules/KDE4/4.8 Feature Plan

2012-01-09T20:41:05Z

Sreich: /* kdeplasma-addons */ add konsole, konq profiles qml

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__

 

= 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}}
{{FeatureInProgress|kcookiejar|New domain specific cookie policy based on patch provided in bug#54300|adawit@kde.org|Dawit A.}}
|}
 

= 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}}
{{FeatureInProgress|Plasma|Plasma QML QtComponents|mart@kde.org|Marco Martin}}
|}
 

= 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
{{FeatureTodo|KWin|Activity switcher|wstephenson@kde.org|Will Stephenson}}
{{FeatureTodo|Plasma|Activity UI improvements|wstephenson@kde.org|Will Stephenson}}
{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureDone|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}}
{{FeatureDone|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureDone|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
{{FeatureDone|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}}
{{FeatureInProgress|Plasma|Merge the QML version of the device notifier|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Merge the QML version of the battery applet|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Create hard disk activity plasmoid (to monitor I/O a la cpu, net)|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|KWin|QML based Window switcher (Tabbox)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Texture Rectangle ARB support in Shaders|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|No Compositor restart on screen change|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Initial Wayland support|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Support for thumbnails in QML|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Add AnimationEffect class|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Option to prefer the mouse position over the focus chain|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureDone|KWin|More cleanup in the window rules kcm|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Trade 1 frame lag for deterministic framerate|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Improved resizing of windows with thin or no borders|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|KWin|Move Workspace's compositing functionality to own class Compositor|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|KWin|Introduce class DecorationPaintRedirector for decoration handling when Compositing is active|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|Screenlocker|New Screenlocker and daemon|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|Plasma|Merge IconTask's taskmanager changes|craig@kde.org|Craig Drummond}}
{{FeatureDone|KCM|Allow flag and label in keyboard layout indicator|arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|KSplash|QML based ksplash|mart@kde.org|Marco Martin/Ivan Čukić}}
|}
 

= 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}}
{{FeatureDone|Settings|Improve proxy configuration dialog|adawit@kde.org|Dawit Alemayehu}}
|}
 

= 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}}
{{FeatureDone|Rocs|Context menu for graph scene|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureInProgress|Cantor|Add Scilab backend|filip.saraiva@gmail.com|Filipe Saraiva}}
{{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|Marble Touch (GSoC, Marble on MeeGo/N9)|earthwings@gentoo.org|Daniel Marth, Dennis Nienhüser}}
{{FeatureDone|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}}
{{FeatureDone|Marble|Speedometer Plugin|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureDone|Marble|Plasma Runner for geo coords and Marble bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Make bookmark editor support editing the lonlat coordinates|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Fix GeoDataCoordinates parsing from a QString|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|OsmNominatim improved display|tgridel@freedorfr|Thibaut Gridel}}
{{FeatureTodo|Marble|Create New Marble About Dialog|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Add Float Item Management|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|New Search|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Make API more QML-friendly|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureTodo|KTurtle|Add modulo command|nielsslot@gmaildotcom|Niels Slot}}
{{FeatureDone|KGeography|Merge stuff from the cherry_field branch|aacid@kde.org|Albert Astals Cid}}
|}
 

= 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}}
{{FeatureDone|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}}
{{FeatureDone|KSudoku|Re-implement the puzzle-symmetry feature.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|KGoldrunner|Add the championship level "Gold Rush" game, with Traditional rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|Okular|Viewer Mode & Interface.|michel.ludwig@kdemail.net|Michel Ludwig}}
{{FeatureDone|Okular|Table selection tool improvements|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|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

{{FeatureTodo|JuK|MPRIS2 support|alex.merry@kdemail.net|Alex Merry}}
|}
 

= 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}}
{{FeatureInProgress|Kopete|Akonadi History Plugin |roideuniverse@gmail.com|Kaushik Saurabh}}
|}
 

= 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}}

{{FeatureDone
|HTML Replies
|Give messagecomposer (especially for KMail) the ability to compose replies in HTML
|nyblom@kde.org|Torgny Nyblom}}

{{FeatureInProgress|KMail import|KMail1 setup import instead of migration|krammer@kde.org|Kevin Krammer}}

{{FeatureInProgress|Agent control workspace integration|Monitoring and control of Akonadi agents through Plasma workspace facilitites|krammer@kde.org|Kevin Krammer}}

|}

 

= 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}}
{{FeatureDone|IconTasks|Import IconTasks|craig@kde.org|Craig Drummond}}
{{FeatureDone|Konqueror Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|Konsole Sessions Applet|Port to QML|shaun.reich@kdemail.net|Shaun Reich}}
|}
 

= 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|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}}
{{FeatureDone|KCachegrind|Upgrade interface to Callgrind (use callgrind_control instead of writing a command file, for > VG 3.7.x)|Josef.Weidendorfer@gmx.de|Josef Weidendorfer}}
|}

 

= 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
{{FeatureDone|ark|Allow Ark to be used as a KPart again|rakuco@FreeBSD.org|Raphael Kubo da Costa}}
{{FeatureInProgress|ksecrets|A suite of tools related to the KSecretsService infrastructure|kde@rusu.info|Valentin Rusu}}
|}

Schedules/KDE4/4.8 Feature Plan

2012-01-09T20:38:17Z

Sreich: /* kde-workspace */ add my hdd activity monitor

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__

 

= 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}}
{{FeatureInProgress|kcookiejar|New domain specific cookie policy based on patch provided in bug#54300|adawit@kde.org|Dawit A.}}
|}
 

= 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}}
{{FeatureInProgress|Plasma|Plasma QML QtComponents|mart@kde.org|Marco Martin}}
|}
 

= 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
{{FeatureTodo|KWin|Activity switcher|wstephenson@kde.org|Will Stephenson}}
{{FeatureTodo|Plasma|Activity UI improvements|wstephenson@kde.org|Will Stephenson}}
{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureDone|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}}
{{FeatureDone|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureDone|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
{{FeatureDone|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}}
{{FeatureInProgress|Plasma|Merge the QML version of the device notifier|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Merge the QML version of the battery applet|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Create hard disk activity plasmoid (to monitor I/O a la cpu, net)|shaun.reich@kdemail.net|Shaun Reich}}
{{FeatureDone|KWin|QML based Window switcher (Tabbox)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Texture Rectangle ARB support in Shaders|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|No Compositor restart on screen change|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|KWin|Initial Wayland support|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Support for thumbnails in QML|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|KWin|Add AnimationEffect class|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Option to prefer the mouse position over the focus chain|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureDone|KWin|More cleanup in the window rules kcm|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Trade 1 frame lag for deterministic framerate|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|KWin|Improved resizing of windows with thin or no borders|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|KWin|Move Workspace's compositing functionality to own class Compositor|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|KWin|Introduce class DecorationPaintRedirector for decoration handling when Compositing is active|a.arlt@stud.uni-heidelberg.de|Arthur Arlt}}
{{FeatureInProgress|Screenlocker|New Screenlocker and daemon|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureDone|Plasma|Merge IconTask's taskmanager changes|craig@kde.org|Craig Drummond}}
{{FeatureDone|KCM|Allow flag and label in keyboard layout indicator|arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|KSplash|QML based ksplash|mart@kde.org|Marco Martin/Ivan Čukić}}
|}
 

= 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}}
{{FeatureDone|Settings|Improve proxy configuration dialog|adawit@kde.org|Dawit Alemayehu}}
|}
 

= 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}}
{{FeatureDone|Rocs|Context menu for graph scene|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureInProgress|Cantor|Add Scilab backend|filip.saraiva@gmail.com|Filipe Saraiva}}
{{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|Marble Touch (GSoC, Marble on MeeGo/N9)|earthwings@gentoo.org|Daniel Marth, Dennis Nienhüser}}
{{FeatureDone|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}}
{{FeatureDone|Marble|Speedometer Plugin|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureDone|Marble|Plasma Runner for geo coords and Marble bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Make bookmark editor support editing the lonlat coordinates|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|Fix GeoDataCoordinates parsing from a QString|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|OsmNominatim improved display|tgridel@freedorfr|Thibaut Gridel}}
{{FeatureTodo|Marble|Create New Marble About Dialog|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Add Float Item Management|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|New Search|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Make API more QML-friendly|bbeschow@cs.tu-berlin.de|Bernhard Beschow}}
{{FeatureTodo|KTurtle|Add modulo command|nielsslot@gmaildotcom|Niels Slot}}
{{FeatureDone|KGeography|Merge stuff from the cherry_field branch|aacid@kde.org|Albert Astals Cid}}
|}
 

= 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}}
{{FeatureDone|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}}
{{FeatureDone|KSudoku|Re-implement the puzzle-symmetry feature.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|KGoldrunner|Add the championship level "Gold Rush" game, with Traditional rules, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|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}}
{{FeatureDone|Okular|Viewer Mode & Interface.|michel.ludwig@kdemail.net|Michel Ludwig}}
{{FeatureDone|Okular|Table selection tool improvements|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|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

{{FeatureTodo|JuK|MPRIS2 support|alex.merry@kdemail.net|Alex Merry}}
|}
 

= 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}}
{{FeatureInProgress|Kopete|Akonadi History Plugin |roideuniverse@gmail.com|Kaushik Saurabh}}
|}
 

= 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}}

{{FeatureDone
|HTML Replies
|Give messagecomposer (especially for KMail) the ability to compose replies in HTML
|nyblom@kde.org|Torgny Nyblom}}

{{FeatureInProgress|KMail import|KMail1 setup import instead of migration|krammer@kde.org|Kevin Krammer}}

{{FeatureInProgress|Agent control workspace integration|Monitoring and control of Akonadi agents through Plasma workspace facilitites|krammer@kde.org|Kevin Krammer}}

|}

 

= 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}}
{{FeatureDone|IconTasks|Import IconTasks|craig@kde.org|Craig Drummond}}
|}
 

= 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|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}}
{{FeatureDone|KCachegrind|Upgrade interface to Callgrind (use callgrind_control instead of writing a command file, for > VG 3.7.x)|Josef.Weidendorfer@gmx.de|Josef Weidendorfer}}
|}

 

= 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
{{FeatureDone|ark|Allow Ark to be used as a KPart again|rakuco@FreeBSD.org|Raphael Kubo da Costa}}
{{FeatureInProgress|ksecrets|A suite of tools related to the KSecretsService infrastructure|kde@rusu.info|Valentin Rusu}}
|}

Development/Git/Configuration

2011-12-27T05:29:45Z

Sreich: Add gitexcludes file documentation, now that I've added it to kdelibs master (well, frameworks branch apparently)

== Git Configuration ==

How to set up Git for use in KDE.

=== Quick Start ===

To quickly set up git to just build a copy of KDE you do not need to perform any git configuration, however the following steps will simplify using Git:

* [[../Configuration#URL_Renaming|URL Renaming]]

If you plan to commit to a KDE repository using Git then you should follow all the steps on this page.

=== Configuration Levels ===

Your Git configuration operates at 3 levels:
* System
* User
* Repository

The System Level sets up global Git configuration defaults for every User and Repository on your system. We will ignore these for our purposes as they are usually blank.

The User Level (aka Global) sets up the default configuration for a particular User to apply to all repositories used by that User. Settings made at this level will always override any matching System Level settings. The User Configuration is stored in your ~/.gitconfig file.

The Repository Level sets up the configuration for a particular Repository clone. Settings made at this level will always override any matching User or System Level settings. The Repository Configuration is stored in the repository .git/config file.

The recommended KDE Git Configuration will set some settings at a user level and some at a repository level. You may wish to change the level some settings apply at however as we will assume you only or mostly use Git for developing KDE.

You can set Git settings either by directly editing the config files, but it is far safer to use the ''git config'' command.

To set a Git setting at User level (i.e. in ~/.gitconfig):

git config --global <key> <value>

To set a Git setting at repo level (i.e in <repo>/.git/config):

cd <repo>
git config <key> <value>

=== Basic Settings ===

If you plan to commit to KDE Git, then you will need to set up git to use your identity.kde.org name and details to help identify your work:

git config --global user.name <Your Real Name>
git config --global user.email <Your identity.kde.org email>

The name and email address you configure will be used as the author information for every commit you make. Note that in order for commit message keywords such as BUG and CCBUG to work, your Bugzilla account email address has to match the email address used in your commits.

To enable colored output when using git:

git config --global color.ui true

=== Commit Template ===

The Commit Template is a standard layout for commit messages, usually containing instructions for how a project expects messages to formatted and what details are to be included. You can choose to set a User Level template as a default, then use any project level variations at a repo level.

It is recommended to use the kdelibs template as your default. Once you have cloned kdelibs then set as follows to ensure you use the latest available version:

git config --global commit.template <path/to/kdelibs/>.commit-template

If you don't plan to have kdelibs cloned then download the kdelibs template from [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/raw/.commit-template here], save as ~/.commit-template, and configure to use that copy:

git config --global commit.template ~/.commit-template

When cloning other KDE repositories, you should check to see if they have a project specific commit template, and if so you should set that at a repo level:

cd <repo>
git config commit.template .commit-template

=== Exclusion rules ===
It's often necessary or desirable to limit the types of files that git will consider when commands like 'git status' and 'git add' or 'git add --all' are run. There are 2 types of exclusion rules.

 

The first, is a .gitignore in the repository. This text file will contain a list of wildcard expressions to ignore files and/or dirs. It can also contain bash-like comments (#) in addition to new lines.

 

The second method is similar to the first, except it is specified globally and will override (and add to) settings specified on a per-repository basis. This file can be named whatever, wherever, as long as it is specified in your ~/.gitconfig file.
 

An example .gitexcludes file can be found in kdelibs from [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/raw/.gitexcludes here], save as ~/.gitexcludes, and configure to use that copy using:

git config --global core.excludesfile ~/.gitexcludes

 

or alternatively, edit ~/.gitconfig manually and specify:
 

[core]
excludesfile = ~/.gitexcludes
 

Remember that this file is meant to be a global exclusion rule, so you probably shouldn't use it on a per-repo basis unless you really feel the need. The file excludes archive files (tar, gz, 7z, rar, etc.) as well as .directory, thumbs.db(Microsoft Windows file), .swp (swap file, used for vim and kate), as well as many many others.

=== Push Default ===

It is recommended for new Git users to set the push default to nothing:

git config --global push.default nothing

This option forces you to ''always'' enter the name of the remote branch you wish to push to, rather than using a default value. This is good practice as it ensures you push to the correct remote branch and avoid accidentally pushing all local branches to the remote.

More experienced users may wish to set the option to tracking:

git config --global push.default tracking

This will default to push to the remote branch your local branch is tracking, but if you setup your local branch incorrectly you may still accidentally push to the wrong remote.

=== URL Renaming ===

Instead of having to remember and type in the different full git addresses for pulling and pushing, we recommend you manually add the following to your Git User Configuration (~/.gitconfig):

<nowiki>[url "git://anongit.kde.org/"]</nowiki>
insteadOf = kde:
[url "git@git.kde.org:"]
pushInsteadOf = kde:

=== Bash Auto-Completion ===

Bash auto-completion for Git commands and branches may or may not work out-of-the-box for you depending on how Git is installed on your system. To see if you have auto-completion already working type ''git'' on your command line followed by a space and hit the ''tab'' key twice. If you see a list of available git commands then you have Git auto-completion enabled.

If auto-completion does not work for you then you can download the [http://git.kernel.org/?p=git/git.git;a=blob_plain;f=contrib/completion/git-completion.bash;hb=HEAD git-completion.bash] script and follow the instructions inside it.

=== Bash Prompt ===

If you have git-completion.bash installed, you can also add details like the branch name and dirty status to your command prompt, which will save repeated uses of ''git branch'' and ''git status''.

To activate this, you need to add the following to your $PS1 environment variable:

$(__git_ps1 " (%s)")

Note that in the " (%s)" part the %s variable is replaced with the branch name, the rest of the text between the quotes is up to you.

If you have not set a PS1 value yourself, then you are likely to be using your distro default value which you can find out by typing:

echo $PS1

To change this for your user, edit your .bashrc and copy the result of the echo command into there, then change it to add the Git branch.

For example, if ''echo $PS1'' shows:

$(ppwd \l)\u@\h:\w>

then add the following to your .bashrc:

PS1='$(ppwd \l)\u@\h:\w$(__git_ps1 " (%s)")> '

which will show your prompt as follows:

odysseus@argo:~/kde/src/trunk/KDE/kdelibs (master + u+2)>

You can learn more about customizing your bash prompt at http://www.tldp.org/HOWTO/Bash-Prompt-HOWTO/.

You can also have the prompt show the 'dirty' status of your repo, i.e. if you have uncommited changes, and whether your branch differs from upstream HEAD:

* * = unstaged changes
* + = staged changes
* $ = stashed changes
* % = untracked files
* u-1 = behind upstream by 1 commit
* u+2 = ahead of upstream by 2 commits
* u= = same as upstream

To enable showing the dirty (unstaged/staged) state, add the following line to your .bashrc 'before' your PS1 setting:

export GIT_PS1_SHOWDIRTYSTATE=1

To enable showing the stashed state, add the following line to your .bashrc ''before'' your PS1 setting:

export GIT_PS1_SHOWSTASHSTATE=1

To enable showing the untracked state, add the following line to your .bashrc ''before'' your PS1 setting:

export GIT_PS1_SHOWUNTRACKEDFILES=1

To enable showing the upstream state, add the following line to your .bashrc ''before'' your PS1 setting:

export GIT_PS1_SHOWUPSTREAM="auto verbose"

To not show the number of commits ahead or behind remove the "verbose" flag.

To disable showing the dirty state for any one repo:

cd <repo>
git config bash.showDirtyState false

To disable showing the upstream state for any one repo:

cd <repo>
git config bash.showUpstream false

=== Multiple Work Branches ===

You will often want to have more than one build environment in parallel, for example if you want to work on both stable and unstable branches at the same time.

With Git you can easily have many work branches in your repository and easily switch between them. The problem here however is that you can only work on the one branch at a time, and switching branches will usually trigger a massive rebuild of the entire repository.

One solution would be to have a separate repository clone for each branch you wish to work on in parallel, but this takes up more disk space, the clones and branches can easily get out-of-sync, and it makes forward/back porting bug fixes between branches more difficult. If choosing this method then you should make each new clone from your initial local clone rather than from the main repo as this will be quicker.

The ideal solution is for a single git repository clone to provide separate source directories for each branch you wish to work on. This can be achieved using the git-new-workdir script provided in the Git contrib directory. This script uses sym-links to create what appears as a new clone in a separate folder but actually uses the same local clone.

The git-new-workdir script may be installed as part of your system git. If not download the script from [https://github.com/git/git/raw/master/contrib/workdir/git-new-workdir the git repo] and install in your ~/.bin.

For example, assuming your have a kdelibs.git clone living in ~/kde/src/master/kdelibs, then the following command will create a 4.6 work branch in ~/kde/src/4.6/kdelibs:

git-new-workdir ~/kde/src/master/kdelibs ~/kde/src/4.6/kdelibs KDE/4.6

== RSA Key fingerprint for git.kde.org==
c8:45:ba:89:85:11:78:b5:a4:09:d9:31:f6:7f:7c:79

Getting Started/Build

2011-12-21T20:08:16Z

Sreich: /* build-tool */

{{warning|These pages are currently being completely re-written to reflect the new KDE infrastructure and may not be in a consistent state. Information and commands on some page may no longer be valid and should be used with care.}}

{{Template:I18n/Language Navigation Bar|Getting Started/Build}}

== Introduction ==

This page provides an overview of the KDE build process. Once you complete the steps described here you will have a complete KDE development system customized to your needs.

== Build Steps ==

This section will briefly explain the concepts and steps involved in building software so you are not being asked to blindly follow some recipes you do not understand.

It is assumed you are at least familiar with the basics of using the command line.

Once you have read the summary you can see a [[/Example|worked example here]].

=== Source ===

The ''Source'' step is obtaining a local copy of the source code that you want to build. For a detailed explanation of where to obtain the source code and how KDE stores and organizes our source code please read the [[Getting_Started/Sources|KDE Sources section]].

The two main options here are to either download a snapshot tarball of the code, or to directly access the source code repository. For developing on the unstable branch of the KDE SC it is recommended you directly access the required repositories.

=== Configure ===

The ''Configure'' step is setting up how the source code is to be built and installed.

=== Build ===

The ''Build'' step is compiling the source code and linking it to other libraries to create the new executables and libraries.

=== Install ===

The ''Install'' step is copy the new executables and libraries somewhere that they can be found and run from.

=== Update ===

The ''Update'' step is updating an existing build to use the latest version of the source code and then re-building and re-installing it.

== Scripted Builds ==

The easiest way to build the KDE SC from scratch is to use one of the build scripts that are available. This approach is highly recommended for those new to building KDE SC as it takes care of the Source, Configure, Build, Install and Update steps for you. The builds remain compatible with the manual methods of building KDE SC so you can change later if you want.

Even KDE Core Developers use build scripts like these as opposed to doing everything manually, as there's just no point otherwise.

* The [[/kdesrc-build|kdesrc-build]] script by Michael Pyne
* The [http://michael-jansen.biz/build-tool build-tool] script by Michael Jansen

If you run into any issues, be sure to ask either on the kde-devel mailing list, or the #kde-devel IRC channel (which many developers reside in and are willing to ask any questions or address any problems encountered).

== kdesrc-build ==

=== build-tool ===

Build-tool is a ruby program which is meant not for just building KDE, but also can easily be expanded to compile any other applications. It also has some neat features like progress bars and eta for compile time. It can also automatically generate a ~/.xsessionrc which can be used by KDM when you select to boot into a "Custom" session type. That will enable you to easily get into a KDE session which was built from source, without even having to modify any of your scripts like ~/.bashrc, ~/.zshrc, etc.

Install rubygems through your package manager. Run 'sudo gem install build-tool'. Now that build-tool is installed, we need to install the KDE recipes to have it build KDE from source. Run 'build-tool recipe add git://gitorious.org/build-tool/kde-trunk-recipe.git kde' to add the KDE recipe to the program. Then 'build-tool recipes install kde'. From there, you can run 'kde-build help' to see the commands available for the KDE recipe, as well as compile and update the git repositories.
For more detailed information, visit: [[http://michael-jansen.biz/content/quick-start]]

== Platform Specific Information ==

The build process described in these pages is kept as simple and generic as possible, but it is generally assumed you are building KDE4 on Linux. Extra information about building KDE Software on specific distributions or platforms, or under certain conditions can be found at the following links:

* [[/Distributions|Linux, BSD and other *nix based distributions]]
* [[/Windows|Microsoft Windows]]
* [[/Mac_OS_X|Apple Mac OS X]]
* [[/KDE4/on_virtual_machines|On a Virtual Machine]].
* [[/Historic|Building historic versions of KDE Software (KDE3 and KDE2)]]

== Stable versus Unstable ==

A stable build is a released and supported version of KDE Software, such as KDE SC 4.6. This software is guaranteed to remain unchanged other than bug-fixes. You will want a Stable build if you want to use the KDE Software for normal use or to develop bug fixes.

An unstable build is the latest development version of KDE Software and is not guaranteed to build or run properly at any given time. You will want an Unstable build if you want to develop new features for KDE Software.

In Git, the Unstable branch is called Master while in Subversion it is called Trunk.

== Build and Install ==

You need to complete each of the following steps to build and/or install a working KDE development system. Manually building KDE Software requires that you first set up the build environment and install the required development tools and libraries.

* Choose the appropriate [[/Methods|Build Method]] for your requirements
* Set up your [[/Environment|Build Environment]]
* Choose the appropriate [[/Recipes|Build Recipes]] for your requirements and environment
* Install the [[/Requirements|Build Requirements]]
* Install or build [[/Qt|Qt]]
* Install or build [[/KDE_Support|KDE Support]]
* Install or build [[/KDE_Development_Platform|KDE Development Platform]]
* Install or build [[/KDE_Workspace|KDE Workspace]]
* [[/KDE_Applications|Build KDE Applications]]

== Troubleshooting The Build ==

Compile and Linking errors are frequent sources of discouragement. Make careful note of the first occurrence of an error in your build process. It could be as simple as a bad environment variable, an unexpected version of a library or missing prerequisite. Please read the instructions carefully.

Please review your logs and do searches for fixes. If you cannot find a solution, try the [[/Troubleshooting|Troubleshooting]] page. If you still cannot resolve the problem then please [[Development/Getting_Help|ask for help]] on IRC or a Mailing List.

[[Category:Build KDE]]

Getting Started/Build

2011-12-21T20:07:50Z

Sreich: /* Scripted Builds */ further build-tool info. i don't know kdesrc-build, so I can't add stuff about that.

{{warning|These pages are currently being completely re-written to reflect the new KDE infrastructure and may not be in a consistent state. Information and commands on some page may no longer be valid and should be used with care.}}

{{Template:I18n/Language Navigation Bar|Getting Started/Build}}

== Introduction ==

This page provides an overview of the KDE build process. Once you complete the steps described here you will have a complete KDE development system customized to your needs.

== Build Steps ==

This section will briefly explain the concepts and steps involved in building software so you are not being asked to blindly follow some recipes you do not understand.

It is assumed you are at least familiar with the basics of using the command line.

Once you have read the summary you can see a [[/Example|worked example here]].

=== Source ===

The ''Source'' step is obtaining a local copy of the source code that you want to build. For a detailed explanation of where to obtain the source code and how KDE stores and organizes our source code please read the [[Getting_Started/Sources|KDE Sources section]].

The two main options here are to either download a snapshot tarball of the code, or to directly access the source code repository. For developing on the unstable branch of the KDE SC it is recommended you directly access the required repositories.

=== Configure ===

The ''Configure'' step is setting up how the source code is to be built and installed.

=== Build ===

The ''Build'' step is compiling the source code and linking it to other libraries to create the new executables and libraries.

=== Install ===

The ''Install'' step is copy the new executables and libraries somewhere that they can be found and run from.

=== Update ===

The ''Update'' step is updating an existing build to use the latest version of the source code and then re-building and re-installing it.

== Scripted Builds ==

The easiest way to build the KDE SC from scratch is to use one of the build scripts that are available. This approach is highly recommended for those new to building KDE SC as it takes care of the Source, Configure, Build, Install and Update steps for you. The builds remain compatible with the manual methods of building KDE SC so you can change later if you want.

Even KDE Core Developers use build scripts like these as opposed to doing everything manually, as there's just no point otherwise.

* The [[/kdesrc-build|kdesrc-build]] script by Michael Pyne
* The [http://michael-jansen.biz/build-tool build-tool] script by Michael Jansen

If you run into any issues, be sure to ask either on the kde-devel mailing list, or the #kde-devel IRC channel (which many developers reside in and are willing to ask any questions or address any problems encountered).

== kdesrc-build ==

=== build-tool ===

Build-tool is a ruby program which is meant not for just building KDE, but also can easily be expanded to compile any other applications. It also has some neat features like progress bars and eta for compile time. It can also automatically generate a ~/.xsessionrc which can be used by KDM when you select to boot into a "Custom" session type. That will enable you to easily get into a KDE session which was built from source, without even having to modify any of your scripts like ~/.bashrc, ~/.zshrc, etc.

Install rubygems through your package manager. Run 'sudo gem install build-tool'. Now that build-tool is installed, we need to install the KDE recipes to have it build KDE from source. Run 'build-tool recipe add git://gitorious.org/build-tool/kde-trunk-recipe.git kde' to add the KDE recipe to the program. Then 'build-tool recipes install kde'. From there, you can run 'kde-build help' to see the commands available for the KDE recipe, as well as compile and update the git repositories.
For more detailed information, visit: [[http://michael-jansen.biz/content/quick-start|kde-build quick start]]

== Platform Specific Information ==

The build process described in these pages is kept as simple and generic as possible, but it is generally assumed you are building KDE4 on Linux. Extra information about building KDE Software on specific distributions or platforms, or under certain conditions can be found at the following links:

* [[/Distributions|Linux, BSD and other *nix based distributions]]
* [[/Windows|Microsoft Windows]]
* [[/Mac_OS_X|Apple Mac OS X]]
* [[/KDE4/on_virtual_machines|On a Virtual Machine]].
* [[/Historic|Building historic versions of KDE Software (KDE3 and KDE2)]]

== Stable versus Unstable ==

A stable build is a released and supported version of KDE Software, such as KDE SC 4.6. This software is guaranteed to remain unchanged other than bug-fixes. You will want a Stable build if you want to use the KDE Software for normal use or to develop bug fixes.

An unstable build is the latest development version of KDE Software and is not guaranteed to build or run properly at any given time. You will want an Unstable build if you want to develop new features for KDE Software.

In Git, the Unstable branch is called Master while in Subversion it is called Trunk.

== Build and Install ==

You need to complete each of the following steps to build and/or install a working KDE development system. Manually building KDE Software requires that you first set up the build environment and install the required development tools and libraries.

* Choose the appropriate [[/Methods|Build Method]] for your requirements
* Set up your [[/Environment|Build Environment]]
* Choose the appropriate [[/Recipes|Build Recipes]] for your requirements and environment
* Install the [[/Requirements|Build Requirements]]
* Install or build [[/Qt|Qt]]
* Install or build [[/KDE_Support|KDE Support]]
* Install or build [[/KDE_Development_Platform|KDE Development Platform]]
* Install or build [[/KDE_Workspace|KDE Workspace]]
* [[/KDE_Applications|Build KDE Applications]]

== Troubleshooting The Build ==

Compile and Linking errors are frequent sources of discouragement. Make careful note of the first occurrence of an error in your build process. It could be as simple as a bad environment variable, an unexpected version of a library or missing prerequisite. Please read the instructions carefully.

Please review your logs and do searches for fixes. If you cannot find a solution, try the [[/Troubleshooting|Troubleshooting]] page. If you still cannot resolve the problem then please [[Development/Getting_Help|ask for help]] on IRC or a Mailing List.

[[Category:Build KDE]]

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-23T16:45:04Z

Sreich: /* metadata.desktop */

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

The line below indicates the default size of the plasmoid. The applet's starting size will be this, when added to a scene:

<syntaxhighlight lang="ini">
X-Plasma-DefaultSize=200,100
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== Installing ==
You can install your plasmoid, though obviously this is just temporary. CMake, below, is recommended:
plasmapkg --install plasmoid-qml

=== Installation through CMake ===
In your CMakeLists.txt:

<syntaxhighlight lang="bash">
project(helloqml)

install(DIRECTORY package/
DESTINATION ${DATA_INSTALL_DIR}/plasma/plasmoids/org.kde.plasma.applet.myapplet)

install(FILES package/metadata.desktop DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-applet-myapplet.desktop)
</syntaxhighlight>

Your directory structure should now be as follows:

<syntaxhighlight lang="bash">
myproject/CMakeLists.txt
myproject/package/
myproject/package/metadata.desktop
myproject/package/contents/
myproject/package/contents/ui/
myproject/package/contents/ui/helloworld.qml
</syntaxhighlight>

(if you have a configuration file (.ui file) to load the right-click 'plasmoid settings' menu, then your structure will also have myproject/package/contents/config/config.ui, or so)

== 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, like the following''':
* localization with i18n()
* access to the global ''plasmoid'' object
* device specific qml files imported with plasmapackage:// urls
* bindings for qicons, KJobs, services and KConfig
* retrieving data from a DataEngine

Therefore, it is recommended to simply use '''plasmoidviewer'''

= 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-22T16:38:02Z

Sreich: /* Package Structure */ fixen fixen

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

The line below indicates the starting minimum size of the plasmoid. The applet will become no smaller than this:

<syntaxhighlight lang="ini">
X-Plasma-DefaultSize=200,100
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== Installing ==
You can install your plasmoid, though obviously this is just temporary. CMake, below, is recommended:
plasmapkg --install plasmoid-qml

=== Installation through CMake ===
In your CMakeLists.txt:

<syntaxhighlight lang="bash">
project(helloqml)

install(DIRECTORY package/
DESTINATION ${DATA_INSTALL_DIR}/plasma/plasmoids/org.kde.plasma.applet.myapplet)

install(FILES package/metadata.desktop DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-applet-myapplet.desktop)
</syntaxhighlight>

Your directory structure should now be as follows:

<syntaxhighlight lang="bash">
myproject/CMakeLists.txt
myproject/package/
myproject/package/metadata.desktop
myproject/package/contents/
myproject/package/contents/ui/
myproject/package/contents/ui/helloworld.qml
</syntaxhighlight>

(if you have a configuration file (.ui file) to load the right-click 'plasmoid settings' menu, then your structure will also have myproject/package/contents/config/config.ui, or so)

== 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, like the following''':
* localization with i18n()
* access to the global ''plasmoid'' object
* device specific qml files imported with plasmapackage:// urls
* bindings for qicons, KJobs, services and KConfig
* retrieving data from a DataEngine

Therefore, it is recommended to simply use '''plasmoidviewer'''

= 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-22T02:18:46Z

Sreich: /* metadata.desktop */

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

The line below indicates the starting minimum size of the plasmoid. The applet will become no smaller than this:

<syntaxhighlight lang="ini>
X-Plasma-DefaultSize=200,100
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== Installing ==
You can install your plasmoid, though obviously this is just temporary. CMake, below, is recommended:
plasmapkg --install plasmoid-qml

=== Installation through CMake ===
In your CMakeLists.txt:

<syntaxhighlight lang="bash">
project(helloqml)

install(DIRECTORY package/
DESTINATION ${DATA_INSTALL_DIR}/plasma/plasmoids/org.kde.plasma.applet.myapplet)

install(FILES package/metadata.desktop DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-applet-myapplet.desktop)
</syntaxhighlight>

Your directory structure should now be as follows:

<syntaxhighlight lang="bash">
myproject/CMakeLists.txt
myproject/package/
myproject/package/metadata.desktop
myproject/package/contents/
myproject/package/contents/ui/
myproject/package/contents/ui/helloworld.qml
</syntaxhighlight>

(if you have a configuration file (.ui file) to load the right-click 'plasmoid settings' menu, then your structure will also have myproject/package/contents/config/config.ui, or so)

== 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, like the following''':
* localization with i18n()
* access to the global ''plasmoid'' object
* device specific qml files imported with plasmapackage:// urls
* bindings for qicons, KJobs, services and KConfig
* retrieving data from a DataEngine

Therefore, it is recommended to simply use '''plasmoidviewer'''

= 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma

2011-08-19T01:34:08Z

Sreich: /* Plasma and Creating QML Plasmoids */ rename that

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma and Creating QML Plasmoids ==
Plasmoids that use the QML (aka QtQuick) declarative language to describe their user interface while having the logic of the applet, in JavaScript (QML is essentially a forge between CSS and JavaScript).

This is now the '''recommended''' method of creating plasmoids, where possible. The plasmoid, or applet serves as the visualization for the data which a Plasma::DataEngine contains.

It allows easily the declaring of an interface and to easily create things like ListViews with native Plasma theming. It is what Plasma is leaning the most towards, especially in the Mobile, MediaCenter and KDM shells.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/Basic_ListView|Basic List Plasmoid]]
:''Make a QML ListView which displays basic text objects as items. Utilizes native Plasma theming and animations.''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma

2011-08-19T01:33:44Z

Sreich: /* Plasma and Creating QML Plasmoids */ Add listview example(TODO)

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma and Creating QML Plasmoids ==
Plasmoids that use the QML (aka QtQuick) declarative language to describe their user interface while having the logic of the applet, in JavaScript (QML is essentially a forge between CSS and JavaScript).

This is now the '''recommended''' method of creating plasmoids, where possible. The plasmoid, or applet serves as the visualization for the data which a Plasma::DataEngine contains.

It allows easily the declaring of an interface and to easily create things like ListViews with native Plasma theming. It is what Plasma is leaning the most towards, especially in the Mobile, MediaCenter and KDM shells.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/Basic_ListView|Basic Listing Plasmoid]]
:''Make a QML ListView which displays basic text objects as items. Utilizes native Plasma theming and animations.''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T01:30:02Z

Sreich: /* Installation through CMake */ .ui file thing. We'll need to touch on that later...

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== Installing ==
You can install your plasmoid, though obviously this is just temporary. CMake, below, is recommended:
plasmapkg --install plasmoid-qml

=== Installation through CMake ===
In your CMakeLists.txt:

<syntaxhighlight lang="bash">
project(helloqml)

install(DIRECTORY package/
DESTINATION ${DATA_INSTALL_DIR}/plasma/plasmoids/org.kde.plasma.applet.myapplet)

install(FILES package/metadata.desktop DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-applet-myapplet.desktop)
</syntaxhighlight>

Your directory structure should now be as follows:

<syntaxhighlight lang="bash">
myproject/CMakeLists.txt
myproject/package/
myproject/package/metadata.desktop
myproject/package/contents/
myproject/package/contents/ui/
myproject/package/contents/ui/helloworld.qml
</syntaxhighlight>

(if you have a configuration file (.ui file) to load the right-click 'plasmoid settings' menu, then your structure will also have myproject/package/contents/config/config.ui, or so)

== 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, like the following''':
* localization with i18n()
* access to the global ''plasmoid'' object
* device specific qml files imported with plasmapackage:// urls
* bindings for qicons, KJobs, services and KConfig
* retrieving data from a DataEngine

Therefore, it is recommended to simply use '''plasmoidviewer'''

= 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T01:27:21Z

Sreich: /* Anchors */ format

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== Installing ==
You can install your plasmoid, though obviously this is just temporary. CMake, below, is recommended:
plasmapkg --install plasmoid-qml

=== Installation through CMake ===
In your CMakeLists.txt:

<syntaxhighlight lang="bash">
project(helloqml)

install(DIRECTORY package/
DESTINATION ${DATA_INSTALL_DIR}/plasma/plasmoids/org.kde.plasma.applet.myapplet)

install(FILES package/metadata.desktop DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-applet-myapplet.desktop)
</syntaxhighlight>

Your directory structure should now be as follows:

<syntaxhighlight lang="bash">
myproject/CMakeLists.txt
myproject/package/
myproject/package/metadata.desktop
myproject/package/contents/
myproject/package/contents/ui/
myproject/package/contents/ui/helloworld.qml
</syntaxhighlight>

== 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, like the following''':
* localization with i18n()
* access to the global ''plasmoid'' object
* device specific qml files imported with plasmapackage:// urls
* bindings for qicons, KJobs, services and KConfig
* retrieving data from a DataEngine

Therefore, it is recommended to simply use '''plasmoidviewer'''

= 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T01:25:40Z

Sreich: /* qmlviewer */ bold

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== Installing ==
You can install your plasmoid, though obviously this is just temporary. CMake, below, is recommended:
plasmapkg --install plasmoid-qml

=== Installation through CMake ===
In your CMakeLists.txt:

<syntaxhighlight lang="bash">
project(helloqml)

install(DIRECTORY package/
DESTINATION ${DATA_INSTALL_DIR}/plasma/plasmoids/org.kde.plasma.applet.myapplet)

install(FILES package/metadata.desktop DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-applet-myapplet.desktop)
</syntaxhighlight>

Your directory structure should now be as follows:

<syntaxhighlight lang="bash">
myproject/CMakeLists.txt
myproject/package/
myproject/package/metadata.desktop
myproject/package/contents/
myproject/package/contents/ui/
myproject/package/contents/ui/helloworld.qml
</syntaxhighlight>

== 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, like the following''':
* localization with i18n()
* access to the global ''plasmoid'' object
* device specific qml files imported with plasmapackage:// urls
* bindings for qicons, KJobs, services and KConfig
* retrieving data from a DataEngine

Therefore, it is recommended to simply use '''plasmoidviewer'''

= 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T01:25:18Z

Sreich: /* qmlviewer */ plasmoidviewer

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== Installing ==
You can install your plasmoid, though obviously this is just temporary. CMake, below, is recommended:
plasmapkg --install plasmoid-qml

=== Installation through CMake ===
In your CMakeLists.txt:

<syntaxhighlight lang="bash">
project(helloqml)

install(DIRECTORY package/
DESTINATION ${DATA_INSTALL_DIR}/plasma/plasmoids/org.kde.plasma.applet.myapplet)

install(FILES package/metadata.desktop DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-applet-myapplet.desktop)
</syntaxhighlight>

Your directory structure should now be as follows:

<syntaxhighlight lang="bash">
myproject/CMakeLists.txt
myproject/package/
myproject/package/metadata.desktop
myproject/package/contents/
myproject/package/contents/ui/
myproject/package/contents/ui/helloworld.qml
</syntaxhighlight>

== 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, like the following:
* localization with i18n()
* access to the global ''plasmoid'' object
* device specific qml files imported with plasmapackage:// urls
* bindings for qicons, KJobs, services and KConfig
* retrieving data from a DataEngine

Therefore, it is recommended to simply use '''plasmoidviewer'''

= 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T01:22:34Z

Sreich: /* Installation through CMake */ Show dir structure.

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== Installing ==
You can install your plasmoid, though obviously this is just temporary. CMake, below, is recommended:
plasmapkg --install plasmoid-qml

=== Installation through CMake ===
In your CMakeLists.txt:

<syntaxhighlight lang="bash">
project(helloqml)

install(DIRECTORY package/
DESTINATION ${DATA_INSTALL_DIR}/plasma/plasmoids/org.kde.plasma.applet.myapplet)

install(FILES package/metadata.desktop DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-applet-myapplet.desktop)
</syntaxhighlight>

Your directory structure should now be as follows:

<syntaxhighlight lang="bash">
myproject/CMakeLists.txt
myproject/package/
myproject/package/metadata.desktop
myproject/package/contents/
myproject/package/contents/ui/
myproject/package/contents/ui/helloworld.qml
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T01:16:44Z

Sreich: /* Installing */ Add installation via cmake, and this only uses 1 file, not a dupe of .desktop like a lot of stuff in git has ;-)

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== Installing ==
You can install your plasmoid, though obviously this is just temporary. CMake, below, is recommended:
plasmapkg --install plasmoid-qml

=== Installation through CMake ===
In your CMakeLists.txt:

<syntaxhighlight lang="bash">
project(helloqml)

install(DIRECTORY package/
DESTINATION ${DATA_INSTALL_DIR}/plasma/plasmoids/org.kde.plasma.applet.myapplet)

install(FILES package/metadata.desktop DESTINATION ${SERVICES_INSTALL_DIR} RENAME plasma-applet-myapplet.desktop)
</syntaxhighlight>

Your directory structure should now be as follows:

- myproject/
-- CMakeLists.txt
-- package/
--- metadata.desktop
--- contents/
---- ui/
----- helloworld.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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T00:58:05Z

Sreich: /* Extra types */ gram

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 config 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/API

2011-08-19T00:57:31Z

Sreich: /* Properties */

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= 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], however 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"

==== 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 ===
If 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.

=== 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)

== 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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed? It has no affect presently).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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]
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:54:56Z

Sreich: /* Properties */

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= 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], however 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
* 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"

==== 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 ===
If 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.

=== 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)

== 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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed? It has no affect presently).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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]
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:53:41Z

Sreich: /* Main QML classes */ rename header

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed? It has no affect presently).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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]
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma

2011-08-19T00:46:23Z

Sreich: /* Plasma and Creating QML Plasmoids */ gram

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma and Creating QML Plasmoids ==
Plasmoids that use the QML (aka QtQuick) declarative language to describe their user interface while having the logic of the applet, in JavaScript (QML is essentially a forge between CSS and JavaScript).

This is now the '''recommended''' method of creating plasmoids, where possible. The plasmoid, or applet serves as the visualization for the data which a Plasma::DataEngine contains.

It allows easily the declaring of an interface and to easily create things like ListViews with native Plasma theming. It is what Plasma is leaning the most towards, especially in the Mobile, MediaCenter and KDM shells.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma

2011-08-19T00:45:41Z

Sreich: better summary

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma and Creating QML Plasmoids ==
Plasmoids that use the QML (aka QtQuick) declarative language to describe their user interface while having the logic of the applet, in JavaScript (QML is essentially a forge between CSS and JavaScript).

This is now the '''recommended''' method of creating plasmoids, where possible. The plasmoid, or applet serves as the visualization for the data which a Plasma::DataEngine contains.

It allows easily the declaring of an interface and to easily create things like ListViews with native Plasma theming. It what Plasma is leaning the most towards, especially in the Mobile, MediaCenter and KDM shells.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma

2011-08-19T00:42:02Z

Sreich: reorder QML to be at the top. it's the most important yet it's at the bottom. I've seen too many people think that C++, or simply javascript is the best way/preferred to write Plasmoids

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma and Creating QML Plasmoids ==
It's possible to write Javascript Plasmoids that use the QML (aka QtQuick) declarative language to describe their user interface, while having the logic in JavaScript. This is now the '''recommended''' method of creating plasmoids, if possible. It allows easily the declaring of an interface. It is also what Plasma is leaning the most towards, especially in the Mobile, MediaCenter and KDM shells.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma

2011-08-19T00:40:02Z

Sreich: /* Plasma Programming with JavaScript */ lets move this

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T00:38:12Z

Sreich: /* Plasma Widgets in QML */

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), you simply add an import line for them.
All properties, signals and slots from ordinary Plasma widgets are available there.
'''These widgets are provided as a transition tool, intended to be replaced by the Plasma version of QtComponents''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T00:38:02Z

Sreich: /* Plasma Widgets in QML */ bold

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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''', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T00:37:48Z

Sreich: /* Plasma Widgets in QML */

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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'', which is currently in development by a gsoc.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma

2011-08-19T00:31:25Z

Sreich: /* QML (QtQuick) Plasmoids */ bolden

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== QML (QtQuick) Plasmoids ===
It's possible to write Javascript Plasmoids that use the QML declarative language to describe their user interface, while having the logic in JavaScript. This is now the '''recommended''' method of creating plasmoids, if possible. It allows easily the declaring of an interface. It is also what Plasma is leaning the most towards, especially in the Mobile, MediaCenter and KDM shells.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma

2011-08-19T00:28:45Z

Sreich: /* QML (QtQuick) Plasmoids */ clarify

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== QML (QtQuick) Plasmoids ===
It's possible to write Javascript Plasmoids that use the QML declarative language to describe their user interface, while having the logic in JavaScript. This is now the recommended method of creating plasmoids, if possible. It allows easily the declaring of an interface. It is also what Plasma is leaning the most towards, especially in the Mobile, MediaCenter and KDM shells.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript ScriptEngine, the differences between pure Qt QML and Plasma, and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma/QML/API

2011-08-19T00:26:41Z

Sreich: /* Popup Applet */ clarify

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed? It has no affect presently).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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]
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:23:51Z

Sreich: /* FrameSvgItem */ add sample code

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed?).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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]
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:18:15Z

Sreich: /* SvgItem */ fix bracket

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed?).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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]
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:17:56Z

Sreich: /* SvgItem */ add SvgItem sample code

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed?).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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]
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:15:18Z

Sreich: /* Svg */ explain imagepath, rearrange it

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed?).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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]
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</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)

=== 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:14:09Z

Sreich: /* Theme */ bolden

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed?).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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'''
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</syntaxhighlight>
'''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]

=== 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)

=== 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:13:13Z

Sreich: /* Theme */ gram

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed?).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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)

=== 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'''
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</syntaxhighlight>
'''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]

=== 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)

=== 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:10:28Z

Sreich: /* Svg */ code sample for Svg, as well as link to more information

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed?).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

Sample Code:
<syntaxhighlight lang="javascript">
PlasmaCore.Svg {
id: mySvg
imagePath: "widgets/line"
}
</syntaxhighlight>
'''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]

=== 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)

=== 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-19T00:04:33Z

Sreich: /* Svg */ gram

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed?).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T00:03:46Z

Sreich: /* Plasma specific imports */ clarify

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 and to take advantage of them in order for your applet to become a true Plasma applet, it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-19T00:01:23Z

Sreich: /* Plasma specific imports */ remove the dupes from QML/API, and just link to there. too much to maintain as it is...

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 it is necessary to use some particular QML imports. See [http://techbase.kde.org/Development/Tutorials/Plasma/QML/API Plasma QML API].

== Extra Qt features ==
org.kde.qtextraimports
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-18T21:43:59Z

Sreich: /* QML Basics */ add some links to QML examples

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples/repository KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile/repository Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-18T21:41:35Z

Sreich: /* QML Basics */

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples KDE Examples] repository for more KDE-related helpful resources. Also of use (which use QML and Plasma) are: [https://projects.kde.org/projects/playground/base/plasma-mobile Plasma Mobile], [https://projects.kde.org/projects/playground/base/declarative-plasmoids/repository Declarative Plasmoids (playground)], for WIP ports of C++ originals

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-18T21:32:52Z

Sreich: /* Extra Qt features */ add extracomponents import

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples KDE Examples] repository for more KDE-related helpful resources.

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

== 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:

== Minimum size ==
if the root object of the plasmoid has the properties minimumWidth and minimumHeight, they will be used as the minimum size for the plasmoid. If they will change during the plasmoid execution, the plasmoid minimum size will be updated accordingly.
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
property int minimumWidth: paintedWidth
property int minimumHeight: paintedHeight
text: "Hello world!";
}
</syntaxhighlight>

In the above example, the minimum size is binded to the paintedWidth/paintedHeight properties of the Text element, ensuring there will always be enough room for the whole text to be displayed.

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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
To use, do:

<syntaxhighlight lang="javascript">
import org.kde.qtextracomponents 0.1 as QtExtraComponents
</syntaxhighlight>

* QPixmapItem
* QImageItem
* QIconItem

== Plasma Widgets in QML ==
To use standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/API

2011-08-17T22:41:51Z

Sreich: /* Popup Applet */

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect, yet the icons seems to get retrieved from the desktop file (FIXME - is this needed?).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-17T22:30:29Z

Sreich: move popupapplet up a bit so it's seen

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== 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, simply change

<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:

NOTE: the below code presently has no affect (FIXME).

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

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-08-17T22:26:39Z

Sreich: add popup applet crap

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== 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)

== 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

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

== 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, simply change

<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:

NOTE: the below code presently has no affect (FIXME).

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/GettingStarted

2011-08-10T18:36:36Z

Sreich: /* QML Basics */

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

Essentially, most of the content is the same. The exceptions to be noted are how data is gathered...since we use Data Engines, it is a bit different. Text color and font should be made to use PlasmaCore.Theme.

See the [https://projects.kde.org/projects/kde/kdeexamples KDE Examples] repository for more KDE-related helpful resources.

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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:
<syntaxhighlight lang="javascript">
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
height: 300

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;
}
}
}
</syntaxhighlight>

=== 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> ===
<syntaxhighlight lang="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
</syntaxhighlight>

=== <tt>main.qml</tt> ===
<syntaxhighlight lang="javascript">
import QtQuick 1.0

Text {
text: "Hello world!";
}
</syntaxhighlight>

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

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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.

<syntaxhighlight lang="javascript">
import QtQuick 1.0
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
}
}
</syntaxhighlight>

Development/Tutorials/Plasma/QML/API

2011-08-01T20:33:58Z

Sreich: /* FrameSvgItem */ grammar++

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Git/Recipes

2011-07-28T03:40:17Z

Sreich: /* Interactive Rebasing */

== Git Recipes ==

Brief recipes for common use cases.

=== Cloning a Repository ===

To clone a local copy of a KDE Git repository, find the repository on http://projects.kde.org/projects, choose the project, choose the Repository tab and copy the git clone command displayed:

git clone git://anongit.kde.org/<repository-name>

Note this clone will be read-only and you will not be able to push from it.

Alternatively, if you have the standard [[Development/Git/Configuration|KDE Git configuration]] and know the name of the repository simply do:

git clone kde:<repository-name>

This will automatically set the repository up to have push access.

=== Working with existing remote branches ===

Remote branches are branches created on the main KDE repository. These may be a stable branch that you need to do bugfixes on, i.e. the 4.6 release, or a feature branch based on master.

To see what local and remote branches exist:
git branch -a

Create a local branch that tracks a remote branch:
git branch --track <local-branch> <remote-branch>
git checkout <local-branch>

When you want to add your commits to the local branch, first update your local to the current remote state, then push your commits:
git pull --rebase
git push origin <local-branch>:<remote-branch>

=== Working with stable branches ===

For kdelibs, kdepimlibs, kde-runtime, kate, konsole and kde-workspace, the remote stable branches are named as follows:

origin/KDE/4.6

For these modules, to set up a local stable branch to track the remote stable branch:

git branch --track KDE/4.6 origin/KDE/4.6
git checkout KDE/4.6

To then push changes to the remote stable branch:

git push origin KDE/4.6:KDE/4.6

In other projects the remote stable branches are named as follows:

origin/4.6

For these modules, to set up a local stable branch to track the remote stable branch:

git branch --track 4.6 origin/4.6
git checkout 4.6

To then push changes to the remote stable branch:

git push origin 4.6:4.6

=== Creating / Deleting Remote Branches ===

To create a new remote branch simply push your current branch to it:

git push origin <local-branch>:<remote-branch>

To delete a remote branch is a little obscure:

git push origin :<remote-branch>

=== Tracking Branches ===

To create a new branch that tracks an existing local or remote branch:

git branch --track <new-branch> <existing-branch>

To change the branch the current branch is tracking to a different local or remote branch:

git branch --set-upstream <existing-branch> <new-upstream-branch>

=== Cherry Picking ===

Cherry picking is a way to copy a single commit from any local or remote branch to your current local branch.

When cherry picking between stable and unstable branches, use the following form:

git cherry-pick -e -x <original-commit>

Note you can add ''any'' remote repository to your local clone if cherry-pick from.

;Common Options

'''-e''' will allow you to edit the commit message to add any extra details and to change the BUG/CCBUG/FIXED-IN messages.

'''-x''' will automatically add the original commit number to the end of the commit message to enable better tracing and to simplify merging. Only do this if the original commit was already published in a public repository, e.g. your are forward porting or back porting the patch.

'''-n''' will cherry-pick the changes but not commit them to the new branch. This is very useful if you need to do further work on a commit.

=== Interactive Rebasing ===

If you have many commits in a branch that you want to clean up before pushing to the central repository, then you can use interactive rebasing to merge, split, delete, re-order or edit them.

To work with all commits to a branch:

git rebase -i <parent-branch>

where <parent-branch> is the branch you want to rebase onto. This is usually the branch that you based the original local branch off or are remotely tracking, but can be any branch you want.

To work with just the last x commits you made to a branch:

git rebase -i HEAD^x

HEAD^ is the terminology for saying "commit prior to head". HEAD~ works too. HEAD^^ would indicate 2 commits back, and so forth.

See http://book.git-scm.com/4_interactive_rebasing.html for full details.

=== Viewing What You've Changed ===

To see the difference between your tracked but unstaged changes and the current branch (including your not-yet-pushed commits)

git diff
git diff <filename>

To see the difference between your staged changes and the current branch (including your not-yet-pushed commits):

git diff --staged
git diff --staged <filename>

=== Stashing Changes ===

If you have changes you don't wish to commit but don't want to lose either while you do something else, you can temporarily 'stash' the changes away. This could be some frequently used debug code,or just some work in progress you need to move to another branch without committing. If the code is just WIP for the current branch we recommend using an interim commit instead.

The stash is a temporary store that holds a stack of uncommitted changes at a repository level. Commands given below work by default with the stash at the top of the stack, or you can optionally provide the stack reference.

To store your current changes at the top of the stash stack:

git stash <optional comment>

For example:

git stash "My debug code"

To see all your stashed items in the stash stack:

git stash list

This will show something like:

stash@{0}: WIP on master: 6ebd0e2... My debug code
stash@{1}: WIP on master: 9cc0589... My stashed changes

To see the details of an individual stash:

git stash show <optional stash ref>

To see the stash at the top of the stack:

git stash show

To see the second item from top:

git stash show stash@{1}

To restore a stash while keeping a copy in the stack:

git stash apply <optional stash ref>

To restore a stash and remove it from the stack:

git stash pop <optional stash ref>

To remove a single stash from the stack without applying it:

git stash drop <optional stash ref>

To clear out your entire stash stack:

git stash clear

For more details see:

http://www.kernel.org/pub/software/scm/git/docs/git-stash.html
http://book.git-scm.com/4_stashing.html

ISV/Why use KDE

2011-07-23T05:40:16Z

Sreich: /* Technologies */ s/hal/udev/

{{Template:I18n/Language Navigation Bar|ISV/Why use KDE}}
This page intends to help '''Independent Software Vendors (ISVs)''' getting into KDE related topics. This includes companies developing commercial applications as well as other Open Source Projects.

== The KDE Community ==
The KDE project attracts many people with different backgrounds. As such, the day-by-day growing KDE community includes many '''developers''', '''translators''', '''artists''' as well as '''usability and accessibility experts''' and - of course - '''lots of users'''. For several years now all those people are welcome to meet at the '''annual KDE Conference [http://akademy.kde.org/ aKademy]''' to discuss KDE related topics and shape the ''roadmap'' for future development.

== KDE e.V. ==
The non-profit organization [http://ev.kde.org KDE e.V.] helps in creating and distributing KDE by securing cash, hardware, and other donations, then using donations to aid KDE development and promotion. All its members are part of the KDE community which means the KDE e.V. plays an important role in the KDE project. Members of the KDE e.V. form several '''working groups''' like the [http://www.spreadkde.org/handbook/mwg/charter Marketing Working Group (MWG)] and the [http://ev.kde.org/workinggroups/hci.php Human-Computer Interaction (HCI) Working Group] to help realize KDE's vision.

== Adoption of KDE ==
KDE is one of the biggest Open Source projects making the Linux/UNIX desktop's experience much more user friendly. As such, distributions strongly support KDE by actively taking part in its development process and ship KDE as their default desktop environment. Many companies use KDE for production use.

== Development ==
The KDE development process takes place in steady release cycles. '''[http://developer.kde.org/development-versions/release.html Release schedules]''' and '''feature plans''' help the KDE project coordinating a KDE release by introducing several ''phases'' like ''feature freeze'' and ''message freeze''. This phases make sure that developers concentrate on polishing the release and the translation teams have time enough to translate all the KDE software into many different languages. Further information about KDE development tools can be found on the [[Development|development pages]].

=== Documentation ===
The KDE project provides excellent documentation about its API and its technologies, such as KParts or KXmlGui. There are many '''Tutorials and HOWTOs''' which help getting into KDE development. An overview can be found at the [[Development|development pages]].

=== Technologies ===
KDE provides a wide range of '''powerful technologies''' such as [http://khtml.info KHTML and KJS] which are adopted by other companies like Apple (Safari browsers) and Nokia. Additionally there are several '''development frameworks''' like KParts (KDE's component technology), KIO (network/protocol architecture) or KXmlGui (build GUIs based on XML definitions).

KDE uses '''well-known standards''' like [http://en.wikipedia.org/wiki/Udev UDev]) and [http://dbus.freedesktop.org D-Bus] (interprocess communication).

=== Compatibility & Integration ===
The last major KDE release was KDE 4.0. All KDE 4.x versions are '''binary compatible''', i.e. software written for KDE 4.0 will be compatible with KDE 4.5 years later. As KDE is based on standards it is, for instance, easy to integrate applications with plain [http://todo-link-to-howto .desktop files].

==== Freedesktop.org & Portland ====
As an ISV, your target is probably not only KDE but all Linux/UNIX desktops. This is made possible due to '''strong collaboration between KDE and other projects''' like [http://freedesktop.org freedesktop.org] which defines standards and software that helps integrating applications in all standard conform desktop environments.

One of those projects is the [http://developer.kde.org/portland/ Portland project], which intends to develop a common set of Linux Desktop Programming Interfaces and Tools to allow applications to '''easily integrate''' with the free desktop configuration an end user has chosen to work with.

=== Sub-Projects ===
KDE has many sub-projects to more specifically coordinate unique project goals of major supporting applications. Several of these significant projects are noted below:

; KDE Pim
: The goal of [http://pim.kde.org KDE Pim] (Personal information management) is to provide an application suite to manage personal information. This includes applications like an email client, a calender etc. The main result is '''KDE Kontact''', our personal information manager.

; KOffice
: [http://koffice.kde.org KOffice] is an '''integrated office suite''' using KDE-technology and features a full set of applications which work together seamlessly to provide the best user experience possible. The office suite contains applications like KWord, KSpread, KPresenter, Krita and many more.

; KDevelop
: [http://kdevelop.kde.org KDevelop] is an '''Integrated Development Environment''' (IDE) for KDE. It supports language like C/C++ and Java and helps with rapid application development.

== Roadmap ==
KDE development follows a release schedule in order to coordinate releases. These usually cover for minor releases the last 10 weeks and for major releases the last 20 weeks before the official release. The features planned for a release are usually published at the same time as the schedule.

Further details can be found in the [[../Roadmap|roadmap page]].

[[Category:ISV]]

ISV/Why use KDE

2011-07-23T05:38:37Z

Sreich: /* Technologies */

{{Template:I18n/Language Navigation Bar|ISV/Why use KDE}}
This page intends to help '''Independent Software Vendors (ISVs)''' getting into KDE related topics. This includes companies developing commercial applications as well as other Open Source Projects.

== The KDE Community ==
The KDE project attracts many people with different backgrounds. As such, the day-by-day growing KDE community includes many '''developers''', '''translators''', '''artists''' as well as '''usability and accessibility experts''' and - of course - '''lots of users'''. For several years now all those people are welcome to meet at the '''annual KDE Conference [http://akademy.kde.org/ aKademy]''' to discuss KDE related topics and shape the ''roadmap'' for future development.

== KDE e.V. ==
The non-profit organization [http://ev.kde.org KDE e.V.] helps in creating and distributing KDE by securing cash, hardware, and other donations, then using donations to aid KDE development and promotion. All its members are part of the KDE community which means the KDE e.V. plays an important role in the KDE project. Members of the KDE e.V. form several '''working groups''' like the [http://www.spreadkde.org/handbook/mwg/charter Marketing Working Group (MWG)] and the [http://ev.kde.org/workinggroups/hci.php Human-Computer Interaction (HCI) Working Group] to help realize KDE's vision.

== Adoption of KDE ==
KDE is one of the biggest Open Source projects making the Linux/UNIX desktop's experience much more user friendly. As such, distributions strongly support KDE by actively taking part in its development process and ship KDE as their default desktop environment. Many companies use KDE for production use.

== Development ==
The KDE development process takes place in steady release cycles. '''[http://developer.kde.org/development-versions/release.html Release schedules]''' and '''feature plans''' help the KDE project coordinating a KDE release by introducing several ''phases'' like ''feature freeze'' and ''message freeze''. This phases make sure that developers concentrate on polishing the release and the translation teams have time enough to translate all the KDE software into many different languages. Further information about KDE development tools can be found on the [[Development|development pages]].

=== Documentation ===
The KDE project provides excellent documentation about its API and its technologies, such as KParts or KXmlGui. There are many '''Tutorials and HOWTOs''' which help getting into KDE development. An overview can be found at the [[Development|development pages]].

=== Technologies ===
KDE provides a wide range of '''powerful technologies''' such as [http://khtml.info KHTML and KJS] which are adopted by other companies like Apple (Safari browsers) and Nokia. Additionally there are several '''development frameworks''' like KParts (KDE's component technology), KIO (network/protocol architecture) or KXmlGui (build GUIs based on XML definitions).

KDE uses '''well-known standards''' like [http://hal.freedesktop.org HAL (Hardware Abstraction Layer)] (now replaced by [http://en.wikipedia.org/wiki/Udev UDev]) and [http://dbus.freedesktop.org D-Bus] (interprocess communication).

=== Compatibility & Integration ===
The last major KDE release was KDE 4.0. All KDE 4.x versions are '''binary compatible''', i.e. software written for KDE 4.0 will be compatible with KDE 4.5 years later. As KDE is based on standards it is, for instance, easy to integrate applications with plain [http://todo-link-to-howto .desktop files].

==== Freedesktop.org & Portland ====
As an ISV, your target is probably not only KDE but all Linux/UNIX desktops. This is made possible due to '''strong collaboration between KDE and other projects''' like [http://freedesktop.org freedesktop.org] which defines standards and software that helps integrating applications in all standard conform desktop environments.

One of those projects is the [http://developer.kde.org/portland/ Portland project], which intends to develop a common set of Linux Desktop Programming Interfaces and Tools to allow applications to '''easily integrate''' with the free desktop configuration an end user has chosen to work with.

=== Sub-Projects ===
KDE has many sub-projects to more specifically coordinate unique project goals of major supporting applications. Several of these significant projects are noted below:

; KDE Pim
: The goal of [http://pim.kde.org KDE Pim] (Personal information management) is to provide an application suite to manage personal information. This includes applications like an email client, a calender etc. The main result is '''KDE Kontact''', our personal information manager.

; KOffice
: [http://koffice.kde.org KOffice] is an '''integrated office suite''' using KDE-technology and features a full set of applications which work together seamlessly to provide the best user experience possible. The office suite contains applications like KWord, KSpread, KPresenter, Krita and many more.

; KDevelop
: [http://kdevelop.kde.org KDevelop] is an '''Integrated Development Environment''' (IDE) for KDE. It supports language like C/C++ and Java and helps with rapid application development.

== Roadmap ==
KDE development follows a release schedule in order to coordinate releases. These usually cover for minor releases the last 10 weeks and for major releases the last 20 weeks before the official release. The features planned for a release are usually published at the same time as the schedule.

Further details can be found in the [[../Roadmap|roadmap page]].

[[Category:ISV]]

Development/Tutorials/Plasma

2011-07-23T02:52:28Z

Sreich: /* QML (QtQuick) Plasmoids */

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== QML (QtQuick) Plasmoids ===
It's possible to write Javascript Plasmoids that use the QML declarative language to describe their user interface, while having the logic in JavaScript. This is now the recommended method of creating plasmoids, if possible. It allows easily the declaring of an interface. It is also what Plasma is leaning the most towards, especially in the Mobile, MediaCenter and KDM shells.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript scriptengine and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma

2011-07-23T02:38:50Z

Sreich: nevermind. I'm blind. although my excuse is that somebody else duplicated the first qml entry (and I don't think it was me ;p

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== QML (QtQuick) Plasmoids ===
It's possible to write Javascript Plasmoids that use the QML declarative language to describe their user interface, while having the logic in JavaScript.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript scriptengine and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma

2011-07-23T02:32:59Z

Sreich: /* Plasma Programming with Qt Quick (QML) */ add link to QML API. I'm *fairly* sure it was hidden behind 400 pages of nothingness, hidden in a hallway of unmarked doors leading to random, alternative universes.

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma}}

== Plasma Programming with C++ ==

;[[Development/Tutorials/Plasma/GettingStarted|Getting Started With Plasmoids]]
:''Creating your first plasmoid in C++ with SVG background, icon and text''

;[[Development/Tutorials/Plasma/GettingStarted..Some_More|Getting Started With Plasmoids..Some more]] :''A few more starter's tips.''

;[[Development/Tutorials/Plasma/DataEngines|Writing a DataEngine]]
:''DataEngines provide a standardized interface to various (read only) data sources for visualizations to use. Learn what a DataEngine is and how to write one of your own.''

;[[Development/Tutorials/Plasma/Services|Writing a Service]]
:''Services provide a standardized interface for visualizations to perform "write operations". This can be for example, uploading pasted test to a pastebin service..''

;[[Development/Tutorials/Plasma/PackageStructure|Writing a PackageStructure Plugin]]
:''PackageStructure plugins allow custom Packages to be defined, installed, removed and listed as well as provide access their contents at runtime. Packages may contain any kind of data addons, including scripts.''

;[[Development/Tutorials/Plasma/UsingExtenders|How to use extenders in your Plasmoid]]
:''A simple example that shows how to use extenders in a Plasmoid.''

;[[Development/Tutorials/Plasma/AbstractRunner|Creating Runners]]
:''Runners are plugins that provide action-based search functionality in the Plasma workspace "run command" dialog. These plugins can be used by any application that links again libplasma.''

;[[Development/Tutorials/Plasma/WallpaperHelloWorld|Wallpaper Tutorial 1]]
:''This tutorial shows you how to make a simple Hello World plasma wallpaper plugin.''

;[[Development/Tutorials/Plasma/WallpaperConfiguration|Wallpaper Tutorial 2]]
:''This tutorial covers how to add configuration options to the wallpaper.''

;[[Development/Tutorials/Plasma/ShellDesign|Creating a Plasma Shell]]
:''This tutorial covers the essentials of writing a new Plasma shell from scratch. A must-read for anyone creating a new or modifying an existing Plasma Shell. Existing Plasma shells include Plasma Desktop, Plasma Netbook, Plasma Mobile, Plasma Media Center, Plasma Screensaver, Plasma KPart and Plasma KDM, and all follow the patterns documented here.''

;[http://www.linux-magazine.com/w3/issue/114/036-040_plasma.pdf Creating Plasmoids]
:''May 2010 article from Linux Magazine''

;[http://www.ibm.com/developerworks/linux/library/l-kde-plasmoids/index.html Create Plasmoids using KDevelop]
:''Article explaining the structure of Plasma and how to create a Plasmoid''

;[http://community.kde.org/User:Mxttie#Adding_configuration Adding configuration to your plasmoid]
:''Article explaining how to add a configuration dialog to your plasmoid.''

;[[Development/Tutorials/Plasma/ApplicationShell|Integrate Plasma in Applications]]
:''This tutorial shows you how to make an application dashboard based on Plasma technologies.''

== Plasma Programming with JavaScript ==

Plasma has built-in JavaScript (also known as ECMAScript, and often referred to as QtScript in the context of Qt) scripting support without requiring any external dependencies.

=== Plasmoids ===

;[[Development/Tutorials/Plasma/JavaScript/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in JavaScript''

;[[Development/Tutorials/Plasma/JavaScript/DataEngine|Getting Data]]
:''How to retreive data from a data engine''

;[[Development/Tutorials/Plasma/JavaScript/NowPlaying|Now Playing]]
:''Slightly more advanced data engine usage: displaying what's currently playing''

;[[Development/Tutorials/Plasma/JavaScript/SystemMonitor|System Monitor]]
:''How to access systemmonitor data engine''

;[[Development/Tutorials/Plasma/JavaScript/CheatSheet|Cheat Sheet]]
:''A cheat sheet, rather than a tutorial, of things to remember and watch out for when developing JavaScript plasmoids''

;[[Development/Tutorials/Plasma/JavaScript/API|API Reference]]
:''The Simplified JavaScript Plasmoid API. Useful for referencing what is available in the runtime and as a study aid for the tutorials above.''

=== QML Plasmoids ===
It's possible to write Javascript Plasmoids that use the QML declarative language to describe their user interface, while having the logic in JavaScript.

;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in QML''

;[[Development/Tutorials/Plasma/QML/API|API Reference]]
:''The QML Plasmoid API. Useful for referencing what is available in the runtime, what are the differences with the pure JavaScript scriptengine and as a study aid for the tutorials above.''

=== Other Applications Of Javascript ===
;[[KDE_System_Administration/PlasmaDestkopScripting|Scripting Plasma Shells]]
:The KDE Plasma Desktop and Netbook provide means to manage the desktop shell (desktop, panels, widget) via scripts written in JavaScript. This article describes how to take advantage of this feature set as well as documents the full API. This is primarily a system administration tool, but may also be of interest to power users.

;[[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations]]
:''How to write Animations using Javascript for use in Plasma applications''

;[[Development/Tutorials/Plasma/ComicPlugin|Creating Comic Plugins]]
:''This guide shows you how to create a comic plugin for the comic plasmoid.''

== Plasma Programming with Python ==

;[[Development/Tutorials/Plasma/Python/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Python''

;[[Development/Tutorials/Plasma/Python/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Python/Using DataEngines|Using DataEngines]]
:''How to use DataEngines from a plasmoid''

;[[Development/Tutorials/Plasma/Python/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine''

;[[Development/Tutorials/Plasma/PythonPlasmoid|Writing a Plasmoid in Python]]
:''Writing a simple battery graph in python''

;[[Development/Tutorials/Plasma/PythonRunner|Writing a KRunner plugin in Python]]
:''Writing a simple krunner plugin in python''

== Plasma Programming with Ruby ==
;[[Development/Tutorials/Plasma/Ruby/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in Ruby''

;[[Development/Tutorials/Plasma/Ruby/Using widgets|Using widgets]]
:''Introduction to using Plasma widgets''

;[[Development/Tutorials/Plasma/Ruby/SimplePasteApplet|Writing a simple paste applet]]
:''A tutorial explaining how to set up a plasmoid, create a simple paste applet using widgets and add Plasma features seen elsewhere. Complete with tips for those who have never programmed before.''

;[[Development/Tutorials/Plasma/Ruby/Writing DataEngines|Writing DataEngines]]
:''How to write your own Plasma DataEngine using Ruby''

;[[Development/Tutorials/Plasma/Ruby/Blinker|Use SVG artwork in the simplest way possible]]
:''Follow a fellow student as he asks around about SVG usage and explains why the code examples work. This is a wiki so feel free to add your own insights until this tutorial can be considered complete.''

== Plasma Programming with Web Technologies (HTML/JS/CSS etc) ==
;[[Development/Tutorials/Plasma/Web/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid in HTML''

== Plasma Programming with Qt Quick (QML) ==
;[[Development/Tutorials/Plasma/QML/GettingStarted|Getting Started]]
:''Creating and running your first plasmoid with Qt Quick/QML''

;[[Development/Tutorials/Plasma/QML/API|QML API]]
:''Check out the QML API and be amazed. Also check out the Javascript API docs''

== Plasma integration ==

;[[Development/Tutorials/Solid_Device_Actions|Creating a Device Notifier action]]
:''When your application is interested in removable hardware''

== Theme development ==

;[[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme Quickstart]]
:''A quick guide to creating your first Plasma theme''

;[[Development/Tutorials/Plasma/ThemeDetails|The Plasma Theme Structure In Detail]]
:''A comprehensive guide to the contents of a Plasma SVG theme, including configuration options, wallpapers, on-disk layout, names of all standard SVG files and every element in them.''

== Activity Template development ==

;[[KDE_System_Administration/PlasmaDesktopScripting#Activity_templates|Creating a Plasma Activity Template Quickstart]]
:''A quick guide to creating your first Plasma Activity Template''

== Resources ==

* [[Projects/Plasma|Projects: Plasma]]
* [http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/index.html Plasma api documentation]
* [http://techbase.kde.org/Projects/Plasma/Eclipse_Integration Plasma Eclipse Integration]
* The [https://mail.kde.org/mailman/listinfo/plasma-devel plasma-devel mailing list] and #plasma on IRC (irc.freenode.org).

== Presentation Slides==
http://chani.wordpress.com/2009/04/25/quick-update-for-my-presentation/ Victory Calendar -- also link to websvn plasma playground in the odp file.

Development/Tutorials/Plasma/QML/API

2011-07-23T02:08:52Z

Sreich: /* DataSource */ document signals for dataSource. HUZZAH! made a clearer separation as well.

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

==== 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 ===
If 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.

=== 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)

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== FrameSvgItem ===
It's a graphical elenent that paints a Plasma::FrameSvg, so a ractangular 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/Services

2011-07-19T18:31:01Z

Sreich: /* The Code */ added operations file & cmake stuff. I'm not sure what should be added for the c++ code, since I can't think of a good example..*shrug*

{{Template:I18n/Language Navigation Bar|Development/Tutorials/Plasma/DataEngines}}

{{TutorialBrowser|

series=Plasma Tutorial|

name=Writing a Service|

pre=[http://mindview.net/Books/TICPP/ThinkingInCPP2e.html C++], [http://www.trolltech.com/products/qt/ Qt], [[Getting_Started/Build|KDE development environment]]|

next=|

reading=[http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/classPlasma_1_1DataEngine.html DataEngine API], [[Development/Tutorials/CMake|CMake Tutorials]], [[Development/Tutorials/Plasma/GettingStarted|Writing a Plasmoid (Tutorial)]], [[Development/Tutorials/Plasma/DataEngines|Writing a Data Engine (Tutorial)]]
}}

==Abstract==

cover services, .operations file, .operations dtd spec, perhaps make a service like the pastebin one or something. idk, something easy.

http://www.kde.org/standards/kcfg/1.0/kcfg.xsd

also mention how a service can access the dataengine via it's pointer(I think that's in public api), if it really really needs to(e.g. plasma-kdm can't live without that)

==The Plasma Engine Explorer==

A very useful tool for anyone writing services is the Plasma engine explorer. You can use it to see test services by launching them by running

<syntaxhighlight lang="bash">
plasmaengineexplorer
</syntaxhighlight>

If the service you want to test is associated to a source, you can access a dialog to launch the service and set its parameters by using the contextual menu of the source and selecting "Get associated service"

[[Image:Plasma-engine-explorer-task-service.png]]

==The Code==

This tutorial will cover adding a service associated with a source into an existing data engine. Depending on your requirements, you may want a service which is associated with a certain source, and will be able to perform actions based on that source, or you may want a service that simply performs global calls which are not tied to any one source. We will cover the first case, since it is the most prominent.

===The Description of the Service and its parameters===
The service you make yourself and can really have any parameters you want, it's quite flexible. The constructor can be e.g. MyService(QObject* parent, const QString& source), or it can create a custom class which is a custom data source.
====Writing an Operations File====
The operations file is quite core to the service, as it defines which operations are available. It is simply an XML file:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE kcfg SYSTEM
"http://www.kde.org/standards/kcfg/1.0/kcfg.xsd">
<kcfg>
<group name="setIcon">
<entry name="Icon" type="String">
<label>Set the name of the icon for this somesource</label>
</entry>
</group>
</kcfg>
</syntaxhighlight>

===The Main Code===

====Responding to Request for the Service Associated to a Source====

====Writing the Code Executing the Action of the Service====

====Building it====
As in the previous DataEngine tutorial, the CMakeLists.txt file is required to build your plugin. To create a service in addition to an engine, only a few lines of code need to be added. We need to add our service's C++ source file to our existing project, then install the operations file that was made.
<syntaxhighlight lang="bash">
set(myproject_SRCS
myengine.cpp
myservice.cpp
)

install(FILES org.kde.myprogramsname.service.operations
DESTINATION ${DATA_INSTALL_DIR}/plasma/services)
</syntaxhighlight>

In the case of "myprogramsname", that is simply e.g. microblog, pastebin, activities or whatever your collection of components is going to be named. (the reverse-domain name is used to prevent conflictions, so try to use it as much as possible).

==Testing==

Development/Tutorials/Plasma/QML/API

2011-07-16T18:03:17Z

Sreich: /* DataModel */

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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>

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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

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 ===
If 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.

=== 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)

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== FrameSvgItem ===
It's a graphical elenent that paints a Plasma::FrameSvg, so a ractangular 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-07-15T01:45:41Z

Sreich: /* DataModel */ how about I actually specify markup lang this time..

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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>

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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

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 ===
If 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.

=== 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 use, for example...

<syntaxhighlight lang="javascript">
onCurrentIndexChanged: sometextedit.text = model.get(currentIndex).myproperty
</syntaxhighlight>

=== 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)

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== FrameSvgItem ===
It's a graphical elenent that paints a Plasma::FrameSvg, so a ractangular 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-07-15T01:44:36Z

Sreich: /* DataModel */ I don't know where to put this, so I'm just going to cram it in there. but seeing as it's nowhere else and non-obvious, I'd might as well.

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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>

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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

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 ===
If 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.

=== 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 use, for example...

<syntaxhighlight>
onCurrentIndexChanged: sometextedit.text = model.get(currentIndex).myproperty
</syntaxhighlight>

=== 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)

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== FrameSvgItem ===
It's a graphical elenent that paints a Plasma::FrameSvg, so a ractangular 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-07-14T17:29:00Z

Sreich: /* DataModel */

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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>

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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

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 ===
If 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.

=== 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"].

=== 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)

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== FrameSvgItem ===
It's a graphical elenent that paints a Plasma::FrameSvg, so a ractangular 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-07-14T17:27:02Z

Sreich: /* DataModel */

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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>

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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

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 ===
If 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.

=== 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
* 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"].

=== 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)

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== FrameSvgItem ===
It's a graphical elenent that paints a Plasma::FrameSvg, so a ractangular 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/QML/API

2011-06-29T17:34:37Z

Sreich:

= 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 bassed 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 paged should probably be copied and stripped down the imperative bits not present there, it would make harder to update tough)

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

= Main 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], however 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>

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) no polling will be executed
* string '''engine''': the plugin name of the dataengine to load
* 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"

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 ===
If 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.

=== 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
* 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.

=== 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)

== Plasma Themes ==

=== Theme ===
This class instantiable from QML provides access to the Plasma Theme colors and other facilities such as fonts.
It has the following properties:
* String '''themeName''' (read only)
* QFont '''font''' (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 '''viewBackgroundColo''' (read only)r
* color '''viewHoverColor''' (read only)
* color '''viewFocusColor''' (read only)
* String '''styleSheet''' (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'''
* 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

=== 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)

=== FrameSvgItem ===
It's a graphical elenent that paints a Plasma::FrameSvg, so a ractangular 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)

== 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

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

= Plasma QtComponents (4.8) =
TODO

Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject

2011-06-29T17:31:42Z

Sreich: migrate to new syntaxhighlight

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

= 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 [[#AspectRatioMode|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

= 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(name, text, icon, shortcut)''': adds an item to the context menu with the given text and icon; 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

* '''removeAction(name)''': removes the item

Development/Tutorials/Plasma/QML/GettingStarted

2011-06-24T18:30:36Z

Sreich: bam. crosslink to js 'plasmoid' object api.

== 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 ==

It is recommended that you have read through the [http://doc.qt.nokia.com/4.7/qtquick.html Qt QML Tutorials], as there are quite a few and they are explained thoroughly. There is also a list of all [http://doc.qt.nokia.com/4.7/qdeclarativeelements.html standard QML elements].

See the [https://projects.kde.org/projects/kde/kdeexamples KDE Examples] repository for more KDE-related helpful resources.

=== Root Item ===

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

=== 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 QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore

Item {
width: 200
heigt: 300

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 QtQuick 1.0

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.

For specific info on this, see [http://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/API-PlasmoidObject Javascript API-Plasmoid Object]

== 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 standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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 QtQuick 1.0
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>

Development/Tutorials/Plasma/QML/GettingStarted

2011-04-19T19:26:19Z

Sreich: more love for the world. hurrah!

== 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 ==

It is recommended that you have read through the Qt QML Tutorials, as there are quite a few and they are explained thoroughly:
http://doc.qt.nokia.com/4.7/qtquick.html

Here is a list of the available elements:
http://doc.qt.nokia.com/4.7/qdeclarativeelements.html

The root item can be anything that inherits QGraphicsItem. For example, in this case it is QGraphicsWidget which is a plasmoid. It can also simply be an Item. I also noticed that PathView does not respond to mouse inputs automatically (so flicking doesn't work). Probably because events are being intercepted. So take note, it'll have to be e.g. an Item, for that case.

See the [https://projects.kde.org/projects/kde/kdeexamples KDE Examples] git repository for more KDE-related helpful resources.

=== 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 standard plasma widgets (e.g. Plasma::LineEdit, etc.), 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>