KDE TechBase - User contributions [en]

Development/Tutorials/Plasma/ThemeDetails

2013-06-05T14:39:34Z

Broulik: /* Theme Location, Structure and Definition */ Added line about versioning and cache refresh

<tt>libplasma</tt> provides the Theme class so Plasma elements and other applications, such as KRunner, that need to graphically hint or theme interface elements. This is not a replacement for {{qt|qstyle}}, but rather provides standard elements for things such as box backgrounds.

This allows for easy re-theming of the desktop while also keeping elements on the desktop more consistent with each other.

See also [[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme]].

== Theme Location, Structure and Definition ==
Themes are stored in {{path|share/apps/desktoptheme}}. A theme is described by a .desktop file in {{path|share/apps/desktoptheme}}. The contents of which might look like this:

<syntaxhighlight lang="text">
[Desktop Entry]
Name=Oxygen
Comment=Theme done in the Oxygen style

X-KDE-PluginInfo-Author=The Oxygen Project
X-KDE-PluginInfo-Email=kde-artists@kde.org
X-KDE-PluginInfo-Name=default
X-KDE-PluginInfo-Version=pre0.1
X-KDE-PluginInfo-Website=http://plasma.kde.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</syntaxhighlight>

The X-KDE-PluginInfo-Name entry must contain the name of the subdirectory in {{path|share/apps/desktoptheme}} where the SVG files for this theme exist.

If you do changes to SVG files in your theme, make sure to '''update the version number''' so Plasma can properly refresh its cache.

Beneath this directory one will find the following file structure:

* '''colors''': optional a configuration file defining a colorscheme that blends well with the images
* '''dialogs/''': images for dialogs
* '''wallpapers/''': wallpaper packages
* '''widgets/''': images for widgets
* '''opaque/''': optional directory containing images appropriate for non-compositing environments
* '''locolor/''': optional directory containing images appropraite for locolor (e.g. 8 bit color) environments

== Image Access ==
Theme elements are accessed by path. Whether this maps to literal paths on disk or not is not guaranteed and considered an implementation detail of Plasma::Theme.

Therefore, to access the dialog background, one might create an svg in this manner:

<syntaxhighlight lang="cpp-qt">
Plasma::Theme theme;
QSvgRenderer svg(theme.image("dialogs/background"));
</syntaxhighlight>

It '''is generally recommended''' to use Plasma::Svg instead of QSvgRenderer directly, however. This is because Plasma::Svg uses caching where it can. Remember to call resize() on the Plasma::Svg before painting with it!

<syntaxhighlight lang="cpp-qt">
Plasma::Svg svg("dialogs/background");
svg.resize(size());
</syntaxhighlight>

== Wallpaper Access ==

Themes may optionally provide wallpapers to be used with the theme. These wallpapers must appear in the {{path|wallpapers/}} directory within the theme.

A theme may also define a default wallpaper, wallpaper size and wallpaper file extension to be used in conjunction with the theme. The default wallpaper may either be installed in the standard location for wallpapers or may be shipped with the theme itself. The default wallpaper settings should appear in the theme's metadata.desktop file and contain the following entries:

<syntaxhighlight lang="text">
[Wallpaper]
defaultWallpaperTheme=<name of default wallpaper package>
defaultFileSuffix=<wallpaper file suffix, e.g. .jpg>
defaultWidth=<width in pixels of default wallpaper file>
defaultHeight=<height in pixels of default wallpaper file>
</syntaxhighlight>

== Animations ==

Animations written in Javascript can be included in the {{path|animations}} directory within the theme. To learn how to create such animations and expose them in your theme, visit the [[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations tutorial]].

== Reaction to Theme Changes ==
If you use Plasma::Svg, changes to the theme are automatically picked up. Otherwise, you can connect to the <tt>changed()</tt> signal in the Plasma::Theme class. This signal is emitted whenever the theme is changed, which may be triggered by the user switching the theme used or system changes such as a composite manager becoming available.

== Colors ==

The colors file follows the standard KDE colorscheme file format and allows a theme to define what colors work best with its theme elements. The colors in this file can be edited with the default color scheme module.
*Make a new colorscheme using the editor in SystemSettings>>Appearance>>Colors.
*Save it with a unique name.
*Open the colorscheme in kate.
**Saved at /home/[user]/.kde/share/apps/color-schemes/[unique name].colors
*Copy everything to your plasma colors file except the "[ColorEffects:Disabled]" and "[ColorEffects:Inactive]" sections.

The most common use of the colors file is to ensure that text is readable on various backgrounds.

Here is a list of color entries in the colors file that are currently actively used in a Plasma theme:

* '''[Colors:Window]'''
** '''ForegroundNormal''' the text color applied to text on the standard background elements; maps to Theme::TextColor
** '''DecorationHover''' the color used for text highlighting; maps to Theme::HighlightCoor
** '''BackgroundNormal''' the default background color, for items that paint a background themselves, allowing them to blend in with the theme; maps to Theme::BackgroundColor
* '''[Colors:Button]'''
** '''ForegroundNormal''' the text color to use on push buttons; maps to Theme::ButtonTextColor
** '''BackgroundNormal''' used for hinting buttons; maps to Theme::ButtonBackgroundColor
** '''ForegroundActive''' color used to tint BackgroundNormal for final button hinting color
* '''[Colors:View]'''
** '''ForegroundLink''' clickable text link font color
** '''ForegroundVisited''' visited clickable text link font color

Other colors in the file may be used by individual widgets or used in the future, so it doesn't hurt to provide a complete colorscheme file and is probably a safer strategy.

Currently also used by individual widgets, which should give a good idea of additional usage patterns:

* '''[Colors:View]'''
** '''ForegroundActive''' used by the digital and fuzzy clocks for the default text color, dictionary widget for results text, microblog for status update text
** '''ForegroundInactive''' used by the pager to draw non-active windows and frames, microblog for user names
** '''ForegroundNormal''' used by microblog for status update entry area background

Note that some of these may end up folded back into Plasma::Theme properly at some point.

== Backgrounds format==
All background svg's (except for desktop wallpapers) must have the following named elements, all of which will be painted at the ''native'' size (and can therefore be bitmaps), except for the center which will be scaled:
* '''topleft''': the top left corner
* '''topright''': the top right corner
* '''bottomleft''': the bottom left corner
* '''bottomright''': the bottom right corner
* '''top''': the top bar between the two top corners
* '''left''': the left bar between the two left corners
* '''right''': the right bar between the two right corners
* '''bottom''': the bottom bar between the two bottom corners
* '''center''': the center fill; will be scaled so should be an actual SVG element

Some plasma components may use the above named elements with prefixes. For example the panel placed on the left side of the screen uses the "west" prefix ('''west-topleft''', '''west-topright''', etc.).

Additionally, the following elements can be used to control the rendering of the backgrounds:

* '''hint-stretch-borders''': if it exists, the borders will not be tiled but rather will be stretched to fit
* '''hint-tile-center''': if it exists, the center will not be scaled but rather will be tiled to fit. (Optional, from 4.1 and later)
* '''hint-no-border-padding''': If this element exists, padding will not be added for the borders, and content will therefore be able to use the entire area (inclusive borders).
* '''hint-apply-color-scheme''': If this element exists, the svg will be colorized using the color scheme colors. Colorization is applied at 100%, and tapers off on either side, of an HSV color value/intensity of 127. (Optional, From KDE 4.1 and later)
* '''current-color-scheme''': If a style element with this id exists it is replaced by a css-style with colors of the current colorscheme. See below for details. (Optional, From KDE 4.6 and later)
* '''[prefix]-hint-[direction]-margin''': Use this optional hints if you want different margins than the borders size. The [prefix]- part is optional and identifies the prefix of the panel you want to specify the margins. [direction] can be either top, bottom, left or right and indicates the border you want to configure. For top and bottom margins the height of these hints are used, for left and right margins the width. (Optional, From KDE 4.2 and later)
* '''[prefix]-hint-compose-over-border''': if this element is resent, the center element will be drawn with the same size as the total image, composed under the borders and shaped with the alpha mask frame, that has to be present in order to make work this hint(Optional, from KDE 4.5)

From KDE 4.3 can exists an element called overlay (or prefix-overlay if to be appled to a frame with a different prefix) it will be rendered over the frame as a filigrane effects, with the rules given from the following mutually exclusive hints:
* '''hint-overlay-random-pos''' it will be put at a random position, this works just for applet backgrounds
* '''hint-overlay-tile''' tile the overlay
* '''hint-overlay-stretch''' the overlay will be stretched
* '''hint-overlay-pos-right''' align the overlay at right of the background rather than to the left (from KDE 4.4)
* '''hint-overlay-pos-bottom''' align the overlay at bottom of the background rather than to the top (from KDE 4.4)

=== Using system colors ===
It is possible to apply colors from the color scheme to a graphic. A very easy way to reach this is by adding an element with the id '''hint-apply-color-scheme''' to the svg. In this case the rendered graphic gets converted to monochrome and colorized by the window background color.

A more flexible solution is available since KDE 4.6 by using css-styling. For this to work the svg must have a style-element with the id '''current-color-scheme'''. Before the graphic is rendered this element gets replaced by a style containing classes where the color attribute is set to the corresponding system color. Currently the following classes are defined:
* ColorScheme-Text
* ColorScheme-Background
* ColorScheme-ViewText
* ColorScheme-ViewBackground
* ColorScheme-ViewHover
* ColorScheme-ViewFocus
* ColorScheme-ButtonText
* ColorScheme-ButtonBackground
* ColorScheme-ButtonHover
* ColorScheme-ButtonFocus

In order to apply a color from a class to an element, its fill or stroke attribute must be '''currentColor''' and of course the name of the wanted class has to be in the class-attribute. Special attention is needed on gradients, as neither the gradient-tags themself nor the stop-tags accept classes. To still get the wanted result one can put a g-tag around them and apply the class to this.

'''Hint:''' If you want to use this new feature and still be able to use the graphics on older versions, you can set the color for ColorScheme-Background to #7f7f7f and place a <tt><rect id="hint-apply-color-scheme" width="1" height="1" fill="none" /></tt> below your css-code but before the closing <tt></style></tt>

If you don't want to bother with the source code of your graphics, you can use the tool svgmod for easily applying system colors. See [https://projects.kde.org/projects/playground/devtools/svgmod here].

== Current Theme Elements ==

Themes get installed to {{path|share/apps/desktoptheme}}. Each theme is stored in a subdirectory with the following file structure

*'''/dialogs''': elements for dialogs
**'''/background.svg''': generic dialog background used by the sceensaver password dialog, etc. See the section on backgrounds above for information on the required elements in this file.
*** '''hint-left-shadow''': from KDE 4.10: optional hints that say how big the shadow is
*** '''hint-top-shadow'''
*** '''hint-right-shadow'''
*** '''hint-bottom-shadow'''
**'''/krunner.svg''': dialog background, used by the Run Command. Please note, that this is used only when <menuchoice>Positioning</menuchoice> is set to <menuchoice>Free floating window</menuchoice>, '''not''' <menuchoice>Top edge of screen</menuchoice> (which is default). See the section on backgrounds above for information on the required elements in this file.
**'''/shutdowndlg.svg''': background and buttons for the log out dialog
***''background'': background for the logout dialog
***''button-normal'': button background
***''button-hover'': button background on cursor hover
***''button-small-normal'': small button background
***''button-small-hover'': small button background on cursor hover
** '''/kickoff.svgz''' : background for the kickoff launcher, needs a frame, with the prefix 'plain'
*'''/widgets''': generic desktop widget background
** '''/action-overlays.svgz''': overlays for icons to indicate actions (since KDE 4.4)
*** ''add-normal'': icon used to add the parent icon to a selection of elements (used for instance in folderview), normal state, there are also ''add-hover'' and ''add-pressed''
*** ''remove-normal'': icon used to remove the parent icon to a selection of elements, normal state, there are also ''remove-hover'' and ''remove-pressed''
*** ''open-normal'': icon used to initialize tooltip on folderview widget, there are also ''open-hover'' and ''open-pressed''
** '''/analog_meter.svg''': an analog gauge widget.
***''background'': the body of the analog instrument
***''foreground'': the pin where the hand rotates
***''pointer'': the hand of the instrument
***''rotateminmax'': how much the hand can rotate, the width is the maximum angle in degrees the height the minimum angle
***''label0'': the rect for the first label
***''label1'': the rect for the second label
**'''/arrows.svg''': arrows that match the theme. Four elements should exist in this svg: up-arrow, down-arrow, left-arrow, right-arrow.
**'''/background.svg''': a background image for plasmoids. See the section on backgrounds above for information on the required elements in this file.
*** '''hint-left-shadow''': from KDE 4.10: optional hints that say how big the shadow is
*** '''hint-top-shadow'''
*** '''hint-right-shadow'''
*** '''hint-bottom-shadow'''
** '''/bar_meter_horizontal.svg''': an horizontal meter like a progressbar
***''background'': background of the progressbar
***''foreground'': overlay in the foreground of the progressbar
***''bar'': the progressbar itself
***''background'': a 9 pieces svg with the ''background'' prefix, it replaces the background element if available (KDE 4.2 and later)
***''hint-stretched-bar'': make the progressbar background element stretched rather than tiled (KDE 4.2 and later)
***''bar-active'' and ''bar-inactive'': 9 pieces svgs with the ''bar-active'' and ''bar-inactive'' prefixes, they replace the bar element when available, they will be drawn tiled (KDE4.2 and later)
***''label0'', ''label1'' and ''label2'': rects for 3 labels to be placed around
** '''/bar_meter_vertical.svg''': a vertical meter like a vertical progressbar. It has the same format of ''/bar_meter_horizontal.svg''
** '''/branding.svgz''': a little KDE logo that can be customized by distributors as a branding element. Contains a single element called ''brilliant''
** '''/busywidget.svgz''': Used to indicate a busy state, it's a circular image that will be animated with a rotation.
*** ''busywidget'': the main spinner
*** ''paused'': the paused state
** '''/button.svg''': graphics elements for a button widget (KDE 4.2 and later), it needs the followin prefixes:
*** ''normal'' normal button
*** ''pressed'' pressed button
*** ''active'' button under mouse. Active can have ticker borders that would be rendered outside the widget. It's useful to do a glowing effect DEPRECATED: use ''hover'' instead
*** ''hover'' element that will be in the background of the widget, will act as a border (useful for glow effects) since KDE 4.5
*** ''shadow'' a shadow for the button, can be bigger than the button itself since KDE 4.5
*** ''focus'' keyboard focus rectangle superimposed to the button graphics
** '''/calendar.svg''': graphics for a calendar widget, since 4.3
*** ''weeksColumn'': background for the vertical column with week numbers in it.
*** ''weekDayHeader'': background for the row with week day names in it.
*** ''active'': background for the day numbers of the current month.
*** ''inactive'': background for the day numbers of the next and previous months.
*** ''hoverHighlight'': background for the day under the mouse cursor.
*** ''today'': border for the current day cell.
*** ''selected'': border for the selected day cell.
*** ''red'': border for holidays on sundays
*** ''green'': border for holidays during week days
**'''/clock.svg''': an analog clock face. it must have the following named elements:
*** ''ClockFace'': the background of the clock, usually containing the numbers, etc
*** ''HourHand'': the hour hand, pointing down in the svg
*** ''MinuteHand'': the minute hand, pointing down in the svg
*** ''SecondHand'': the second hand, pointing down in the svg
*** ''HourHandShadow'', ''MinuteHandShadow'' and ''SecondHandShadow'': drop shadows for the hands (optional, KDE 4.1 and later)
*** ''HandCenterScrew'': the "pin" that holds the hands together in the center
*** ''Glass'': a final overlay which allows for things such as the appearance of glass
*** ''hint-square-clock'': if present the shape of the clock will be square rather than round
*** Note: In the svg, the Hand elements must be placed in a position that indicates the time 6:30:30. The y-axis position of the Hand elements with respect to the center of ClockFace is the one they will have in the rendered applet. The x-axis position of the Hand elements does not matter. The Shadow elements should have the same y-axis position as their Hand element counterpart.
** '''/configuration-icons''': it's a set of simple icons that are meant to be shortcuts for configuration actions (KDE 4.2 and later). Must contain the following elements:
*** ''close'': a close icon
*** ''configure'': a setup action
*** ''move''
*** ''resize-vertical'': resize in the y axis
*** ''resize-horizontal'': resize in the x axis
*** ''size-diagonal-tl2br'': resize diagonal, usually an arrow from top-left to bottom-right
*** ''size-diagonal-tr2bl'': resize diagonal, usually an arrow from top-right to bottom-left
*** ''rotate''
*** ''help''
*** ''maximize''
*** ''unmaximize''
*** ''collapse'': set something in a minimized, collapsed status
*** ''restore'': restore from ''collapse'' status
*** ''status'': refers to a status of something, logging or system monitoring in general
*** ''retourn-to-source'': make detached extender items return to their owner applet
*** ''add'' and ''remove'': specular actions, adding and removing for instance an item from a list
*** ''delete'': the (potentially dangerous) action of deleting something
** '''/containment-controls.svg''': handles for the control used to resize the panel (KDE 4.1 and later). The following elements are required.
*** ''maxslider'' maximum size slider, south position
*** ''minslider'' minimum size slider, south position
*** ''offsetslider'' positioning slider, south position
*** Each of the above elements must be present with ''north'', ''south'', ''east'' and ''west'' prefixes for each panel position.
*** There are also four backgrounds (north, south, east and west orientations) for the ruler widget itself in the "Backgrounds format", since the width of the widget is 100% the elements of left and right (or north and bottom if vertical) are not needed
** '''/dragger.svgz''': meant to be a generic drag handle (not currently used but available). It needs to contain the same elements as other backgrounds, see the section about backgrounds above. In addition it needs the following element:
*** ''hint-preferred-icon-size'': the size icons within the drag handle should get. The vertical size of the dragger is also derived from this: this size hint + the dragger's margins.
** '''/extender-background.svgz''': background for extenders. It needs the same elements as other backgrounds.
** '''/extender-dragger.svgz''': Same as dragger.svgz. Drag handle for extenders (like the notification applet, KDE 4.2 and later). It needs to contain the same elements as other backgrounds, see the section about backgrounds above. In addition it needs the following element:
*** ''hint-preferred-icon-size'': the size icons within the drag handle should get. The vertical size of the dragger is also derived from this: this size hint + the dragger's margins.
*** Since KDE 4.6 it contains two optional prefixes: ''grouped'' for extender items contained in extender groups and ''root'' for root extender items. The version without prefix must still exist and is still used for extenders that don't have a stacked appearance.
** '''/frame.svgz''' : a generic frame, used mostly for widget containers, to visually group widgets together. It must contain the following prefixes, for different 3d looks:
*** ''sunken''
*** ''plain''
*** ''raised''
** '''/glowbar.svgz''' : a frame without a prefix, it represents a glow, it's used for instance in Plasma Desktop for the panel autohide unhide hint.
** '''/identiconshapes.svgz''' : shapes for the auto-generation of the activity icons, they must be named from ''Shape1'' to ''Shape32''. Since KDE SC 4.5
** '''/line.svgz''' : a simple line use to separate items in layouts, containe ''vertical-line'' and ''horizzontal-line'' elements (since KDE 4.3)
** '''/lineedit.svgz''': it's a framesvg, used to style line edits, spinboxes and other similar fields (since KDE 4.4) it must have the following prefixes
*** ''base'': the background of the line edit
*** ''focus'': will be drawn outside base, when the line edit has input focus
*** ''hover'': will be drawn outside base, when the line edit is under the mouse
** '''/listitem.svgz''': used for "opened"/clicked notifications (since KDE 4.10)
** '''/monitor.svgz''' : represents a screen, it's used in places such as the wallpaper config dialog. It contains a frame without prefixes and the following extra elements:
*** ''glass'' : glass reflection effect over the screen
*** ''base'' : a stand for the monitor
** '''/pager.svgz''' : graphic elements for the little screens of the pager, it must have 3 frames with the following prefixes:
*** ''normal'' : all virtual desktops
*** ''active'' : active virtual desktop
*** ''hover'' : virtual desktop under mouse
**'''/panel-background.svg''': the background image for panels.
*** If you want to create different background for panels located at the top, bottom, left or right, then also create sets of background elements with the following prefixes: ''north'', ''south'', ''west'' and ''east'' respectively. For example the center element of the left positioned panel's background should be named ''west-center''. (KDE 4.1 and later)
*** When the panel is not 100% wide/tall the north, south etc. prefixes becomes ''north-mini'', ''south-mini'' etc. (KDE 4.2 and later). Please note that if KRunner <menuchoice>Positioning</menuchoice> is set to <menuchoice>Top edge of screen</menuchoice> (which is default), then KDE treats it as not 100% wide north panel.
*** All prefixes fallback to a no prefix version when not available
*** if a prefix called ''shadow'' is available, it will be used as a drop shadow for the panel when compositing is available.
** '''/plot-background.svg''': a background for plotter (graph) widgets, such as the plots in ksysguard
** '''/scrollbar.svgz''' : the classical ''elevator'' scrollbar, must have the following elemens : ''arrow-up'', ''mouseover-arrow-up'', ''sunken-arrow-up'', same 3 elements for ''arrow-left'', ''arrow-right'' and ''arrow-bottom''. From KDE 4.10 it can have an element called ''hint-scrollbar-size'' that says at what size the scrollbar should be rendered (width if vertical, height if horizontal). It must also have frames with the following prefixes:
*** ''slider''
*** ''mouseover-slider''
*** ''sunken-slider''
*** ''background-vertical''
*** ''background-horizontal''
** '''/scrollwidget''': used by Plasma::ScrollWidget, it has a single prefix (KDE4.4 and later)
*** ''border'': a border used when the scrollbar is enabled
** '''/slider.svgz''': used to theme sliders (since KDE 4.3) it must have the following elements:
*** ''vertical-slider-line'': the background for vertical sliders, it indicates how much the indicator can scroll
*** ''vertical-slider-handle'': the handle for vertical sliders
*** ''vertical-slider-focus'': background for the handle when it has input focus (since KDE 4.4)
*** ''vertical-slider-hover'': background for the handle when it is under the mouse (since KDE 4.4)
*** ''groove'': groove for the slider (since KDE 4.8 replaces *-slider-line)
*** ''groove-highlight'': highlight part of the groove (since KDE 4.8 replaces *-slider-line)
*** ''horizontal-slider-line'': the background for horizontal sliders
*** ''horizontal-slider-handle'': the handle for horizontal sliders
*** ''horizontal-slider-focus'': background for the handle when it has input focus (since KDE 4.4)
*** ''horizontal-slider-hover'': background for the handle when it is under the mouse (since KDE 4.4)
** '''/systemtray.svg''': a background for the system tray (KDE 4.1 and later). See the section on backgrounds above for information on the required elements in this file. Since KDE 4.2 it contains also the '''lastelements''' prefix, used for elements in the last position of the systray and the four elements '''expander-right''' up, left and bottom, used for the icon that shows/hides the other systray icons. Since KDE 4.3 there are the '''horizontal-separator''' and '''vertical-separator''' used as a border to separe the last elements.
**'''/tasks.svg''': task item backgrounds for tasks (KDE 4.1 and later). See the section on backgrounds above for information on the required elements in this file. The following element prefixes are required:
*** ''focus'': background of focused task item
*** ''hover'': background when the pointer hovers the task item. From KDE 4.2 focus and hover can have ticker borders that will be painted outside the task button, useful to make a glow effect.
*** ''attention'': background when tasks item is trying to get attention
*** ''normal'': background of normal, unfocused task item
*** ''minimized'': background for minimized tasks
*** The svg should contain elements of all five prefixes, if a prefix is missing that element will be not be drawn.
** '''/toolbox.svgz''' : graphical elements for the desktop toolbox, it must have a frame without prefixes plus those following elements:
*** ''desktop-northwest'', ''desktop-northeast'', ''desktop-southwest'', ''desktop-southeast'': the 4 corners for the desktop toolbox.
*** ''panel-north'', ''panel-south'', ''panel-west'', ''panel-east'' : elements for the panel toolbox.
** '''/tooltip.svg''': background for tooltips used for instance in the taskbar and with icons. See the section on backgrounds above for information on the required elements in this file.
** '''/translucentbackground.svg''': a standard background image for plasmoids that for their nature are bigger and with not much text. In this case a translucent background looks better. It needs the same elements of background.svg in it. If this file is not present, the plasmoids that uses this will use background.svg instead.
** '''/media-delegate.svgz''': intended to be used as delegate for media types: as KDE 4.7 contains a single prefix: picture.
** '''/viewitem.svgz''': controls the background look of selections (results in KRunner, networks in network applet), it can have 4 elements of 9 parts each with prefix ''normal'', ''hover'', ''selected'', ''selected+hover''.
** '''/toolbar.svgz''': used in the ToolBar QML component, can be used in custom applications in a similar way, contains a single frame without prefix. Since KDE 4.8.

=="Opaque" folder==

In the folder {{path|share/apps/desktoptheme/opaque}} the same hierarchy can be found: when compositing is disabled files in this folder are preferred over the corresponding ones listed above. Only background for top level windows are appropriate to go in this folder.

Since top-level windows will be shaped according to the transparency of the svg and window shapes don't support alpha-blending, if the svg has rounded borders they should have a shape that don't require antialiasing, like the following example.

[[Image:No_composite_plasma_svg.jpg]]

=="translucent" folder ==

In the folder {{path|share/apps/desktoptheme/translucent}} the same hierarchy is used: when the KWin ''blurbehind'' effect is enabled the file under this folder will be used if found. As the opaque folder, only elements that will be rendered as window backgrounds should be present in this folder, so the dialogs folder, plus the panel and tooltip backgrounds. When is possible to blur the background of the window, the graphics can be more transparent, keeping the window text readable.

=="icons" folder==

In the folder {{path|share/apps/desktoptheme/icons}}, SVG files that contain scalable icons for use with application status items (e.g. icons in the system tray) are contained.

The default theme contains the following SVGs:

* audio.svgz
* battery.svgz
* device.svgz
* klipper.svgz
* kwalletmanager.svgz
* nepomuk.svgz
* network.svgz
* notification.svgz
* preferences.svgz
* wallet.svgz

The files are named the same as the matching icon theme names or their prefix (both work, which is why "audio" matches for mixers, e.g.). Other icons can be added as long as they match the names of requested icons by the application status items.

== Theming Application Icons in the Systemtray ==

Applications that use a function called setIconByName can have their icon in the system tray themed. Applications can have more than one icon (for example Konversation flashes between two different icons to hilight when your username is mentioned and Kpackagekit changes it's icon depending on the status of it's upgrade / installs). Theming these icons requires firstly that an application has been coded to use setIconByName, and secondly that you call your svg object by the same name (use ctrl+shift+o in Inkscape). Then you can just put your .svgz in {{path|share/apps/desktoptheme/default/icons}} (changing default to your theme folder name).

The following is an attempt to list known icon names that may be themed by this method. Please add any other known icon names and the object ID here to help other people making themes:

* Amarok
** filename: '''amarok.svgz'''
*** ID: '''amarok'''
* audio (for kmix, veromix, a.o.)
** filename: '''audio.svgz'''
*** volume muted ID: '''audio-volume-muted'''
*** volume low ID: '''audio-volume-low'''
*** volume medium ID: '''audio-volume-medium'''
*** volume high ID: '''audio-volume-high'''
* battery
** filename: '''battery.svgz'''
*** battery (always shown object) ID: '''Battery'''
*** on powerline ID: '''AcAdapter'''
*** no battery found ID: '''Unavailable'''
*** battery on 10% ID: '''Fill10''' ''(new in 4.11)''
*** battery on 20% ID: '''Fill20'''
*** battery on 30% ID: '''Fill30''' ''(new in 4.11)''
*** battery on 40% ID: '''Fill40'''
*** battery on 50% ID: '''Fill50''' ''(new in 4.11)''
*** battery on 60% ID: '''Fill60'''
*** battery on 70% ID: '''Fill70''' ''(new in 4.11)''
*** battery on 80% ID: '''Fill80'''
*** battery on 90% ID: '''Fill90''' ''(new in 4.11)''
*** battery on 100% ID: '''Fill100'''
* device (the device-notifier)
** filename: '''device.svgz'''
*** ID: '''device-notifier'''
* juk
** filename: '''juk.svgz'''
*** ID: '''juk'''
* KGet
** filename: '''kget.svgz'''
*** ID: '''kget'''
* Klipper
** filename: '''klipper.svgz'''
*** ID: '''klipper'''
* Konversation
** filename: '''konversation'''
*** ID: '''konversation'''
** filename: '''konv_message.svgz''' (new incomming message)
*** ID: '''konv_message'''
* Kopete
** filename: '''kopete.svgz'''
*** öffline ID: '''kopete-offline'''
*** online ID: '''kopete'''
*** other statuses are not supported atm
* Korgac
** filename: '''korgac.svgz'''
*** ID: '''korgac'''
* Ktorrent
** filename: '''ktorrent.svgz'''
*** ID: '''ktorrent'''
* message-indicator
** filename: '''message-indicator.svgz'''
*** standard ID: '''normal'''
*** new message ID: '''new'''
* Nepomuk
** filename: '''nepomuk.svgz'''
*** ID: '''nepomuk'''
* Network-management-plasmoid
** filename: '''network.svgz'''
*** wired online ID: '''network-wired-activated'''
*** wired offline ID: '''network-wired'''
*** wless offline ID: '''network-wireless-0'''
*** wless on 20% ID: '''network-wireless-20'''
*** wless on 25% ID: '''network-wireless-25'''
*** wless on 40% ID: '''network-wireless-40'''
*** wless on 50% ID: '''network-wireless-50'''
*** wless on 60% ID: '''network-wireless-60'''
*** wless on 75% ID: '''network-wireless-75'''
*** wless on 80% ID: '''network-wireless-80'''
*** wless on 100% ID: '''network-wireless-100'''
*** mobile broadband on 0% ID: '''network-mobile-0'''
*** mobile broadband on 20% ID: '''network-mobile-20'''
*** mobile broadband on 40% ID: '''network-mobile-40'''
*** mobile broadband on 60% ID: '''network-mobile-60'''
*** mobile broadband on 80% ID: '''network-mobile-80'''
*** mobile broadband on 100% ID: '''network-mobile-100'''
*** mobile broadband with access technology on 0% ID: '''network-mobile-0-technology''' (''technology'' can be: ''none, gprs, edge, umts, hsdpa, hsupa, hspa, lte'')
* preferences (some apps like bluedevil, krandrtray, text-to-speech)
** filename: '''preferences.svgz'''
*** bluedevil online ID: '''preferences-system-bluetooth'''
*** bluedevil offline ID: '''preferences-system-bluetooth-inactive'''
*** text-to-speech ID: '''preferences-desktop-text-to-speech'''
*** krandrtray ID: '''preferences-desktop-display-randr'''
*** activity manager ID: '''preferences-activities'''
* Printer applet
** filename: '''printer.svgz'''
*** ID: '''printer'''
* Quassel IRC
** filename: '''quassel.svgz'''
*** quassel öffline ID: '''quassel_inactive''' ("quassel-inactive" in kde 4.10)
*** quassel online ID: '''quassel'''
*** quassel new message ID: '''quassel_message''' ("quassel-message" in kde 4.10)
* KWallet
** filename: '''wallet.svgz'''
*** open ID: '''wallet-open'''
*** closed ID: '''wallet-closed'''

At the time of writing, KDE-PIM (Kmail, Akregator etc) do not yet use setIconByName and thus aren't able to be themed this way. Reportedly, this is is coming in Kontact 2.

Development/Tutorials/Plasma/ThemeDetails

2013-06-04T21:04:56Z

Broulik: /* Theming Application Icons in the Systemtray */ Added theming for mobile broadband icons

<tt>libplasma</tt> provides the Theme class so Plasma elements and other applications, such as KRunner, that need to graphically hint or theme interface elements. This is not a replacement for {{qt|qstyle}}, but rather provides standard elements for things such as box backgrounds.

This allows for easy re-theming of the desktop while also keeping elements on the desktop more consistent with each other.

See also [[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme]].

== Theme Location, Structure and Definition ==
Themes are stored in {{path|share/apps/desktoptheme}}. A theme is described by a .desktop file in {{path|share/apps/desktoptheme}}. The contents of which might look like this:

<syntaxhighlight lang="text">
[Desktop Entry]
Name=Oxygen
Comment=Theme done in the Oxygen style

X-KDE-PluginInfo-Author=The Oxygen Project
X-KDE-PluginInfo-Email=kde-artists@kde.org
X-KDE-PluginInfo-Name=default
X-KDE-PluginInfo-Version=pre0.1
X-KDE-PluginInfo-Website=http://plasma.kde.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</syntaxhighlight>

The X-KDE-PluginInfo-Name entry must contain the name of the subdirectory in {{path|share/apps/desktoptheme}} where the SVG files for this theme exist.

Beneath this directory one will find the following file structure:

* '''colors''': optional a configuration file defining a colorscheme that blends well with the images
* '''dialogs/''': images for dialogs
* '''wallpapers/''': wallpaper packages
* '''widgets/''': images for widgets
* '''opaque/''': optional directory containing images appropriate for non-compositing environments
* '''locolor/''': optional directory containing images appropraite for locolor (e.g. 8 bit color) environments

== Image Access ==
Theme elements are accessed by path. Whether this maps to literal paths on disk or not is not guaranteed and considered an implementation detail of Plasma::Theme.

Therefore, to access the dialog background, one might create an svg in this manner:

<syntaxhighlight lang="cpp-qt">
Plasma::Theme theme;
QSvgRenderer svg(theme.image("dialogs/background"));
</syntaxhighlight>

It '''is generally recommended''' to use Plasma::Svg instead of QSvgRenderer directly, however. This is because Plasma::Svg uses caching where it can. Remember to call resize() on the Plasma::Svg before painting with it!

<syntaxhighlight lang="cpp-qt">
Plasma::Svg svg("dialogs/background");
svg.resize(size());
</syntaxhighlight>

== Wallpaper Access ==

Themes may optionally provide wallpapers to be used with the theme. These wallpapers must appear in the {{path|wallpapers/}} directory within the theme.

A theme may also define a default wallpaper, wallpaper size and wallpaper file extension to be used in conjunction with the theme. The default wallpaper may either be installed in the standard location for wallpapers or may be shipped with the theme itself. The default wallpaper settings should appear in the theme's metadata.desktop file and contain the following entries:

<syntaxhighlight lang="text">
[Wallpaper]
defaultWallpaperTheme=<name of default wallpaper package>
defaultFileSuffix=<wallpaper file suffix, e.g. .jpg>
defaultWidth=<width in pixels of default wallpaper file>
defaultHeight=<height in pixels of default wallpaper file>
</syntaxhighlight>

== Animations ==

Animations written in Javascript can be included in the {{path|animations}} directory within the theme. To learn how to create such animations and expose them in your theme, visit the [[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations tutorial]].

== Reaction to Theme Changes ==
If you use Plasma::Svg, changes to the theme are automatically picked up. Otherwise, you can connect to the <tt>changed()</tt> signal in the Plasma::Theme class. This signal is emitted whenever the theme is changed, which may be triggered by the user switching the theme used or system changes such as a composite manager becoming available.

== Colors ==

The colors file follows the standard KDE colorscheme file format and allows a theme to define what colors work best with its theme elements. The colors in this file can be edited with the default color scheme module.
*Make a new colorscheme using the editor in SystemSettings>>Appearance>>Colors.
*Save it with a unique name.
*Open the colorscheme in kate.
**Saved at /home/[user]/.kde/share/apps/color-schemes/[unique name].colors
*Copy everything to your plasma colors file except the "[ColorEffects:Disabled]" and "[ColorEffects:Inactive]" sections.

The most common use of the colors file is to ensure that text is readable on various backgrounds.

Here is a list of color entries in the colors file that are currently actively used in a Plasma theme:

* '''[Colors:Window]'''
** '''ForegroundNormal''' the text color applied to text on the standard background elements; maps to Theme::TextColor
** '''DecorationHover''' the color used for text highlighting; maps to Theme::HighlightCoor
** '''BackgroundNormal''' the default background color, for items that paint a background themselves, allowing them to blend in with the theme; maps to Theme::BackgroundColor
* '''[Colors:Button]'''
** '''ForegroundNormal''' the text color to use on push buttons; maps to Theme::ButtonTextColor
** '''BackgroundNormal''' used for hinting buttons; maps to Theme::ButtonBackgroundColor
** '''ForegroundActive''' color used to tint BackgroundNormal for final button hinting color
* '''[Colors:View]'''
** '''ForegroundLink''' clickable text link font color
** '''ForegroundVisited''' visited clickable text link font color

Other colors in the file may be used by individual widgets or used in the future, so it doesn't hurt to provide a complete colorscheme file and is probably a safer strategy.

Currently also used by individual widgets, which should give a good idea of additional usage patterns:

* '''[Colors:View]'''
** '''ForegroundActive''' used by the digital and fuzzy clocks for the default text color, dictionary widget for results text, microblog for status update text
** '''ForegroundInactive''' used by the pager to draw non-active windows and frames, microblog for user names
** '''ForegroundNormal''' used by microblog for status update entry area background

Note that some of these may end up folded back into Plasma::Theme properly at some point.

== Backgrounds format==
All background svg's (except for desktop wallpapers) must have the following named elements, all of which will be painted at the ''native'' size (and can therefore be bitmaps), except for the center which will be scaled:
* '''topleft''': the top left corner
* '''topright''': the top right corner
* '''bottomleft''': the bottom left corner
* '''bottomright''': the bottom right corner
* '''top''': the top bar between the two top corners
* '''left''': the left bar between the two left corners
* '''right''': the right bar between the two right corners
* '''bottom''': the bottom bar between the two bottom corners
* '''center''': the center fill; will be scaled so should be an actual SVG element

Some plasma components may use the above named elements with prefixes. For example the panel placed on the left side of the screen uses the "west" prefix ('''west-topleft''', '''west-topright''', etc.).

Additionally, the following elements can be used to control the rendering of the backgrounds:

* '''hint-stretch-borders''': if it exists, the borders will not be tiled but rather will be stretched to fit
* '''hint-tile-center''': if it exists, the center will not be scaled but rather will be tiled to fit. (Optional, from 4.1 and later)
* '''hint-no-border-padding''': If this element exists, padding will not be added for the borders, and content will therefore be able to use the entire area (inclusive borders).
* '''hint-apply-color-scheme''': If this element exists, the svg will be colorized using the color scheme colors. Colorization is applied at 100%, and tapers off on either side, of an HSV color value/intensity of 127. (Optional, From KDE 4.1 and later)
* '''current-color-scheme''': If a style element with this id exists it is replaced by a css-style with colors of the current colorscheme. See below for details. (Optional, From KDE 4.6 and later)
* '''[prefix]-hint-[direction]-margin''': Use this optional hints if you want different margins than the borders size. The [prefix]- part is optional and identifies the prefix of the panel you want to specify the margins. [direction] can be either top, bottom, left or right and indicates the border you want to configure. For top and bottom margins the height of these hints are used, for left and right margins the width. (Optional, From KDE 4.2 and later)
* '''[prefix]-hint-compose-over-border''': if this element is resent, the center element will be drawn with the same size as the total image, composed under the borders and shaped with the alpha mask frame, that has to be present in order to make work this hint(Optional, from KDE 4.5)

From KDE 4.3 can exists an element called overlay (or prefix-overlay if to be appled to a frame with a different prefix) it will be rendered over the frame as a filigrane effects, with the rules given from the following mutually exclusive hints:
* '''hint-overlay-random-pos''' it will be put at a random position, this works just for applet backgrounds
* '''hint-overlay-tile''' tile the overlay
* '''hint-overlay-stretch''' the overlay will be stretched
* '''hint-overlay-pos-right''' align the overlay at right of the background rather than to the left (from KDE 4.4)
* '''hint-overlay-pos-bottom''' align the overlay at bottom of the background rather than to the top (from KDE 4.4)

=== Using system colors ===
It is possible to apply colors from the color scheme to a graphic. A very easy way to reach this is by adding an element with the id '''hint-apply-color-scheme''' to the svg. In this case the rendered graphic gets converted to monochrome and colorized by the window background color.

A more flexible solution is available since KDE 4.6 by using css-styling. For this to work the svg must have a style-element with the id '''current-color-scheme'''. Before the graphic is rendered this element gets replaced by a style containing classes where the color attribute is set to the corresponding system color. Currently the following classes are defined:
* ColorScheme-Text
* ColorScheme-Background
* ColorScheme-ViewText
* ColorScheme-ViewBackground
* ColorScheme-ViewHover
* ColorScheme-ViewFocus
* ColorScheme-ButtonText
* ColorScheme-ButtonBackground
* ColorScheme-ButtonHover
* ColorScheme-ButtonFocus

In order to apply a color from a class to an element, its fill or stroke attribute must be '''currentColor''' and of course the name of the wanted class has to be in the class-attribute. Special attention is needed on gradients, as neither the gradient-tags themself nor the stop-tags accept classes. To still get the wanted result one can put a g-tag around them and apply the class to this.

'''Hint:''' If you want to use this new feature and still be able to use the graphics on older versions, you can set the color for ColorScheme-Background to #7f7f7f and place a <tt><rect id="hint-apply-color-scheme" width="1" height="1" fill="none" /></tt> below your css-code but before the closing <tt></style></tt>

If you don't want to bother with the source code of your graphics, you can use the tool svgmod for easily applying system colors. See [https://projects.kde.org/projects/playground/devtools/svgmod here].

== Current Theme Elements ==

Themes get installed to {{path|share/apps/desktoptheme}}. Each theme is stored in a subdirectory with the following file structure

*'''/dialogs''': elements for dialogs
**'''/background.svg''': generic dialog background used by the sceensaver password dialog, etc. See the section on backgrounds above for information on the required elements in this file.
*** '''hint-left-shadow''': from KDE 4.10: optional hints that say how big the shadow is
*** '''hint-top-shadow'''
*** '''hint-right-shadow'''
*** '''hint-bottom-shadow'''
**'''/krunner.svg''': dialog background, used by the Run Command. Please note, that this is used only when <menuchoice>Positioning</menuchoice> is set to <menuchoice>Free floating window</menuchoice>, '''not''' <menuchoice>Top edge of screen</menuchoice> (which is default). See the section on backgrounds above for information on the required elements in this file.
**'''/shutdowndlg.svg''': background and buttons for the log out dialog
***''background'': background for the logout dialog
***''button-normal'': button background
***''button-hover'': button background on cursor hover
***''button-small-normal'': small button background
***''button-small-hover'': small button background on cursor hover
** '''/kickoff.svgz''' : background for the kickoff launcher, needs a frame, with the prefix 'plain'
*'''/widgets''': generic desktop widget background
** '''/action-overlays.svgz''': overlays for icons to indicate actions (since KDE 4.4)
*** ''add-normal'': icon used to add the parent icon to a selection of elements (used for instance in folderview), normal state, there are also ''add-hover'' and ''add-pressed''
*** ''remove-normal'': icon used to remove the parent icon to a selection of elements, normal state, there are also ''remove-hover'' and ''remove-pressed''
*** ''open-normal'': icon used to initialize tooltip on folderview widget, there are also ''open-hover'' and ''open-pressed''
** '''/analog_meter.svg''': an analog gauge widget.
***''background'': the body of the analog instrument
***''foreground'': the pin where the hand rotates
***''pointer'': the hand of the instrument
***''rotateminmax'': how much the hand can rotate, the width is the maximum angle in degrees the height the minimum angle
***''label0'': the rect for the first label
***''label1'': the rect for the second label
**'''/arrows.svg''': arrows that match the theme. Four elements should exist in this svg: up-arrow, down-arrow, left-arrow, right-arrow.
**'''/background.svg''': a background image for plasmoids. See the section on backgrounds above for information on the required elements in this file.
*** '''hint-left-shadow''': from KDE 4.10: optional hints that say how big the shadow is
*** '''hint-top-shadow'''
*** '''hint-right-shadow'''
*** '''hint-bottom-shadow'''
** '''/bar_meter_horizontal.svg''': an horizontal meter like a progressbar
***''background'': background of the progressbar
***''foreground'': overlay in the foreground of the progressbar
***''bar'': the progressbar itself
***''background'': a 9 pieces svg with the ''background'' prefix, it replaces the background element if available (KDE 4.2 and later)
***''hint-stretched-bar'': make the progressbar background element stretched rather than tiled (KDE 4.2 and later)
***''bar-active'' and ''bar-inactive'': 9 pieces svgs with the ''bar-active'' and ''bar-inactive'' prefixes, they replace the bar element when available, they will be drawn tiled (KDE4.2 and later)
***''label0'', ''label1'' and ''label2'': rects for 3 labels to be placed around
** '''/bar_meter_vertical.svg''': a vertical meter like a vertical progressbar. It has the same format of ''/bar_meter_horizontal.svg''
** '''/branding.svgz''': a little KDE logo that can be customized by distributors as a branding element. Contains a single element called ''brilliant''
** '''/busywidget.svgz''': Used to indicate a busy state, it's a circular image that will be animated with a rotation.
*** ''busywidget'': the main spinner
*** ''paused'': the paused state
** '''/button.svg''': graphics elements for a button widget (KDE 4.2 and later), it needs the followin prefixes:
*** ''normal'' normal button
*** ''pressed'' pressed button
*** ''active'' button under mouse. Active can have ticker borders that would be rendered outside the widget. It's useful to do a glowing effect DEPRECATED: use ''hover'' instead
*** ''hover'' element that will be in the background of the widget, will act as a border (useful for glow effects) since KDE 4.5
*** ''shadow'' a shadow for the button, can be bigger than the button itself since KDE 4.5
*** ''focus'' keyboard focus rectangle superimposed to the button graphics
** '''/calendar.svg''': graphics for a calendar widget, since 4.3
*** ''weeksColumn'': background for the vertical column with week numbers in it.
*** ''weekDayHeader'': background for the row with week day names in it.
*** ''active'': background for the day numbers of the current month.
*** ''inactive'': background for the day numbers of the next and previous months.
*** ''hoverHighlight'': background for the day under the mouse cursor.
*** ''today'': border for the current day cell.
*** ''selected'': border for the selected day cell.
*** ''red'': border for holidays on sundays
*** ''green'': border for holidays during week days
**'''/clock.svg''': an analog clock face. it must have the following named elements:
*** ''ClockFace'': the background of the clock, usually containing the numbers, etc
*** ''HourHand'': the hour hand, pointing down in the svg
*** ''MinuteHand'': the minute hand, pointing down in the svg
*** ''SecondHand'': the second hand, pointing down in the svg
*** ''HourHandShadow'', ''MinuteHandShadow'' and ''SecondHandShadow'': drop shadows for the hands (optional, KDE 4.1 and later)
*** ''HandCenterScrew'': the "pin" that holds the hands together in the center
*** ''Glass'': a final overlay which allows for things such as the appearance of glass
*** ''hint-square-clock'': if present the shape of the clock will be square rather than round
*** Note: In the svg, the Hand elements must be placed in a position that indicates the time 6:30:30. The y-axis position of the Hand elements with respect to the center of ClockFace is the one they will have in the rendered applet. The x-axis position of the Hand elements does not matter. The Shadow elements should have the same y-axis position as their Hand element counterpart.
** '''/configuration-icons''': it's a set of simple icons that are meant to be shortcuts for configuration actions (KDE 4.2 and later). Must contain the following elements:
*** ''close'': a close icon
*** ''configure'': a setup action
*** ''move''
*** ''resize-vertical'': resize in the y axis
*** ''resize-horizontal'': resize in the x axis
*** ''size-diagonal-tl2br'': resize diagonal, usually an arrow from top-left to bottom-right
*** ''size-diagonal-tr2bl'': resize diagonal, usually an arrow from top-right to bottom-left
*** ''rotate''
*** ''help''
*** ''maximize''
*** ''unmaximize''
*** ''collapse'': set something in a minimized, collapsed status
*** ''restore'': restore from ''collapse'' status
*** ''status'': refers to a status of something, logging or system monitoring in general
*** ''retourn-to-source'': make detached extender items return to their owner applet
*** ''add'' and ''remove'': specular actions, adding and removing for instance an item from a list
*** ''delete'': the (potentially dangerous) action of deleting something
** '''/containment-controls.svg''': handles for the control used to resize the panel (KDE 4.1 and later). The following elements are required.
*** ''maxslider'' maximum size slider, south position
*** ''minslider'' minimum size slider, south position
*** ''offsetslider'' positioning slider, south position
*** Each of the above elements must be present with ''north'', ''south'', ''east'' and ''west'' prefixes for each panel position.
*** There are also four backgrounds (north, south, east and west orientations) for the ruler widget itself in the "Backgrounds format", since the width of the widget is 100% the elements of left and right (or north and bottom if vertical) are not needed
** '''/dragger.svgz''': meant to be a generic drag handle (not currently used but available). It needs to contain the same elements as other backgrounds, see the section about backgrounds above. In addition it needs the following element:
*** ''hint-preferred-icon-size'': the size icons within the drag handle should get. The vertical size of the dragger is also derived from this: this size hint + the dragger's margins.
** '''/extender-background.svgz''': background for extenders. It needs the same elements as other backgrounds.
** '''/extender-dragger.svgz''': Same as dragger.svgz. Drag handle for extenders (like the notification applet, KDE 4.2 and later). It needs to contain the same elements as other backgrounds, see the section about backgrounds above. In addition it needs the following element:
*** ''hint-preferred-icon-size'': the size icons within the drag handle should get. The vertical size of the dragger is also derived from this: this size hint + the dragger's margins.
*** Since KDE 4.6 it contains two optional prefixes: ''grouped'' for extender items contained in extender groups and ''root'' for root extender items. The version without prefix must still exist and is still used for extenders that don't have a stacked appearance.
** '''/frame.svgz''' : a generic frame, used mostly for widget containers, to visually group widgets together. It must contain the following prefixes, for different 3d looks:
*** ''sunken''
*** ''plain''
*** ''raised''
** '''/glowbar.svgz''' : a frame without a prefix, it represents a glow, it's used for instance in Plasma Desktop for the panel autohide unhide hint.
** '''/identiconshapes.svgz''' : shapes for the auto-generation of the activity icons, they must be named from ''Shape1'' to ''Shape32''. Since KDE SC 4.5
** '''/line.svgz''' : a simple line use to separate items in layouts, containe ''vertical-line'' and ''horizzontal-line'' elements (since KDE 4.3)
** '''/lineedit.svgz''': it's a framesvg, used to style line edits, spinboxes and other similar fields (since KDE 4.4) it must have the following prefixes
*** ''base'': the background of the line edit
*** ''focus'': will be drawn outside base, when the line edit has input focus
*** ''hover'': will be drawn outside base, when the line edit is under the mouse
** '''/listitem.svgz''': used for "opened"/clicked notifications (since KDE 4.10)
** '''/monitor.svgz''' : represents a screen, it's used in places such as the wallpaper config dialog. It contains a frame without prefixes and the following extra elements:
*** ''glass'' : glass reflection effect over the screen
*** ''base'' : a stand for the monitor
** '''/pager.svgz''' : graphic elements for the little screens of the pager, it must have 3 frames with the following prefixes:
*** ''normal'' : all virtual desktops
*** ''active'' : active virtual desktop
*** ''hover'' : virtual desktop under mouse
**'''/panel-background.svg''': the background image for panels.
*** If you want to create different background for panels located at the top, bottom, left or right, then also create sets of background elements with the following prefixes: ''north'', ''south'', ''west'' and ''east'' respectively. For example the center element of the left positioned panel's background should be named ''west-center''. (KDE 4.1 and later)
*** When the panel is not 100% wide/tall the north, south etc. prefixes becomes ''north-mini'', ''south-mini'' etc. (KDE 4.2 and later). Please note that if KRunner <menuchoice>Positioning</menuchoice> is set to <menuchoice>Top edge of screen</menuchoice> (which is default), then KDE treats it as not 100% wide north panel.
*** All prefixes fallback to a no prefix version when not available
*** if a prefix called ''shadow'' is available, it will be used as a drop shadow for the panel when compositing is available.
** '''/plot-background.svg''': a background for plotter (graph) widgets, such as the plots in ksysguard
** '''/scrollbar.svgz''' : the classical ''elevator'' scrollbar, must have the following elemens : ''arrow-up'', ''mouseover-arrow-up'', ''sunken-arrow-up'', same 3 elements for ''arrow-left'', ''arrow-right'' and ''arrow-bottom''. From KDE 4.10 it can have an element called ''hint-scrollbar-size'' that says at what size the scrollbar should be rendered (width if vertical, height if horizontal). It must also have frames with the following prefixes:
*** ''slider''
*** ''mouseover-slider''
*** ''sunken-slider''
*** ''background-vertical''
*** ''background-horizontal''
** '''/scrollwidget''': used by Plasma::ScrollWidget, it has a single prefix (KDE4.4 and later)
*** ''border'': a border used when the scrollbar is enabled
** '''/slider.svgz''': used to theme sliders (since KDE 4.3) it must have the following elements:
*** ''vertical-slider-line'': the background for vertical sliders, it indicates how much the indicator can scroll
*** ''vertical-slider-handle'': the handle for vertical sliders
*** ''vertical-slider-focus'': background for the handle when it has input focus (since KDE 4.4)
*** ''vertical-slider-hover'': background for the handle when it is under the mouse (since KDE 4.4)
*** ''groove'': groove for the slider (since KDE 4.8 replaces *-slider-line)
*** ''groove-highlight'': highlight part of the groove (since KDE 4.8 replaces *-slider-line)
*** ''horizontal-slider-line'': the background for horizontal sliders
*** ''horizontal-slider-handle'': the handle for horizontal sliders
*** ''horizontal-slider-focus'': background for the handle when it has input focus (since KDE 4.4)
*** ''horizontal-slider-hover'': background for the handle when it is under the mouse (since KDE 4.4)
** '''/systemtray.svg''': a background for the system tray (KDE 4.1 and later). See the section on backgrounds above for information on the required elements in this file. Since KDE 4.2 it contains also the '''lastelements''' prefix, used for elements in the last position of the systray and the four elements '''expander-right''' up, left and bottom, used for the icon that shows/hides the other systray icons. Since KDE 4.3 there are the '''horizontal-separator''' and '''vertical-separator''' used as a border to separe the last elements.
**'''/tasks.svg''': task item backgrounds for tasks (KDE 4.1 and later). See the section on backgrounds above for information on the required elements in this file. The following element prefixes are required:
*** ''focus'': background of focused task item
*** ''hover'': background when the pointer hovers the task item. From KDE 4.2 focus and hover can have ticker borders that will be painted outside the task button, useful to make a glow effect.
*** ''attention'': background when tasks item is trying to get attention
*** ''normal'': background of normal, unfocused task item
*** ''minimized'': background for minimized tasks
*** The svg should contain elements of all five prefixes, if a prefix is missing that element will be not be drawn.
** '''/toolbox.svgz''' : graphical elements for the desktop toolbox, it must have a frame without prefixes plus those following elements:
*** ''desktop-northwest'', ''desktop-northeast'', ''desktop-southwest'', ''desktop-southeast'': the 4 corners for the desktop toolbox.
*** ''panel-north'', ''panel-south'', ''panel-west'', ''panel-east'' : elements for the panel toolbox.
** '''/tooltip.svg''': background for tooltips used for instance in the taskbar and with icons. See the section on backgrounds above for information on the required elements in this file.
** '''/translucentbackground.svg''': a standard background image for plasmoids that for their nature are bigger and with not much text. In this case a translucent background looks better. It needs the same elements of background.svg in it. If this file is not present, the plasmoids that uses this will use background.svg instead.
** '''/media-delegate.svgz''': intended to be used as delegate for media types: as KDE 4.7 contains a single prefix: picture.
** '''/viewitem.svgz''': controls the background look of selections (results in KRunner, networks in network applet), it can have 4 elements of 9 parts each with prefix ''normal'', ''hover'', ''selected'', ''selected+hover''.
** '''/toolbar.svgz''': used in the ToolBar QML component, can be used in custom applications in a similar way, contains a single frame without prefix. Since KDE 4.8.

=="Opaque" folder==

In the folder {{path|share/apps/desktoptheme/opaque}} the same hierarchy can be found: when compositing is disabled files in this folder are preferred over the corresponding ones listed above. Only background for top level windows are appropriate to go in this folder.

Since top-level windows will be shaped according to the transparency of the svg and window shapes don't support alpha-blending, if the svg has rounded borders they should have a shape that don't require antialiasing, like the following example.

[[Image:No_composite_plasma_svg.jpg]]

=="translucent" folder ==

In the folder {{path|share/apps/desktoptheme/translucent}} the same hierarchy is used: when the KWin ''blurbehind'' effect is enabled the file under this folder will be used if found. As the opaque folder, only elements that will be rendered as window backgrounds should be present in this folder, so the dialogs folder, plus the panel and tooltip backgrounds. When is possible to blur the background of the window, the graphics can be more transparent, keeping the window text readable.

=="icons" folder==

In the folder {{path|share/apps/desktoptheme/icons}}, SVG files that contain scalable icons for use with application status items (e.g. icons in the system tray) are contained.

The default theme contains the following SVGs:

* audio.svgz
* battery.svgz
* device.svgz
* klipper.svgz
* kwalletmanager.svgz
* nepomuk.svgz
* network.svgz
* notification.svgz
* preferences.svgz
* wallet.svgz

The files are named the same as the matching icon theme names or their prefix (both work, which is why "audio" matches for mixers, e.g.). Other icons can be added as long as they match the names of requested icons by the application status items.

== Theming Application Icons in the Systemtray ==

Applications that use a function called setIconByName can have their icon in the system tray themed. Applications can have more than one icon (for example Konversation flashes between two different icons to hilight when your username is mentioned and Kpackagekit changes it's icon depending on the status of it's upgrade / installs). Theming these icons requires firstly that an application has been coded to use setIconByName, and secondly that you call your svg object by the same name (use ctrl+shift+o in Inkscape). Then you can just put your .svgz in {{path|share/apps/desktoptheme/default/icons}} (changing default to your theme folder name).

The following is an attempt to list known icon names that may be themed by this method. Please add any other known icon names and the object ID here to help other people making themes:

* Amarok
** filename: '''amarok.svgz'''
*** ID: '''amarok'''
* audio (for kmix, veromix, a.o.)
** filename: '''audio.svgz'''
*** volume muted ID: '''audio-volume-muted'''
*** volume low ID: '''audio-volume-low'''
*** volume medium ID: '''audio-volume-medium'''
*** volume high ID: '''audio-volume-high'''
* battery
** filename: '''battery.svgz'''
*** battery (always shown object) ID: '''Battery'''
*** on powerline ID: '''AcAdapter'''
*** no battery found ID: '''Unavailable'''
*** battery on 10% ID: '''Fill10''' ''(new in 4.11)''
*** battery on 20% ID: '''Fill20'''
*** battery on 30% ID: '''Fill30''' ''(new in 4.11)''
*** battery on 40% ID: '''Fill40'''
*** battery on 50% ID: '''Fill50''' ''(new in 4.11)''
*** battery on 60% ID: '''Fill60'''
*** battery on 70% ID: '''Fill70''' ''(new in 4.11)''
*** battery on 80% ID: '''Fill80'''
*** battery on 90% ID: '''Fill90''' ''(new in 4.11)''
*** battery on 100% ID: '''Fill100'''
* device (the device-notifier)
** filename: '''device.svgz'''
*** ID: '''device-notifier'''
* juk
** filename: '''juk.svgz'''
*** ID: '''juk'''
* KGet
** filename: '''kget.svgz'''
*** ID: '''kget'''
* Klipper
** filename: '''klipper.svgz'''
*** ID: '''klipper'''
* Konversation
** filename: '''konversation'''
*** ID: '''konversation'''
** filename: '''konv_message.svgz''' (new incomming message)
*** ID: '''konv_message'''
* Kopete
** filename: '''kopete.svgz'''
*** öffline ID: '''kopete-offline'''
*** online ID: '''kopete'''
*** other statuses are not supported atm
* Korgac
** filename: '''korgac.svgz'''
*** ID: '''korgac'''
* Ktorrent
** filename: '''ktorrent.svgz'''
*** ID: '''ktorrent'''
* message-indicator
** filename: '''message-indicator.svgz'''
*** standard ID: '''normal'''
*** new message ID: '''new'''
* Nepomuk
** filename: '''nepomuk.svgz'''
*** ID: '''nepomuk'''
* Network-management-plasmoid
** filename: '''network.svgz'''
*** wired online ID: '''network-wired-activated'''
*** wired offline ID: '''network-wired'''
*** wless offline ID: '''network-wireless-0'''
*** wless on 20% ID: '''network-wireless-20'''
*** wless on 25% ID: '''network-wireless-25'''
*** wless on 40% ID: '''network-wireless-40'''
*** wless on 50% ID: '''network-wireless-50'''
*** wless on 60% ID: '''network-wireless-60'''
*** wless on 75% ID: '''network-wireless-75'''
*** wless on 80% ID: '''network-wireless-80'''
*** wless on 100% ID: '''network-wireless-100'''
*** mobile broadband on 0% ID: '''network-mobile-0'''
*** mobile broadband on 20% ID: '''network-mobile-20'''
*** mobile broadband on 40% ID: '''network-mobile-40'''
*** mobile broadband on 60% ID: '''network-mobile-60'''
*** mobile broadband on 80% ID: '''network-mobile-80'''
*** mobile broadband on 100% ID: '''network-mobile-100'''
*** mobile broadband with access technology on 0% ID: '''network-mobile-0-technology''' (''technology'' can be: ''none, gprs, edge, umts, hsdpa, hsupa, hspa, lte'')
* preferences (some apps like bluedevil, krandrtray, text-to-speech)
** filename: '''preferences.svgz'''
*** bluedevil online ID: '''preferences-system-bluetooth'''
*** bluedevil offline ID: '''preferences-system-bluetooth-inactive'''
*** text-to-speech ID: '''preferences-desktop-text-to-speech'''
*** krandrtray ID: '''preferences-desktop-display-randr'''
*** activity manager ID: '''preferences-activities'''
* Printer applet
** filename: '''printer.svgz'''
*** ID: '''printer'''
* Quassel IRC
** filename: '''quassel.svgz'''
*** quassel öffline ID: '''quassel_inactive''' ("quassel-inactive" in kde 4.10)
*** quassel online ID: '''quassel'''
*** quassel new message ID: '''quassel_message''' ("quassel-message" in kde 4.10)
* KWallet
** filename: '''wallet.svgz'''
*** open ID: '''wallet-open'''
*** closed ID: '''wallet-closed'''

At the time of writing, KDE-PIM (Kmail, Akregator etc) do not yet use setIconByName and thus aren't able to be themed this way. Reportedly, this is is coming in Kontact 2.

Development/Tutorials/Plasma/ThemeDetails

2013-06-04T20:59:20Z

Broulik: /* Theming Application Icons in the Systemtray */ Added more finegrained battery icon theming to battery

<tt>libplasma</tt> provides the Theme class so Plasma elements and other applications, such as KRunner, that need to graphically hint or theme interface elements. This is not a replacement for {{qt|qstyle}}, but rather provides standard elements for things such as box backgrounds.

This allows for easy re-theming of the desktop while also keeping elements on the desktop more consistent with each other.

See also [[Development/Tutorials/Plasma/Theme|Creating a Plasma Theme]].

== Theme Location, Structure and Definition ==
Themes are stored in {{path|share/apps/desktoptheme}}. A theme is described by a .desktop file in {{path|share/apps/desktoptheme}}. The contents of which might look like this:

<syntaxhighlight lang="text">
[Desktop Entry]
Name=Oxygen
Comment=Theme done in the Oxygen style

X-KDE-PluginInfo-Author=The Oxygen Project
X-KDE-PluginInfo-Email=kde-artists@kde.org
X-KDE-PluginInfo-Name=default
X-KDE-PluginInfo-Version=pre0.1
X-KDE-PluginInfo-Website=http://plasma.kde.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</syntaxhighlight>

The X-KDE-PluginInfo-Name entry must contain the name of the subdirectory in {{path|share/apps/desktoptheme}} where the SVG files for this theme exist.

Beneath this directory one will find the following file structure:

* '''colors''': optional a configuration file defining a colorscheme that blends well with the images
* '''dialogs/''': images for dialogs
* '''wallpapers/''': wallpaper packages
* '''widgets/''': images for widgets
* '''opaque/''': optional directory containing images appropriate for non-compositing environments
* '''locolor/''': optional directory containing images appropraite for locolor (e.g. 8 bit color) environments

== Image Access ==
Theme elements are accessed by path. Whether this maps to literal paths on disk or not is not guaranteed and considered an implementation detail of Plasma::Theme.

Therefore, to access the dialog background, one might create an svg in this manner:

<syntaxhighlight lang="cpp-qt">
Plasma::Theme theme;
QSvgRenderer svg(theme.image("dialogs/background"));
</syntaxhighlight>

It '''is generally recommended''' to use Plasma::Svg instead of QSvgRenderer directly, however. This is because Plasma::Svg uses caching where it can. Remember to call resize() on the Plasma::Svg before painting with it!

<syntaxhighlight lang="cpp-qt">
Plasma::Svg svg("dialogs/background");
svg.resize(size());
</syntaxhighlight>

== Wallpaper Access ==

Themes may optionally provide wallpapers to be used with the theme. These wallpapers must appear in the {{path|wallpapers/}} directory within the theme.

A theme may also define a default wallpaper, wallpaper size and wallpaper file extension to be used in conjunction with the theme. The default wallpaper may either be installed in the standard location for wallpapers or may be shipped with the theme itself. The default wallpaper settings should appear in the theme's metadata.desktop file and contain the following entries:

<syntaxhighlight lang="text">
[Wallpaper]
defaultWallpaperTheme=<name of default wallpaper package>
defaultFileSuffix=<wallpaper file suffix, e.g. .jpg>
defaultWidth=<width in pixels of default wallpaper file>
defaultHeight=<height in pixels of default wallpaper file>
</syntaxhighlight>

== Animations ==

Animations written in Javascript can be included in the {{path|animations}} directory within the theme. To learn how to create such animations and expose them in your theme, visit the [[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations tutorial]].

== Reaction to Theme Changes ==
If you use Plasma::Svg, changes to the theme are automatically picked up. Otherwise, you can connect to the <tt>changed()</tt> signal in the Plasma::Theme class. This signal is emitted whenever the theme is changed, which may be triggered by the user switching the theme used or system changes such as a composite manager becoming available.

== Colors ==

The colors file follows the standard KDE colorscheme file format and allows a theme to define what colors work best with its theme elements. The colors in this file can be edited with the default color scheme module.
*Make a new colorscheme using the editor in SystemSettings>>Appearance>>Colors.
*Save it with a unique name.
*Open the colorscheme in kate.
**Saved at /home/[user]/.kde/share/apps/color-schemes/[unique name].colors
*Copy everything to your plasma colors file except the "[ColorEffects:Disabled]" and "[ColorEffects:Inactive]" sections.

The most common use of the colors file is to ensure that text is readable on various backgrounds.

Here is a list of color entries in the colors file that are currently actively used in a Plasma theme:

* '''[Colors:Window]'''
** '''ForegroundNormal''' the text color applied to text on the standard background elements; maps to Theme::TextColor
** '''DecorationHover''' the color used for text highlighting; maps to Theme::HighlightCoor
** '''BackgroundNormal''' the default background color, for items that paint a background themselves, allowing them to blend in with the theme; maps to Theme::BackgroundColor
* '''[Colors:Button]'''
** '''ForegroundNormal''' the text color to use on push buttons; maps to Theme::ButtonTextColor
** '''BackgroundNormal''' used for hinting buttons; maps to Theme::ButtonBackgroundColor
** '''ForegroundActive''' color used to tint BackgroundNormal for final button hinting color
* '''[Colors:View]'''
** '''ForegroundLink''' clickable text link font color
** '''ForegroundVisited''' visited clickable text link font color

Other colors in the file may be used by individual widgets or used in the future, so it doesn't hurt to provide a complete colorscheme file and is probably a safer strategy.

Currently also used by individual widgets, which should give a good idea of additional usage patterns:

* '''[Colors:View]'''
** '''ForegroundActive''' used by the digital and fuzzy clocks for the default text color, dictionary widget for results text, microblog for status update text
** '''ForegroundInactive''' used by the pager to draw non-active windows and frames, microblog for user names
** '''ForegroundNormal''' used by microblog for status update entry area background

Note that some of these may end up folded back into Plasma::Theme properly at some point.

== Backgrounds format==
All background svg's (except for desktop wallpapers) must have the following named elements, all of which will be painted at the ''native'' size (and can therefore be bitmaps), except for the center which will be scaled:
* '''topleft''': the top left corner
* '''topright''': the top right corner
* '''bottomleft''': the bottom left corner
* '''bottomright''': the bottom right corner
* '''top''': the top bar between the two top corners
* '''left''': the left bar between the two left corners
* '''right''': the right bar between the two right corners
* '''bottom''': the bottom bar between the two bottom corners
* '''center''': the center fill; will be scaled so should be an actual SVG element

Some plasma components may use the above named elements with prefixes. For example the panel placed on the left side of the screen uses the "west" prefix ('''west-topleft''', '''west-topright''', etc.).

Additionally, the following elements can be used to control the rendering of the backgrounds:

* '''hint-stretch-borders''': if it exists, the borders will not be tiled but rather will be stretched to fit
* '''hint-tile-center''': if it exists, the center will not be scaled but rather will be tiled to fit. (Optional, from 4.1 and later)
* '''hint-no-border-padding''': If this element exists, padding will not be added for the borders, and content will therefore be able to use the entire area (inclusive borders).
* '''hint-apply-color-scheme''': If this element exists, the svg will be colorized using the color scheme colors. Colorization is applied at 100%, and tapers off on either side, of an HSV color value/intensity of 127. (Optional, From KDE 4.1 and later)
* '''current-color-scheme''': If a style element with this id exists it is replaced by a css-style with colors of the current colorscheme. See below for details. (Optional, From KDE 4.6 and later)
* '''[prefix]-hint-[direction]-margin''': Use this optional hints if you want different margins than the borders size. The [prefix]- part is optional and identifies the prefix of the panel you want to specify the margins. [direction] can be either top, bottom, left or right and indicates the border you want to configure. For top and bottom margins the height of these hints are used, for left and right margins the width. (Optional, From KDE 4.2 and later)
* '''[prefix]-hint-compose-over-border''': if this element is resent, the center element will be drawn with the same size as the total image, composed under the borders and shaped with the alpha mask frame, that has to be present in order to make work this hint(Optional, from KDE 4.5)

From KDE 4.3 can exists an element called overlay (or prefix-overlay if to be appled to a frame with a different prefix) it will be rendered over the frame as a filigrane effects, with the rules given from the following mutually exclusive hints:
* '''hint-overlay-random-pos''' it will be put at a random position, this works just for applet backgrounds
* '''hint-overlay-tile''' tile the overlay
* '''hint-overlay-stretch''' the overlay will be stretched
* '''hint-overlay-pos-right''' align the overlay at right of the background rather than to the left (from KDE 4.4)
* '''hint-overlay-pos-bottom''' align the overlay at bottom of the background rather than to the top (from KDE 4.4)

=== Using system colors ===
It is possible to apply colors from the color scheme to a graphic. A very easy way to reach this is by adding an element with the id '''hint-apply-color-scheme''' to the svg. In this case the rendered graphic gets converted to monochrome and colorized by the window background color.

A more flexible solution is available since KDE 4.6 by using css-styling. For this to work the svg must have a style-element with the id '''current-color-scheme'''. Before the graphic is rendered this element gets replaced by a style containing classes where the color attribute is set to the corresponding system color. Currently the following classes are defined:
* ColorScheme-Text
* ColorScheme-Background
* ColorScheme-ViewText
* ColorScheme-ViewBackground
* ColorScheme-ViewHover
* ColorScheme-ViewFocus
* ColorScheme-ButtonText
* ColorScheme-ButtonBackground
* ColorScheme-ButtonHover
* ColorScheme-ButtonFocus

In order to apply a color from a class to an element, its fill or stroke attribute must be '''currentColor''' and of course the name of the wanted class has to be in the class-attribute. Special attention is needed on gradients, as neither the gradient-tags themself nor the stop-tags accept classes. To still get the wanted result one can put a g-tag around them and apply the class to this.

'''Hint:''' If you want to use this new feature and still be able to use the graphics on older versions, you can set the color for ColorScheme-Background to #7f7f7f and place a <tt><rect id="hint-apply-color-scheme" width="1" height="1" fill="none" /></tt> below your css-code but before the closing <tt></style></tt>

If you don't want to bother with the source code of your graphics, you can use the tool svgmod for easily applying system colors. See [https://projects.kde.org/projects/playground/devtools/svgmod here].

== Current Theme Elements ==

Themes get installed to {{path|share/apps/desktoptheme}}. Each theme is stored in a subdirectory with the following file structure

*'''/dialogs''': elements for dialogs
**'''/background.svg''': generic dialog background used by the sceensaver password dialog, etc. See the section on backgrounds above for information on the required elements in this file.
*** '''hint-left-shadow''': from KDE 4.10: optional hints that say how big the shadow is
*** '''hint-top-shadow'''
*** '''hint-right-shadow'''
*** '''hint-bottom-shadow'''
**'''/krunner.svg''': dialog background, used by the Run Command. Please note, that this is used only when <menuchoice>Positioning</menuchoice> is set to <menuchoice>Free floating window</menuchoice>, '''not''' <menuchoice>Top edge of screen</menuchoice> (which is default). See the section on backgrounds above for information on the required elements in this file.
**'''/shutdowndlg.svg''': background and buttons for the log out dialog
***''background'': background for the logout dialog
***''button-normal'': button background
***''button-hover'': button background on cursor hover
***''button-small-normal'': small button background
***''button-small-hover'': small button background on cursor hover
** '''/kickoff.svgz''' : background for the kickoff launcher, needs a frame, with the prefix 'plain'
*'''/widgets''': generic desktop widget background
** '''/action-overlays.svgz''': overlays for icons to indicate actions (since KDE 4.4)
*** ''add-normal'': icon used to add the parent icon to a selection of elements (used for instance in folderview), normal state, there are also ''add-hover'' and ''add-pressed''
*** ''remove-normal'': icon used to remove the parent icon to a selection of elements, normal state, there are also ''remove-hover'' and ''remove-pressed''
*** ''open-normal'': icon used to initialize tooltip on folderview widget, there are also ''open-hover'' and ''open-pressed''
** '''/analog_meter.svg''': an analog gauge widget.
***''background'': the body of the analog instrument
***''foreground'': the pin where the hand rotates
***''pointer'': the hand of the instrument
***''rotateminmax'': how much the hand can rotate, the width is the maximum angle in degrees the height the minimum angle
***''label0'': the rect for the first label
***''label1'': the rect for the second label
**'''/arrows.svg''': arrows that match the theme. Four elements should exist in this svg: up-arrow, down-arrow, left-arrow, right-arrow.
**'''/background.svg''': a background image for plasmoids. See the section on backgrounds above for information on the required elements in this file.
*** '''hint-left-shadow''': from KDE 4.10: optional hints that say how big the shadow is
*** '''hint-top-shadow'''
*** '''hint-right-shadow'''
*** '''hint-bottom-shadow'''
** '''/bar_meter_horizontal.svg''': an horizontal meter like a progressbar
***''background'': background of the progressbar
***''foreground'': overlay in the foreground of the progressbar
***''bar'': the progressbar itself
***''background'': a 9 pieces svg with the ''background'' prefix, it replaces the background element if available (KDE 4.2 and later)
***''hint-stretched-bar'': make the progressbar background element stretched rather than tiled (KDE 4.2 and later)
***''bar-active'' and ''bar-inactive'': 9 pieces svgs with the ''bar-active'' and ''bar-inactive'' prefixes, they replace the bar element when available, they will be drawn tiled (KDE4.2 and later)
***''label0'', ''label1'' and ''label2'': rects for 3 labels to be placed around
** '''/bar_meter_vertical.svg''': a vertical meter like a vertical progressbar. It has the same format of ''/bar_meter_horizontal.svg''
** '''/branding.svgz''': a little KDE logo that can be customized by distributors as a branding element. Contains a single element called ''brilliant''
** '''/busywidget.svgz''': Used to indicate a busy state, it's a circular image that will be animated with a rotation.
*** ''busywidget'': the main spinner
*** ''paused'': the paused state
** '''/button.svg''': graphics elements for a button widget (KDE 4.2 and later), it needs the followin prefixes:
*** ''normal'' normal button
*** ''pressed'' pressed button
*** ''active'' button under mouse. Active can have ticker borders that would be rendered outside the widget. It's useful to do a glowing effect DEPRECATED: use ''hover'' instead
*** ''hover'' element that will be in the background of the widget, will act as a border (useful for glow effects) since KDE 4.5
*** ''shadow'' a shadow for the button, can be bigger than the button itself since KDE 4.5
*** ''focus'' keyboard focus rectangle superimposed to the button graphics
** '''/calendar.svg''': graphics for a calendar widget, since 4.3
*** ''weeksColumn'': background for the vertical column with week numbers in it.
*** ''weekDayHeader'': background for the row with week day names in it.
*** ''active'': background for the day numbers of the current month.
*** ''inactive'': background for the day numbers of the next and previous months.
*** ''hoverHighlight'': background for the day under the mouse cursor.
*** ''today'': border for the current day cell.
*** ''selected'': border for the selected day cell.
*** ''red'': border for holidays on sundays
*** ''green'': border for holidays during week days
**'''/clock.svg''': an analog clock face. it must have the following named elements:
*** ''ClockFace'': the background of the clock, usually containing the numbers, etc
*** ''HourHand'': the hour hand, pointing down in the svg
*** ''MinuteHand'': the minute hand, pointing down in the svg
*** ''SecondHand'': the second hand, pointing down in the svg
*** ''HourHandShadow'', ''MinuteHandShadow'' and ''SecondHandShadow'': drop shadows for the hands (optional, KDE 4.1 and later)
*** ''HandCenterScrew'': the "pin" that holds the hands together in the center
*** ''Glass'': a final overlay which allows for things such as the appearance of glass
*** ''hint-square-clock'': if present the shape of the clock will be square rather than round
*** Note: In the svg, the Hand elements must be placed in a position that indicates the time 6:30:30. The y-axis position of the Hand elements with respect to the center of ClockFace is the one they will have in the rendered applet. The x-axis position of the Hand elements does not matter. The Shadow elements should have the same y-axis position as their Hand element counterpart.
** '''/configuration-icons''': it's a set of simple icons that are meant to be shortcuts for configuration actions (KDE 4.2 and later). Must contain the following elements:
*** ''close'': a close icon
*** ''configure'': a setup action
*** ''move''
*** ''resize-vertical'': resize in the y axis
*** ''resize-horizontal'': resize in the x axis
*** ''size-diagonal-tl2br'': resize diagonal, usually an arrow from top-left to bottom-right
*** ''size-diagonal-tr2bl'': resize diagonal, usually an arrow from top-right to bottom-left
*** ''rotate''
*** ''help''
*** ''maximize''
*** ''unmaximize''
*** ''collapse'': set something in a minimized, collapsed status
*** ''restore'': restore from ''collapse'' status
*** ''status'': refers to a status of something, logging or system monitoring in general
*** ''retourn-to-source'': make detached extender items return to their owner applet
*** ''add'' and ''remove'': specular actions, adding and removing for instance an item from a list
*** ''delete'': the (potentially dangerous) action of deleting something
** '''/containment-controls.svg''': handles for the control used to resize the panel (KDE 4.1 and later). The following elements are required.
*** ''maxslider'' maximum size slider, south position
*** ''minslider'' minimum size slider, south position
*** ''offsetslider'' positioning slider, south position
*** Each of the above elements must be present with ''north'', ''south'', ''east'' and ''west'' prefixes for each panel position.
*** There are also four backgrounds (north, south, east and west orientations) for the ruler widget itself in the "Backgrounds format", since the width of the widget is 100% the elements of left and right (or north and bottom if vertical) are not needed
** '''/dragger.svgz''': meant to be a generic drag handle (not currently used but available). It needs to contain the same elements as other backgrounds, see the section about backgrounds above. In addition it needs the following element:
*** ''hint-preferred-icon-size'': the size icons within the drag handle should get. The vertical size of the dragger is also derived from this: this size hint + the dragger's margins.
** '''/extender-background.svgz''': background for extenders. It needs the same elements as other backgrounds.
** '''/extender-dragger.svgz''': Same as dragger.svgz. Drag handle for extenders (like the notification applet, KDE 4.2 and later). It needs to contain the same elements as other backgrounds, see the section about backgrounds above. In addition it needs the following element:
*** ''hint-preferred-icon-size'': the size icons within the drag handle should get. The vertical size of the dragger is also derived from this: this size hint + the dragger's margins.
*** Since KDE 4.6 it contains two optional prefixes: ''grouped'' for extender items contained in extender groups and ''root'' for root extender items. The version without prefix must still exist and is still used for extenders that don't have a stacked appearance.
** '''/frame.svgz''' : a generic frame, used mostly for widget containers, to visually group widgets together. It must contain the following prefixes, for different 3d looks:
*** ''sunken''
*** ''plain''
*** ''raised''
** '''/glowbar.svgz''' : a frame without a prefix, it represents a glow, it's used for instance in Plasma Desktop for the panel autohide unhide hint.
** '''/identiconshapes.svgz''' : shapes for the auto-generation of the activity icons, they must be named from ''Shape1'' to ''Shape32''. Since KDE SC 4.5
** '''/line.svgz''' : a simple line use to separate items in layouts, containe ''vertical-line'' and ''horizzontal-line'' elements (since KDE 4.3)
** '''/lineedit.svgz''': it's a framesvg, used to style line edits, spinboxes and other similar fields (since KDE 4.4) it must have the following prefixes
*** ''base'': the background of the line edit
*** ''focus'': will be drawn outside base, when the line edit has input focus
*** ''hover'': will be drawn outside base, when the line edit is under the mouse
** '''/listitem.svgz''': used for "opened"/clicked notifications (since KDE 4.10)
** '''/monitor.svgz''' : represents a screen, it's used in places such as the wallpaper config dialog. It contains a frame without prefixes and the following extra elements:
*** ''glass'' : glass reflection effect over the screen
*** ''base'' : a stand for the monitor
** '''/pager.svgz''' : graphic elements for the little screens of the pager, it must have 3 frames with the following prefixes:
*** ''normal'' : all virtual desktops
*** ''active'' : active virtual desktop
*** ''hover'' : virtual desktop under mouse
**'''/panel-background.svg''': the background image for panels.
*** If you want to create different background for panels located at the top, bottom, left or right, then also create sets of background elements with the following prefixes: ''north'', ''south'', ''west'' and ''east'' respectively. For example the center element of the left positioned panel's background should be named ''west-center''. (KDE 4.1 and later)
*** When the panel is not 100% wide/tall the north, south etc. prefixes becomes ''north-mini'', ''south-mini'' etc. (KDE 4.2 and later). Please note that if KRunner <menuchoice>Positioning</menuchoice> is set to <menuchoice>Top edge of screen</menuchoice> (which is default), then KDE treats it as not 100% wide north panel.
*** All prefixes fallback to a no prefix version when not available
*** if a prefix called ''shadow'' is available, it will be used as a drop shadow for the panel when compositing is available.
** '''/plot-background.svg''': a background for plotter (graph) widgets, such as the plots in ksysguard
** '''/scrollbar.svgz''' : the classical ''elevator'' scrollbar, must have the following elemens : ''arrow-up'', ''mouseover-arrow-up'', ''sunken-arrow-up'', same 3 elements for ''arrow-left'', ''arrow-right'' and ''arrow-bottom''. From KDE 4.10 it can have an element called ''hint-scrollbar-size'' that says at what size the scrollbar should be rendered (width if vertical, height if horizontal). It must also have frames with the following prefixes:
*** ''slider''
*** ''mouseover-slider''
*** ''sunken-slider''
*** ''background-vertical''
*** ''background-horizontal''
** '''/scrollwidget''': used by Plasma::ScrollWidget, it has a single prefix (KDE4.4 and later)
*** ''border'': a border used when the scrollbar is enabled
** '''/slider.svgz''': used to theme sliders (since KDE 4.3) it must have the following elements:
*** ''vertical-slider-line'': the background for vertical sliders, it indicates how much the indicator can scroll
*** ''vertical-slider-handle'': the handle for vertical sliders
*** ''vertical-slider-focus'': background for the handle when it has input focus (since KDE 4.4)
*** ''vertical-slider-hover'': background for the handle when it is under the mouse (since KDE 4.4)
*** ''groove'': groove for the slider (since KDE 4.8 replaces *-slider-line)
*** ''groove-highlight'': highlight part of the groove (since KDE 4.8 replaces *-slider-line)
*** ''horizontal-slider-line'': the background for horizontal sliders
*** ''horizontal-slider-handle'': the handle for horizontal sliders
*** ''horizontal-slider-focus'': background for the handle when it has input focus (since KDE 4.4)
*** ''horizontal-slider-hover'': background for the handle when it is under the mouse (since KDE 4.4)
** '''/systemtray.svg''': a background for the system tray (KDE 4.1 and later). See the section on backgrounds above for information on the required elements in this file. Since KDE 4.2 it contains also the '''lastelements''' prefix, used for elements in the last position of the systray and the four elements '''expander-right''' up, left and bottom, used for the icon that shows/hides the other systray icons. Since KDE 4.3 there are the '''horizontal-separator''' and '''vertical-separator''' used as a border to separe the last elements.
**'''/tasks.svg''': task item backgrounds for tasks (KDE 4.1 and later). See the section on backgrounds above for information on the required elements in this file. The following element prefixes are required:
*** ''focus'': background of focused task item
*** ''hover'': background when the pointer hovers the task item. From KDE 4.2 focus and hover can have ticker borders that will be painted outside the task button, useful to make a glow effect.
*** ''attention'': background when tasks item is trying to get attention
*** ''normal'': background of normal, unfocused task item
*** ''minimized'': background for minimized tasks
*** The svg should contain elements of all five prefixes, if a prefix is missing that element will be not be drawn.
** '''/toolbox.svgz''' : graphical elements for the desktop toolbox, it must have a frame without prefixes plus those following elements:
*** ''desktop-northwest'', ''desktop-northeast'', ''desktop-southwest'', ''desktop-southeast'': the 4 corners for the desktop toolbox.
*** ''panel-north'', ''panel-south'', ''panel-west'', ''panel-east'' : elements for the panel toolbox.
** '''/tooltip.svg''': background for tooltips used for instance in the taskbar and with icons. See the section on backgrounds above for information on the required elements in this file.
** '''/translucentbackground.svg''': a standard background image for plasmoids that for their nature are bigger and with not much text. In this case a translucent background looks better. It needs the same elements of background.svg in it. If this file is not present, the plasmoids that uses this will use background.svg instead.
** '''/media-delegate.svgz''': intended to be used as delegate for media types: as KDE 4.7 contains a single prefix: picture.
** '''/viewitem.svgz''': controls the background look of selections (results in KRunner, networks in network applet), it can have 4 elements of 9 parts each with prefix ''normal'', ''hover'', ''selected'', ''selected+hover''.
** '''/toolbar.svgz''': used in the ToolBar QML component, can be used in custom applications in a similar way, contains a single frame without prefix. Since KDE 4.8.

=="Opaque" folder==

In the folder {{path|share/apps/desktoptheme/opaque}} the same hierarchy can be found: when compositing is disabled files in this folder are preferred over the corresponding ones listed above. Only background for top level windows are appropriate to go in this folder.

Since top-level windows will be shaped according to the transparency of the svg and window shapes don't support alpha-blending, if the svg has rounded borders they should have a shape that don't require antialiasing, like the following example.

[[Image:No_composite_plasma_svg.jpg]]

=="translucent" folder ==

In the folder {{path|share/apps/desktoptheme/translucent}} the same hierarchy is used: when the KWin ''blurbehind'' effect is enabled the file under this folder will be used if found. As the opaque folder, only elements that will be rendered as window backgrounds should be present in this folder, so the dialogs folder, plus the panel and tooltip backgrounds. When is possible to blur the background of the window, the graphics can be more transparent, keeping the window text readable.

=="icons" folder==

In the folder {{path|share/apps/desktoptheme/icons}}, SVG files that contain scalable icons for use with application status items (e.g. icons in the system tray) are contained.

The default theme contains the following SVGs:

* audio.svgz
* battery.svgz
* device.svgz
* klipper.svgz
* kwalletmanager.svgz
* nepomuk.svgz
* network.svgz
* notification.svgz
* preferences.svgz
* wallet.svgz

The files are named the same as the matching icon theme names or their prefix (both work, which is why "audio" matches for mixers, e.g.). Other icons can be added as long as they match the names of requested icons by the application status items.

== Theming Application Icons in the Systemtray ==

Applications that use a function called setIconByName can have their icon in the system tray themed. Applications can have more than one icon (for example Konversation flashes between two different icons to hilight when your username is mentioned and Kpackagekit changes it's icon depending on the status of it's upgrade / installs). Theming these icons requires firstly that an application has been coded to use setIconByName, and secondly that you call your svg object by the same name (use ctrl+shift+o in Inkscape). Then you can just put your .svgz in {{path|share/apps/desktoptheme/default/icons}} (changing default to your theme folder name).

The following is an attempt to list known icon names that may be themed by this method. Please add any other known icon names and the object ID here to help other people making themes:

* Amarok
** filename: '''amarok.svgz'''
*** ID: '''amarok'''
* audio (for kmix, veromix, a.o.)
** filename: '''audio.svgz'''
*** volume muted ID: '''audio-volume-muted'''
*** volume low ID: '''audio-volume-low'''
*** volume medium ID: '''audio-volume-medium'''
*** volume high ID: '''audio-volume-high'''
* battery
** filename: '''battery.svgz'''
*** battery (always shown object) ID: '''Battery'''
*** on powerline ID: '''AcAdapter'''
*** no battery found ID: '''Unavailable'''
*** battery on 10% ID: '''Fill10''' ''(new in 4.11)''
*** battery on 20% ID: '''Fill20'''
*** battery on 30% ID: '''Fill30''' ''(new in 4.11)''
*** battery on 40% ID: '''Fill40'''
*** battery on 50% ID: '''Fill50''' ''(new in 4.11)''
*** battery on 60% ID: '''Fill60'''
*** battery on 70% ID: '''Fill70''' ''(new in 4.11)''
*** battery on 80% ID: '''Fill80'''
*** battery on 90% ID: '''Fill90''' ''(new in 4.11)''
*** battery on 100% ID: '''Fill100'''
* device (the device-notifier)
** filename: '''device.svgz'''
*** ID: '''device-notifier'''
* juk
** filename: '''juk.svgz'''
*** ID: '''juk'''
* KGet
** filename: '''kget.svgz'''
*** ID: '''kget'''
* Klipper
** filename: '''klipper.svgz'''
*** ID: '''klipper'''
* Konversation
** filename: '''konversation'''
*** ID: '''konversation'''
** filename: '''konv_message.svgz''' (new incomming message)
*** ID: '''konv_message'''
* Kopete
** filename: '''kopete.svgz'''
*** öffline ID: '''kopete-offline'''
*** online ID: '''kopete'''
*** other statuses are not supported atm
* Korgac
** filename: '''korgac.svgz'''
*** ID: '''korgac'''
* Ktorrent
** filename: '''ktorrent.svgz'''
*** ID: '''ktorrent'''
* message-indicator
** filename: '''message-indicator.svgz'''
*** standard ID: '''normal'''
*** new message ID: '''new'''
* Nepomuk
** filename: '''nepomuk.svgz'''
*** ID: '''nepomuk'''
* Network-management-plasmoid
** filename: '''network.svgz'''
*** wired online ID: '''network-wired-activated'''
*** wired offline ID: '''network-wired'''
*** wless offline ID: '''network-wireless-0'''
*** wless on 20% ID: '''network-wireless-20'''
*** wless on 25% ID: '''network-wireless-25'''
*** wless on 40% ID: '''network-wireless-40'''
*** wless on 50% ID: '''network-wireless-50'''
*** wless on 60% ID: '''network-wireless-60'''
*** wless on 75% ID: '''network-wireless-75'''
*** wless on 80% ID: '''network-wireless-80'''
*** wless on 100% ID: '''network-wireless-100'''
* preferences (some apps like bluedevil, krandrtray, text-to-speech)
** filename: '''preferences.svgz'''
*** bluedevil online ID: '''preferences-system-bluetooth'''
*** bluedevil offline ID: '''preferences-system-bluetooth-inactive'''
*** text-to-speech ID: '''preferences-desktop-text-to-speech'''
*** krandrtray ID: '''preferences-desktop-display-randr'''
*** activity manager ID: '''preferences-activities'''
* Printer applet
** filename: '''printer.svgz'''
*** ID: '''printer'''
* Quassel IRC
** filename: '''quassel.svgz'''
*** quassel öffline ID: '''quassel_inactive''' ("quassel-inactive" in kde 4.10)
*** quassel online ID: '''quassel'''
*** quassel new message ID: '''quassel_message''' ("quassel-message" in kde 4.10)
* KWallet
** filename: '''wallet.svgz'''
*** open ID: '''wallet-open'''
*** closed ID: '''wallet-closed'''

At the time of writing, KDE-PIM (Kmail, Akregator etc) do not yet use setIconByName and thus aren't able to be themed this way. Reportedly, this is is coming in Kontact 2.

Schedules/KDE4/4.11 Feature Plan

2013-06-04T16:52:04Z

Broulik: Battery monitor merged. And the other stuff I didn't have time for unfortunately

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|nepomuk|Better Scheduling for Nepomuk indexing - File and Email|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomuk|Configurable KIO Backend for FileWatcher|me@vhanda.in|Vishesh Handa}}
{{FeatureTodo|nepomuk|Indexers for ebook formats|me@vhanda.in|Vishesh Handa}}
{{FeatureTodo|nepomuk|Indexers for original msoffice formats|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomukcontroller-qml|QML version of the current Nepomuk controller. |joerg.ehrichs@gmx.de|Jörg Ehrichs}}
{{FeatureDone|Web Shortcuts|Update old shortcuts.|de.meyer.maarten@gmail.com|Maarten De Meyer}}
{{FeatureDone|Web Shortcuts|Use https where possible. ({{bug |308029}})|de.meyer.maarten@gmail.com|Maarten De Meyer}}
{{FeatureDone|Web Shortcuts|Look for url on clipboard when creating new shortcut. ({{bug |146880}})|de.meyer.maarten@gmail.com|Maarten De Meyer}}
{{FeatureDone|Web Shortcuts|Insert query placeholder button. ({{bug |146879}}) |de.meyer.maarten@gmail.com|Maarten De Meyer}}
{{FeatureInProgress|DrKonqi| Detect and inform users they are using outdated and unsupported versions. ({{bug |315073}})|adaptee@gmail.com|Jekyll Wu}}
|}
 

= 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|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Integration with KScreen ({{bug |319994}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Support for buffer age extensions ({{bug |319995}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Egl backend using Wayland Surfaces ({{bug |319996}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|KWin keybindings is missing a shortcut for move window to previous screen ({{bug |303083}})|thomas.luebking@gmail.com}}
{{FeatureTodo|kwin|There should be a shortcut to close window group ({{bug |238233}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|JJ: Use a bit of Wobbly effect while closing a window also. ({{bug |250856}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Highlight/shadow of application on screen 1 displayed on screen 0 ({{bug |278697}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Allow Effects to Temporarily Grab All Screen Edges ({{bug |283397}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Translucency Effect needs to be rewritten on top of AnimationEffect ({{bug |294856}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Broken Desktop Switch On-Screen Display Animation ({{bug |316372}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows with no border (decoration) are visible on all activities ({{bug |274931}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|"Thumbnail Aside" effect visible when screen is locked -- privacy issue ({{bug |255712}}, Review 108670)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Quick Tile shortcuts should be toggle buttons ({{bug |263755}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Shaded windows are not considered in ::checkWorkspacePosition ({{bug |268660}}, Review 109679)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|build fails - getdomainname ({{bug |270586}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window Specific Settings for Disabling Screen Edges ({{bug |271607}}, Review 108513)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add fade in/fade out for outline effect ({{bug |274474}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Compositing not possible on each screen with multi head ({{bug |282677}}, Review 107853)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Remove "Move TBLR" from Zoom or at least pass the shortcuts reasonable names ({{bug |288903}}, Review 108290)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Hot Screen Corners do not work properly in multiscreen setup with different resolutions ({{bug |290887}}, Review 108513)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|When "dim inactive" is used, and "apply effect to groups" is disabled, blocky shadows appear everywhere ({{bug |293236}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|kwin does not honor disableMultihead true and causes window focus problems ({{bug |293734}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|DesktopThumbnailItem for QML ({{bug |296067}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Packages for Desktop Switching Layouts ({{bug |296068}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Walk Through Desktop layout rendering desktop previews ({{bug |296069}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Move ThumbnailBar from BoxSwitch to CoverSwitch ({{bug |296070}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Drop BoxSwitch effect ({{bug |296071}}, Review 104454)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}}, Review 109572)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|New Window Decoration for Thin Clients ({{bug |299143}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}}, Review 110402)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Maximized windows should be moved and maximized to second screen if they are moved with shortcut ({{bug |304506}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window shortcut containing space: "Launch Mail" doesn't work ({{bug |305434}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}}, Review 108445)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|The "walk through desktop" shortcuts don't show up in the desktop kcm ({{bug |306404}}, Review 108287)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Upper part of windows tears when moving it left/right ONLY in upper part of display ({{bug |307965}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin uses getdomainname() to obtain the hostname, should use getaddrinfo() ({{bug |308391}}, Review 108235)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Use Resize Area in Aurorae ({{bug |308992}}, Review 107936)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Configurable quick tile area config GUI ({{bug |308993}}, Review 109683)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Crash in KWin::Screenedge::unreserve on deactivating Actos script ({{bug |309695}}, Review 108513)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] GHNS button displays icon, even if disabled in style settings ({{bug |309724}}, Review 108286)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|ScreenEdge::raisePanelProxies() is slow due to sync XLib communication ({{bug |311592}}, Review 108513)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|add rule to disobey configure requests ({{bug |311720}}, Review 109691)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Drop explosion effect ({{bug |312176}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Windows wider/taller than screen are cut off/partially mirrored when doing a screenshot of them using ksnapshot ({{bug |312851}}, Review 108258)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Desktop Effects - Zoom: Mouse Tracking "Push" laggy, inprecise and/or not working ({{bug |312956}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|"Login" effect does not fade in on secondary monitor(s) with a multi screen setup ({{bug |313061}}, Review 108362)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Overlap factor of keepAbove windows in placeSmart should be infinite ({{bug |313379}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|XReconfigureWMWindow fails to stack (lower) a window using an Above CWSibling combination ({{bug |313909}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Position rule conflicts with maximization rule ({{bug |314392}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|String representation of KWin::Client should include caption, not name. ({{bug |314402}}, Review 108959)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Please explain the meaning of vsync in the config gui ({{bug |314998}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashes when switching windows ({{bug |315528}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|kwin crash when clicking kickoff widget ("K menu") ({{bug |315951}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Dual screen issue caused by d6b3f6983efebc42abd6028ece9c3ec7facea2d0 ({{bug |316040}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Description text for the Slide Back effect is incorrect ({{bug |316877}})|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Java Swing Apps do not receive Deiconify event if window is shaded ({{bug |317025}}, Review 109593)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Snapping: Can no longer move window to occupy full screen width ({{bug |317845}}, Review 109864)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|when using flip switch to switch virtual desktop, activating hot corner trigger becomes difficult ({{bug |318294}}, Review 110013)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|rickstockton@reno-computerhelp.com}}
{{FeatureDone|kwin|'Slide back' effect should react on stacking order changes ({{bug |294490}})|thomas.luebking@gmail.com}}
{{FeatureDone|kwin|Track mouse effect generates graphics artifacts ({{bug |304435}})|thomas.luebking@gmail.com}}
{{FeatureDone|kwin|vertical maximization doesn't work as expected ({{bug |91703}}, Review 103948)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Slide Back: Sometimes the Inactive window pops to the font for apprx. one frame when it is activated. ({{bug |294865}})|kwin-bugs-null@kde.org}}



{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|window manager|Rework and optimize vertex buffer object handling, vertex uploading, and the window and decoration painting code|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureDone|window manager|Add support for creating an OpenGL 3.1 core context|fredrik@kde.org|Fredrik Höglund}}
{{FeatureDone|window manager|GL_ARB_robustness support|fredrik@kde.org|Fredrik Höglund}}
{{FeatureDone|window manager|Support for detecting GPU resets, and restarting the compositor|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
{{FeatureInProgress|plasma workspace|Order and group tasks by activity|fid@gpul.org|José Millán Soto}}
{{FeatureDone|kmenuedit|Ability to sort entries in the sub-menus ({{bug |108419}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|kmenuedit|Add move up/down buttons ({{bug |61537}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|plasma notifications|Add button to notifications that allow configuring them|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|plasma batterymonitor|Improve situtation with multiple batteries (show battery names, dont just sum up _all_ the percentages etc)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|powerdevil|Implement notifications for non-internal batteries (aka "Your mouse is running low")|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|plasma batterymonitor|UI overhaul for battery monitor|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|powerdevil|Remember action settings when action is disabled|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|klipper|Allow to keep items in clipboard history|fid@gpul.org|José Millán Soto}}
{{FeatureTodo|plasma weather data engine|Add search query (based on code from libplasmaweather)|emdeck@gmail.com|Michał Dutkiewicz}}
{{FeatureTodo|plasma weather data engine|Allow to sort search results by relevance score|emdeck@gmail.com|Michał Dutkiewicz}}
{{FeatureTodo|powerdevil|Asynchronous fallable actions|oliver.henshaw@gmail.com|Oliver Henshaw}}
{{FeatureTodo|powerdevil|Further asynchronicity in powerdevil|oliver.henshaw@gmail.com|Oliver Henshaw}}
{{FeatureTodo|screenlocker|inhibitions/idle tracking in ksmserver ({{bug |318461}})|oliver.henshaw@gmail.com|Oliver Henshaw}}
{{FeatureTodo|screenlocker|Fixes for legacy screensaver that are too invasive for bugfix releases|oliver.henshaw@gmail.com|Oliver Henshaw}}
|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

{{FeatureTodo|Dolphin|Clean up Places panel context menus|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|Dolphin|Permit to disable certain context menu plugins by default if they jeopardize the stability of the application|frank78ac@googlemail.com|Frank Reininghaus}}
{{FeatureTodo|Dolphin|KFileItemModelRolesUpdater: only perform expensive operations for items inside (or close to the) visible area|frank78ac@googlemail.com|Frank Reininghaus}}
{{FeatureTodo|Dolphin|KFileItemModel: reduce memory usage by making use of implicit sharing|frank78ac@googlemail.com|Frank Reininghaus}}
{{FeatureInProgress|Dolphin|Middle clicking on archive files in dolphin does not open them in a new tab. ({{bug |196035}})|emmanuelpescosta099@gmail.com|Emmanuel Pescosta}}
{{FeatureInProgress|Dolphin|"Create new folder" in the folder panel (Maybe use DolphinContextMenu). ({{bug |270360}})|emmanuelpescosta099@gmail.com|Emmanuel Pescosta}}
{{FeatureInProgress|Dolphin|Factor out the tabbing code from DolphinMainWindow into different classes + Implement tab-bar drag and drop (with drop indicator). ({{bug |216433}})|emmanuelpescosta099@gmail.com|Emmanuel Pescosta}}
{{FeatureInProgress|Dolphin|TimSort + Sorting Benchmarks|emmanuelpescosta099@gmail.com|Emmanuel Pescosta}}

{{FeatureTodo|Kate|Search-plugin: Add "Current file mode"|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|Search-plugin: As-you-type search in current file|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|Search-plugin: Multi line search & replace|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|Search-plugin: Replace "\<number>" with corresponding regexp-captures in the replace string|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|gdb-plugin: Unify the stack trace and local variables to one ToolView|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|gdb-plugin: Do not update stack/locals view if not visible|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}
{{FeatureDone|Kate|Pâté plugin now supports Python2 or Python3 as a build-time option|srhaque@theiet.org|Shaheed Haque}}
{{FeatureDone|Kate|Pâté GID plugin now supports autocompletion based on the contents of the ID file|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Many generic functions and generic classes, likely the more outstanding are the autocompletations. Now you can create a code completion model with very few lines from Python
|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté python utils plugin. Utils to Python: Checker Parse, Checker Pep8, Checker Pyflakes, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté javascript utils plugin. Utils to JavaScript: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty JSON, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté XML pretty plugin. A simple XML pretty printer. XML formatter which a good indents|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Django utils plugin. Utils to Django: Snippets, and template utils|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Python autocomplete plugin.|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|[http://kate-editor.org/2013/04/23/a-rich-python-console-and-more-in-kate-editor/ Integration of the python_autocomplete and python_console_ipython plugins with the project plugin] .|goinnn@gmail.com|Pablo Martín}}

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

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}
{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

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

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureDone|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Dock Widgets|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Stars Constellations|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|KML I/O Improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Basic KML Editor|tgridel@free.fr|Thibaut Gridel}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|License Information Info Box|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|Navigation Tool Redesign|rahn@kde.org|Torsten Rahn, Mohammed Nafees}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|GHNS Map Installation In Marble Qt|earthwings@gentoo.org|Dennis Nienhüser}}{{FeatureInProgress|Marble|Support GPX-tracks in elevationProfile|roman.karlstetter@googlemail.com|Roman Karlstetter}}
{{FeatureInProgress|Marble|Spherical Projection Panning|void@void|Paul Nader}}
{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|In-Program documentation for scripting API|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Scripting API cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Statistics module: scripts may add statistics data during algorithm executions|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Text-only interface for Rocs aka Cantor backend|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Worksheet Integration|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Geogebra Support|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|Kig|CAS Backend|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|KAlgebra|Matrix support|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KTouch|Right-to-Left Training|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureInProgress|KTouch|Support for Custom Lessons|sebastiangottfried@web.de|Sebastian Gottfried}}
{{FeatureDone|KStars|User data and Custom Catalog SQLite Databases|ra.rishab@gmail.com|Rishab Arora}}
{{FeatureDone|KStars|What's Interesting Tool|samikshan@gmail.com|Samikshan Bairagya}}
|}
 

= kdegames=

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

! Status
! Project
! Description
! Contact

{{FeatureDone|KJumpingCube|Make computer think-times shorter and responses faster|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Provide five skill levels (previously three)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Provide board size up to 15x15 (previously 10x10)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add multi-move undo and redo (previously one move only)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Improve the algorithm for computer opponent Newton|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Make a new toolbar layout with a general-purpose stop-start button|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add optional pauses after computer moves or animation steps, to help new players understand how the game works|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Major internal restructure and rewrite: involving separation of model, view, control and AI classes, new classes for Game and AI_Box and executing AI code on a separate thread|iandw.au@gmail.com|Ian Wadham}}

|}
 

= kdegraphics=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}

{{FeatureDone|kolourpaint|WebP image format plugin|kollix@aon.at|Martin Koller}}

{{FeatureDone|okular|Configurable review tools {{bug |159601}}|okular-devel@kde.org|Okular Developers}}
{{FeatureDone|okular|Undo/Redo support in forms and annotations {{bug |177501}}|okular-devel@kde.org|Okular Developers}}

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Support excluding directories from a recursive search [https://git.reviewboard.kde.org/r/110273/ Review Request 110273]|biergaizi2009@gmail.com|Tom Li}}
{{FeatureDone|Juk|Add support for [http://www.opus-codec.org/ Ogg Opus audio editing/playback] (requires TagLib and Phonon also support)|mpyne@kde.org|Michael Pyne}}
|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureTodo|kcalcore|Support for ical UID property in kdepim (kcalcore and gui)|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureTodo|Akonadi Client Libraries|GID Fetch Support|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureInProgress|KABC|use uid's for references in ContactGroups|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|SendLaterAgent|Agent for allow to send later mails|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|PimActivity|Create a library to support activity in pim apps|montel@kde.org|Montel Laurent}}
{{FeatureDone|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureDone|headerthemeeditor|Program to edit kmail header theme based on Grantlee|montel@kde.org|Montel Laurent}}
{{FeatureDone|Sieve|Add support for autogenerate sieve script|montel@kde.org|Montel Laurent}}
{{FeatureDone|Blogilo|Use new widget component based on qtwebkit for html editor|montel@kde.org|Montel Laurent}}
{{FeatureDone|ImportWizard|Allow to import settings/data for trojita and improve all others importer|montel@kde.org|Montel Laurent}}

|}
 

= kdeplasma-addons =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|Ark|Merge Basyskom's contributions|rakuco@FreeBSD.org|Raphael Kubo da Costa}}
{{FeatureDone|KWallet|UI Refactoring|kde@rusu.info|Valentin Rusu}}
|}
 

= kdetoys =

{| 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|KTeaTime|Bring back the system tray progress indicator known from KTeaTime 4.6.5 and earlier ({{bug |279222}})|kde@hilefoks.org|Stefan Böhmann}}
|}

Projects/Usability/HIG/Notifications

2013-06-01T18:45:38Z

Broulik: /* Guidelines */ Added my 2cents to notification configurability

__NOTOC__

== Purpose ==
A ''notification'' is an information that is not directly relevant to the user's current task. It is displayed via a certain [[Projects/Usability/HIG/NotificationMechanism|notification mechanism]] on a panel above/below the taskbar notification area. Notifications inform users about non-critical problems, but they don't prevent them.

Notifications pop up and overlay all other windows. Multiple notifications are stacked vertically. Notifications disappear after a short period automatically (unless the cursor hovers over them), but can be closed by the user at any point. Each notification has its own [[Projects/Usability/HIG/CentralConfiguration|central configuration]] which can be reached by a button next to the close button.
== Examples ==
(remark: pictures only?)
=== Positive ===
* Email received
* New update available
* Download completed
* Low battery power
todo: picture
=== Negative ===
* Low space on medium (this information becomes relevant for file managers and invoked as modal message in this case)
todo: picture
== Guidelines ==
* Do not use notifications for user assistance (consider to use [[Projects/Usability/HIG/Tooltip|tool-tips]] or [[Projects/Usability/HIG/Balloon|balloons]] for short information, or refer to [[Projects/Usability/HIG/HelpSystem|help system]] for extended text.
* Do not use notifications for context relevant information that might interfere with the actual workflow (consider to use a [[Projects/Usability/HIG/MessageDialog|message dialog]].
* Do not add controls to notification. Thomas: I would remove this. Adding action buttons is allowed in the API and has reasonable use cases, other controls simply cannot be added technically)
* Do not override system settings. (remark: more specific) Thomas: Which settings do you mean here?
* Provide title and content text (remark: not precise enough) Thomas: guidelines regarding the wording of title and content are indeed very important. Maybe celeste can help here.
* Make sure to make the origin of the notification clear from the notification title. For instance: "Amarok: Now playing" or "Konsole: Event"
* Keep the notification content concise (no more than about three simple sentences).
* Customize notification with the origin's icon. Heiko: (remark: word "origin" needs to be replaced; "icon" might be replaced by technical term) 
* Provide actionable information (e.g. "Low battery power" "Only 13 min (2%) capacity remaining. Please save your stuff now. Your system will get shut down soon.") Heiko: (remark: should be according actual text)
* Heiko: to be defined: Are all notifications configured in KCM? If not, how to separate? -- Kai Uwe: All notifications emitted through KNotify (ie. application has a notifyrc file) can be configured. Using the FDO notification dbus iface directly is discouraged. In 4.11 there's a configure button on notifications.

== Code snippets ==
to be done

Schedules/KDE4/4.11 Feature Plan

2013-05-21T14:54:29Z

Broulik: /* kde-workspace */

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomukcontroller-qml|QML version of the current Nepomuk controller. |joerg.ehrichs@gmx.de|Jörg Ehrichs}}
{{FeatureDone|Web Shortcuts|Update old shortcuts.|de.meyer.maarten@gmail.com|Maarten De Meyer}}
{{FeatureDone|Web Shortcuts|Use https where possible. ({{bug |308029}})|de.meyer.maarten@gmail.com|Maarten De Meyer}}
{{FeatureDone|Web Shortcuts|Look for url on clipboard when creating new shortcut. ({{bug |146880}})|de.meyer.maarten@gmail.com|Maarten De Meyer}}
{{FeatureInProgress|Web Shortcuts|Insert query placeholder button. ({{bug |146879}})|de.meyer.maarten@gmail.com|Maarten De Meyer}}
|}
 

= 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|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}



{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
{{FeatureDone|kmenuedit|Ability to sort entries in the sub-menus ({{bug |108419}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|kmenuedit|Add move up/down buttons ({{bug |61537}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|plasma notifications|Add button to notifications that allow configuring them|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|plasma batterymonitor|Improve situtation with multiple batteries (show battery names, dont just sum up _all_ the percentages etc)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Implement notifications for non-internal batteries (aka "Your mouse is running low")|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|plasma batterymonitor|UI overhaul for battery monitor|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Remember action settings when action is disabled|kde@privat.broulik.de|Kai Uwe Broulik}}
|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

{{FeatureTodo|Dolphin|Clean up Places panel context menus|kde@privat.broulik.de|Kai Uwe Broulik}}

{{FeatureTodo|Kate|Search-plugin: Add "Current file mode"|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|Search-plugin: As-you-type search in current file|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|Search-plugin: Multi line search & replace|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|Search-plugin: Replace "\<number>" with corresponding regexp-captures in the replace string|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|gdb-plugin: Unify the stack trace and local variables to one ToolView|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|gdb-plugin: Do not update stack/locals view if not visible|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}
{{FeatureDone|Kate|Pâté plugin now supports Python2 or Python3 as a build-time option|srhaque@theiet.org|Shaheed Haque}}
{{FeatureDone|Kate|Pâté GID plugin now supports autocompletion based on the contents of the ID file|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Many generic functions and generic classes, likely the more outstanding are the autocompletations. Now you can create a code completion model with very few lines from Python
|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté python utils plugin. Utils to Python: Checker Parse, Checker Pep8, Checker Pyflakes, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté javascript utils plugin. Utils to JavaScript: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty JSON, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté XML pretty plugin. A simple XML pretty printer. XML formatter which a good indents|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Django utils plugin. Utils to Django: Snippets, and template utils|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Python autocomplete plugin.|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|[http://kate-editor.org/2013/04/23/a-rich-python-console-and-more-in-kate-editor/ Integration of the python_autocomplete and python_console_ipython plugins with the project plugin] .|goinnn@gmail.com|Pablo Martín}}

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

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}
{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

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

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureDone|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Dock Widgets|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Stars Constellations|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|KML I/O Improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Basic KML Editor|tgridel@free.fr|Thibaut Gridel}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|License Information Info Box|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|Navigation Tool Redesign|rahn@kde.org|Torsten Rahn, Mohammed Nafees}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureDone|Marble|GHNS Map Installation In Marble Qt|earthwings@gentoo.org|Dennis Nienhüser}}{{FeatureInProgress|Marble|Support GPX-tracks in elevationProfile|roman.karlstetter@googlemail.com|Roman Karlstetter}}
{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|In-Program documentation for scripting API|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Scripting API cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Statistics module: scripts may add statistics data during algorithm executions|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Text-only interface for Rocs aka Cantor backend|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Worksheet Integration|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Geogebra Support|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|Kig|CAS Backend|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|KAlgebra|Matrix support|aleixpol@kde.org|Aleix Pol Gonzalez}}
|}
 

= kdegames=

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

! Status
! Project
! Description
! Contact

{{FeatureDone|KJumpingCube|Make computer think-times shorter and responses faster|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Provide five skill levels (previously three)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Provide board size up to 15x15 (previously 10x10)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add multi-move undo and redo (previously one move only)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Improve the algorithm for computer opponent Newton|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Make a new toolbar layout with a general-purpose stop-start button|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Add optional pauses after computer moves or animation steps, to help new players understand how the game works|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KJumpingCube|Major internal restructure and rewrite: involving separation of model, view, control and AI classes, new classes for Game and AI_Box and executing AI code on a separate thread|iandw.au@gmail.com|Ian Wadham}}

|}
 

= kdegraphics=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}

{{FeatureDone|kolourpaint|WebP image format plugin|kollix@aon.at|Martin Koller}}

{{FeatureInProgress|okular|Configurable review tools {{bug |159601}}|okular-devel@kde.org|Okular Developers}}
{{FeatureInProgress|okular|Undo/Redo support in PDF forms {{bug |177501}}|okular-devel@kde.org|Okular Developers}}

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureInProgress|Juk|Support excluding directories from a recursive search [https://git.reviewboard.kde.org/r/110273/ Review Request 110273]|biergaizi2009@gmail.com|Tom Li}}
{{FeatureDone|Juk|Add support for [http://www.opus-codec.org/ Ogg Opus audio editing/playback] (requires TagLib and Phonon also support)|mpyne@kde.org|Michael Pyne}}
|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureTodo|KABC Contact groups|use uid's for references|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|SendLaterAgent|Agent for allow to send later mails|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|PimActivity|Create a library to support activity in pim apps|montel@kde.org|Montel Laurent}}
{{FeatureDone|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureDone|headerthemeeditor|Program to edit kmail header theme based on Grantlee|montel@kde.org|Montel Laurent}}
{{FeatureDone|Sieve|Add support for autogenerate sieve script|montel@kde.org|Montel Laurent}}
{{FeatureDone|Blogilo|Use new widget component based on qtwebkit for html editor|montel@kde.org|Montel Laurent}}
{{FeatureDone|ImportWizard|Allow to import settings/data for trojita and improve all others importer|montel@kde.org|Montel Laurent}}

|}
 

= kdeplasma-addons =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

{{FeatureDone|KWallet|UI Refactoring|kde@rusu.info|Valentin Rusu}}
|}
 

= kdetoys =

{| 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|KTeaTime|Bring back the system tray progress indicator known from KTeaTime 4.6.5 and earlier ({{bug |279222}})|kde@hilefoks.org|Stefan Böhmann}}
|}

Schedules/KDE4/4.11 Feature Plan

2013-05-18T12:09:18Z

Broulik: /* kde-baseapps */ Just in case

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
{{FeatureInProgress|nepomukcontroller-qml|QML version of the current Nepomuk controller. |joerg.ehrichs@gmx.de|Jörg Ehrichs}}
|}
 

= 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|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}



{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
{{FeatureDone|kmenuedit|Ability to sort entries in the sub-menus ({{bug |108419}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|kmenuedit|Add move up/down buttons ({{bug |61537}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|plasma notifications|Add button to notifications that allow configuring them|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|plasma batterymonitor|Improve situtation with multiple batteries (show battery names, dont just sum up _all_ the percentages etc)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Implement notifications for non-internal batteries (aka "Your mouse is running low")|kde@privat.broulik.de|Kai Uwe Broulik}}
|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}
{{FeatureTodo|Dolphin|Clean up Places panel context menus|kde@privat.broulik.de|Kai Uwe Broulik}}

{{FeatureTodo|Kate|Search-plugin: Add "Current file mode"|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|Search-plugin: As-you-type search in current file|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|Search-plugin: Multi line search & replace|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|Search-plugin: Replace "\<number>" with corresponding regexp-captures in the replace string|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|gdb-plugin: Unify the stack trace and local variables to one ToolView|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate|gdb-plugin: Do not update stack/locals view if not visible|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}
{{FeatureDone|Kate|Pâté plugin now supports Python2 or Python3 as a build-time option|srhaque@theiet.org|Shaheed Haque}}
{{FeatureDone|Kate|Pâté GID plugin now supports autocompletion based on the contents of the ID file|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Many generic functions and generic classes, likely the more outstanding are the autocompletations. Now you can create a code completion model with very few lines from Python
|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté python utils plugin. Utils to Python: Checker Parse, Checker Pep8, Checker Pyflakes, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté javascript utils plugin. Utils to JavaScript: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty JSON, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté XML pretty plugin. A simple XML pretty printer. XML formatter which a good indents|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Django utils plugin. Utils to Django: Snippets, and template utils|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Python autocomplete plugin.|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|[http://kate-editor.org/2013/04/23/a-rich-python-console-and-more-in-kate-editor/ Integration of the python_autocomplete and python_console_ipython plugins with the project plugin] .|goinnn@gmail.com|Pablo Martín}}

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

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}
{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

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

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Dock Widgets|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Stars Constellations|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|KML I/O Improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Basic KML Editor|tgridel@free.fr|Thibaut Gridel}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|License Information Info Box|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|Navigation Tool Redesign|rahn@kde.org|Torsten Rahn, Mohammed Nafees}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}

{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|In-Program documentation for scripting API|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Scripting API cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Statistics module: scripts may add statistics data during algorithm executions|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Text-only interface for Rocs aka Cantor backend|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Worksheet Integration|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Geogebra Support|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|Kig|CAS Backend|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|KAlgebra|Matrix support|aleixpol@kde.org|Aleix Pol Gonzalez}}
|}
 

= kdegames=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KJumpingCube|Make computer think-times shorter and responses faster|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KJumpingCube|Provide five skill levels (previously three)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KJumpingCube|Provide board size up to 15x15 (previously 10x10)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KJumpingCube|Add multi-move undo and redo (previously one move only)|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KJumpingCube|Improve the algorithm for computer opponent Newton|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KJumpingCube|Make computer think-times shorter and responses faster|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KJumpingCube|Make a new toolbar layout with a general-purpose stop-start button|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KJumpingCube|Add optional pauses after computer moves or animation steps, to help new players understand how the game works|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KJumpingCube|Major internal restructure and rewrite: involving separation of model, view, control and AI classes, new classes for Game and AI_Box and executing AI code on a separate thread|iandw.au@gmail.com|Ian Wadham}}

|}
 

= kdegraphics=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}

{{FeatureInProgress|kolourpaint|WebP image format plugin|kollix@aon.at|Martin Koller}}

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add support for [http://www.opus-codec.org/ Ogg Opus audio editing/playback] (requires TagLib and Phonon also support)|mpyne@kde.org|Michael Pyne}}
|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureTodo|KABC Contact groups|use uid's for references|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|SendLaterAgent|Agent for allow to send later mails|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|PimActivity|Create a library to support activity in pim apps|montel@kde.org|Montel Laurent}}
{{FeatureDone|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureDone|headerthemeeditor|Program to edit kmail header theme based on Grantlee|montel@kde.org|Montel Laurent}}
{{FeatureDone|Sieve|Add support for autogenerate sieve script|montel@kde.org|Montel Laurent}}
{{FeatureDone|Blogilo|Use new widget component based on qtwebkit for html editor|montel@kde.org|Montel Laurent}}
{{FeatureDone|ImportWizard|Allow to import settings/data for trojita and improve all others importer|montel@kde.org|Montel Laurent}}

|}
 

= kdeplasma-addons =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}

{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

{{FeatureDone|KWallet|UI Refactoring|kde@rusu.info|Valentin Rusu}}
|}
 

= kdetoys =

{| 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|KTeaTime|Bring back the system tray progress indicator known from KTeaTime 4.6.5 and earlier ({{bug |279222}})|kde@hilefoks.org|Stefan Böhmann}}
|}

Schedules/KDE4/4.11 Feature Plan

2013-05-16T18:43:31Z

Broulik: /* kdeutils */ Let's hope the best for the Ark rewrite ;)

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

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

! Status
! Project
! Description
! Contact


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}



{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
{{FeatureDone|kmenuedit|Ability to sort entries in the sub-menus ({{bug |108419}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|kmenuedit|Add move up/down buttons ({{bug |61537}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|plasma notifications|Add button to notifications that allow configuring them|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|plasma batterymonitor|Improve situtation with multiple batteries (show battery names, dont just sum up _all_ the percentages etc)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Implement notifications for non-internal batteries (aka "Your mouse is running low")|kde@privat.broulik.de|Kai Uwe Broulik}}
|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

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

{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}
{{FeatureDone|Kate|Pâté plugin now supports Python2 or Python3 as a build-time option|srhaque@theiet.org|Shaheed Haque}}
{{FeatureDone|Kate|Pâté GID plugin now supports autocompletion based on the contents of the ID file|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Many generic functions and generic classes, likely the more outstanding are the autocompletations. Now you can create a code completion model with very few lines from Python
|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté python utils plugin. Utils to Python: Checker Parse, Checker Pep8, Checker Pyflakes, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté javascript utils plugin. Utils to JavaScript: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty JSON, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté XML pretty plugin. A simple XML pretty printer. XML formatter which a good indents|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Django utils plugin. Utils to Django: Snippets, and template utils|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Python autocomplete plugin.|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|[http://kate-editor.org/2013/04/23/a-rich-python-console-and-more-in-kate-editor/ Integration of the python_autocomplete and python_console_ipython plugins with the project plugin] .|goinnn@gmail.com|Pablo Martín}}

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

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}
{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

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

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Dock Widgets|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Stars Constellations|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|KML I/O Improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Basic KML Editor|tgridel@free.fr|Thibaut Gridel}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|License Information Info Box|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|Navigation Tool Redesign|rahn@kde.org|Torsten Rahn, Mohammed Nafees}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}

{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|In-Program documentation for scripting API|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Scripting API cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Statistics module: scripts may add statistics data during algorithm executions|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Text-only interface for Rocs aka Cantor backend|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Worksheet Integration|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Geogebra Support|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|Kig|CAS Backend|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|KAlgebra|Matrix support|aleixpol@kde.org|Aleix Pol Gonzalez}}
|}
 

= kdegames=

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

! Status
! Project
! Description
! Contact

|}
 

= kdegraphics=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}

{{FeatureInProgress|kolourpaint|WebP image format plugin|kollix@aon.at|Martin Koller}}

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add support for [http://www.opus-codec.org/ Ogg Opus audio editing/playback] (requires TagLib and Phonon also support)|mpyne@kde.org|Michael Pyne}}
|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureInProgress|SendLaterAgent|Agent for allow to send later mails|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|PimActivity|Create a library to support activity in pim apps|montel@kde.org|Montel Laurent}}
{{FeatureDone|headerthemeeditor|Program to edit kmail header theme based on Grantlee|montel@kde.org|Montel Laurent}}
{{FeatureDone|Sieve|Add support for autogenerate sieve script|montel@kde.org|Montel Laurent}}
{{FeatureDone|Blogilo|Use new widget component based on qtwebkit for html editor|montel@kde.org|Montel Laurent}}
{{FeatureDone|ImportWizard|Allow to import settings/data for trojita and improve all others importer|montel@kde.org|Montel Laurent}}

|}
 

= kdeplasma-addons =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}

{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

{{FeatureDone|KWallet|UI Refactoring|kde@rusu.info|Valentin Rusu}}
|}
 

= kdetoys =

{| 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|KTeaTime|Bring back the system tray progress indicator known from KTeaTime 4.6.5 and earlier ({{bug |279222}})|kde@hilefoks.org|Stefan Böhmann}}
|}

Schedules/KDE4/4.11 Feature Plan

2013-05-16T18:42:48Z

Broulik: /* kde-workspace */ battery monitor done

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

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

! Status
! Project
! Description
! Contact


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}



{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
{{FeatureDone|kmenuedit|Ability to sort entries in the sub-menus ({{bug |108419}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|kmenuedit|Add move up/down buttons ({{bug |61537}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|plasma notifications|Add button to notifications that allow configuring them|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|plasma batterymonitor|Improve situtation with multiple batteries (show battery names, dont just sum up _all_ the percentages etc)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Implement notifications for non-internal batteries (aka "Your mouse is running low")|kde@privat.broulik.de|Kai Uwe Broulik}}
|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

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

{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}
{{FeatureDone|Kate|Pâté plugin now supports Python2 or Python3 as a build-time option|srhaque@theiet.org|Shaheed Haque}}
{{FeatureDone|Kate|Pâté GID plugin now supports autocompletion based on the contents of the ID file|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Many generic functions and generic classes, likely the more outstanding are the autocompletations. Now you can create a code completion model with very few lines from Python
|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté python utils plugin. Utils to Python: Checker Parse, Checker Pep8, Checker Pyflakes, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté javascript utils plugin. Utils to JavaScript: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty JSON, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté XML pretty plugin. A simple XML pretty printer. XML formatter which a good indents|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Django utils plugin. Utils to Django: Snippets, and template utils|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Python autocomplete plugin.|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|[http://kate-editor.org/2013/04/23/a-rich-python-console-and-more-in-kate-editor/ Integration of the python_autocomplete and python_console_ipython plugins with the project plugin] .|goinnn@gmail.com|Pablo Martín}}

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

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}
{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

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

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Dock Widgets|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Stars Constellations|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|KML I/O Improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Basic KML Editor|tgridel@free.fr|Thibaut Gridel}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|License Information Info Box|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|Navigation Tool Redesign|rahn@kde.org|Torsten Rahn, Mohammed Nafees}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}

{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|In-Program documentation for scripting API|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Scripting API cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Statistics module: scripts may add statistics data during algorithm executions|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Text-only interface for Rocs aka Cantor backend|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Worksheet Integration|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Geogebra Support|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|Kig|CAS Backend|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|KAlgebra|Matrix support|aleixpol@kde.org|Aleix Pol Gonzalez}}
|}
 

= kdegames=

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

! Status
! Project
! Description
! Contact

|}
 

= kdegraphics=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}

{{FeatureInProgress|kolourpaint|WebP image format plugin|kollix@aon.at|Martin Koller}}

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add support for [http://www.opus-codec.org/ Ogg Opus audio editing/playback] (requires TagLib and Phonon also support)|mpyne@kde.org|Michael Pyne}}
|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
{{FeatureInProgress|SendLaterAgent|Agent for allow to send later mails|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|PimActivity|Create a library to support activity in pim apps|montel@kde.org|Montel Laurent}}
{{FeatureDone|headerthemeeditor|Program to edit kmail header theme based on Grantlee|montel@kde.org|Montel Laurent}}
{{FeatureDone|Sieve|Add support for autogenerate sieve script|montel@kde.org|Montel Laurent}}
{{FeatureDone|Blogilo|Use new widget component based on qtwebkit for html editor|montel@kde.org|Montel Laurent}}
{{FeatureDone|ImportWizard|Allow to import settings/data for trojita and improve all others importer|montel@kde.org|Montel Laurent}}

|}
 

= kdeplasma-addons =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}

{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Ark|Make it possible to disable internal previewer|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|KWallet|UI Refactoring|kde@rusu.info|Valentin Rusu}}
|}
 

= kdetoys =

{| 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|KTeaTime|Bring back the system tray progress indicator known from KTeaTime 4.6.5 and earlier ({{bug |279222}})|kde@hilefoks.org|Stefan Böhmann}}
|}

Schedules/KDE4/4.11 Feature Plan

2013-05-14T21:35:41Z

Broulik: Configure button for notifications done

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

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

! Status
! Project
! Description
! Contact


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}



{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
{{FeatureDone|kmenuedit|Ability to sort entries in the sub-menus ({{bug |108419}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|kmenuedit|Add move up/down buttons ({{bug |61537}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|plasma notifications|Add button to notifications that allow configuring them|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|plasma batterymonitor|Improve situtation with multiple batteries (show battery names, dont just sum up _all_ the percentages etc)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Implement notifications for non-internal batteries (aka "Your mouse is running low")|kde@privat.broulik.de|Kai Uwe Broulik}}
|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

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

{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}
{{FeatureDone|Kate|Pâté plugin now supports Python2 or Python3 as a build-time option|srhaque@theiet.org|Shaheed Haque}}
{{FeatureDone|Kate|Pâté GID plugin now supports autocompletion based on the contents of the ID file|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Many generic functions and generic classes, likely the more outstanding are the autocompletations. Now you can create a code completion model with very few lines from Python
|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté python utils plugin. Utils to Python: Checker Parse, Checker Pep8, Checker Pyflakes, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté javascript utils plugin. Utils to JavaScript: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty JSON, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté XML pretty plugin. A simple XML pretty printer. XML formatter which a good indents|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Django utils plugin. Utils to Django: Snippets, and template utils|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Python autocomplete plugin.|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|[http://kate-editor.org/2013/04/23/a-rich-python-console-and-more-in-kate-editor/ Integration of the python_autocomplete and python_console_ipython plugins with the project plugin] .|goinnn@gmail.com|Pablo Martín}}

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

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}
{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

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

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Dock Widgets|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Stars Constellations|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|KML I/O Improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Basic KML Editor|tgridel@free.fr|Thibaut Gridel}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|License Information Info Box|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|Navigation Tool Redesign|rahn@kde.org|Torsten Rahn, Mohammed Nafees}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}

{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|In-Program documentation for scripting API|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Scripting API cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Statistics module: scripts may add statistics data during algorithm executions|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Text-only interface for Rocs aka Cantor backend|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Worksheet Integration|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Geogebra Support|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|Kig|CAS Backend|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|KAlgebra|Matrix support|aleixpol@kde.org|Aleix Pol Gonzalez}}
|}
 

= kdegames=

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

! Status
! Project
! Description
! Contact

|}
 

= kdegraphics=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}

{{FeatureInProgress|kolourpaint|WebP image format plugin|kollix@aon.at|Martin Koller}}

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add support for [http://www.opus-codec.org/ Ogg Opus audio editing/playback] (requires TagLib and Phonon also support)|mpyne@kde.org|Michael Pyne}}
|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}

|}
 

= kdeplasma-addons =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}

{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Ark|Make it possible to disable internal previewer|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|KWallet|UI Refactoring|kde@rusu.info|Valentin Rusu}}
|}
 

= kdetoys =

{| 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|KTeaTime|Bring back the system tray progress indicator known from KTeaTime 4.6.5 and earlier ({{bug |279222}})|kde@hilefoks.org|Stefan Böhmann}}
|}

Schedules/KDE4/4.11 Feature Plan

2013-05-13T21:22:35Z

Broulik: /* kde-baseapps */ Don't need it anymore. Sorry :)

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

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

! Status
! Project
! Description
! Contact


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}



{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
{{FeatureDone|kmenuedit|Ability to sort entries in the sub-menus ({{bug |108419}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|kmenuedit|Add move up/down buttons ({{bug |61537}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureInProgress|plasma notifications|Add button to notifications that allow configuring them|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|plasma batterymonitor|Improve situtation with multiple batteries (show battery names, dont just sum up _all_ the percentages etc)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Implement notifications for non-internal batteries (aka "Your mouse is running low")|kde@privat.broulik.de|Kai Uwe Broulik}}
|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

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

{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}
{{FeatureDone|Kate|Pâté plugin now supports Python2 or Python3 as a build-time option|srhaque@theiet.org|Shaheed Haque}}
{{FeatureDone|Kate|Pâté GID plugin now supports autocompletion based on the contents of the ID file|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Many generic functions and generic classes, likely the more outstanding are the autocompletations. Now you can create a code completion model with very few lines from Python
|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté python utils plugin. Utils to Python: Checker Parse, Checker Pep8, Checker Pyflakes, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté javascript utils plugin. Utils to JavaScript: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty JSON, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté XML pretty plugin. A simple XML pretty printer. XML formatter which a good indents|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Django utils plugin. Utils to Django: Snippets, and template utils|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Python autocomplete plugin.|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|[http://kate-editor.org/2013/04/23/a-rich-python-console-and-more-in-kate-editor/ Integration of the python_autocomplete and python_console_ipython plugins with the project plugin] .|goinnn@gmail.com|Pablo Martín}}

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

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}
{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

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

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Dock Widgets|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Stars Constellations|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|KML I/O Improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Basic KML Editor|tgridel@free.fr|Thibaut Gridel}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|License Information Info Box|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|Navigation Tool Redesign|rahn@kde.org|Torsten Rahn, Mohammed Nafees}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}

{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|In-Program documentation for scripting API|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Scripting API cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Statistics module: scripts may add statistics data during algorithm executions|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Text-only interface for Rocs aka Cantor backend|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Worksheet Integration|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Geogebra Support|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|Kig|CAS Backend|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|KAlgebra|Matrix support|aleixpol@kde.org|Aleix Pol Gonzalez}}
|}
 

= kdegames=

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

! Status
! Project
! Description
! Contact

|}
 

= kdegraphics=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}

{{FeatureInProgress|kolourpaint|WebP image format plugin|kollix@aon.at|Martin Koller}}

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add support for [http://www.opus-codec.org/ Ogg Opus audio editing/playback] (requires TagLib and Phonon also support)|mpyne@kde.org|Michael Pyne}}
|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}

|}
 

= kdeplasma-addons =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}

{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Ark|Make it possible to disable internal previewer|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|KWallet|UI Refactoring|kde@rusu.info|Valentin Rusu}}
|}
 

= kdetoys =

{| 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|KTeaTime|Bring back the system tray progress indicator known from KTeaTime 4.6.5 and earlier ({{bug |279222}})|kde@hilefoks.org|Stefan Böhmann}}
|}

Schedules/KDE4/4.11 Feature Plan

2013-05-13T21:14:09Z

Broulik: Added the stuff I'm planning for 4.11 (plasma notifications configuring, improve multiple batteries situation)

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|kio-mtp|KIO-Slave for MTP|philschmidt@gmx.net|Philipp Schmidt}}
{{FeatureInProgress|nepomuk filemetadatawidget|Nepomuk Metadata Widget|me@vhanda.in|Vishesh Handa}}
|}
 

= kde-workspace =

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

! Status
! Project
! Description
! Contact


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Medium focus stealing prevention should also prevent focus stealing when the timestamp on the active window is uncertain ({{bug |304746}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Usability issue: "Attach as tab to" menu can be empty ({{bug |306451}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab ({{bug |296772}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Get rid of "Display borders on maximized windows" setting ({{bug |299245}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Cube animation on border approach should not be used unless the electric borders are actually in use and the config should be disabled, align or hint the electric border configuration ({{bug |299901}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make ShaderManager act as a real stack ({{bug |300349}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|clientPopup: "'More actions' and "Attach as tab to" lack mnemonics ({{bug |302833}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Make KWin compile with C++11 ({{bug |303313}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Copy all useful Client properties to Deleted ({{bug |303916}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Display content of resizing/moving windows: KDE-Help shows obsolete instructions ({{bug |305297}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Mouse action support for sending window to different activity ({{bug |305758}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Windows list icon does not show up in "Walk Through Desktop List" ({{bug |306187}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Game mode ({{bug |306448}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Common animation settings for effects of same type ({{bug |308991}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Use Resize Area in Aurorae ({{bug |308992}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Configurable quick tile area config GUI ({{bug |308993}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Remove legacy window decorations ({{bug |299144}}, Review 104281)|kwin-bugs-null@kde.org}}



{{FeatureInProgress|plasma workspace|Port Task Manager applets to QML|hein@kde.org|Eike Hein (Sho_)}}
{{FeatureInProgress|plasma workspace|refresh Air Plasma theme|mart@kde.org|Marco Martin}}
{{FeatureInProgress|plasma workspace|Port Kickoff to qml|yellowcake-@gmx.net|Greg T}}
{{FeatureTodo|systemsettings|Replace krandr KCM by libkscreen-based one|dvratil@redhat.com|Dan Vrátil}}
{{FeatureInProgress|plasma workspace|Port rssnow to qml|terietor@gmail.com|Giorgos Tsiapaliokas}}
{{FeatureInProgress|various|KActivities/SLC support for most our applications|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|plasma workspace|first desktop SLC applet release|mart@kde.org|Marco Martin}}
{{FeatureTodo|plasma workspace|Top-rated documents for Task Manager|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|window manager|Rework and optimize vertex specification|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Dynamic shader generation|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|Partial port to xcb|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|window manager|New launch feedback effect|fredrik@kde.org|Fredrik Höglund}}
{{FeatureInProgress|activities|Encrypted activities|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|powerdevil|Improve profile error handling (DPMS)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|plasma workspace|Social Feed|mklapetek@kde.org|Martin Klapetek}}
{{FeatureDone|kmenuedit|Ability to sort entries in the sub-menus ({{bug |108419}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureDone|kmenuedit|Add move up/down buttons ({{bug |61537}})|frajibe@gmail.com|Julien Borderie}}
{{FeatureInProgress|plasma notifications|Add button to notifications that allow configuring them|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|plasma batterymonitor|Improve situtation with multiple batteries (show battery names, dont just sum up _all_ the percentages etc)|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureInProgress|powerdevil|Implement notifications for non-internal batteries (aka "Your mouse is running low")|kde@privat.broulik.de|Kai Uwe Broulik}}
|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

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

{{FeatureTodo|Kate|As-you-type search for the search plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|Kate|Session name API for plugins + automatic ctags database naming|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Add optional document "minimap" to the Symbols view plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Kate|Vim Mode Macro support|kdedevel@etothepiplusone.com|Simon St James}}
{{FeatureDone|Kate|Pâté plugin now supports Python2 or Python3 as a build-time option|srhaque@theiet.org|Shaheed Haque}}
{{FeatureDone|Kate|Pâté GID plugin now supports autocompletion based on the contents of the ID file|srhaque@theiet.org|Shaheed Haque}}

{{FeatureDone|Kate|Many generic functions and generic classes, likely the more outstanding are the autocompletations. Now you can create a code completion model with very few lines from Python
|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté python utils plugin. Utils to Python: Checker Parse, Checker Pep8, Checker Pyflakes, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté javascript utils plugin. Utils to JavaScript: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty JSON, Snippets|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté XML pretty plugin. A simple XML pretty printer. XML formatter which a good indents|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Django utils plugin. Utils to Django: Snippets, and template utils|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|Pâté Python autocomplete plugin.|goinnn@gmail.com|Pablo Martín}}
{{FeatureDone|Kate|[http://kate-editor.org/2013/04/23/a-rich-python-console-and-more-in-kate-editor/ Integration of the python_autocomplete and python_console_ipython plugins with the project plugin] .|goinnn@gmail.com|Pablo Martín}}

{{FeatureTodo|Kdialog|Add support for detailedsorry/detailederror messages|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureTodo|Konsole|Improve the search filter bar|francesco.cecconi@gmail.com|Francesco Cecconi}}

{{FeatureTodo|Konsole|Add the --separate cmdline option for running in new process|adaptee@gmail.com|Jekyll Wu}}
{{FeatureTodo|Konsole|Make the d&d popup menu optional|adaptee@gmail.com|Jekyll Wu}}

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

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|Marble|Have support for "repeatX" in the projection classes|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Satellite Map NG|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Mars & Venus satellite plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn / Gerhard Holtkamp}}
{{FeatureTodo|Marble|Help Menu polishing / Support page inclusion|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Toolbar polishing/refactoring|rahn@kde.org|Torsten Rahn}}
{{FeatureTodo|Marble|Solar Eclipse Plugin|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|Worldwide hillshading|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Extended library API (no MarbleWidget dependency for tasks like parsing, routing)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Marble Touch on Plasma Active|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Foursquare plugin|utkuaydin34@gmail.com|Utku Aydın}}
{{FeatureTodo|Marble|Marble Touch on Android (including SOK branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|OSM vector rendering (GSOC branch merge)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Dock Widgets|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Stars Constellations|rahn@kde.org|Torsten Rahn}}
{{FeatureInProgress|Marble|KML I/O Improvements|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Basic KML Editor|tgridel@free.fr|Thibaut Gridel}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|WebKit Powered Info Dialog|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|License Information Info Box|marble-devel@kde.org|Various Artists}}
{{FeatureDone|Marble|Navigation Tool Redesign|rahn@kde.org|Torsten Rahn, Mohammed Nafees}}
{{FeatureTodo|Marble|Zoom to content of geo file after loading (at least on start-up)|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files thumbnailer|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Marble|Geo files metadata extractor|kossebau@kde.org|Friedrich W. H. Kossebau}}

{{FeatureTodo|Rocs|Data Structure Backend wise iconsets and preconfigurations for types|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Printing and image export of graphs.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Data Structure Snapshot and Recovery.|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Visual Graph Editor Handling: copy&paste, data structure focus, property display|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|In-Program documentation for scripting API|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Scripting API cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Statistics module: scripts may add statistics data during algorithm executions|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Text-only interface for Rocs aka Cantor backend|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Worksheet Integration|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Python backend|filipe@kde.org|Filipe Saraiva}}
{{FeatureInProgress|Kig|Geogebra Support|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|Kig|CAS Backend|david.narvaez@computer.org|David E. Narváez}}
{{FeatureInProgress|KAlgebra|Matrix support|aleixpol@kde.org|Aleix Pol Gonzalez}}
|}
 

= kdegames=

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

! Status
! Project
! Description
! Contact

|}
 

= kdegraphics=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|libkipi|[http://www.google-melange.com/gsoc/proposal/review/google/gsoc2012/dodonvictor/10002 Porting libkipi to KDE-XML GUI]|dodonvictor@gmail.com|Victor Dodon}}

{{FeatureInProgress|kolourpaint|WebP image format plugin|kollix@aon.at|Martin Koller}}

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Juk|[http://community.kde.org/Juk#Porting_plan Port Juk away from kde3support]|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|Juk|Add support for [http://www.opus-codec.org/ Ogg Opus audio editing/playback] (requires TagLib and Phonon also support)|mpyne@kde.org|Michael Pyne}}
|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureTodo|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}

|}
 

= kdeplasma-addons =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureTodo|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}

{{FeatureInProgress|Eyes|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|FifteenPuzzle|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Luna|replace with QML version|bettio@kde.org|Davide Bettio}}
{{FeatureInProgress|Timer|replace with QML version|bettio@kde.org|Davide Bettio}}
|}
 

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Ark|Make it possible to disable internal previewer|kde@privat.broulik.de|Kai Uwe Broulik}}
{{FeatureDone|KWallet|UI Refactoring|kde@rusu.info|Valentin Rusu}}
|}
 

= kdetoys =

{| 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|KTeaTime|Bring back the system tray progress indicator known from KTeaTime 4.6.5 and earlier ({{bug |279222}})|kde@hilefoks.org|Stefan Böhmann}}
|}

Thread:Talk:KDE System Administration/PlasmaDesktopScripting/Writing an example for setting widget's geometry/reply

2013-01-10T01:36:21Z

Broulik: Reply to Writing an example for setting widget's geometry

Sorry, I just saw this message :D
Go ahead :-)

Schedules/KDE4/4.10 Feature Plan

2012-11-20T21:28:31Z

Broulik: Added powerdevil notifications overhaul (now with really beautiful messages if your battery goes low :P)

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

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

= kde-workspace =

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

! Status
! Project
! Description
! Contact

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


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


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

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}
 

= kdeedu =

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

! Status
! Project
! Description
! Contact

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

= kdegames=

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

! Status
! Project
! Description
! Contact

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

= kdegraphics=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
|}
 

= kdeplasma-addons =

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

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

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

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

Schedules/KDE4/4.10 Feature Plan

2012-10-25T11:21:54Z

Broulik: Added kdialog detailedsorry/detailederror impl, powerdevil profile error handling and ark previewer make optional feature

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

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

= kde-workspace =

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

! Status
! Project
! Description
! Contact

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


{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows ({{bug |213847}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Fix fullscreen state handling: NETWM says it's bound to focus and not stacking order, also see bug #224600 ({{bug |296076}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Lanczos Filter broken after screen size changes ({{bug |296065}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|GHNS support for KWin Scripts ({{bug |296774}}, Review 104877)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|KConf Update Script for KWin 4.9 ({{bug |296775}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for scripted KWin Effects on kde-(look<nowiki>|</nowiki>app).org ({{bug |297634}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for KWin Scripts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297635}})|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|GHNS support for Window Switching Layouts ({{bug |297636}}, Review 104894)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org ({{bug |297637}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Update Documentation for Window Switcher Layouts ({{bug |297638}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|ThumbnailItem allows upscaling of Windows ({{bug |297864}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Window Tab support for QML based Aurorae ({{bug |299138}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Increase ABI version for KDecorations ({{bug |299140}})|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Break NETWM to allow inner xinerama struts ({{bug |299247}})|kwin-bugs-null@kde.org}}


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

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}
 

= kdeedu =

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

! Status
! Project
! Description
! Contact

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

= kdegames=

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

! Status
! Project
! Description
! Contact

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

= kdegraphics=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact
{{FeatureInProgress|Facebook resource|Include it in default install|martin.klapetek@gmail.com|Martin Klapetek}}
{{FeatureInProgress|Akregator2|Merge in kdepim|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Knode|Merge in KMail|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|BackupMail|Extend backup to all kdepim apps|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|Sieve|Rewrite dialogbox|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|libs|Move folderview to kdepimlibs/akonadi|montel@kde.org|Montel Laurent}}
{{FeatureInProgress|kolab-resource|Make Kolab 3.0 option available|mollekopf@kolabsys.com|Christian Mollekopf}}
|}
 

= kdeplasma-addons =

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

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

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

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

Development/Tutorials/Plasma/JavaScript/API

2011-05-17T23:48:47Z

Broulik: /* LinearLayout */ Did not get the QtOrientation thing, so I added the parameters

= Introduction to the Plasmoid JavaScript API =

This document provides an overview/reference of the Simplified JavaScript API for Plasmoids. The "Simplified" refers to the fact that it isn't a full binding to all of Qt or KDE's libraries, but a highly focused set of bindings designed to make writing Plasmoids fast and easy, while remaining powerful.

The API in this documentation covers the JavaScript API as it appears in the KDE Software Compilation as of version 4.4, unless otherwise noted. This API ships as part of the KDE Base Runtime package, so can be relied on being there by any application that is Powered By KDE.

If you have not done so already, please read the [http://websvn.kde.org/trunk/KDE/kdebase/workspace/plasma/design/plasmoids "plasmoid" design document] first.

== What Is A Simplified JavaScript Plasmoid? ==

This document describes the native Plasma API available to Simplified JavaScript Plasmoids. What makes them "Simplified" is that they do not have access to the entire C++ API in the Plasma, KDE and Qt libraries (let alone things lower in the API stack). This helps ensure that these Plasmoids are more likely to work properly between releases as changes in underlying API don't affect them as well as allowing Plasma to offer stronger security guarantees around them.

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

X-Plasma-API=javascript

What follows is a description of the runtime environment available to a Simplified JavaScript Plasmoid.

== QtScript ==

The Simplified JavaScript API is powered by Qt's QtScript system which provides access to a full featured ECMA Script interpreter. If it works in ECMA Script, it will work in a Simplified JavaScript Plasmoid. As an interesting implementation note, QtScript uses the high performance ECMA Script interpreter from WebKit and shares this code with QtWebKit.

On top of the ECMA Script language, QtScript provides Qt integration features. Probably the most useful one in this context is the use of signals and slots which is Qt's callback mechanism. Signals may be emitted in QtScript by calling the signal method in question, a signal can be connected to a slot by using the connect() method (and disconnected with disconnect()) and any function defined in the Plasmoid may be used as a slot. For example: <code javascript="javascript">
function onClick()
{
print("We got clicked!")
}

function onFirstClick()
{
print("First click!")
button.clicked.disconnect(onFirstClick)
}

button = new PushButton
button.clicked.connect(onClick)
button.clicked.connect(onFirstClick)
button.clicked()
</code> This will print out:

<code>
We got clicked!
First click!
</code>

on the console when the Plasmoid starts, and the "We got clicked!" again whenever the button is clicked by the user.

The object that emitted the signal that caused a slot to be called can be retrieved using the ''QObject'' '''sender''' read-only property of the global '''plasmoid''' object.

== Events (API v2) ==

Starting in API v2, it is possible register functions as event handlers. To register an event handler, use:

* '''addEventListener(String event, Function listener)'''

The event parameter is the name of the event (see list at end of section for known events) and the handler parameter is the function that will be called whenever the event occurs. Event names are not case sensitive. An event object will be passed into the handler, and the type and behavior of that object is event specific.

Any number of event handlers may be added to a given event, and one handler may be registered to any number of events. The order of execution of event handlers is not guaranteed.

To remove an event handler, use:

* '''removeEventListener(String event, Function listener)'''

The function passed in will no longer be called as a result of the event occurring. Any currently pending calls to the listener are still made, however.

If an event handler is registered using addEventListener, then any callback in the global plasmoid object that may be related to the same event will be suppressed. For instance, if an event handler is registered using addEventListener for the paintInterface event, then plasmoid.paintInterface will not be called.

=== Input Events (API v2) ===

Following are the input events which are recognized on the Plasmoid along with the type of event object passed in to registered event listeners:

* HoverEnter: HoverEvent Object
* HoverLeave: HoverEvent Object
* HoverMove: HoverEvent Object
* KeyPress: KeyEvent Object
* KeyRelease: KeyEvent Object
* MouseDoubleClick: MouseEvent Object
* MouseMove: MouseEvent Object
* MousePress: MouseEvent Object
* MouseRelease: MouseEvent Object
* Wheel: WheelEvent Object

Example:

<code javascript>
// anonymous function as a listener on KeyPress
plasmoid.addEventListener('KeyPress', function(a) { print(a.key) })

function output()
{
print('Hover Event!')
}

function hovered(event)
{
plasmoid.busy = true
plasmoid.removeEventListener('HoverEnter', output)
}

function unhovered(event)
{
plasmoid.busy = false
}

plasmoid.addEventListener('HoverEnter', hovered)
plasmoid.addEventListener('HoverLeave', unhovered)
plasmoid.addEventListener('HoverEnter', output)
plasmoid.addEventListener('HoverLeave', output)
</code>

==== HoverEvent (API v2) ====

==== KeyEvent (API v2) ====

==== MouseEvent (API v2) ====

==== WheelEvent (API v2) ====

=== Addon Events (API v3) ===

The following two events are used in conjuction with Addons. See the Addons section for more information on Addons.

* addonCreated: Object addOn
* newAddonsAvailable

== 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: <code javascript="javascript">
plasmoid.formFactorChanged = function() {

print("the form factor has changed to: " + plasmoid.formFactor())

}
</code>

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:

<code javascript>plasmoid.addEventListener('popupEvent', function(shown) { print('shown? ' + shown) } )</code>

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.

=== Painting and Layout ===

To paint directly on to the canvas, a widget may implement the paintInterface function in the plasmoid object:
<code javascript>
plasmoid.paintInterface = function(painter) { /* painting code goes here*/ }
</code>
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. <code javascript>var path = plasmoid.file("mainscript")</code> or <code javascript>var pm = new QPixmap(plasmoid.file("images", "mypixmap.png"))</code>

* ''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

== Global Enumerations ==
In the global namespace are a set of useful enumerations that can be used with various classes in the Simplified Javascript Plasmoid API. These include:

=== AspectRatioMode ===
* '''IgnoreAspectRatio''': The Plasmoid can be freely resized
* '''KeepAspectRatio''': The Plasmoid keeps a fixed aspect ratio
* '''Square: The Plasmoid is always a square
* '''ConstrainedSquare''': The Plasmoid is no wider (in horizontal formfactors) or no higher (in vertical ones) than a square
* '''FixedSize''': The Plasmoid cannot be resized

=== FormFactor ===
* '''Planar''': The Plasmoid lives in a plane and has two degrees of freedom to grow. Optimize for desktop, laptop or tablet usage: a high resolution screen 1-3 feet distant from the viewer.
* '''MediaCenter''': As with Plasmoid the applet lives in a but the interface should be optimized for medium-to-high resolution screens that 5-15 feet distant from the viewer. Sometimes referred to as a "ten foot interface".
* '''Horizontal''': The Plasmoid is constrained vertically, but can expand horizontally.
* '''Vertical''': The Plasmoid is constrained horizontally, but can expand vertically.

=== Location ===
* '''Floating''': Free floating. Neither geometry or z-ordering is described precisely by this value.
* '''Desktop''': On the planar desktop layer, extending across the full screen from edge to edge
* '''FullScreen'''
* '''TopEdge'''
* '''BottomEdge'''
* '''LeftEdge'''
* '''RightEdge'''

=== AnimationDirection ===
* '''AnimationForward'''
* '''AnimationBackward'''

=== BackgroundHints ===
* '''NoBackground'''
* '''StandardBackground'''
* '''TranslucentBackground'''
* '''DefaultBackground'''

=== QtAlignment ===
* QtAlignLeft
* QtAlignRight
* QtAlignHCenter
* QtAlignJustify
* QtAlignTop
* QtAlignBottom
* QtAlignVCenter

If you need to align something in the center (both horizontally and vertically) you can sum the constans.

=== QtAnchorPoint ===
* QtAnchorLeft
* QtAnchorRight
* QtAnchorBottom
* QtAnchorTop
* QtAnchorHorizontalCenter
* QtAnchorVerticalCenter

=== QtCorner ===
* QtTopLeftCorner
* QtTopRightCorner
* QtBottomLeftCorner
* QtBottomRightCorner

=== QtMouseButton ===
* QtNoButton
* QtLeftButton
* QtRightButton
* QtMidButton
* QtXButton1
* QtXButton2

=== QtOrientation ===
* QtHorizontal
* QtVertical

=== QtScrollBarPolicy ===
* QtScrollBarAsNeeded
* QtScrollBarAlwaysOff
* QtScrollBarAlwaysOn

=== QtSizePolicy ===
* QSizePolicyFixed
* QSizePolicyMinimum
* QSizePolicyMaximum
* QSizePolicyPreferred
* QSizePolicyExpanding
* QSizePolicyMinimumExpanding
* QSizePolicyIgnored

=== Theme Colors (API v3) ===
* TextColor
* HighlightColor
* BackgroundColor
* ButtonTextColor
* ButtonBackgroundColor
* LinkColor
* VisitedLinkColor

=== Status ===
* UnknownStatus The status is unknown
* PassiveStatus The Item is passive
* ActiveStatus The Item is active
* NeedsAttentionStatus The Item needs attention
* AcceptingInputStatus The Item is accepting input

== User Interface Elements ==

=== Plasma Widgets ===

The Plasma framework provides a set of standard user interface elements such as pushbuttons and checkboxes for use in Plasmoids, and these are available from the Simplified Javascript API as well. These elements follow the Plasma style and other conventions so that widgets blend well both visually and functionally with other Plasma elements.

Note that some UI elements have functions that are synonymous with a read-write property. In those cases, the function can serve as a slot and be connected to signals for easy setting of the property.

=== DataEngine-Aware UI Elements ===
Some of the UI elements are able to accept data directly from DataEngines. These widgets will have a dataUpdated function and can be passed into the DataEngine::connectSource method successfully.

DataEngine-aware UI elements include:

* Label
* TextEdit
* Meter

=== Common Properties ===

By default, all of the Plasma user interface elements have the following properties:

* ''String'' '''objectName'''
* ''number'' '''opacity'''
* ''boolean'' '''enabled'''
* ''boolean'' '''visible'''
* ''QPointF'' '''pos'''
* ''number'' '''x'''
* ''number'' '''y'''
* ''number'' '''z'''
* ''number'' '''rotation'''
* ''number'' '''scale'''
* ''QPointF'' '''transformOriginPoint'''
* ''QPalette'' '''palette'''
* ''QFont'' '''font'''
* ''QSizeF'' '''size'''
* ''QtFocusPolicy'' '''focusPolicy'''
* ''QRectF'' '''geometry'''

=== Common Signals ===

* '''opacityChanged()'''
* '''visibleChanged()'''
* '''enabledChanged()'''
* '''xChanged()'''
* '''yChanged()'''
* '''zChanged()'''
* '''rotationChanged()'''
* '''scaleChanged() '''

=== UI Element Gallery ===

==== CSS Styleable UI Elements ====

Most UI Elements are able to have their appearance adjust using a CSS stylesheet. All of these elements have the following read/write property:

*''String'' '''styleSheet''': A CSS stylesheet describing visual properties to apply to the widget; see [http://doc.trolltech.com/4.5/stylesheet.html the Qt Documentation for more information]

===== CheckBox =====
Read-write properties:
* ''String'' '''text'''
* ''String'' '''image'''
* ''boolean'' '''checked'''
* '''toggled(bool)'''

===== ComboBox =====
Read-only properties:
* ''number'' '''count''': (API v 3) the number of items in the combobox

Read-write properties:
* ''String'' '''text''': the text of the currently selected item in the combobox
* ''number'' currentIndex: (API v 3) the index of the current item

Funtions:
* '''clear()'''

Signals:
* '''activated(String)'''
* '''textChanged(String)'''
* '''currentIndexChanged(number)'''

===== Frame =====
Read-write properties:
* ''Shadow'' '''frameShadow'''
* ''String'' '''text'''
* ''String'' '''image'''

Enumerations:
* '''Shadow'''
* '''Plain'''
* '''Raised'''
* '''Sunken'''

===== GroupBox =====
Read-write properties:
* ''String'' '''text'''

===== Label =====
Read-write properties:
* ''String'' '''text'''
* ''String'' '''image'''
* ''number'' '''alignment''' (see [[#QtAlignment]] for the valid values)
* ''boolean'' '''hasScaledContents'''
* ''boolean'' '''textIsSelectable''' (since 4.4.1)
* ''boolean'' '''wordWrap''' (API v2)

Functions:
* '''dataUpdated(String, Data)'''

Signals:
* '''linkActivated(String)''': emitted when a link is clicked; includes the URL of link that is clicked; this is only available when textIsSelectable
* '''linkHovered(String)''': emitted when a link is hovered

===== LineEdit =====
Read-write properties:
* ''String'' '''text'''
* ''boolean'' '''clearButtonShown'''

Signals:
* '''editingFinished()'''
* '''returnPressed()'''
* '''textEdited(String)'''
* '''textChanged(String)'''

===== PushButton =====
Read-write properties:
* ''String'' '''text'''
* ''String'' '''image'''
* ''QAction'' '''action'''
* ''QIcon'' '''icon'''
* ''boolean'' '''checkable'''
* ''boolean'' '''checked'''
* ''boolean'' '''down'''

Signals:
* '''pressed()'''
* '''released()'''
* '''clicked()'''
* '''toggled(bool)'''

===== RadioButton =====
Read-write properties:
* ''String'' '''text'''
* ''String'' '''image'''
* ''boolean'' '''checked'''

Signals:
* '''toggled(bool)'''

===== ScrollWidget =====
Read-write properties:
* ''QGraphicsWidget'' '''widget'''
* ''number'' '''horizontalScrollBarPolicy'''
* ''number'' '''verticalScrollBarPolicy'''
* ''QPointF'' '''scrollPosition'''
* ''QSizeF'' '''contentsSize'''
* ''QRectF'' '''viewportGeometry'''

Functions:
* '''ensureRectVisible(QRectF)'''
* '''ensureItemVisible(QGraphicsItem)'''
* '''registerAsDragHandle(QGraphicsWidget)'''
* '''unregisterAsDragHandle(QGraphicsWidget)'''

===== ScrollBar =====
Read-write properties:
* ''number'' '''singleStep'''
* ''number'' '''pageStep'''
* ''number'' '''value'''
* ''number'' '''minimum'''
* ''number'' '''maximum'''
* ''QtOrientation'' '''setOrientation'''

Functions:
* '''setValue(number)'''
* '''setOrientation(QtOrientation)'''

Signals:
* '''valueChanged(number)'''

===== Slider =====
Read-write properties:
* ''number'' '''maximum'''
* ''number'' '''minimum'''
* ''number'' '''value'''
* ''number'' '''orientation'''

Signals:
* '''sliderMoved(number)'''
* '''valueChanged(number)'''

Functions:
* '''setMaximum(number)'''
* '''setMinimum(number)'''
* '''setRange(number, number)'''
* '''setValue(number)'''
* '''setOrientation(QtOrientation)'''

===== SpinBox =====
Read-write properties:
* ''number'' '''maximum'''
* ''number'' '''minimum'''
* ''number'' '''value'''

Functins:
* '''setMaximum(number)'''
* '''setMinimum(number)'''
* '''setRange(number, number)'''
* '''setValue(number)'''

Signals:
* '''sliderMoved(number)'''
* '''valueChanged(number)'''
* '''editingFinished()'''

===== TabBar =====
Read-write properties:
* ''number'' '''currentIndex'''
* ''number'' '''count'''
* ''boolean'' '''tabBarShown'''

Functions:
* '''setCurrentIndex(number)'''
* '''insertTab(number, QIcon,String,QGraphicsLayoutItem)'''
* '''insertTab(number, QIcon,String)'''
* '''insertTab(number, String,QGraphicsLayoutItem)'''
* '''insertTab(number, String)'''
* '''addTab(QIcon,String,QGraphicsLayoutItem)'''
* '''addTab(QIcon,String)'''
* '''addTab(String,QGraphicsLayoutItem)'''
* '''addTab(String)'''
* '''removeTab(number)'''
* '''takeTab(number)'''
* '''tabAt(number)'''
* '''setTabText(number, String)'''
* '''tabText(number)'''
* '''setTabIcon(number, QIcon)'''
* '''tabIcon(number)'''

Signals:
* '''currentChanged(number)'''

===== TextEdit =====
Read-write properties:
* ''String'' '''text'''
* ''boolean'' '''readOnly'''

Functions:
* '''dataUpdated(String, Data)'''

Signals:
* '''textChanged()'''

===== ToolButton =====
:Read-write properties:

* ''''QAction'' '''action''': the action associated with this '''ToolButton'''
* ''''boolean'' '''autoRaise''': whether or not the ToolButton should raise automatically when the user interacts with it'''
* ''''String'' '''image''': path to an icon or image (e.g. in the widget's Package) to show on the ToolButton
* ''''String'' '''text''': the text shown on the ToolButton

API v2 adds:
* ''''boolean'' '''down''': whether or not the ToolButton is in the down position (since protocol version 2)

:Signals:
* '''clicked()'''
* '''pressed()'''
* '''released()'''

===== TreeView =====
Read-write properties:
* ''QAbstractModel'' '''model'''

===== VideoWidget =====
Read-writeproperties:
* ''String'' '''url'''
* ''number'' '''currentTime'''
* ''number'' '''totalTime'''
* ''number'' '''remainingTime'''
* ''Controls'' '''usedControls'''
* ''boolean'' '''controlsVisible'''

Functions:
* '''play()'''
* '''pause()'''
* '''stop()'''
* '''seek(number)'''

Signals:
* '''tick(number)'''
* '''aboutToFinish()'''
* '''nextRequested()'''
* '''previousRequested()'''

Enumerations:
* Controls
** NoControls
** Play
** Pause
** Stop
** PlayPause
** Previous
** Next
** Progress
** Volume
** OpenFile
** DefaultControls

==== Other UI Elements ====

===== BusyWidget =====
Read-write properties:
* ''boolean'' '''running'''
* ''String'' '''label'''

Signals:
* '''clicked()'''

===== FlashingLabel =====
Read-write properties:
* ''boolean'' '''autohide'''
* ''QColor'' '''color'''
* ''number'' '''duration'''

Functins:
* '''kill()'''
* '''fadeIn()'''
* '''fadeOut()'''
* '''flash(String, number, QTextOption)'''
* '''flash(String ,number)'''
* '''flash(String)'''
* '''flash(QPixmap, number, QtAlignment)'''
* '''flash(QPixmap, number)'''
* '''flash(QPixmap)'''

===== GraphicsWidget (API v3) =====
This is just a plain element with no painting or other features. It is useful primarily as a place holder, especially to contain layouts for other elements.

===== IconWidget =====
Read-only properties:
* ''QSizeF'' '''iconSize''' - the actual size of the icon given the size of the IconWidget, space reserved (if any) for text displayed, etc.

Read-write properties:
* ''String'' '''text'''
* ''String'' '''infoText'''
* ''QIcon'' '''icon'''
* ''QColor'' '''textBackgroundColor'''
* ''String'' '''svg'''
* ''QAction'' '''action'''
* ''QtOrientation'' '''orientation'''
* ''number'' '''numDisplayLines'''

Functions:
* '''setPressed(boolean)'''
* '''setUnpressed()'''
* '''setIcon(String)'''

Signals:
* '''pressed(bool)'''
* '''clicked()'''
* '''doubleClicked()'''
* '''activated()'''
* '''changed()'''

===== ItemBackground =====
Read-write properties:
* ''QRectF'' '''target'''
* ''QGraphicsItem'' '''targetItem'''

Signals:
* '''appearanceChanged()'''
* '''animationStep(qreal)'''
* '''targetReached(QRectF)'''
* '''targetItemReached(QGraphicsItem)'''

===== Meter =====
Read-write properties:
* ''number'' '''minimum'''
* ''number'' '''maximum'''
* ''number'' '''value'''
* ''String'' '''svg'''
* ''MeterType'' '''meterType'''

Functions:
* '''dataUpdated(String, Data)'''

Enumerations:
* '''MeterType'''
** BarMeterHorizontal
** BarMeterVertical
** AnalogMeter

===== Separator =====
Read-write properties:
* ''QtOrientation'' '''orientation'''

===== SignalPlotter =====
Read-write properties:
* ''String'' '''title'''
* ''String'' '''unit'''
* ''boolean'' '''useAutoRange'''
* ''number'' '''horizontalScale'''
* ''boolean'' '''showVerticalLines'''
* ''QColor'' '''verticalLinesColor'''
* ''number'' '''verticalLinesDistance'''
* ''boolean'' '''verticalLinesScroll'''
* ''boolean'' '''showHorizontalLines'''
* ''QColor'' '''horizontalLinesColor'''
* ''QColor'' '''fontColor'''
* ''number'' '''horizontalLinesCount'''
* ''boolean'' '''showLabels'''
* ''boolean'' '''showTopBar'''
* ''QColor'' '''backgroundColor'''
* ''String'' '''svgBackground'''
* ''boolean'' '''thinFrame'''
* ''boolean'' '''stackPlots'''

===== SvgWidget =====
Read-write properties:
* ''Svg'' '''svg'''
* ''String'' '''elementID'''

Signals:
* '''clicked(QtMouseButton)'''

===== WebView =====
Read-only properties:
* ''QSizeF'' '''contentsSize'''
* ''QRectF'' '''viewportGeometry'''

Read-write properties:
* ''Url'' '''url'''
* ''String'' '''html'''
* ''boolean'' '''dragToScroll'''
* ''QPointF'' '''scrollPosition'''

Signals:
* '''loadProgress(number)'''
* '''loadFinished(bool)'''

=== Layouts ===

==== LinearLayout ====
* ''number'' '''spacing'''
* ''QtOrientation'' '''orientation''' (''QtVertical'' or ''QtHorizontal'')
* ''function'' '''removeAt'''
* ''function'' '''addStretch'''
* ''function'' '''setStretchFactor'''
* ''function'' '''setAlignment'''
* ''function'' '''insertStretch'''
* ''function'' '''setItemSpacing'''
* ''function'' '''setContentsMargins'''
* ''function'' '''addItem'''
* ''function'' '''removeItem'''
* ''function'' '''insertItem'''
* ''function'' '''toString'''
* ''function'' '''activate''' (API v3)

==== AnchorLayout ====
* ''number'' '''horizontalSpacing'''
* ''number'' '''verticalSpacing'''
* ''function'' '''setSpacing'''
* ''function'' '''removeAt'''
* ''function'' '''addAnchor'''
* ''function'' '''anchor'''
* ''function'' '''addAnchors'''
* ''function'' '''addCornerAnchors'''
* ''function'' '''toString'''
* ''function'' '''activate''' (API v3)

==== GridLayout ====
* ''number '''horizontalSpacing'''
* ''number '''verticalSpacing'''
* ''function'' '''rowSpacing'''
* ''function'' '''setRowSpacing'''
* ''function'' '''columnSpacing'''
* ''function'' '''setColumnSpacing'''
* ''function'' '''rowMinimumHeight'''
* ''function'' '''setRowMinimumHeight'''
* ''function'' '''rowPreferredHeight'''
* ''function'' '''setRowPreferredHeight'''
* ''function'' '''rowMaximumHeight'''
* ''function'' '''setRowMaximumHeight'''
* ''function'' '''rowFixedHeight'''
* ''function'' '''setRowFixedHeight'''
* ''function'' '''columnMinimumWidth'''
* ''function'' '''setColumnMinimumWidth'''
* ''function'' '''columnPreferredWidth'''
* ''function'' '''setColumnPreferredWidth'''
* ''function'' '''columnMaximumWidth'''
* ''function'' '''setColumnMaximumWidth'''
* ''function'' '''columnFixedWidth'''
* ''function'' '''setColumnFixedWidth'''
* ''function'' '''remoteAt'''
* ''function'' '''setAlignment'''
* ''function'' '''setSpacing'''
* ''function'' '''setContentsMargins'''
* ''function'' '''addItem'''
* ''function'' '''toString'''
* ''function'' '''activate''' (API v3)

=== Undocumented Properties and Functions ===

There are a handful of other undocumented properties and functions available to UI elements. These are not supported or guaranteed to exist in future versions however, and as such should not be used or relied upon.

== Animations ==

=== Creating Animation Objects ===
An Animation object can be retrieved by calling the ''Animation'' '''animation(string type)''' function. The ''string'' corresponds to the type of animation, which are listed below.

New Animation objects are associated with (and therefore will animate) the Plasmoid by default. By setting the widgetToAnimate property, however, it can be assigned to animate any QGraphicsWidget desired (e.g. Plasma widgets such as push buttons, sliders, etc) .

=== Enumerations ===
All Animation objects have the following enumerations:

==== MovementDirection ====
* '''MoveUp'''
* '''MoveUpRight'''
* '''MoveRight'''
* '''MoveDownRight'''
* '''MoveDown'''
* '''MoveDownLeft'''
* '''MoveLeft'''
* '''MoveUpLeft'''

==== Reference ====
The reference point, relative to the target widget, for the animation.
* '''Center'''
* '''Up'''
* '''Down'''
* '''Left'''
* '''Right'''

==== State ====
* '''Paused'''
* '''Running'''
* '''Stopped'''

=== Common API ===
With the exception of Pause and Property animations, all animations support the following read/write properties:

* ''AnimationDirection'' '''direction''': the direction the animation should play: AnimationForward or AnimationBackward
* ''int'' '''duration''': length of the animation in ms.
* ''EasingCurveType'' '''easingCurveType''': The easing curve to use in the animation
* ''QGraphicsWidget'' '''targetWidget''': the QGraphicsWidget (e.g. a Plasma::Widget) that this animation should operate on

=== Animation Groups ===
Animations may be put into groups for convenient sequential or parallel running. Sequential groups, where the animations run one after the other, are handled by the '''AnimationGroup''' class. Parallel aniations, where the animations run simultaneously, are handled the '''ParallelAnimationGroup''' class.

Animations are added to a group by calling '''add(Animation)''' on the group object. Groups may also be added to other groups.

=== Custom Animations ===
Custom animation types can be defined using Javascript files that are included as part of the Plasmoid's package in the {{path|contents/animations/}} directory. To learn how to create such animations and access them from your Plasmoid, visit the [[Development/Tutorials/Plasma/JavaScript/Animations|Javascript Animations tutorial]].

=== Standard Animation Types ===
Below is a list of all current standard animation types and their particular read/write properties:

==== Fade ====
* ''number'' '''startOpacity''': the opacity, between 0 and 1, that the target widget starts at when the animation begins
* ''number'' '''targetOpacity''': the opacity, between 0 and 1, that the target widget will be at the end of the animation

==== Geometry ====
* ''QRectF'' '''startGeometry''': the geometry that the target widget should start with
* ''QRectF'' '''targetGeometry''': the geometry the target widget will have at the end of the animation

==== Grow ====
* ''number'' '''factor''': the factor by which the target widget will grow to by the end of the animation

==== Pause ====
* ''number'' '''duration''': the number of milliseconds to pause for

==== Property ====
Animates an object (must be a QObject internally, which includes all Plasma Widgets) by manipulating one of its properties. Property animations have the following read/write properties:

* ''any'' '''startValue'''
* ''any'' '''endValue'''
* ''ByteArray'' '''propertyName'''
* ''QObject'' '''targetObject'''
* ''number'' '''duration'''
* ''EasingCurve'' '''easingCurve'''

==== Pulser ====
* ''number'' '''targetScale''': the maximum scale of the pulse-shadow item, relative to the target widget

==== Rotate ====
* ''QtAxis'' '''axis''': the axis along which to rotate the item
* ''Reference'' '''reference''': the reference point around which to rotate the target widget
* ''number'' '''angle''': the number of degrees to rotate the item

==== RotateStacked ====
* ''MovementDirection'' '''movementDirection''': the direction to rotate the widgets in the stack around
* ''QGraphicsLayoutItem'' '''layout'''
* ''Reference'' '''reference''': the reference point around which to rotate the target widget
* ''QGraphicsWidget'' '''backingWidget''': the widget in the "back" to rotate to the front of the target widget

==== Slide ====
* ''MovementDirection'' '''movementDirection''': the direction to slide the widget
* ''number'' '''distance''': the distance to slide the widget

==== Zoom ====
* ''number'' '''zoom''': the factor by which to zoom the target widget

=== QEasingCurve ===
Used to set the progress shape of Animation objects, this class has the following read-only properties:

* ''string'' '''toString'''
* ''number'' '''valueForProgress(number progress)''': returns effective progress for the easing curve at progress. While progress must be between 0 and 1, the returned effective progress can be outside those bounds.

as well as the following read/write property:

* ''EasingCurveType'' '''type''': the shape of this easing curve

and the following enumeration:

* '''EasingCurveType'''
** Linear
** InQuad
** OutQuad
** InOutQuad
** OutInQuad
** InCubic
** OutCubic
** InOutCubic
** OutInCubic
** InQuart
** OutQuart
** InOutQuart
** OutInQuart
** InQuint
** OutQuint
** InOutQuint
** OutInQuint
** InSize
** OutSine
** InOutSine
** OutInSine
** InExpo
** OutExpo
** InOutExpo
** OutInExpo
** InCirc
** OutCirc
** InOutCirc
** InOutCirc
** OutInCirc
** InElastic
** OutElastic
** InOutElastic
** OutInElastic
** InBack
** OutBack
** InOutBack
** OutInBack
** InBounc
** OutBounce
** InOutBounce
** OutInBounce
** InCurve
** OutCurve
** SineCurve
** CosineCurve

== Painting ==

See the "[[Development/Tutorials/Plasma/JavaScript/API#Painting_and_Layout|Painting and Layout]]" section, part of the Global Plasmoid object chapter, for information on using these classes within a widget.

=== Pixmaps ===

The QPixmap object allows widgets to use pixmaps for painting. Widgets may include pixmaps in various common formats (PNG, JPEG, GIF, etc.) in the contents/images/ directory of the Plasmoid package and load them by passing the name of the file into the pixmap constructor:
<code javascript>
var pixmap = new QPixmap("myimage.png")
</code>
In addition to being used as a file load, some objects return or take pixmaps and the QPixmap object facilitates that as well.

Read-only properties:
* ''boolean'' '''null''': true if the pixmap is empty
* ''QRectF'' '''rect''': the rect of the pixmap

Functions:
* ''QPixmap'' '''scaled(number width, number height);;: returns a scaled version of the pixmap with width and height dimensions.

=== Icons ===

(Since 4.4.1)

The QIcon object provides simple access to icons. They can be constructed using a String or a QPixmap, with the String version either loading a file from disk if given an absolute path (useful for loading icons from the Plasmoid's package) or from the desktop icon theme if given just a name (e.g. "file-open").

Read-only properties:
* ''boolean'' '''null''': true if the icon is empty

Functions:
* '''addPixmap(QPixmap)''': adds another pixmap to this icon
* '''addFile(String)''': adds another file to this icon

=== SVG Images ===

Plasma makes heavy usage of SVG images. More information on this industry standard scalable vector format can be found here:

:http://www.w3.org/Graphics/SVG/

Free and Open Source Software tools for creating SVGs include Inkscape and Karbon13. Widgets may include their own SVG files in the contents/images/ directory or may use SVG images that are part of the standard Plasma Desktop Theme as documented here:

:http://techbase.kde.org/Projects/Plasma/Theme

Two classes are provide: Svg and FrameSvg. Svg allows loading and painting entire SVG documents or individual elements in an SVG document. FrameSvg extends Svg with methods to paint bordered frames from specially crafted SVG documents (see the Plasma Desktop Theme documentation for more information on this).

====Svg====
Constructors:
*'''Svg(string fileName)'''': fileName can be a file in the desktop theme or the plasmoid package

Read-only properties:
*''QSizeF'' '''size''': the current size of the svg

Read-write properties:
* ''boolean'' '''multipleImages''': whether or not the svg contains multiple separate images
* ''string'' '''imagePath''': the file path, including name of the svg
* ''boolean'' '''usingRenderingCache'': whether or not to cache rendered pixmaps; improves performance (at the cost of some disk and memory usage) for SVG data that is repeatedly rendered

Functions:
* ''QSizeF'' elementSize(String svgElemen)'''
* ''QRectF'' elementRect(String svgElemen)'''
* ''boolean'' '''hasElement(String svgElement)'''
* '''elementAtPoint(QPoint pos)'''
* ''boolean'' '''isValid()'''
* ''QPixmap'' '''pixmap(String svgElement)''': a pixmap of the element in the svg rendered to the current size
* ''QPixmap'' '''pixmap()''': a pixmap of the entire svg rendered to the current size
* '''paint(QPainter painter, QPointF point)'''
* '''paint(QPainter painter, QPointF point, String svgElement)'''
* '''paint(QPainter painter, number x, number y)'''
* '''paint(QPainter painter, number x, number y, String svgElement)'''
* '''paint(QPainter painter, QRectF destination)'''
* '''paint(QPainter painter, QRectF destination, String svgElement)'''
* '''paint(QPainter painter, number y, number width, number height)'''
* '''paint(QPainter painter, number x, number y, number width, number height, QString svgElement)'''
* '''resize(number width, number height)
* '''resize(QSizeF size)'''
* '''resize()''': resizes the SVG to the document size defined in the SVG itself

Signals:
* '''repaintNeeded()''': emitted when the SVG is in need of a repaint, such as when the theme changes and the SVG has reloaded its data

====FrameSvg====
Constructors:
* '''FrameSvg(String fileName)''': fileName can be a file in the desktop theme or the plasmoid package

Read-only properties:
* ''boolean'' '''multipleImages''': whether or not the svg contains multiple separate images

Functions:
* '''setEnabledBorders(EnabledBorders borders)''': sets which borders are enabled when painting
* ''EnabledBorders'' '''enabledBorders()''': the borders which are enabled when painting
* '''resizeFrame(QSizeF size)''': resizes the frame to size
* ''QSizeF'' '''frameSize()''': the size of the current frame
* ''number'' '''marginSize(MarginEdge margin)''': the size of the margin for a given edge
* '''getMargins(number left, number top, number right, number bottom)''': stores the margin values in the variables passed in
* ''QRectF'' '''contentsRect()''': the rect containing the contents, e.g. the size of the SVG minus the space required by the enabled borders
* '''setElementPrefix(Location)''': sets the frame element for the given location if it exists
* '''setElementPrefix(String prefix)''': sets the element prefix
* ''boolean'' '''hasElementPrefix(String prefix)''': returns true if the SVG contains a frame with the given prefix
* ''boolean'' '''hasElementPrefix(Location location)''': true if the SVG contains a frame element for the given location
* '''prefix()'''
* '''mask()'''
* '''setCacheAllRenderedFrames(bool)'''
* '''cacheAllRenderedFrames()'''
* ''QPixmap'' '''framePixmap()''': a pixmap containing the current frame at the current size
* '''paintFrame(QPainter painter)'''
* '''paintFrame(QPainter painter, QPointF target)'''
* '''paintFrame(QPainter painter, QRectF target)'''
* '''paintFrame(QPainter painter, QRectF target, QRectF source)'''

Enumerations
* '''EnabledBorder'''
** NoBorder
** TopBorder
** BottomBorder
** LeftBorder
** RightBorder
** AllBorders

=== Painting on the Canvas ===

==== QColor ====

*Constructors:
** QColor
** QColor(string colorName)
** QColor(number red, number green, number blue, number alpha)

Functions:
* '''setThemeColor(ThemeColor color)''': sets the color to the appropriate ThemeColor

Read/write properties:
* ''number'' '''red'''
* ''number'' '''green'''
* ''number'' '''blue'''
* ''number'' '''alpha'''
* ''boolean'' '''valid'''

==== QFont ====

*Constructors:
**QFont
**QFont(string fontName)
**QFont(string fontName, number pointSize)
**QFont(string fontName, number pointSize, number weight)
**QFont(string fontName, number pointSize, number weight, boolean italic)
*string key
*string lastResortFamily
*string lastResortFont
*string defaultFamily
*boolean exactMatch
*string toString
*boolean bold
*string family
*boolean fixedPitch
*undefined fromString
*boolean italic
*boolean kerning
*boolean overline
*number pixelSize
*number pointSize
*number pointSizeF
*boolean strikeOut
*number stretch
*boolean underline
*number weight
*function isCopyOf
*function resolve

====QPainter ====
* Constructors
** QPainter
** QPainter(object paintDevice): used to start a painter on a specific QWidget; rarely if ever needed in a JavaScript Plasmoid
* object background
* number backgroundMode
* object brush
* undefined setBrush
* object brushOrigin
* undefined clipping
* object clipPath
* object clipRegion
* number compositionMode
* object font
* number layoutDirection
* number opacity
* object pen
* number renderHints
* undefined transform
* object viewport
* boolean viewTransformEnabled
* object window
* object worldMatrix
* object worldTransform
* boolean worldMatrixEnabled
* object combinedMatrix
* object combinedTransform
* boolean active
* function begin
* function end
* function boundingRect
* function drawChord
* function drawConvexPolygon
* function drawArc
* function drawEllipse
* function drawImage
* function drawLine
* function drawLines
* function drawPath
* function drawPicture
* function drawPie
* function drawPixmap
* function drawPoint
* function drawPoints
* function drawPolygon
* function drawPolyline
* function drawRect
* function drawRects
* function drawRoundRect
* function drawText
* function drawTiledPixmap
* function eraseRect
* function fillPath
* function fillRect
* function resetMatrix
* function resetTransform
* function restore
* function rotate
* function save
* function scale
* function setClipRect
* function setRenderHint
* function shear
* function strokePath
* function testRenderHint
* function toString
* function translate

==== QPen ====
*Constructors:
**QPen
* object brush
* object color
* number capStyle
* number joinStyle
* number style
* number dashOffset
* number miterLimit
* number width
* boolean solid
* number red
* number green
* number blue
* number alpha
* boolean valid

==== QRectF ====
Read-only properties:
* ''boolean'' '''empty''': true if the rectangle's width or height is less than, or equal to, 0; an empty rectangle is also invalid
* ''boolean'' '''null''': true if the rectangle has both the width and the height set to 0; a null rectangle is also empty and not valid
* ''boolean'' '''valid''': true if the rectangle has a width > 0 and height 0.

Read-write properties:
* ''number'' '''left'''
* ''number'' '''top'''
* ''number'' '''bottom'''
* ''number'' '''right'''
* ''number'' '''height'''
* ''number'' '''width'''
* ''number'' '''x'''
* ''number'' '''y'''

Constructors:
* '''QRectF'''
* '''QRectF(number x, number y, number width, number height)''': Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

Functions:
* '''adjust(number dx1, number dy1, number dx2, number dy2)''': adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle
* ''QRectF'' '''adjusted(number dx1, number dy1, number dx2, number dy2)''': returns a new QRectF with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of the rectangle
* '''translate(number dx, number dy)''': translates the rect by dx, dy
* '''setCoords(number x1, number y1, number x2, number y2)''': sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).
* '''setRect(number x, number y, number width, number height)''': sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.
* ''boolean'' '''contains(number x, number y)''': returns true if the rect contains the point (x, y)
* '''moveBottom(number delta)'': moves the bottom by delta pixels
* '''moveLeft(number delta)''': moves the left by delta pixels
* '''moveRight(number delta)''': moves the right by delta pixels
* '''moveTo(number x, number y)''': moves the top left of the rect to point (x, y)
* '''moveTop(number delta)''': moves the top by delta pixels

==== QSizeF ====

*Constructors:
**QSizeF
**QSizeF(number width, number height)
*number height
*number width

==== QPoint ====

Constructors:
* '''QPoint'''
* '''QPoint(number x, number y)'''

Read-only properties:
* ''bool'' '''null'''
* ''number'' '''manhattanLength '''

Read-write propertie:
* ''number'' '''x '''
* ''number'' '''y'''

== Accessing Sources of Data ==

See the [[Development/Tutorials/Plasma/JavaScript/DataEngine|JavaScript Plasmoid DataEngine tutorials]]

=== Global Functions to Access DataEngines and Services ===
* dataEngine(string name): returns a DataEngine object
* service(string dataEngineName, string sourceName): returns a ServiceObject, see also DataEngine::serviceForSource

=== DataEngine ===
Read-only properties:
* ''Array[String]'' '''sources'''
* ''boolean'' '''valid'''
* ''String'' '''icon'''
* ''String'' '''name'''

Signals:
* '''sourceAdded(String sourceName)'''
* '''sourceRemoved(String sourceName)'''

Functions:
* '''serviceForSource(String sourceName)'''
* '''connectSource(String sourceName, Object connectTo[, number interval[, IntervalAlignment alignment] ])''': if the object passed in as the object to connect to is the plasmoid object, then the plasmoid.dataUpdated(String source, Map[String, Any] data) callback will be called if it exists
* '''connectAllSources(Object connectTo[, number interval[, IntervalAlignment alignment] ])''': if the object passed in as the object to connect to is the plasmoid object, then the plasmoid.dataUpdated(String source, Map[String, Any] data) callback will be called if it exists
* '''disconnectSource(String sourceName, Object connectedTo)''': if the object passed in as the object to connect to is the plasmoid object, then the plasmoid.dataUpdated(String source, Map[String, Any] data) callback will be called if it exists
* '''Data query(String sourceName)'''

The following functions are only of interest to DataEngine reimplementations (e.g. JavaScript DataEngines):

* '''scheduleSourcesUpdated()'''
* '''removeSource(String)'''
* '''updateAllSources()'''
* '''forceImmediateUpdateOfAllVisualizations()'''
* '''DataContainer containerForSource(String)'''

=== Service ===
* function finished(Plasma::ServiceJob*)
* function operationsChanged()
* function serviceReady(Plasma::Service*)
* function setDestination(QString)
* function destination()
* function operationNames()
* function operationDescription(QString)
* function startOperationCall(KConfigGroup,QObject*)
* function startOperationCall(KConfigGroup)
* function isOperationEnabled(QString)
* function name()
* function associateWidget(QWidget*,QString)
* function disassociateWidget(QWidget*)
* function associateWidget(QGraphicsWidget*,QString)
* function disassociateWidget(QGraphicsWidget*)
* function parametersFromDescription(KConfigGroup)

== Other Functions and Classes ==
=== Print and Debug ===
* '''print(string message)''': prints message to console
* '''debug(string message)''': print message to console if it is running in a KDE debug build

=== GraphicsItem ===
This class represents an item on the canvas. Support is only provided so that GraphicsItem objects returned or taken by other objects work. There is no meaningful API provided directly in the JavaScript runtime for these objects and they should not need to be used directly.

=== QSizePolicy ===
The QSizePolicy class is a layout attribute describing horizontal and vertical resizing policy. This can be set on any graphics widget that you have using the enums provided for this (QtSizePolicy ), for example:

button = new PushButton();
button.sizePolicy = QSizePolicy(QSizePolicyMaximum, QSizePolicyFixed);

This is useful when your widgets are being laid out by a layout (specially the anchor layout).

* ''QtSizePolicy '' '''horizontalPolicy''': The horizontal component of the size policy.
* ''QtSizePolicy '' '''verticalPolicy''': The vertical component of the size policy.
* ''number'' '''horizontalStretch''': The horizontal stretch factor of the size policy.
* ''number'' '''verticalStretch''': The vertical stretch factor of the size policy.

=== IOJob ===
This object is returned by input/output access for asynchronous file and data access (see the section on Extensions for documentation on getUrl). It is used by connecting Javascript functions in your code to the relevant signals.

Functions:
* '''kill()'''
* '''suspend()'''
* '''resume()'''

Signals:
* '''data(IOJob job, ByteArray data)''': emitted whenever data arrives. If data is empty (data.length == 0) then the transmission has completed.
* '''dataReq(IOJob job, ByteArray data)''': when sending data, this signal is emitted when data is requested; add the data to be sent ot the data member, or leave it empty to signal that the process is complete and there is no more data to send
* '''finished(IOJob job)''': emitted when the transmission has completed
* '''suspended(IOJob job)''': emitted when the job has been suspeneded
* '''resumed(IOJob job)'''
* '''canceled(IOJob job)'''
* '''connected(IOJob job)'''
* '''redirection(IOJob job, Url to)'''
* '''permanentRedirection(IOJob job, Url from, Url to)'''
* '''mimetype(IOJob job, String mimetype)'''

=== QTimer ===
Read-write properties:
* ''boolean'' '''active''': true if active, false if not
* ''boolean'' '''singleShot''': true if the timer will fire once when started, false if it will fire repeatedly until stopped
* ''boolean'' '''interval''': the interval in milliseconds that the timer will trigger

Functions:
* '''start(int msec)''': starts the timer with msec as the interval
* '''start()''': starts the timer with the default interval
* '''stop()''': stops the timer

Signals:
* '''timeout()''': this signal is emitted whenever the timer interval is reached

=== Url ===
Represents a local or remote address. To create a new Url (or assign to an existing one), use the following syntax:

<code javascript>var url = new Url("http://kde.org")</code>

Read-only properties:
* ''string'' '''toString''': the URL as a String object

Read-write properties (each representing a portion of the full URL):
* ''string'' '''protocol'''
* ''string'' '''host'''
* ''string'' '''path'''
* ''string'' '''user'''
* ''string'' '''password'''

=== ByteArray ===
This class provides an array of bytes. This is often used by data centric objects, such as the Job classes returned by getUrl.

Read-only properties:
* ''number'' '''length''': the size of the array (number of bytes)

Functions:
* '''chop(number numBytes)''': chops numBytes from the end of the array
* ''bool'' '''equals(ByteArray other)'''
* ''ByteArray '''left(number len)''': return len bytes from the left of the array
* ''ByteArray '''mid(number pos, number len)''': returns an array of bytes starting a post and length len (if len is -1, it returns all remaining bytes)
* ''ByteArray '''remove(number pos, number len)''': removes len bytes starting at index pos from the array and returns it
* ''ByteArray '''right(number len)''': returns len bytes from the right of the array
* ''ByteArray '''simplified()''': returns a byte array that has whitespace removed from the start and the end, and which has each sequence of internal whitespace replaced with a single space
* ''ByteArray '''toBase64()''': returns the array encoded in base64
* ''ByteArray '''toLower()''': returns a lowercased copy of the array
* ''ByteArray '''toUpper()''': returns an uppercased copy of the array
* ''ByteArray '''trimmed()''': returns a copy of the array with whitespace remove from the start and end
* truncate(number pos): truncates the array at index pos
* ''String'' '''toLatin1String()''': returns a Latin1-ized string based on the array
* ''String'' '''toUtf8()''': (API v3) returns a string from the contents of the array using a Utf8 conversation
* ''String'' '''valueOf()''': returns the raw data in the array as a string

== Addons (API V3) ==
Plasmoids may also have plugins of their own, also written in Javascript, and which are shipped separately to the Plasmoid. These are referred to as "Addons" and are packaged similarly to a Plasmoid. For more information on creating Javascript Addons, visit the [[/JavascriptAddons|Javascript Addons tutorial]].

It is possible to list, load and be notified of new Addons having been installed for your Plasmoid.

* ''Array[AddonInformation]'' '''listAddons(string type)''': an array of available addons of the provided type. The type name maps to the X-KDE-PluginInfo-Category entry in the Addon's metadata.desktop file.
* ''boolean'' '''loadAddon(String type, String id)''': load the addon with the given id and type, return true on success. In order to be notified when the addon is successfully created, add an event listener to the "addCreated" event.

The following are the Addon events which are recognized by the Plasmoid along with the type of event objects (if any) that are passed to registered event listeners that are registered with addEventListener:

* addonCreated: Object addOn
* newAddonsAvaiable

=== AddonInformation (API V3) ===

The AddonInformation object contains the following read-only properties:

* ''String'' '''id''': the id of the Addon. Can be used with loadAddon
* ''String'' '''name''': a string suitable for showing the user, such as in a configuration dialog

== Extensions ==
An API extension is a security controlled set of functions and objects that are loaded on demand. These extensions are requested by the widget by listing the required and the optional extensions (if any) it wants loaded in its metadata.desktop file. This way, even prior to the widget being loaded, Plasma can know what it will want.

Required extensions are requested using the X-Plasma-RequiredExtensions key, and optional extensions with the X-Plasma-OptionalExtensions. For example:

<code ini>
X-Plasma-RequiredExtensions=FileDialog,MyCustomQScriptExtension
X-Plasma-OptionalExtensions=LaunchApp,HTTP
</code>

The Simplified Javascript Engine then decides if the widget will actually get that extension or not. Failure to load a required extension will result in script execution being aborted.

Each of the built-in extensions provided are described below.

=== FileDialog ===

Provides access to open and save dialog classes: OpenFileDialog and SaveFileDialog. Both are non-modal and run asynchronously, so the signals must be used. Other than the name difference (and resulting UI variance) the API for each is identical:

* Constructors
** '''OpenFileDialog'''
** '''SaveFileDialog'''
* Properties
** Read Only
*** ''array(Url)'' '''urls''': the selected file, as a Url object
*** ''Url'' '''baseUrl''', the current path (minus filename) as a Url
*** ''string '''file''': the selected file, as a string
*** ''array(string)'' '''files''': selected files (plural), as an array of strings
** Read/Write
*** ''Url'' '''url''': the current Url, can be read from when the user is done or assigned before to set the starting path
*** ''string'' '''filter''': a string representing the mimetype filter; e.g. "*.cpp|C++ Source Files\n*.h|Header files" or "*.cpp" or "*.cpp|*h"
*** ''boolean'' '''localOnly''': true to show only local files, false if network locations are Ok as well
*** ''boolean'' '''directoriesOnly''': true to only allow selection of a directory (not a file)
*** ''boolean'' '''existingOnly''': true if only existing files/directories may be selected
* Functions
** '''show()''': when called, the dialog will be shown to the user
* Signals
** '''accepted(FileDialogProxy)'''': emitted when the file dialog has been successfully accepted by the user with one or more files/directories.
** '''finished(FileDialogProxy)''': emitted when the file dialog closes, included when cancelled/closed without being accepted

=== LocalIO ===
This extension allows access to local files.

Functions:
* ''IOJob'' '''getUrl(Url url)''': attempts to fetch the file using an IOJob
* ''IOJob'' '''getUrl(String url)''': attempts to fetch the file using an IOJob

=== NetworkIO ===
This extensions allows access to network addresses.

Functions:
* ''IOJob'' '''getUrl(Url url)''': attempts to fetch the file using an IOJob
* ''IOJob'' '''getUrl(String url)''': attempts to fetch the file using an IOJob

=== HTTP ===
This extension allows access to data and files via http and https.

Functions:
* ''IOJob'' '''getUrl(Url url)''': attempts to fetch the file using an IOJob
* ''IOJob'' '''getUrl(String url)''': attempts to fetch the file using an IOJob
* ''bool'' '''openUrl([string|Url] url)''': (API v4) Opens the url in the default application (or asks the user if there is no default application for the file). The url parameter may be either a string or a Url. Returns true on success, false on failure.

=== LaunchApp ===

Adds methods to the global plasmoid object that allow launching applications, running commands and opening files and urls.

* ''bool'' '''runApplication(string application[, array files])''' Runs an application by name (can reference an installed .desktop file as well as an executable in the user's $PATH) with an optional array of files. The file array may contain either Urls or strings. Returns true on success, false on failure.
* ''bool'' '''runCommand(string exe[, array args])''' Runs the executable with the given arguments. Returns true on success, false on failure.
* ''bool'' '''openUrl([string|Url] url)''': Opens the url in the default application (or asks the user if there is no default application for the file). The url parameter may be either a string or a Url. Returns true on success, false on failure.

KDE System Administration/PlasmaDesktopScripting

2011-05-06T13:07:22Z

Broulik: /* General time and date settings */

== ECMA Script Interaction With Plasma Shells ==

It is possible to control and interact with a Plasma user interface shell such as a plasma-desktop or (starting in KDE SC 4.5) plasma-netbook session using ECMA Script (aka JavaScript). This scripting mechanism exposes containments (Desktop Activities and Panels), widgets and various other aspects of plasma-desktop configuration using the widely known and used ECMA Script language. The QtScript engine is used for the runtime environment.

This document describes the API that is provided along with how to
run such scripts in plasma-desktop.

== Examples ==

A set of examples can be found [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/plasma/javascript/plasma-shell-scripting here] that demonstrate the use of various aspects of Plasma shell scripting.

Contributions of additional examples are welcome and an be sent to the Plasma development mailing list (plasma-devel at kde.org) for inclusion if you do not have commit rights to the kdeexamples module.

== Running Scripts ==
There are three ways that scripts can be executed in plasma-desktop:

* '''on first run''': when plasma-desktop is started without any pre-existing configuration, any scripts in $APPDATA/plasma-desktop/init/ with a ".js" suffix are run. If there is more than one script, they are run sequentially in the alphabetical order of the file names.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''on update''': when plasma-desktop is started, it will check in
`kde4-config --path data`/plasma-desktop/updates/
with a ".js" suffix for scripts that have not yet been run. If there is more than one script which has not been run yet they will be executed serially in the alphabetical order of the file names.

A record of which update scripts have been run is kept in the application's config file in the [Updates] group. This means that if the plasma-desktop configuraiton file is removed, all the update scripts will be run again.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''interactively''': an interactive scripting dialog can be requested either via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "desktop console" as the search term. It can also be triggered directly via dbus with <code bash>qdbus org.kde.plasma-desktop /MainApplication showInteractiveConsole</code>

{{note|This method is not available for plasma-netbook.}}

:ECMA Script may be entered directly into this window for execution and output appears in the lower half of the window. Ctrl+E is a shortcut to run scripts, and scripts can be saved to and loaded from disk.

:Scripts from files can also be loaded using KRunner with "desktop console /path/to/file" or via dbus with
<code bash>qdbus org.kde.plasma-desktop /MainApplication loadScriptInInteractiveConsole /path/to/file</code>

== Templates ==

Templates are named packages that contain scripts. This provides a way for common functionality to be easily reused, helping to increase consistency and lower maintenance costs. Templates can be loaded from other scripts by name and they are also used to populate some parts of the user interface, such as the entries in the Add Panels menu.

A template is a small set of files in a specified file hierarchy (or, in Plasma terms, a "Package"). In particular, a Template package contains the following files:

* metadata.desktop: a .desktop file describing the template
* contents/layout.js: a Javascript file containing the actual script

Templates are stored under share/apps/plasma/layout-templates and may be installed using `plasmapkg -t layout-template -i /path/to/package`. Template packages may also be provided as a .zip file with a .plasmalayout suffix.

The metadata.desktop file contains the usual .desktop entries such as Name and Icon but must also contain Type=Service and ServiceTypes=Plasma/LayoutTemplate entries. If the layout is specific to a given Plasma application, such as plasma-desktop, this can be specific using X-Plasma-Shell. X-Plasma-ContainmentCategories defines what kind of layout it is with possible values being panel and desktop. Finally a X-KDE-PluginInfo-Name entry is required to provide a globally unique internal name for the Template. Here is an example of a Template that provides a Panel layout for Plasma Netbook:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Panel
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-netbook
X-Plasma-ContainmentCategories=panel
X-KDE-PluginInfo-Author=Aaron Seigo
X-KDE-PluginInfo-Email=aseigo@kde.org
X-KDE-PluginInfo-Name=org.kde.CoolNetbookPanel
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma.kde.org/
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

When running a template, two global variables will be accessible in read-only mode: templateName and templateComment. They will contain the Name and Comment fields of the above desktop file, and are translated if a localization is available.

=== Examples of Usage ===

==== Creating panels ====
A good example of the use of templates is the use case that triggered the creation of this feature: the desire to make it easy for users to re-create the default panel that is created on first start. There is a Template called org.kde.plasma-desktop.defaultPanel that ships with the KDE Plasma Workspace which contains the layout for the initial default panel. This is referenced by the default Plasma Desktop init script and, because it is marked as a Panel Template in the metadata.desktop file it also shows up to the user in the Add Panels menu. When selected by the user from the menu, the exact same panel that is created on desktop start up is created for them, complete with Plasma Widgets and configuration.

==== Automating tasks ====
Another example of the usefulness of templates is the "Find Widgets" template. This template, which first shipped with Plasma Desktop v4.5, provides a function for finding widgets by name. It appears in the toolbar "Load" and "Use" menus in the Desktop Console in plasma-desktop, and makes finding widgets as simple as:

<code javascript>
var template = loadTemplate('org.kde.plasma-desktop.findWidgets')
template.findWidgets('systemtray')
</code>

==== Activity templates ====
Probably the most user visible use of templates are "Activity templates". The structure of Activity templates is similar to the other use of templates, but a few extra features are provided in the metadata.desktop file. Here is an example of such an activity template:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Activity Template
Icon=user-desktop
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-desktop
X-Plasma-ContainmentCategories=desktop
X-Plasma-ContainmentLayout-ExecuteOnCreation=dolphin $desktop, gwenview $pictures
X-Plasma-ContainmentLayout-ShowAsExisting=true
X-KDE-PluginInfo-Author=John Doe
X-KDE-PluginInfo-Email=john@doe.org
X-KDE-PluginInfo-Name=org.kde.plasma-desktop.CoolTemplate
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://john.doe.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

The layout itself is still created from the layout.js file as usual, but this template also shows as a precreated activity to the user thanks to the X-Plasma-ContainmentLayout-ShowAsExisting key. Additionally, it starts applications in the newly created activity using the X-Plasma-ContainmentLayout-ExecuteOnCreation key.

That key is a list of commands to execute, and it supports the following variables:
* $desktop
* $autostart
* $documents
* $music
* $video
* $downloads
* $pictures

They all expand into the path toward the user corresponding default folder.

== API ==

In addition to the normal ECMA Script API and the Qt-specific extensions (such as signal/slot support) provided by QtScript, the following API is provided for use by scripts.

All of the API below, unless otherwise noted with a version noticed, appear as below in the KDE Software Compilation v4.4.0 and later. API that is not noted as being part of a given class or object is part of the global namespace.

{{note|API compatibility is guaranteed from version to version starting with KDE Software Compilation v4.4.0.}}

=== Version Numbers ===

Starting with KDE SC 4.5, the version number of both the scripting API and the application is available to the script via the following read-only properties:

* ''String'' '''applicationVersion''': the version of the application, e.g. 0.3
* ''String'' '''platformVersion''': the version of the KDE Platform, e.g. 0.3
* ''number'' '''scriptingVersion''': the version of the scripting API; e.g. in KDE SC 4.5 this is 2

=== Activities ===
Activities are the desktop layer in a plasma-desktop session and may contain widgts. In sightly more technical terms, they are desktop containments. Activities can be created, enumerated, modified and destroyed.

New Activities can be created using the Activity constructor, like this:

var activity = new Activity("folderview")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file). See the documentation on the Containment object class below.

Read-only properties:
* ''Array[number]'' '''activityIds''': returns a list of integer ids of all existing Plasma activities
* ''Array[String]'' '''knownActivityTypes''': (scripting version >= 2) a list of types of activities that can be created. This is useful to check if an Activity type is available on the system before trying to construct one.

Functions:
* ''Activity'' '''activityById(number id)''': return an object representing the activity with the given id
* ''Activity'' '''activityForScreen(number screen[, number dekstop])''': returns an object representing the activity currently associated with the given screen and, optionally, the given desktop.
* ''Array[Activity]'' '''activities()''': returns an array of all activities that currently exist

=== Panels ===
Panels can be created, enumerated, modified and destroyed. A panel object combines both a containment as well as the container itself, allowing for full control of things such as where it appears on screen and the hiding features associated with them.

New Panels can be created using the Panel constructor, like this:

var panel = new Panel("dock")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file).

Read-only properties:
* ''Array[number]'' '''panelIds''': returns a list of integer ids of all existing Plasma panels
* ''Array[String]'' '''knownPanelTypes''': (scripting version >= 2) a list of types of panels that can be created. This is useful to check if a Panel type is available on the system before trying to construct one.

Functions:
* ''Panel'' '''panelById(int id)''': returns an object representing the Panel that matches the given id
* ''Array[Panels]'' '''panels()''': returns an array of all panels that currently exist

=== Activities and Panels ===
Activity and Panel objects, once created by the script, or as returned by activityById, activityForScreen,
or panelById) provide the following read-only properties:

* ''number'' '''id: the integer id of this activity
* ''String'' '''formFactor''': returns the form factor of the activity, e.g. "planar" for most desktop activities,"mediacenter" for media centers and either "horizontal" or "vertical" for panels.
* ''Array[number]'' '''widgetIds''': a list of integer ids of all the widgets in this Activity
* ''Array[String]'' '''configKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current configuration group
* ''Array[String]'' '''configGroups''': (scriptingVersion >= 2) a list of all the groups in the current configuration group
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group

as well as the following read/write properties:

* ''number'' '''desktop''': the virtual desktop this activity is associated with, or -1 for none
* ''number'' '''screen''': the screen this activity is associated with, or -1 for none
* ''String'' '''name''': the name of this activity
* ''String'' '''wallpaperPlugin''': (scriptingVersion >= 2) the wallpaper plugin to use with the Activity
* ''String'' '''wallpaperMode''': (scriptingVersion >= 2) the wallpaper plugin mode to use with the Activity
* ''Array[String]'' '''currentConfigGroup''': (scriptingVersion >= 2) the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

and the following methods:

* '''remove()''': deletes this activity and all widgets inside of it
* ''Widget'' '''widgetById(number id)''': returns an object representing the widget with the given id
* ''Widget'' '''addWidget(String name)''': adds a new widget to the activity; the name maps to the X-KDE-PluginInfo-Name= entry
in the widget's .desktop file
* ''Widget'' '''addWidget(Widget widget)''': adds an existing widget to this activity; useful for moving widgets between Activities and Panels
* '''showConfigurationInteface()''': shows the configuration user interface for this Activity or Panel on the screen
* '''readConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the config with default for the default value
* '''writeConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': (scriptingVersion >= 2) causes the Activity or Panel to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of panels and activities of the same type.
* ''Array[Widget]'' '''widgets([String type])''': (scriptingVersion >= 2) returns all the widgets in the Panel or Activity. If the optional type is specified, only widgets matching that type will be returned.

In addition to all of the above properties and functions, Panel objects also provide the folowing read/write properties:
* ''number'' '''length''': the number of pixels along the screen edge used
* ''number'' '''height''': the height (or for vertical panels, the width) of the panel
* ''String'' '''hiding''': the hiding mode of the panel, one of "none" (for no hiding), "autohide", "windowscover" or "windowsbelow"
* ''String'' '''alignment''': right, left or center alignment of the panel (for vertical panels, right corrsponds to top and left to bottom)
* ''String'' '''location''': returns the location of the activity (only relevant for Panels); valid values include "top", "bottom", "left", "right" and "floating"

=== Widgets ===
Widgets may be enumerated by calling the widgetIds property on a Activity or Panel object. With a widget id in hand, a Widget object can be retrieved by calling widgetById(id) on an Activity or Panel object. New Widgets can be created with add addWidget(String) function provided by Activity and Panel objects.

A list of all installed widget types can be retrieved the following read-only property:

* ''Array[String]'' '''knownWidgetTypes''' (scripting version >= 2)

A Widget object provides the following read-only properties:

* ''number'' '''id''': the id of the widget
* ''String'' '''type''': the plugin type of this widget
* ''Array[String]'' '''configKeys''': a list of all keys that are set in the current configuration
* ''Array[String]'' '''configGroups''': a list of all the groups in the current configuration
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

as well as the following read-write properties:

* ''Array[String]'' '''currentConfigGroup''': the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of widgets of the same type.
* ''QRectF'' '''geometry''': the geometry of the widget (settable)
* ''String'' '''globalShortcut''': the shortcut sequence (in the format used by QKeySequence, e.g. "Alt+F1") associated with this widget
* ''number'' '''index''': the layout index of the widget; in a Panel this corresponds to the order the widget appears in. Changing the value of the index will change the position of the widget in Panels and may do so in some Activities as well.

and the following methods:

* '''remove()''': deletes this widget
* '''readConfig(String key, any default)''': reads the value of key in the config with default
for the default value
* '''writeConfig(String key, any value)''': sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': causes the widget to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* '''showConfigurationInteface()''': shows the configuration user interface for this widget on the screen

=== Screen Geometry ===
Read-only properties:
* ''number'' '''screenCount''': returns the number of screens connected to the computer

Functions:
* ''QRectF'' '''screenGeometry(number screen)''': returns a rect object representing the geometry of a screen

=== Wallpaper Plugins ===

* ''Array[String => Array[String]]'' '''knownWallpaperPlugins()''': (scripting version >= 4) returns a list of all installed wallpaper plugins. They keys of the array are the wallpaper plugin names. The values are arrays containing the modes available for that wallpaper plugin. The mode array may be empty, as most wallpaper plugins only offer one mode.

=== Locating Applications and Paths ===
* ''boolean'' '''applicationExists(String name)''': (scripting version >= 4) searches $PATH first, then tries in the application menu system by application storage name (aka the .desktop file name), then Name= entries for apps with installed .desktop files, then GenericName= entries for same
* ''mixed'' '''defaultApplication(String kind [, boolean storageId = false])''': (scripting version >= 4) returns the executable (or if storageId is true, then the the app menu system id, e.g. its .desktop file name) of the default app. The "kind" parameter may be a well-known application type including "browser", "mailer", "filemanager", "terminal", "imClient" and "windowmanager" (or any other entry in share/apps/kcm_componentchooser/kcm_*.desktop); it may also be a mimetype (e.g. "application/pdf"). On failure, it returns false.
* ''String'' '''applicationPath(String name)''': (scripting version >= 4) returns the full local path to a given application or .desktop file if it exists.
* ''String'' '''userDataPath([String type, String path])''': (scripting version >= 4) returns the default path for user data. Called with no parameters, it returns the user's home directory. If only one string is passed in, the standard directory for that type of data in the user's home directory will be located; the following values are recognized:
** documents
** music
** video
** downloads
** pictures
** autostart
** desktop (should be considered deprecated for Plasma workspaces)

If a second string is passed in, it is considered a request for a specific path and the following types are recognized:
** apps - Applications menu (.desktop files).
** autostart - Autostart directories (both XDG and kde-specific)
** cache - Cached information (e.g. favicons, web-pages)
** cgi - CGIs to run from kdehelp.
** config - Configuration files.
** data - Where applications store data.
** emoticons - Emoticons themes
** exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
** html - HTML documentation.
** icon - Icons, see KIconLoader.
** kcfg - KConfigXT config files.
** lib - Libraries.
** locale - Translation files for KLocale.
** mime - Mime types defined by KDE-specific .desktop files.
** module - Module (dynamically loaded library).
** qtplugins - Qt plugins (dynamically loaded objects for Qt)
** services - Services.
** servicetypes - Service types.
** sound - Application sounds.
** templates - Templates for the "Create new file" functionality.
** wallpaper - Wallpapers.
** tmp - Temporary files (specific for both current host and current user)
** socket - UNIX Sockets (specific for both current host and current user)
** xdgconf-menu - Freedesktop.org standard location for menu layout (.menu) files.
** xdgdata-apps - Freedesktop.org standard location for application desktop files.
** xdgdata-dirs - Freedesktop.org standard location for menu descriptions (.directory files).
** xdgdata-mime - Freedesktop.org standard location for MIME type definitions.
** xdgdata-icon - Freedesktop.org standard location for icons.
** xdgdata-pixmap - Gnome-compatibility location for pixmaps.

The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").

=== Misc. Global Properties and Functions ===
Read-write properties:
* ''boolean'' '''locked''': whether the desktop shell and widgets are locked or not (settable)
* ''string'' '''theme''': (scripting version >= 3) the name of the desktop theme to use for the interface, e.g. default, Air, Oxygen, etc.

Read-only properties:
* ''boolean'' '''hasBattery''': whether or not the system has the ability to run on battery power, e.g. a laptop or mobile device
* ''boolean'' '''multihead''': (scripting version >= 3) true if the system is running with multiple screens in a "Xaphod" multiple display server configuration
* ''int'' '''multiheadScreen''': (scripting version >= 3) if multihead is true, contains the (real) screen id of the current screen

Functions:
* '''sleep(number ms)''': sleeps the script for the specified number of millseconds

=== QRectF ===
A rectangle class is also provided for use with Widget, Panel and screen geometry properties and functions.

Read-only properites:
* ''boolean'' '''empty''': true if the rectangle's width or height is less than, or equal to, 0; an empty rectangle is also invalid
* ''boolean'' '''null''': true if the rectangle has both the width and the height set to 0; a null rectangle is also empty and not valid
* ''boolean'' '''valid''': true if the rectangle has a width > 0 and height 0.

Read-write properties:
* ''number'' '''left'''
* ''number'' '''top'''
* ''number'' '''bottom'''
* ''number'' '''right'''
* ''number'' '''height'''
* ''number'' '''width'''
* ''number'' '''x'''
* ''number'' '''y'''

Constructors:
* '''QRectF'''
* '''QRectF(number x, number y, number width, number height)''': Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

Functions:
* '''adjust(number dx1, number dy1, number dx2, number dy2)''': adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle
* ''QRectF'' '''adjusted(number dx1, number dy1, number dx2, number dy2)''': returns a new QRectF with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of the rectangle
* '''translate(number dx, number dy)''': translates the rect by dx, dy
* '''setCoords(number x1, number y1, number x2, number y2)''': sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).
* '''setRect(number x, number y, number width, number height)''': sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.
* ''boolean'' '''contains(number x, number y)''': returns true if the rect contains the point (x, y)
* '''moveBottom(number delta)'': moves the bottom by delta pixels
* '''moveLeft(number delta)''': moves the left by delta pixels
* '''moveRight(number delta)''': moves the right by delta pixels
* '''moveTo(number x, number y)''': moves the top left of the rect to point (x, y)
* '''moveTop(number delta)''': moves the top by delta pixels

== Configuration Keys ==
Here you find a list of commonly used configuration keys to use with the '''writeConfig''' command. Where the documentation notes that a key is in a subgroup, remember to first use '''currentConfigGroup'''.

=== Common configuration keys ===
Here are some keys that can be used with all widgets:

* '''Share''' (true/false): Whether or not the widget is to be announces throughout the network (Share tab)

=== Common time and date keys ===
Most of the settings listed below apply to all widgets dealing with date and time (clock, digital-clock, binary-clock, …)
Settings for individual plasmoids can be found in their respective category and usually only affect the plasmoid’s appearance.
* '''announceInterval''' (number ≥ 0): Interval in minutes that the time is read out loud
* '''calendarType''' (local/coptic/ethopian/gregorian/gregorian-proleptic/hebrew/hijri/indian-national/jalali/japanese/julian/minguo/thai): Calendar system to be used, defaults to local
* '''defaultTimezone''' (Local/…): Time zone to be used
* '''displayHolidays''' (true/false): Whether holidays are to be displayed
* '''holidayRegions''' (tbd): tbd
* '''holidayRegionaDaysOff''' (tbd): tbd
* '''timeZones''' (Europe/Andorra,…): Comma-separated list of timezones to be used (e. g. Europe/Andorra,Indian/Antananarivo,Asia/Aqtau)

=== Analog clock (clock) ===
* '''showSecondHand''' (true/false): self-explanatory
* '''showTimezoneString''' (true/false): self-explanatory

=== Battery status (battery) ===
* '''showBatteryString''' (true/false): Whether or not battery status is shown as overlay for the battery icon (if in systemtray or panel)
* '''showMultipleBatteries''' (true/false): Whether or not battery status is shown for each battery separately

=== Digital clock (digital-clock) ===
* '''plainClockColor''' (rrr,ggg,bbb): Color set for clock font (e. g. 192,0,0 - to be used with useCustomColor=true!)
* '''plainClockDrawShadow''' (true/false): Whether a shadow is to bed drawn (defaults to true)
* '''plainClockShadowColor''' (rrr,ggg,bbb): Color set for clock shadow (e. g. 64,97,128 - to be used with useCustomShadowColor=true!)
* '''plainClockFont''' (tbd): Font to be used for clock (e. g. Serif,12,-1,5,75,0,0,0,0,0)
* '''showDate''' (true/false): self-explanatory
* '''showDay''' (true/false): self-explanatory
* '''showSeconds''' (true/false): self-explanatory
* '''showTimezone''' (true/false): self-explanatory
* '''showYear''' (true/false): self-explanatory
* '''useCustomColor''' (true/false): Whether or not a custom color is to be used (use with plainClockColor=rrr,ggg,bbb!)
* '''useCustomShadowColor''' (true/false): Whether or not a custom shadow color is to be used (use with plainClockShadowColor=rrr,ggg,bbb!)

=== Folderview (folderview) ===
* '''alignToGrid''' (true/false): self-explanatory
* '''customIconSize''' (16/22/24/32/48/…): Use custom icon size for files/folders (use only default/common icon sizes, powers of 2)
* '''customLabel''': Use custom title rather than default path or place name
* '''drawShadows''' (true/false): Whether or not file labels are to draw shadows
* '''filter''' (0/1/2): Defines whether a filter is to be used or not (0 = No filter, 1 = Show only matching files, 2 = Hide matching files)
* '''filterFiles''': Wildcard filter to filter file names
* '''mimeFilter''': Comma-separated list of mimetypes to be filtered (shown/hidden depends on filter-setting)
* '''iconsLocked''' (true/false): Whether or not icons can be moved
* '''numTextLines''' (number > 0): Amount of lines a file name can have before it is truncated
* '''url''': Folder URL to be displayed (e. g. desktop:/// or file:///home/yourusername)
* '''sortColumn''' (-1/0/1/2/3/4/5): The way files and folders are sorted (-1 = No sorting, 0 = By name, 1 = By size, 2 = By type, 3 = By date)
* '''sortDirsFirst''' (true/false): Whether or not folders are displayed before files (defaults to true)
* '''textColor''' (rrr,ggg,bbb): Color the icon labels will have

=== Kickoff menu (launcher) ===
* '''SwitchTabsOnHover''' (true/false): self-explanatory
* '''ShowAppsByName''' (true/false): Apps are sorted by name rather than by description

=== Pager (pager) ===
* '''displayedText''' (0/1/2): Text to be shown on individual virtual desktops (0 = Workspace number, 1 = Workspace title, 2 = None)
* '''ShowWindowIcons''' (true/false): Whether or not the application icon is to be shown on each individual window
* '''currentDesktopSelected''' (0/1/2): Defines what should happen if the user clicks on the virtual desktop that is currently active (0 = Nothing, 1 = Show Workspace, i. e. minimize windows, 2 = Show Dashboard)
* '''rows''' (number > 0): Amount of rows the pager should have. (Note: ''This is a global option, so you need to use '''writeGlobalConfig''' instead'')

=== Notifications (notifications) ===
{{note|This applet is likely to be embedded to system tray. For Systrem Tray specific tasks, i. e. how to add, manage and remove plasmoids inside it, see sections below}}
* '''AutoHidePopup''' (true/false): Whether or not popups are to be hidden automatiaclly
* '''ShowJobs''' (true/false): Whether or not jobs are to be shown (e. g. file transfer progress)
* '''ShowNotifications''' (true/false): Whether or not notifications are to be shown

=== Removable media notifier (notifier) ===
* '''ShowDevices''' (0/1/2): Defines what kind of devices are to be shown (0 = Removable media only, 1 = Non-removable media only, 2 = All)
{{note|Auto-mount settings and device actions are not stored in this Plasmoid’s settings.}}

=== Taskbar (tasks) ===
* '''groupingStrategy''' (0/1/2): Defines how taskbar entries are to be grouped (0 = Never, 1 = Manually, 2 = By Program Name)
* '''groupWhenFull''' (true/false): Only group when taskbar is full (to be used with groupingStrategy=2 only!)
* '''highlightWindows''' (true/false): Highlight a window if your mouse cursor is hovering its taskbar entry (requires Desktop Compositing and “Highlight windows” effect enabled to work)
* '''maxRows''' (number > 0): Amount of rows taskbar entries can take
* '''forceRows''' (true/false): Force row setting for taskbar entries
* '''showOnlyCurrentActivity''' (true/false): Show only windows from current activity
* '''showOnlyCurrentDesktop''' (true/false): Show only windows from current virtual desktop
* '''showOnlyCurrentScreen''' (true/false): Show only windows from current screen (multi monitor setup)
* '''showTooltip''' (true/false): Whether or not tooltips are to be shown
* '''sortingStrategy''' (0/1/2/3): How taskbar entries are to be sorted (0 = Never, 1 = Manually, 2 = Alphabetically, 3 = By Desktop)

=== System Tray ===
The System Tray has some unique behaviors since it can host widgets and configuring it is not as easy as most other widgets, particularly when adding and removing widgets. This section will help you deal with its specific behavior.

==== Generic System Tray configuration keys ====
* '''DefaultAppletAdded''' (true/false): Remembers whether the default plasmoids (networkmanagement, device manager, notifications) have already been added(??)
* '''ShowApplicationStatus''' (true/false): Show system tray icons of applications that belong to the group “Applications”
* '''ShowCommunications''' (true/false): Show system tray icons of applications that belong to the group “Applications” (i. e. Messenger, IRC chat)
* '''ShowHardware''' (true/false): Show system tray icons of applications that belong to the group “Hardware” (i. e. volume control, printer applet)
* '''ShowSystemServices''' (true/false): Show system tray icons of applications that belong to the group “System Services” (i. e. Nepomuk Indexing Agent)
* '''ShowUnknown''' (true/false): Show system tray icons that do not belong into one of the categories mentioned above (or that do not use KDE’s system tray protocol and thus do not provide such information)
* '''alwaysShown''': Comma-separated list of widgets and entries that are to be shown all the time (e. g. KMix,notifier)
* '''hidden''': Comma-separated list of widgets and entries that are to be hidden all the time (e. g. Nepomuk Indexing Agent,Klipper,kmail)
{{note|Although notifications appear to be part of the System Tray, they are handled by a separate plasmoid which is embedded to the system tray. For its configuration keys, see section above}}

==== Add a widget to systemtray ====
You can not add widgets to the systemtray in a similar way like you would add them to a panel or containment using addWidget. Instead, to add, manage and remove them, you need to utilize writeConfig changing the currentConfigGroup.
<code bash>systray = panel.addWidget("systemtray") // First add a systemtray to your panel
systray.currentConfigGroup = Array("Applets","0") // then change the currentConfig Group
// to the subnode [Applets][0]. Use any number you like(?)</code>

Now you can “create” the plasmoid by adding a “plugin” configuration entry
<code bash>systray.writeConfig("plugin","notifier") // This will add a Device Notifier Plasmoid</code>
You can modify the plasmoid’s configuration by using writeConfig.
<code bash>systray.writeConfig("property","value")</code>
To change back to the top configuration level and thus edit the systemtray plasmoid itself pass an empty array to currentConfigGroup.

==== Edit existing widgets in systemtray ====

==== Remove a widget from systemtray =====

KDE System Administration/PlasmaDesktopScripting

2011-05-06T13:06:49Z

Broulik: Grouped all time-date-settings together, added config keys for pager, notifications, notifier, battery and block

== ECMA Script Interaction With Plasma Shells ==

It is possible to control and interact with a Plasma user interface shell such as a plasma-desktop or (starting in KDE SC 4.5) plasma-netbook session using ECMA Script (aka JavaScript). This scripting mechanism exposes containments (Desktop Activities and Panels), widgets and various other aspects of plasma-desktop configuration using the widely known and used ECMA Script language. The QtScript engine is used for the runtime environment.

This document describes the API that is provided along with how to
run such scripts in plasma-desktop.

== Examples ==

A set of examples can be found [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/plasma/javascript/plasma-shell-scripting here] that demonstrate the use of various aspects of Plasma shell scripting.

Contributions of additional examples are welcome and an be sent to the Plasma development mailing list (plasma-devel at kde.org) for inclusion if you do not have commit rights to the kdeexamples module.

== Running Scripts ==
There are three ways that scripts can be executed in plasma-desktop:

* '''on first run''': when plasma-desktop is started without any pre-existing configuration, any scripts in $APPDATA/plasma-desktop/init/ with a ".js" suffix are run. If there is more than one script, they are run sequentially in the alphabetical order of the file names.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''on update''': when plasma-desktop is started, it will check in
`kde4-config --path data`/plasma-desktop/updates/
with a ".js" suffix for scripts that have not yet been run. If there is more than one script which has not been run yet they will be executed serially in the alphabetical order of the file names.

A record of which update scripts have been run is kept in the application's config file in the [Updates] group. This means that if the plasma-desktop configuraiton file is removed, all the update scripts will be run again.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''interactively''': an interactive scripting dialog can be requested either via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "desktop console" as the search term. It can also be triggered directly via dbus with <code bash>qdbus org.kde.plasma-desktop /MainApplication showInteractiveConsole</code>

{{note|This method is not available for plasma-netbook.}}

:ECMA Script may be entered directly into this window for execution and output appears in the lower half of the window. Ctrl+E is a shortcut to run scripts, and scripts can be saved to and loaded from disk.

:Scripts from files can also be loaded using KRunner with "desktop console /path/to/file" or via dbus with
<code bash>qdbus org.kde.plasma-desktop /MainApplication loadScriptInInteractiveConsole /path/to/file</code>

== Templates ==

Templates are named packages that contain scripts. This provides a way for common functionality to be easily reused, helping to increase consistency and lower maintenance costs. Templates can be loaded from other scripts by name and they are also used to populate some parts of the user interface, such as the entries in the Add Panels menu.

A template is a small set of files in a specified file hierarchy (or, in Plasma terms, a "Package"). In particular, a Template package contains the following files:

* metadata.desktop: a .desktop file describing the template
* contents/layout.js: a Javascript file containing the actual script

Templates are stored under share/apps/plasma/layout-templates and may be installed using `plasmapkg -t layout-template -i /path/to/package`. Template packages may also be provided as a .zip file with a .plasmalayout suffix.

The metadata.desktop file contains the usual .desktop entries such as Name and Icon but must also contain Type=Service and ServiceTypes=Plasma/LayoutTemplate entries. If the layout is specific to a given Plasma application, such as plasma-desktop, this can be specific using X-Plasma-Shell. X-Plasma-ContainmentCategories defines what kind of layout it is with possible values being panel and desktop. Finally a X-KDE-PluginInfo-Name entry is required to provide a globally unique internal name for the Template. Here is an example of a Template that provides a Panel layout for Plasma Netbook:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Panel
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-netbook
X-Plasma-ContainmentCategories=panel
X-KDE-PluginInfo-Author=Aaron Seigo
X-KDE-PluginInfo-Email=aseigo@kde.org
X-KDE-PluginInfo-Name=org.kde.CoolNetbookPanel
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma.kde.org/
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

When running a template, two global variables will be accessible in read-only mode: templateName and templateComment. They will contain the Name and Comment fields of the above desktop file, and are translated if a localization is available.

=== Examples of Usage ===

==== Creating panels ====
A good example of the use of templates is the use case that triggered the creation of this feature: the desire to make it easy for users to re-create the default panel that is created on first start. There is a Template called org.kde.plasma-desktop.defaultPanel that ships with the KDE Plasma Workspace which contains the layout for the initial default panel. This is referenced by the default Plasma Desktop init script and, because it is marked as a Panel Template in the metadata.desktop file it also shows up to the user in the Add Panels menu. When selected by the user from the menu, the exact same panel that is created on desktop start up is created for them, complete with Plasma Widgets and configuration.

==== Automating tasks ====
Another example of the usefulness of templates is the "Find Widgets" template. This template, which first shipped with Plasma Desktop v4.5, provides a function for finding widgets by name. It appears in the toolbar "Load" and "Use" menus in the Desktop Console in plasma-desktop, and makes finding widgets as simple as:

<code javascript>
var template = loadTemplate('org.kde.plasma-desktop.findWidgets')
template.findWidgets('systemtray')
</code>

==== Activity templates ====
Probably the most user visible use of templates are "Activity templates". The structure of Activity templates is similar to the other use of templates, but a few extra features are provided in the metadata.desktop file. Here is an example of such an activity template:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Activity Template
Icon=user-desktop
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-desktop
X-Plasma-ContainmentCategories=desktop
X-Plasma-ContainmentLayout-ExecuteOnCreation=dolphin $desktop, gwenview $pictures
X-Plasma-ContainmentLayout-ShowAsExisting=true
X-KDE-PluginInfo-Author=John Doe
X-KDE-PluginInfo-Email=john@doe.org
X-KDE-PluginInfo-Name=org.kde.plasma-desktop.CoolTemplate
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://john.doe.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

The layout itself is still created from the layout.js file as usual, but this template also shows as a precreated activity to the user thanks to the X-Plasma-ContainmentLayout-ShowAsExisting key. Additionally, it starts applications in the newly created activity using the X-Plasma-ContainmentLayout-ExecuteOnCreation key.

That key is a list of commands to execute, and it supports the following variables:
* $desktop
* $autostart
* $documents
* $music
* $video
* $downloads
* $pictures

They all expand into the path toward the user corresponding default folder.

== API ==

In addition to the normal ECMA Script API and the Qt-specific extensions (such as signal/slot support) provided by QtScript, the following API is provided for use by scripts.

All of the API below, unless otherwise noted with a version noticed, appear as below in the KDE Software Compilation v4.4.0 and later. API that is not noted as being part of a given class or object is part of the global namespace.

{{note|API compatibility is guaranteed from version to version starting with KDE Software Compilation v4.4.0.}}

=== Version Numbers ===

Starting with KDE SC 4.5, the version number of both the scripting API and the application is available to the script via the following read-only properties:

* ''String'' '''applicationVersion''': the version of the application, e.g. 0.3
* ''String'' '''platformVersion''': the version of the KDE Platform, e.g. 0.3
* ''number'' '''scriptingVersion''': the version of the scripting API; e.g. in KDE SC 4.5 this is 2

=== Activities ===
Activities are the desktop layer in a plasma-desktop session and may contain widgts. In sightly more technical terms, they are desktop containments. Activities can be created, enumerated, modified and destroyed.

New Activities can be created using the Activity constructor, like this:

var activity = new Activity("folderview")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file). See the documentation on the Containment object class below.

Read-only properties:
* ''Array[number]'' '''activityIds''': returns a list of integer ids of all existing Plasma activities
* ''Array[String]'' '''knownActivityTypes''': (scripting version >= 2) a list of types of activities that can be created. This is useful to check if an Activity type is available on the system before trying to construct one.

Functions:
* ''Activity'' '''activityById(number id)''': return an object representing the activity with the given id
* ''Activity'' '''activityForScreen(number screen[, number dekstop])''': returns an object representing the activity currently associated with the given screen and, optionally, the given desktop.
* ''Array[Activity]'' '''activities()''': returns an array of all activities that currently exist

=== Panels ===
Panels can be created, enumerated, modified and destroyed. A panel object combines both a containment as well as the container itself, allowing for full control of things such as where it appears on screen and the hiding features associated with them.

New Panels can be created using the Panel constructor, like this:

var panel = new Panel("dock")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file).

Read-only properties:
* ''Array[number]'' '''panelIds''': returns a list of integer ids of all existing Plasma panels
* ''Array[String]'' '''knownPanelTypes''': (scripting version >= 2) a list of types of panels that can be created. This is useful to check if a Panel type is available on the system before trying to construct one.

Functions:
* ''Panel'' '''panelById(int id)''': returns an object representing the Panel that matches the given id
* ''Array[Panels]'' '''panels()''': returns an array of all panels that currently exist

=== Activities and Panels ===
Activity and Panel objects, once created by the script, or as returned by activityById, activityForScreen,
or panelById) provide the following read-only properties:

* ''number'' '''id: the integer id of this activity
* ''String'' '''formFactor''': returns the form factor of the activity, e.g. "planar" for most desktop activities,"mediacenter" for media centers and either "horizontal" or "vertical" for panels.
* ''Array[number]'' '''widgetIds''': a list of integer ids of all the widgets in this Activity
* ''Array[String]'' '''configKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current configuration group
* ''Array[String]'' '''configGroups''': (scriptingVersion >= 2) a list of all the groups in the current configuration group
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group

as well as the following read/write properties:

* ''number'' '''desktop''': the virtual desktop this activity is associated with, or -1 for none
* ''number'' '''screen''': the screen this activity is associated with, or -1 for none
* ''String'' '''name''': the name of this activity
* ''String'' '''wallpaperPlugin''': (scriptingVersion >= 2) the wallpaper plugin to use with the Activity
* ''String'' '''wallpaperMode''': (scriptingVersion >= 2) the wallpaper plugin mode to use with the Activity
* ''Array[String]'' '''currentConfigGroup''': (scriptingVersion >= 2) the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

and the following methods:

* '''remove()''': deletes this activity and all widgets inside of it
* ''Widget'' '''widgetById(number id)''': returns an object representing the widget with the given id
* ''Widget'' '''addWidget(String name)''': adds a new widget to the activity; the name maps to the X-KDE-PluginInfo-Name= entry
in the widget's .desktop file
* ''Widget'' '''addWidget(Widget widget)''': adds an existing widget to this activity; useful for moving widgets between Activities and Panels
* '''showConfigurationInteface()''': shows the configuration user interface for this Activity or Panel on the screen
* '''readConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the config with default for the default value
* '''writeConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': (scriptingVersion >= 2) causes the Activity or Panel to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of panels and activities of the same type.
* ''Array[Widget]'' '''widgets([String type])''': (scriptingVersion >= 2) returns all the widgets in the Panel or Activity. If the optional type is specified, only widgets matching that type will be returned.

In addition to all of the above properties and functions, Panel objects also provide the folowing read/write properties:
* ''number'' '''length''': the number of pixels along the screen edge used
* ''number'' '''height''': the height (or for vertical panels, the width) of the panel
* ''String'' '''hiding''': the hiding mode of the panel, one of "none" (for no hiding), "autohide", "windowscover" or "windowsbelow"
* ''String'' '''alignment''': right, left or center alignment of the panel (for vertical panels, right corrsponds to top and left to bottom)
* ''String'' '''location''': returns the location of the activity (only relevant for Panels); valid values include "top", "bottom", "left", "right" and "floating"

=== Widgets ===
Widgets may be enumerated by calling the widgetIds property on a Activity or Panel object. With a widget id in hand, a Widget object can be retrieved by calling widgetById(id) on an Activity or Panel object. New Widgets can be created with add addWidget(String) function provided by Activity and Panel objects.

A list of all installed widget types can be retrieved the following read-only property:

* ''Array[String]'' '''knownWidgetTypes''' (scripting version >= 2)

A Widget object provides the following read-only properties:

* ''number'' '''id''': the id of the widget
* ''String'' '''type''': the plugin type of this widget
* ''Array[String]'' '''configKeys''': a list of all keys that are set in the current configuration
* ''Array[String]'' '''configGroups''': a list of all the groups in the current configuration
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

as well as the following read-write properties:

* ''Array[String]'' '''currentConfigGroup''': the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of widgets of the same type.
* ''QRectF'' '''geometry''': the geometry of the widget (settable)
* ''String'' '''globalShortcut''': the shortcut sequence (in the format used by QKeySequence, e.g. "Alt+F1") associated with this widget
* ''number'' '''index''': the layout index of the widget; in a Panel this corresponds to the order the widget appears in. Changing the value of the index will change the position of the widget in Panels and may do so in some Activities as well.

and the following methods:

* '''remove()''': deletes this widget
* '''readConfig(String key, any default)''': reads the value of key in the config with default
for the default value
* '''writeConfig(String key, any value)''': sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': causes the widget to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* '''showConfigurationInteface()''': shows the configuration user interface for this widget on the screen

=== Screen Geometry ===
Read-only properties:
* ''number'' '''screenCount''': returns the number of screens connected to the computer

Functions:
* ''QRectF'' '''screenGeometry(number screen)''': returns a rect object representing the geometry of a screen

=== Wallpaper Plugins ===

* ''Array[String => Array[String]]'' '''knownWallpaperPlugins()''': (scripting version >= 4) returns a list of all installed wallpaper plugins. They keys of the array are the wallpaper plugin names. The values are arrays containing the modes available for that wallpaper plugin. The mode array may be empty, as most wallpaper plugins only offer one mode.

=== Locating Applications and Paths ===
* ''boolean'' '''applicationExists(String name)''': (scripting version >= 4) searches $PATH first, then tries in the application menu system by application storage name (aka the .desktop file name), then Name= entries for apps with installed .desktop files, then GenericName= entries for same
* ''mixed'' '''defaultApplication(String kind [, boolean storageId = false])''': (scripting version >= 4) returns the executable (or if storageId is true, then the the app menu system id, e.g. its .desktop file name) of the default app. The "kind" parameter may be a well-known application type including "browser", "mailer", "filemanager", "terminal", "imClient" and "windowmanager" (or any other entry in share/apps/kcm_componentchooser/kcm_*.desktop); it may also be a mimetype (e.g. "application/pdf"). On failure, it returns false.
* ''String'' '''applicationPath(String name)''': (scripting version >= 4) returns the full local path to a given application or .desktop file if it exists.
* ''String'' '''userDataPath([String type, String path])''': (scripting version >= 4) returns the default path for user data. Called with no parameters, it returns the user's home directory. If only one string is passed in, the standard directory for that type of data in the user's home directory will be located; the following values are recognized:
** documents
** music
** video
** downloads
** pictures
** autostart
** desktop (should be considered deprecated for Plasma workspaces)

If a second string is passed in, it is considered a request for a specific path and the following types are recognized:
** apps - Applications menu (.desktop files).
** autostart - Autostart directories (both XDG and kde-specific)
** cache - Cached information (e.g. favicons, web-pages)
** cgi - CGIs to run from kdehelp.
** config - Configuration files.
** data - Where applications store data.
** emoticons - Emoticons themes
** exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
** html - HTML documentation.
** icon - Icons, see KIconLoader.
** kcfg - KConfigXT config files.
** lib - Libraries.
** locale - Translation files for KLocale.
** mime - Mime types defined by KDE-specific .desktop files.
** module - Module (dynamically loaded library).
** qtplugins - Qt plugins (dynamically loaded objects for Qt)
** services - Services.
** servicetypes - Service types.
** sound - Application sounds.
** templates - Templates for the "Create new file" functionality.
** wallpaper - Wallpapers.
** tmp - Temporary files (specific for both current host and current user)
** socket - UNIX Sockets (specific for both current host and current user)
** xdgconf-menu - Freedesktop.org standard location for menu layout (.menu) files.
** xdgdata-apps - Freedesktop.org standard location for application desktop files.
** xdgdata-dirs - Freedesktop.org standard location for menu descriptions (.directory files).
** xdgdata-mime - Freedesktop.org standard location for MIME type definitions.
** xdgdata-icon - Freedesktop.org standard location for icons.
** xdgdata-pixmap - Gnome-compatibility location for pixmaps.

The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").

=== Misc. Global Properties and Functions ===
Read-write properties:
* ''boolean'' '''locked''': whether the desktop shell and widgets are locked or not (settable)
* ''string'' '''theme''': (scripting version >= 3) the name of the desktop theme to use for the interface, e.g. default, Air, Oxygen, etc.

Read-only properties:
* ''boolean'' '''hasBattery''': whether or not the system has the ability to run on battery power, e.g. a laptop or mobile device
* ''boolean'' '''multihead''': (scripting version >= 3) true if the system is running with multiple screens in a "Xaphod" multiple display server configuration
* ''int'' '''multiheadScreen''': (scripting version >= 3) if multihead is true, contains the (real) screen id of the current screen

Functions:
* '''sleep(number ms)''': sleeps the script for the specified number of millseconds

=== QRectF ===
A rectangle class is also provided for use with Widget, Panel and screen geometry properties and functions.

Read-only properites:
* ''boolean'' '''empty''': true if the rectangle's width or height is less than, or equal to, 0; an empty rectangle is also invalid
* ''boolean'' '''null''': true if the rectangle has both the width and the height set to 0; a null rectangle is also empty and not valid
* ''boolean'' '''valid''': true if the rectangle has a width > 0 and height 0.

Read-write properties:
* ''number'' '''left'''
* ''number'' '''top'''
* ''number'' '''bottom'''
* ''number'' '''right'''
* ''number'' '''height'''
* ''number'' '''width'''
* ''number'' '''x'''
* ''number'' '''y'''

Constructors:
* '''QRectF'''
* '''QRectF(number x, number y, number width, number height)''': Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

Functions:
* '''adjust(number dx1, number dy1, number dx2, number dy2)''': adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle
* ''QRectF'' '''adjusted(number dx1, number dy1, number dx2, number dy2)''': returns a new QRectF with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of the rectangle
* '''translate(number dx, number dy)''': translates the rect by dx, dy
* '''setCoords(number x1, number y1, number x2, number y2)''': sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).
* '''setRect(number x, number y, number width, number height)''': sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.
* ''boolean'' '''contains(number x, number y)''': returns true if the rect contains the point (x, y)
* '''moveBottom(number delta)'': moves the bottom by delta pixels
* '''moveLeft(number delta)''': moves the left by delta pixels
* '''moveRight(number delta)''': moves the right by delta pixels
* '''moveTo(number x, number y)''': moves the top left of the rect to point (x, y)
* '''moveTop(number delta)''': moves the top by delta pixels

== Configuration Keys ==
Here you find a list of commonly used configuration keys to use with the '''writeConfig''' command. Where the documentation notes that a key is in a subgroup, remember to first use '''currentConfigGroup'''.

=== Common configuration keys ===
Here are some keys that can be used with all widgets:

* '''Share''' (true/false): Whether or not the widget is to be announces throughout the network (Share tab)

=== General time and date settings ===
Most of the settings listed below apply to all widgets dealing with date and time (clock, digital-clock, binary-clock, …)
Settings for individual plasmoids can be found in their respective category and usually only affect the plasmoid’s appearance.
* '''announceInterval''' (number ≥ 0): Interval in minutes that the time is read out loud
* '''calendarType''' (local/coptic/ethopian/gregorian/gregorian-proleptic/hebrew/hijri/indian-national/jalali/japanese/julian/minguo/thai): Calendar system to be used, defaults to local
* '''defaultTimezone''' (Local/…): Time zone to be used
* '''displayHolidays''' (true/false): Whether holidays are to be displayed
* '''holidayRegions''' (tbd): tbd
* '''holidayRegionaDaysOff''' (tbd): tbd
* '''timeZones''' (Europe/Andorra,…): Comma-separated list of timezones to be used (e. g. Europe/Andorra,Indian/Antananarivo,Asia/Aqtau)

=== Analog clock (clock) ===
* '''showSecondHand''' (true/false): self-explanatory
* '''showTimezoneString''' (true/false): self-explanatory

=== Battery status (battery) ===
* '''showBatteryString''' (true/false): Whether or not battery status is shown as overlay for the battery icon (if in systemtray or panel)
* '''showMultipleBatteries''' (true/false): Whether or not battery status is shown for each battery separately

=== Digital clock (digital-clock) ===
* '''plainClockColor''' (rrr,ggg,bbb): Color set for clock font (e. g. 192,0,0 - to be used with useCustomColor=true!)
* '''plainClockDrawShadow''' (true/false): Whether a shadow is to bed drawn (defaults to true)
* '''plainClockShadowColor''' (rrr,ggg,bbb): Color set for clock shadow (e. g. 64,97,128 - to be used with useCustomShadowColor=true!)
* '''plainClockFont''' (tbd): Font to be used for clock (e. g. Serif,12,-1,5,75,0,0,0,0,0)
* '''showDate''' (true/false): self-explanatory
* '''showDay''' (true/false): self-explanatory
* '''showSeconds''' (true/false): self-explanatory
* '''showTimezone''' (true/false): self-explanatory
* '''showYear''' (true/false): self-explanatory
* '''useCustomColor''' (true/false): Whether or not a custom color is to be used (use with plainClockColor=rrr,ggg,bbb!)
* '''useCustomShadowColor''' (true/false): Whether or not a custom shadow color is to be used (use with plainClockShadowColor=rrr,ggg,bbb!)

=== Folderview (folderview) ===
* '''alignToGrid''' (true/false): self-explanatory
* '''customIconSize''' (16/22/24/32/48/…): Use custom icon size for files/folders (use only default/common icon sizes, powers of 2)
* '''customLabel''': Use custom title rather than default path or place name
* '''drawShadows''' (true/false): Whether or not file labels are to draw shadows
* '''filter''' (0/1/2): Defines whether a filter is to be used or not (0 = No filter, 1 = Show only matching files, 2 = Hide matching files)
* '''filterFiles''': Wildcard filter to filter file names
* '''mimeFilter''': Comma-separated list of mimetypes to be filtered (shown/hidden depends on filter-setting)
* '''iconsLocked''' (true/false): Whether or not icons can be moved
* '''numTextLines''' (number > 0): Amount of lines a file name can have before it is truncated
* '''url''': Folder URL to be displayed (e. g. desktop:/// or file:///home/yourusername)
* '''sortColumn''' (-1/0/1/2/3/4/5): The way files and folders are sorted (-1 = No sorting, 0 = By name, 1 = By size, 2 = By type, 3 = By date)
* '''sortDirsFirst''' (true/false): Whether or not folders are displayed before files (defaults to true)
* '''textColor''' (rrr,ggg,bbb): Color the icon labels will have

=== Kickoff menu (launcher) ===
* '''SwitchTabsOnHover''' (true/false): self-explanatory
* '''ShowAppsByName''' (true/false): Apps are sorted by name rather than by description

=== Pager (pager) ===
* '''displayedText''' (0/1/2): Text to be shown on individual virtual desktops (0 = Workspace number, 1 = Workspace title, 2 = None)
* '''ShowWindowIcons''' (true/false): Whether or not the application icon is to be shown on each individual window
* '''currentDesktopSelected''' (0/1/2): Defines what should happen if the user clicks on the virtual desktop that is currently active (0 = Nothing, 1 = Show Workspace, i. e. minimize windows, 2 = Show Dashboard)
* '''rows''' (number > 0): Amount of rows the pager should have. (Note: ''This is a global option, so you need to use '''writeGlobalConfig''' instead'')

=== Notifications (notifications) ===
{{note|This applet is likely to be embedded to system tray. For Systrem Tray specific tasks, i. e. how to add, manage and remove plasmoids inside it, see sections below}}
* '''AutoHidePopup''' (true/false): Whether or not popups are to be hidden automatiaclly
* '''ShowJobs''' (true/false): Whether or not jobs are to be shown (e. g. file transfer progress)
* '''ShowNotifications''' (true/false): Whether or not notifications are to be shown

=== Removable media notifier (notifier) ===
* '''ShowDevices''' (0/1/2): Defines what kind of devices are to be shown (0 = Removable media only, 1 = Non-removable media only, 2 = All)
{{note|Auto-mount settings and device actions are not stored in this Plasmoid’s settings.}}

=== Taskbar (tasks) ===
* '''groupingStrategy''' (0/1/2): Defines how taskbar entries are to be grouped (0 = Never, 1 = Manually, 2 = By Program Name)
* '''groupWhenFull''' (true/false): Only group when taskbar is full (to be used with groupingStrategy=2 only!)
* '''highlightWindows''' (true/false): Highlight a window if your mouse cursor is hovering its taskbar entry (requires Desktop Compositing and “Highlight windows” effect enabled to work)
* '''maxRows''' (number > 0): Amount of rows taskbar entries can take
* '''forceRows''' (true/false): Force row setting for taskbar entries
* '''showOnlyCurrentActivity''' (true/false): Show only windows from current activity
* '''showOnlyCurrentDesktop''' (true/false): Show only windows from current virtual desktop
* '''showOnlyCurrentScreen''' (true/false): Show only windows from current screen (multi monitor setup)
* '''showTooltip''' (true/false): Whether or not tooltips are to be shown
* '''sortingStrategy''' (0/1/2/3): How taskbar entries are to be sorted (0 = Never, 1 = Manually, 2 = Alphabetically, 3 = By Desktop)

=== System Tray ===
The System Tray has some unique behaviors since it can host widgets and configuring it is not as easy as most other widgets, particularly when adding and removing widgets. This section will help you deal with its specific behavior.

==== Generic System Tray configuration keys ====
* '''DefaultAppletAdded''' (true/false): Remembers whether the default plasmoids (networkmanagement, device manager, notifications) have already been added(??)
* '''ShowApplicationStatus''' (true/false): Show system tray icons of applications that belong to the group “Applications”
* '''ShowCommunications''' (true/false): Show system tray icons of applications that belong to the group “Applications” (i. e. Messenger, IRC chat)
* '''ShowHardware''' (true/false): Show system tray icons of applications that belong to the group “Hardware” (i. e. volume control, printer applet)
* '''ShowSystemServices''' (true/false): Show system tray icons of applications that belong to the group “System Services” (i. e. Nepomuk Indexing Agent)
* '''ShowUnknown''' (true/false): Show system tray icons that do not belong into one of the categories mentioned above (or that do not use KDE’s system tray protocol and thus do not provide such information)
* '''alwaysShown''': Comma-separated list of widgets and entries that are to be shown all the time (e. g. KMix,notifier)
* '''hidden''': Comma-separated list of widgets and entries that are to be hidden all the time (e. g. Nepomuk Indexing Agent,Klipper,kmail)
{{note|Although notifications appear to be part of the System Tray, they are handled by a separate plasmoid which is embedded to the system tray. For its configuration keys, see section above}}

==== Add a widget to systemtray ====
You can not add widgets to the systemtray in a similar way like you would add them to a panel or containment using addWidget. Instead, to add, manage and remove them, you need to utilize writeConfig changing the currentConfigGroup.
<code bash>systray = panel.addWidget("systemtray") // First add a systemtray to your panel
systray.currentConfigGroup = Array("Applets","0") // then change the currentConfig Group
// to the subnode [Applets][0]. Use any number you like(?)</code>

Now you can “create” the plasmoid by adding a “plugin” configuration entry
<code bash>systray.writeConfig("plugin","notifier") // This will add a Device Notifier Plasmoid</code>
You can modify the plasmoid’s configuration by using writeConfig.
<code bash>systray.writeConfig("property","value")</code>
To change back to the top configuration level and thus edit the systemtray plasmoid itself pass an empty array to currentConfigGroup.

==== Edit existing widgets in systemtray ====

==== Remove a widget from systemtray =====

KDE System Administration/PlasmaDesktopScripting

2011-05-06T12:43:05Z

Broulik: Added list of configuration keys for notifier

== ECMA Script Interaction With Plasma Shells ==

It is possible to control and interact with a Plasma user interface shell such as a plasma-desktop or (starting in KDE SC 4.5) plasma-netbook session using ECMA Script (aka JavaScript). This scripting mechanism exposes containments (Desktop Activities and Panels), widgets and various other aspects of plasma-desktop configuration using the widely known and used ECMA Script language. The QtScript engine is used for the runtime environment.

This document describes the API that is provided along with how to
run such scripts in plasma-desktop.

== Examples ==

A set of examples can be found [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/plasma/javascript/plasma-shell-scripting here] that demonstrate the use of various aspects of Plasma shell scripting.

Contributions of additional examples are welcome and an be sent to the Plasma development mailing list (plasma-devel at kde.org) for inclusion if you do not have commit rights to the kdeexamples module.

== Running Scripts ==
There are three ways that scripts can be executed in plasma-desktop:

* '''on first run''': when plasma-desktop is started without any pre-existing configuration, any scripts in $APPDATA/plasma-desktop/init/ with a ".js" suffix are run. If there is more than one script, they are run sequentially in the alphabetical order of the file names.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''on update''': when plasma-desktop is started, it will check in
`kde4-config --path data`/plasma-desktop/updates/
with a ".js" suffix for scripts that have not yet been run. If there is more than one script which has not been run yet they will be executed serially in the alphabetical order of the file names.

A record of which update scripts have been run is kept in the application's config file in the [Updates] group. This means that if the plasma-desktop configuraiton file is removed, all the update scripts will be run again.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''interactively''': an interactive scripting dialog can be requested either via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "desktop console" as the search term. It can also be triggered directly via dbus with <code bash>qdbus org.kde.plasma-desktop /MainApplication showInteractiveConsole</code>

{{note|This method is not available for plasma-netbook.}}

:ECMA Script may be entered directly into this window for execution and output appears in the lower half of the window. Ctrl+E is a shortcut to run scripts, and scripts can be saved to and loaded from disk.

:Scripts from files can also be loaded using KRunner with "desktop console /path/to/file" or via dbus with
<code bash>qdbus org.kde.plasma-desktop /MainApplication loadScriptInInteractiveConsole /path/to/file</code>

== Templates ==

Templates are named packages that contain scripts. This provides a way for common functionality to be easily reused, helping to increase consistency and lower maintenance costs. Templates can be loaded from other scripts by name and they are also used to populate some parts of the user interface, such as the entries in the Add Panels menu.

A template is a small set of files in a specified file hierarchy (or, in Plasma terms, a "Package"). In particular, a Template package contains the following files:

* metadata.desktop: a .desktop file describing the template
* contents/layout.js: a Javascript file containing the actual script

Templates are stored under share/apps/plasma/layout-templates and may be installed using `plasmapkg -t layout-template -i /path/to/package`. Template packages may also be provided as a .zip file with a .plasmalayout suffix.

The metadata.desktop file contains the usual .desktop entries such as Name and Icon but must also contain Type=Service and ServiceTypes=Plasma/LayoutTemplate entries. If the layout is specific to a given Plasma application, such as plasma-desktop, this can be specific using X-Plasma-Shell. X-Plasma-ContainmentCategories defines what kind of layout it is with possible values being panel and desktop. Finally a X-KDE-PluginInfo-Name entry is required to provide a globally unique internal name for the Template. Here is an example of a Template that provides a Panel layout for Plasma Netbook:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Panel
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-netbook
X-Plasma-ContainmentCategories=panel
X-KDE-PluginInfo-Author=Aaron Seigo
X-KDE-PluginInfo-Email=aseigo@kde.org
X-KDE-PluginInfo-Name=org.kde.CoolNetbookPanel
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma.kde.org/
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

When running a template, two global variables will be accessible in read-only mode: templateName and templateComment. They will contain the Name and Comment fields of the above desktop file, and are translated if a localization is available.

=== Examples of Usage ===

==== Creating panels ====
A good example of the use of templates is the use case that triggered the creation of this feature: the desire to make it easy for users to re-create the default panel that is created on first start. There is a Template called org.kde.plasma-desktop.defaultPanel that ships with the KDE Plasma Workspace which contains the layout for the initial default panel. This is referenced by the default Plasma Desktop init script and, because it is marked as a Panel Template in the metadata.desktop file it also shows up to the user in the Add Panels menu. When selected by the user from the menu, the exact same panel that is created on desktop start up is created for them, complete with Plasma Widgets and configuration.

==== Automating tasks ====
Another example of the usefulness of templates is the "Find Widgets" template. This template, which first shipped with Plasma Desktop v4.5, provides a function for finding widgets by name. It appears in the toolbar "Load" and "Use" menus in the Desktop Console in plasma-desktop, and makes finding widgets as simple as:

<code javascript>
var template = loadTemplate('org.kde.plasma-desktop.findWidgets')
template.findWidgets('systemtray')
</code>

==== Activity templates ====
Probably the most user visible use of templates are "Activity templates". The structure of Activity templates is similar to the other use of templates, but a few extra features are provided in the metadata.desktop file. Here is an example of such an activity template:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Activity Template
Icon=user-desktop
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-desktop
X-Plasma-ContainmentCategories=desktop
X-Plasma-ContainmentLayout-ExecuteOnCreation=dolphin $desktop, gwenview $pictures
X-Plasma-ContainmentLayout-ShowAsExisting=true
X-KDE-PluginInfo-Author=John Doe
X-KDE-PluginInfo-Email=john@doe.org
X-KDE-PluginInfo-Name=org.kde.plasma-desktop.CoolTemplate
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://john.doe.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

The layout itself is still created from the layout.js file as usual, but this template also shows as a precreated activity to the user thanks to the X-Plasma-ContainmentLayout-ShowAsExisting key. Additionally, it starts applications in the newly created activity using the X-Plasma-ContainmentLayout-ExecuteOnCreation key.

That key is a list of commands to execute, and it supports the following variables:
* $desktop
* $autostart
* $documents
* $music
* $video
* $downloads
* $pictures

They all expand into the path toward the user corresponding default folder.

== API ==

In addition to the normal ECMA Script API and the Qt-specific extensions (such as signal/slot support) provided by QtScript, the following API is provided for use by scripts.

All of the API below, unless otherwise noted with a version noticed, appear as below in the KDE Software Compilation v4.4.0 and later. API that is not noted as being part of a given class or object is part of the global namespace.

{{note|API compatibility is guaranteed from version to version starting with KDE Software Compilation v4.4.0.}}

=== Version Numbers ===

Starting with KDE SC 4.5, the version number of both the scripting API and the application is available to the script via the following read-only properties:

* ''String'' '''applicationVersion''': the version of the application, e.g. 0.3
* ''String'' '''platformVersion''': the version of the KDE Platform, e.g. 0.3
* ''number'' '''scriptingVersion''': the version of the scripting API; e.g. in KDE SC 4.5 this is 2

=== Activities ===
Activities are the desktop layer in a plasma-desktop session and may contain widgts. In sightly more technical terms, they are desktop containments. Activities can be created, enumerated, modified and destroyed.

New Activities can be created using the Activity constructor, like this:

var activity = new Activity("folderview")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file). See the documentation on the Containment object class below.

Read-only properties:
* ''Array[number]'' '''activityIds''': returns a list of integer ids of all existing Plasma activities
* ''Array[String]'' '''knownActivityTypes''': (scripting version >= 2) a list of types of activities that can be created. This is useful to check if an Activity type is available on the system before trying to construct one.

Functions:
* ''Activity'' '''activityById(number id)''': return an object representing the activity with the given id
* ''Activity'' '''activityForScreen(number screen[, number dekstop])''': returns an object representing the activity currently associated with the given screen and, optionally, the given desktop.
* ''Array[Activity]'' '''activities()''': returns an array of all activities that currently exist

=== Panels ===
Panels can be created, enumerated, modified and destroyed. A panel object combines both a containment as well as the container itself, allowing for full control of things such as where it appears on screen and the hiding features associated with them.

New Panels can be created using the Panel constructor, like this:

var panel = new Panel("dock")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file).

Read-only properties:
* ''Array[number]'' '''panelIds''': returns a list of integer ids of all existing Plasma panels
* ''Array[String]'' '''knownPanelTypes''': (scripting version >= 2) a list of types of panels that can be created. This is useful to check if a Panel type is available on the system before trying to construct one.

Functions:
* ''Panel'' '''panelById(int id)''': returns an object representing the Panel that matches the given id
* ''Array[Panels]'' '''panels()''': returns an array of all panels that currently exist

=== Activities and Panels ===
Activity and Panel objects, once created by the script, or as returned by activityById, activityForScreen,
or panelById) provide the following read-only properties:

* ''number'' '''id: the integer id of this activity
* ''String'' '''formFactor''': returns the form factor of the activity, e.g. "planar" for most desktop activities,"mediacenter" for media centers and either "horizontal" or "vertical" for panels.
* ''Array[number]'' '''widgetIds''': a list of integer ids of all the widgets in this Activity
* ''Array[String]'' '''configKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current configuration group
* ''Array[String]'' '''configGroups''': (scriptingVersion >= 2) a list of all the groups in the current configuration group
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group

as well as the following read/write properties:

* ''number'' '''desktop''': the virtual desktop this activity is associated with, or -1 for none
* ''number'' '''screen''': the screen this activity is associated with, or -1 for none
* ''String'' '''name''': the name of this activity
* ''String'' '''wallpaperPlugin''': (scriptingVersion >= 2) the wallpaper plugin to use with the Activity
* ''String'' '''wallpaperMode''': (scriptingVersion >= 2) the wallpaper plugin mode to use with the Activity
* ''Array[String]'' '''currentConfigGroup''': (scriptingVersion >= 2) the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

and the following methods:

* '''remove()''': deletes this activity and all widgets inside of it
* ''Widget'' '''widgetById(number id)''': returns an object representing the widget with the given id
* ''Widget'' '''addWidget(String name)''': adds a new widget to the activity; the name maps to the X-KDE-PluginInfo-Name= entry
in the widget's .desktop file
* ''Widget'' '''addWidget(Widget widget)''': adds an existing widget to this activity; useful for moving widgets between Activities and Panels
* '''showConfigurationInteface()''': shows the configuration user interface for this Activity or Panel on the screen
* '''readConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the config with default for the default value
* '''writeConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': (scriptingVersion >= 2) causes the Activity or Panel to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of panels and activities of the same type.
* ''Array[Widget]'' '''widgets([String type])''': (scriptingVersion >= 2) returns all the widgets in the Panel or Activity. If the optional type is specified, only widgets matching that type will be returned.

In addition to all of the above properties and functions, Panel objects also provide the folowing read/write properties:
* ''number'' '''length''': the number of pixels along the screen edge used
* ''number'' '''height''': the height (or for vertical panels, the width) of the panel
* ''String'' '''hiding''': the hiding mode of the panel, one of "none" (for no hiding), "autohide", "windowscover" or "windowsbelow"
* ''String'' '''alignment''': right, left or center alignment of the panel (for vertical panels, right corrsponds to top and left to bottom)
* ''String'' '''location''': returns the location of the activity (only relevant for Panels); valid values include "top", "bottom", "left", "right" and "floating"

=== Widgets ===
Widgets may be enumerated by calling the widgetIds property on a Activity or Panel object. With a widget id in hand, a Widget object can be retrieved by calling widgetById(id) on an Activity or Panel object. New Widgets can be created with add addWidget(String) function provided by Activity and Panel objects.

A list of all installed widget types can be retrieved the following read-only property:

* ''Array[String]'' '''knownWidgetTypes''' (scripting version >= 2)

A Widget object provides the following read-only properties:

* ''number'' '''id''': the id of the widget
* ''String'' '''type''': the plugin type of this widget
* ''Array[String]'' '''configKeys''': a list of all keys that are set in the current configuration
* ''Array[String]'' '''configGroups''': a list of all the groups in the current configuration
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

as well as the following read-write properties:

* ''Array[String]'' '''currentConfigGroup''': the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of widgets of the same type.
* ''QRectF'' '''geometry''': the geometry of the widget (settable)
* ''String'' '''globalShortcut''': the shortcut sequence (in the format used by QKeySequence, e.g. "Alt+F1") associated with this widget
* ''number'' '''index''': the layout index of the widget; in a Panel this corresponds to the order the widget appears in. Changing the value of the index will change the position of the widget in Panels and may do so in some Activities as well.

and the following methods:

* '''remove()''': deletes this widget
* '''readConfig(String key, any default)''': reads the value of key in the config with default
for the default value
* '''writeConfig(String key, any value)''': sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': causes the widget to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* '''showConfigurationInteface()''': shows the configuration user interface for this widget on the screen

=== Screen Geometry ===
Read-only properties:
* ''number'' '''screenCount''': returns the number of screens connected to the computer

Functions:
* ''QRectF'' '''screenGeometry(number screen)''': returns a rect object representing the geometry of a screen

=== Wallpaper Plugins ===

* ''Array[String => Array[String]]'' '''knownWallpaperPlugins()''': (scripting version >= 4) returns a list of all installed wallpaper plugins. They keys of the array are the wallpaper plugin names. The values are arrays containing the modes available for that wallpaper plugin. The mode array may be empty, as most wallpaper plugins only offer one mode.

=== Locating Applications and Paths ===
* ''boolean'' '''applicationExists(String name)''': (scripting version >= 4) searches $PATH first, then tries in the application menu system by application storage name (aka the .desktop file name), then Name= entries for apps with installed .desktop files, then GenericName= entries for same
* ''mixed'' '''defaultApplication(String kind [, boolean storageId = false])''': (scripting version >= 4) returns the executable (or if storageId is true, then the the app menu system id, e.g. its .desktop file name) of the default app. The "kind" parameter may be a well-known application type including "browser", "mailer", "filemanager", "terminal", "imClient" and "windowmanager" (or any other entry in share/apps/kcm_componentchooser/kcm_*.desktop); it may also be a mimetype (e.g. "application/pdf"). On failure, it returns false.
* ''String'' '''applicationPath(String name)''': (scripting version >= 4) returns the full local path to a given application or .desktop file if it exists.
* ''String'' '''userDataPath([String type, String path])''': (scripting version >= 4) returns the default path for user data. Called with no parameters, it returns the user's home directory. If only one string is passed in, the standard directory for that type of data in the user's home directory will be located; the following values are recognized:
** documents
** music
** video
** downloads
** pictures
** autostart
** desktop (should be considered deprecated for Plasma workspaces)

If a second string is passed in, it is considered a request for a specific path and the following types are recognized:
** apps - Applications menu (.desktop files).
** autostart - Autostart directories (both XDG and kde-specific)
** cache - Cached information (e.g. favicons, web-pages)
** cgi - CGIs to run from kdehelp.
** config - Configuration files.
** data - Where applications store data.
** emoticons - Emoticons themes
** exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
** html - HTML documentation.
** icon - Icons, see KIconLoader.
** kcfg - KConfigXT config files.
** lib - Libraries.
** locale - Translation files for KLocale.
** mime - Mime types defined by KDE-specific .desktop files.
** module - Module (dynamically loaded library).
** qtplugins - Qt plugins (dynamically loaded objects for Qt)
** services - Services.
** servicetypes - Service types.
** sound - Application sounds.
** templates - Templates for the "Create new file" functionality.
** wallpaper - Wallpapers.
** tmp - Temporary files (specific for both current host and current user)
** socket - UNIX Sockets (specific for both current host and current user)
** xdgconf-menu - Freedesktop.org standard location for menu layout (.menu) files.
** xdgdata-apps - Freedesktop.org standard location for application desktop files.
** xdgdata-dirs - Freedesktop.org standard location for menu descriptions (.directory files).
** xdgdata-mime - Freedesktop.org standard location for MIME type definitions.
** xdgdata-icon - Freedesktop.org standard location for icons.
** xdgdata-pixmap - Gnome-compatibility location for pixmaps.

The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").

=== Misc. Global Properties and Functions ===
Read-write properties:
* ''boolean'' '''locked''': whether the desktop shell and widgets are locked or not (settable)
* ''string'' '''theme''': (scripting version >= 3) the name of the desktop theme to use for the interface, e.g. default, Air, Oxygen, etc.

Read-only properties:
* ''boolean'' '''hasBattery''': whether or not the system has the ability to run on battery power, e.g. a laptop or mobile device
* ''boolean'' '''multihead''': (scripting version >= 3) true if the system is running with multiple screens in a "Xaphod" multiple display server configuration
* ''int'' '''multiheadScreen''': (scripting version >= 3) if multihead is true, contains the (real) screen id of the current screen

Functions:
* '''sleep(number ms)''': sleeps the script for the specified number of millseconds

=== QRectF ===
A rectangle class is also provided for use with Widget, Panel and screen geometry properties and functions.

Read-only properites:
* ''boolean'' '''empty''': true if the rectangle's width or height is less than, or equal to, 0; an empty rectangle is also invalid
* ''boolean'' '''null''': true if the rectangle has both the width and the height set to 0; a null rectangle is also empty and not valid
* ''boolean'' '''valid''': true if the rectangle has a width > 0 and height 0.

Read-write properties:
* ''number'' '''left'''
* ''number'' '''top'''
* ''number'' '''bottom'''
* ''number'' '''right'''
* ''number'' '''height'''
* ''number'' '''width'''
* ''number'' '''x'''
* ''number'' '''y'''

Constructors:
* '''QRectF'''
* '''QRectF(number x, number y, number width, number height)''': Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

Functions:
* '''adjust(number dx1, number dy1, number dx2, number dy2)''': adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle
* ''QRectF'' '''adjusted(number dx1, number dy1, number dx2, number dy2)''': returns a new QRectF with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of the rectangle
* '''translate(number dx, number dy)''': translates the rect by dx, dy
* '''setCoords(number x1, number y1, number x2, number y2)''': sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).
* '''setRect(number x, number y, number width, number height)''': sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.
* ''boolean'' '''contains(number x, number y)''': returns true if the rect contains the point (x, y)
* '''moveBottom(number delta)'': moves the bottom by delta pixels
* '''moveLeft(number delta)''': moves the left by delta pixels
* '''moveRight(number delta)''': moves the right by delta pixels
* '''moveTo(number x, number y)''': moves the top left of the rect to point (x, y)
* '''moveTop(number delta)''': moves the top by delta pixels

== Configuration Keys ==
Here you find a list of commonly used configuration keys to use with the '''writeConfig''' command. Where the documentation notes that a key is in a subgroup, remember to first use '''currentConfigGroup'''.

=== Common configuration keys ===
Here are some keys that can be used with all widgets:

* '''Share''' (true/false): Whether or not the widget is to be announces throughout the network (Share tab)

=== Digital clock (digital-clock) ===
* '''announceInterval''' (number ≥ 0): Interval in minutes that the time is read out loud
* '''calendarType''' (local/coptic/ethopian/gregorian/gregorian-proleptic/hebrew/hijri/indian-national/jalali/japanese/julian/minguo/thai): Calendar system to be used, defaults to local
* '''defaultTimezone''' (Local/…): Time zone to be used
* '''displayHolidays''' (true/false): Whether holidays are to be displayed
* '''holidayRegions''' (tbd): tbd
* '''holidayRegionaDaysOff''' (tbd): tbd
* '''plainClockColor''' (rrr,ggg,bbb): Color set for clock font (e. g. 192,0,0 - to be used with useCustomColor=true!)
* '''plainClockDrawShadow''' (true/false): Whether a shadow is to bed drawn (defaults to true)
* '''plainClockShadowColor''' (rrr,ggg,bbb): Color set for clock shadow (e. g. 64,97,128 - to be used with useCustomShadowColor=true!)
* '''plainClockFont''' (tbd): Font to be used for clock (e. g. Serif,12,-1,5,75,0,0,0,0,0)
* '''showDate''' (true/false): self-explanatory
* '''showDay''' (true/false): self-explanatory
* '''showSeconds''' (true/false): self-explanatory
* '''showTimezone''' (true/false): self-explanatory
* '''showYear''' (true/false): self-explanatory
* '''timeZones''' (Europe/Andorra,…): Comma-separated list of timezones to be used (e. g. Europe/Andorra,Indian/Antananarivo,Asia/Aqtau)
* '''useCustomColor''' (true/false): Whether or not a custom color is to be used (use with plainClockColor=rrr,ggg,bbb!)
* '''useCustomShadowColor''' (true/false): Whether or not a custom shadow color is to be used (use with plainClockShadowColor=rrr,ggg,bbb!)

=== Folderview (folderview) ===
* '''alignToGrid''' (true/false): self-explanatory
* '''customIconSize''' (16/22/24/32/48/…): Use custom icon size for files/folders (use only default/common icon sizes, powers of 2)
* '''customLabel''': Use custom title rather than default path or place name
* '''drawShadows''' (true/false): Whether or not file labels are to draw shadows
* '''filter''' (0/1/2): Defines whether a filter is to be used or not (0 = No filter, 1 = Show only matching files, 2 = Hide matching files)
* '''filterFiles''': Wildcard filter to filter file names
* '''mimeFilter''': Comma-separated list of mimetypes to be filtered (shown/hidden depends on filter-setting)
* '''iconsLocked''' (true/false): Whether or not icons can be moved
* '''numTextLines''' (number > 0): Amount of lines a file name can have before it is truncated
* '''url''': Folder URL to be displayed (e. g. desktop:/// or file:///home/yourusername)
* '''sortColumn''' (-1/0/1/2/3/4/5): The way files and folders are sorted (-1 = No sorting, 0 = By name, 1 = By size, 2 = By type, 3 = By date)
* '''sortDirsFirst''' (true/false): Whether or not folders are displayed before files (defaults to true)
* '''textColor''' (rrr,ggg,bbb): Color the icon labels will have

=== Kickoff menu (launcher) ===
* '''SwitchTabsOnHover''' (true/false): self-explanatory
* '''ShowAppsByName''' (true/false): Apps are sorted by name rather than by description

=== Removable media notifier (notifier) ===
* '''ShowDevices''' (0/1/2): Defines what kind of devices are to be shown (0 = Removable media only, 1 = Non-removable media only, 2 = All)
{{note|Auto-mount settings and device actions are not stored in this Plasmoid’s settings.}}

=== Taskbar (tasks) ===
* '''groupingStrategy''' (0/1/2): Defines how taskbar entries are to be grouped (0 = Never, 1 = Manually, 2 = By Program Name)
* '''groupWhenFull''' (true/false): Only group when taskbar is full (to be used with groupingStrategy=2 only!)
* '''highlightWindows''' (true/false): Highlight a window if your mouse cursor is hovering its taskbar entry (requires Desktop Compositing and “Highlight windows” effect enabled to work)
* '''maxRows''' (number > 0): Amount of rows taskbar entries can take
* '''forceRows''' (true/false): Force row setting for taskbar entries
* '''showOnlyCurrentActivity''' (true/false): Show only windows from current activity
* '''showOnlyCurrentDesktop''' (true/false): Show only windows from current virtual desktop
* '''showOnlyCurrentScreen''' (true/false): Show only windows from current screen (multi monitor setup)
* '''showTooltip''' (true/false): Whether or not tooltips are to be shown
* '''sortingStrategy''' (0/1/2/3): How taskbar entries are to be sorted (0 = Never, 1 = Manually, 2 = Alphabetically, 3 = By Desktop)

=== System Tray ===
The System Tray has some unique behaviors since it can host widgets and configuring it is not as easy as most other widgets, particularly when adding and removing widgets. This section will help you deal with its specific behavior.

==== Generic Systemtray configuration keys ====
* '''DefaultAppletAdded''' (true/false): Remembers whether the default plasmoids (networkmanagement, device manager, notifications) have already been added(??)
* '''ShowApplicationStatus''' (true/false): Show system tray icons of applications that belong to the group “Applications”
* '''ShowCommunications''' (true/false): Show system tray icons of applications that belong to the group “Applications” (i. e. Messenger, IRC chat)
* '''ShowHardware''' (true/false): Show system tray icons of applications that belong to the group “Hardware” (i. e. volume control, printer applet)
* '''ShowSystemServices''' (true/false): Show system tray icons of applications that belong to the group “System Services” (i. e. Nepomuk Indexing Agent)
* '''ShowUnknown''' (true/false): Show system tray icons that do not belong into one of the categories mentioned above (or that do not use KDE’s system tray protocol and thus do not provide such information)
* '''alwaysShown''': Comma-separated list of widgets and entries that are to be shown all the time (e. g. KMix,notifier)
* '''hidden''': Comma-separated list of widgets and entries that are to be hidden all the time (e. g. Nepomuk Indexing Agent,Klipper,kmail)

==== Add a widget to systemtray ====
You can not add widgets to the systemtray in a similar way like you would add them to a panel or containment using addWidget. Instead, to add, manage and remove them, you need to utilize writeConfig changing the currentConfigGroup.
<code bash>systray = panel.addWidget("systemtray") // First add a systemtray to your panel
systray.currentConfigGroup = Array("Applets","0") // then change the currentConfig Group
// to the subnode [Applets][0]. Use any number you like(?)</code>

Now you can “create” the plasmoid by adding a “plugin” configuration entry
<code bash>systray.writeConfig("plugin","notifier") // This will add a Device Notifier Plasmoid</code>
You can modify the plasmoid’s configuration by using writeConfig.
<code bash>systray.writeConfig("property","value")</code>
To change back to the top configuration level and thus edit the systemtray plasmoid itself pass an empty array to currentConfigGroup.

==== Edit existing widgets in systemtray ====

==== Remove a widget from systemtray =====

KDE System Administration/PlasmaDesktopScripting

2011-05-05T14:27:26Z

Broulik: Added how to add systemtray widgets and some other systemtray things

== ECMA Script Interaction With Plasma Shells ==

It is possible to control and interact with a Plasma user interface shell such as a plasma-desktop or (starting in KDE SC 4.5) plasma-netbook session using ECMA Script (aka JavaScript). This scripting mechanism exposes containments (Desktop Activities and Panels), widgets and various other aspects of plasma-desktop configuration using the widely known and used ECMA Script language. The QtScript engine is used for the runtime environment.

This document describes the API that is provided along with how to
run such scripts in plasma-desktop.

== Examples ==

A set of examples can be found [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/plasma/javascript/plasma-shell-scripting here] that demonstrate the use of various aspects of Plasma shell scripting.

Contributions of additional examples are welcome and an be sent to the Plasma development mailing list (plasma-devel at kde.org) for inclusion if you do not have commit rights to the kdeexamples module.

== Running Scripts ==
There are three ways that scripts can be executed in plasma-desktop:

* '''on first run''': when plasma-desktop is started without any pre-existing configuration, any scripts in $APPDATA/plasma-desktop/init/ with a ".js" suffix are run. If there is more than one script, they are run sequentially in the alphabetical order of the file names.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''on update''': when plasma-desktop is started, it will check in
`kde4-config --path data`/plasma-desktop/updates/
with a ".js" suffix for scripts that have not yet been run. If there is more than one script which has not been run yet they will be executed serially in the alphabetical order of the file names.

A record of which update scripts have been run is kept in the application's config file in the [Updates] group. This means that if the plasma-desktop configuraiton file is removed, all the update scripts will be run again.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''interactively''': an interactive scripting dialog can be requested either via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "desktop console" as the search term. It can also be triggered directly via dbus with <code bash>qdbus org.kde.plasma-desktop /MainApplication showInteractiveConsole</code>

{{note|This method is not available for plasma-netbook.}}

:ECMA Script may be entered directly into this window for execution and output appears in the lower half of the window. Ctrl+E is a shortcut to run scripts, and scripts can be saved to and loaded from disk.

:Scripts from files can also be loaded using KRunner with "desktop console /path/to/file" or via dbus with
<code bash>qdbus org.kde.plasma-desktop /MainApplication loadScriptInInteractiveConsole /path/to/file</code>

== Templates ==

Templates are named packages that contain scripts. This provides a way for common functionality to be easily reused, helping to increase consistency and lower maintenance costs. Templates can be loaded from other scripts by name and they are also used to populate some parts of the user interface, such as the entries in the Add Panels menu.

A template is a small set of files in a specified file hierarchy (or, in Plasma terms, a "Package"). In particular, a Template package contains the following files:

* metadata.desktop: a .desktop file describing the template
* contents/layout.js: a Javascript file containing the actual script

Templates are stored under share/apps/plasma/layout-templates and may be installed using `plasmapkg -t layout-template -i /path/to/package`. Template packages may also be provided as a .zip file with a .plasmalayout suffix.

The metadata.desktop file contains the usual .desktop entries such as Name and Icon but must also contain Type=Service and ServiceTypes=Plasma/LayoutTemplate entries. If the layout is specific to a given Plasma application, such as plasma-desktop, this can be specific using X-Plasma-Shell. X-Plasma-ContainmentCategories defines what kind of layout it is with possible values being panel and desktop. Finally a X-KDE-PluginInfo-Name entry is required to provide a globally unique internal name for the Template. Here is an example of a Template that provides a Panel layout for Plasma Netbook:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Panel
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-netbook
X-Plasma-ContainmentCategories=panel
X-KDE-PluginInfo-Author=Aaron Seigo
X-KDE-PluginInfo-Email=aseigo@kde.org
X-KDE-PluginInfo-Name=org.kde.CoolNetbookPanel
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma.kde.org/
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

When running a template, two global variables will be accessible in read-only mode: templateName and templateComment. They will contain the Name and Comment fields of the above desktop file, and are translated if a localization is available.

=== Examples of Usage ===

==== Creating panels ====
A good example of the use of templates is the use case that triggered the creation of this feature: the desire to make it easy for users to re-create the default panel that is created on first start. There is a Template called org.kde.plasma-desktop.defaultPanel that ships with the KDE Plasma Workspace which contains the layout for the initial default panel. This is referenced by the default Plasma Desktop init script and, because it is marked as a Panel Template in the metadata.desktop file it also shows up to the user in the Add Panels menu. When selected by the user from the menu, the exact same panel that is created on desktop start up is created for them, complete with Plasma Widgets and configuration.

==== Automating tasks ====
Another example of the usefulness of templates is the "Find Widgets" template. This template, which first shipped with Plasma Desktop v4.5, provides a function for finding widgets by name. It appears in the toolbar "Load" and "Use" menus in the Desktop Console in plasma-desktop, and makes finding widgets as simple as:

<code javascript>
var template = loadTemplate('org.kde.plasma-desktop.findWidgets')
template.findWidgets('systemtray')
</code>

==== Activity templates ====
Probably the most user visible use of templates are "Activity templates". The structure of Activity templates is similar to the other use of templates, but a few extra features are provided in the metadata.desktop file. Here is an example of such an activity template:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Activity Template
Icon=user-desktop
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-desktop
X-Plasma-ContainmentCategories=desktop
X-Plasma-ContainmentLayout-ExecuteOnCreation=dolphin $desktop, gwenview $pictures
X-Plasma-ContainmentLayout-ShowAsExisting=true
X-KDE-PluginInfo-Author=John Doe
X-KDE-PluginInfo-Email=john@doe.org
X-KDE-PluginInfo-Name=org.kde.plasma-desktop.CoolTemplate
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://john.doe.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

The layout itself is still created from the layout.js file as usual, but this template also shows as a precreated activity to the user thanks to the X-Plasma-ContainmentLayout-ShowAsExisting key. Additionally, it starts applications in the newly created activity using the X-Plasma-ContainmentLayout-ExecuteOnCreation key.

That key is a list of commands to execute, and it supports the following variables:
* $desktop
* $autostart
* $documents
* $music
* $video
* $downloads
* $pictures

They all expand into the path toward the user corresponding default folder.

== API ==

In addition to the normal ECMA Script API and the Qt-specific extensions (such as signal/slot support) provided by QtScript, the following API is provided for use by scripts.

All of the API below, unless otherwise noted with a version noticed, appear as below in the KDE Software Compilation v4.4.0 and later. API that is not noted as being part of a given class or object is part of the global namespace.

{{note|API compatibility is guaranteed from version to version starting with KDE Software Compilation v4.4.0.}}

=== Version Numbers ===

Starting with KDE SC 4.5, the version number of both the scripting API and the application is available to the script via the following read-only properties:

* ''String'' '''applicationVersion''': the version of the application, e.g. 0.3
* ''String'' '''platformVersion''': the version of the KDE Platform, e.g. 0.3
* ''number'' '''scriptingVersion''': the version of the scripting API; e.g. in KDE SC 4.5 this is 2

=== Activities ===
Activities are the desktop layer in a plasma-desktop session and may contain widgts. In sightly more technical terms, they are desktop containments. Activities can be created, enumerated, modified and destroyed.

New Activities can be created using the Activity constructor, like this:

var activity = new Activity("folderview")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file). See the documentation on the Containment object class below.

Read-only properties:
* ''Array[number]'' '''activityIds''': returns a list of integer ids of all existing Plasma activities
* ''Array[String]'' '''knownActivityTypes''': (scripting version >= 2) a list of types of activities that can be created. This is useful to check if an Activity type is available on the system before trying to construct one.

Functions:
* ''Activity'' '''activityById(number id)''': return an object representing the activity with the given id
* ''Activity'' '''activityForScreen(number screen[, number dekstop])''': returns an object representing the activity currently associated with the given screen and, optionally, the given desktop.
* ''Array[Activity]'' '''activities()''': returns an array of all activities that currently exist

=== Panels ===
Panels can be created, enumerated, modified and destroyed. A panel object combines both a containment as well as the container itself, allowing for full control of things such as where it appears on screen and the hiding features associated with them.

New Panels can be created using the Panel constructor, like this:

var panel = new Panel("dock")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file).

Read-only properties:
* ''Array[number]'' '''panelIds''': returns a list of integer ids of all existing Plasma panels
* ''Array[String]'' '''knownPanelTypes''': (scripting version >= 2) a list of types of panels that can be created. This is useful to check if a Panel type is available on the system before trying to construct one.

Functions:
* ''Panel'' '''panelById(int id)''': returns an object representing the Panel that matches the given id
* ''Array[Panels]'' '''panels()''': returns an array of all panels that currently exist

=== Activities and Panels ===
Activity and Panel objects, once created by the script, or as returned by activityById, activityForScreen,
or panelById) provide the following read-only properties:

* ''number'' '''id: the integer id of this activity
* ''String'' '''formFactor''': returns the form factor of the activity, e.g. "planar" for most desktop activities,"mediacenter" for media centers and either "horizontal" or "vertical" for panels.
* ''Array[number]'' '''widgetIds''': a list of integer ids of all the widgets in this Activity
* ''Array[String]'' '''configKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current configuration group
* ''Array[String]'' '''configGroups''': (scriptingVersion >= 2) a list of all the groups in the current configuration group
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group

as well as the following read/write properties:

* ''number'' '''desktop''': the virtual desktop this activity is associated with, or -1 for none
* ''number'' '''screen''': the screen this activity is associated with, or -1 for none
* ''String'' '''name''': the name of this activity
* ''String'' '''wallpaperPlugin''': (scriptingVersion >= 2) the wallpaper plugin to use with the Activity
* ''String'' '''wallpaperMode''': (scriptingVersion >= 2) the wallpaper plugin mode to use with the Activity
* ''Array[String]'' '''currentConfigGroup''': (scriptingVersion >= 2) the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

and the following methods:

* '''remove()''': deletes this activity and all widgets inside of it
* ''Widget'' '''widgetById(number id)''': returns an object representing the widget with the given id
* ''Widget'' '''addWidget(String name)''': adds a new widget to the activity; the name maps to the X-KDE-PluginInfo-Name= entry
in the widget's .desktop file
* ''Widget'' '''addWidget(Widget widget)''': adds an existing widget to this activity; useful for moving widgets between Activities and Panels
* '''showConfigurationInteface()''': shows the configuration user interface for this Activity or Panel on the screen
* '''readConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the config with default for the default value
* '''writeConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': (scriptingVersion >= 2) causes the Activity or Panel to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of panels and activities of the same type.
* ''Array[Widget]'' '''widgets([String type])''': (scriptingVersion >= 2) returns all the widgets in the Panel or Activity. If the optional type is specified, only widgets matching that type will be returned.

In addition to all of the above properties and functions, Panel objects also provide the folowing read/write properties:
* ''number'' '''length''': the number of pixels along the screen edge used
* ''number'' '''height''': the height (or for vertical panels, the width) of the panel
* ''String'' '''hiding''': the hiding mode of the panel, one of "none" (for no hiding), "autohide", "windowscover" or "windowsbelow"
* ''String'' '''alignment''': right, left or center alignment of the panel (for vertical panels, right corrsponds to top and left to bottom)
* ''String'' '''location''': returns the location of the activity (only relevant for Panels); valid values include "top", "bottom", "left", "right" and "floating"

=== Widgets ===
Widgets may be enumerated by calling the widgetIds property on a Activity or Panel object. With a widget id in hand, a Widget object can be retrieved by calling widgetById(id) on an Activity or Panel object. New Widgets can be created with add addWidget(String) function provided by Activity and Panel objects.

A list of all installed widget types can be retrieved the following read-only property:

* ''Array[String]'' '''knownWidgetTypes''' (scripting version >= 2)

A Widget object provides the following read-only properties:

* ''number'' '''id''': the id of the widget
* ''String'' '''type''': the plugin type of this widget
* ''Array[String]'' '''configKeys''': a list of all keys that are set in the current configuration
* ''Array[String]'' '''configGroups''': a list of all the groups in the current configuration
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

as well as the following read-write properties:

* ''Array[String]'' '''currentConfigGroup''': the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of widgets of the same type.
* ''QRectF'' '''geometry''': the geometry of the widget (settable)
* ''String'' '''globalShortcut''': the shortcut sequence (in the format used by QKeySequence, e.g. "Alt+F1") associated with this widget
* ''number'' '''index''': the layout index of the widget; in a Panel this corresponds to the order the widget appears in. Changing the value of the index will change the position of the widget in Panels and may do so in some Activities as well.

and the following methods:

* '''remove()''': deletes this widget
* '''readConfig(String key, any default)''': reads the value of key in the config with default
for the default value
* '''writeConfig(String key, any value)''': sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': causes the widget to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* '''showConfigurationInteface()''': shows the configuration user interface for this widget on the screen

==== Configuration keys ====
Here you find a list of common and most used configuration keys to use with '''writeConfig''' command.
===== Global configuration keys (keys that are likely to be applicable on all widgets) =====
* '''Share''' (true/false): Whether or not the widget is to be announces throughout the network (Share tab)

===== Digital clock (digital-clock) =====
* '''announceInterval''' (number ≥ 0): Interval in minutes that the time is read out loud
* '''calendarType''' (local/coptic/ethopian/gregorian/gregorian-proleptic/hebrew/hijri/indian-national/jalali/japanese/julian/minguo/thai): Calendar system to be used, defaults to local
* '''defaultTimezone''' (Local/…): Time zone to be used
* '''displayHolidays''' (true/false): Whether holidays are to be displayed
* '''holidayRegions''' (tbd): tbd
* '''holidayRegionaDaysOff''' (tbd): tbd
* '''plainClockColor''' (rrr,ggg,bbb): Color set for clock font (e. g. 192,0,0 - to be used with useCustomColor=true!)
* '''plainClockDrawShadow''' (true/false): Whether a shadow is to bed drawn (defaults to true)
* '''plainClockShadowColor''' (rrr,ggg,bbb): Color set for clock shadow (e. g. 64,97,128 - to be used with useCustomShadowColor=true!)
* '''plainClockFont''' (tbd): Font to be used for clock (e. g. Serif,12,-1,5,75,0,0,0,0,0)
* '''showDate''' (true/false): self-explanatory
* '''showDay''' (true/false): self-explanatory
* '''showSeconds''' (true/false): self-explanatory
* '''showTimezone''' (true/false): self-explanatory
* '''showYear''' (true/false): self-explanatory
* '''timeZones''' (Europe/Andorra,…): Comma-separated list of timezones to be used (e. g. Europe/Andorra,Indian/Antananarivo,Asia/Aqtau)
* '''useCustomColor''' (true/false): Whether or not a custom color is to be used (use with plainClockColor=rrr,ggg,bbb!)
* '''useCustomShadowColor''' (true/false): Whether or not a custom shadow color is to be used (use with plainClockShadowColor=rrr,ggg,bbb!)
===== Folderview (folderview) =====
* '''alignToGrid''' (true/false): self-explanatory
* '''customIconSize''' (16/22/24/32/48/…): Use custom icon size for files/folders (use only default/common icon sizes, powers of 2)
* '''customLabel''': Use custom title rather than default path or place name
* '''drawShadows''' (true/false): Whether or not file labels are to draw shadows
* '''filter''' (0/1/2): Defines whether a filter is to be used or not (0 = No filter, 1 = Show only matching files, 2 = Hide matching files)
* '''filterFiles''': Wildcard filter to filter file names
* '''mimeFilter''': Comma-separated list of mimetypes to be filtered (shown/hidden depends on filter-setting)
* '''iconsLocked''' (true/false): Whether or not icons can be moved
* '''numTextLines''' (number > 0): Amount of lines a file name can have before it is truncated
* '''url''': Folder URL to be displayed (e. g. desktop:/// or file:///home/yourusername)
* '''sortColumn''' (-1/0/1/2/3/4/5): The way files and folders are sorted (-1 = No sorting, 0 = By name, 1 = By size, 2 = By type, 3 = By date)
* '''sortDirsFirst''' (true/false): Whether or not folders are displayed before files (defaults to true)
* '''textColor''' (rrr,ggg,bbb): Color the icon labels will have
===== Kickoff menu (launcher) =====
* '''SwitchTabsOnHover''' (true/false): self-explanatory
* '''ShowAppsByName''' (true/false): Apps are sorted by name rather than by description
===== Taskbar (tasks) =====
* '''groupingStrategy''' (0/1/2): Defines how taskbar entries are to be grouped (0 = Never, 1 = Manually, 2 = By Program Name)
* '''groupWhenFull''' (true/false): Only group when taskbar is full (to be used with groupingStrategy=2 only!)
* '''highlightWindows''' (true/false): Highlight a window if your mouse cursor is hovering its taskbar entry (requires Desktop Compositing and “Highlight windows” effect enabled to work)
* '''maxRows''' (number > 0): Amount of rows taskbar entries can take
* '''forceRows''' (true/false): Force row setting for taskbar entries
* '''showOnlyCurrentActivity''' (true/false): Show only windows from current activity
* '''showOnlyCurrentDesktop''' (true/false): Show only windows from current virtual desktop
* '''showOnlyCurrentScreen''' (true/false): Show only windows from current screen (multi monitor setup)
* '''showTooltip''' (true/false): Whether or not tooltips are to be shown
* '''sortingStrategy''' (0/1/2/3): How taskbar entries are to be sorted (0 = Never, 1 = Manually, 2 = Alphabetically, 3 = By Desktop)

=== System Tray ===
The System Tray has some odd behaviors since it can host widgets and configuring it (i. e. add and remove widgets) is not as easy as above. This paragraph will help you deal with its specific behavior.
==== Generic Systemtray configuration keys ====
* '''DefaultAppletAdded''' (true/false): Remembers whether the default plasmoids (networkmanagement, device manager, notifications) have already been added(??)
* '''ShowApplicationStatus''' (true/false): Show system tray icons of applications that belong to the group “Applications”
* '''ShowCommunications''' (true/false): Show system tray icons of applications that belong to the group “Applications” (i. e. Messenger, IRC chat)
* '''ShowHardware''' (true/false): Show system tray icons of applications that belong to the group “Hardware” (i. e. volume control, printer applet)
* '''ShowSystemServices''' (true/false): Show system tray icons of applications that belong to the group “System Services” (i. e. Nepomuk Indexing Agent)
* '''ShowUnknown''' (true/false): Show system tray icons that do not belong into one of the categories mentioned above (or that do not use KDE’s system tray protocol and thus do not provide such information)
* '''alwaysShown''': Comma-separated list of widgets and entries that are to be shown all the time (e. g. KMix,notifier)
* '''hidden''': Comma-separated list of widgets and entries that are to be hidden all the time (e. g. Nepomuk Indexing Agent,Klipper,kmail)

===== Add a widget to systemtray =====
Unfortunately you cannot add widgets to the systemtray in a similar way like you would add them to a panel or containment using addWidget.
To add, manage and remove them, you need to utilize writeConfig changing the currentConfigGroup.
<code bash>systray = panel.addWidget("systemtray") // First add a systemtray to your panel
systray.currentConfigGroup = Array("Applets","0") // then change the currentConfig Group
// to the subnode [Applets][0]. Use any number you like(?)</code>
Now you can “create” the plasmoid by adding a “plugin” configuration entry
<code bash>systray.writeConfig("plugin","notifier") // This will add a Device Notifier Plasmoid</code>
You can modify the plasmoid’s configuration by using writeConfig.
<code bash>systray.writeConfig("property","value")</code>
To change back to the top configuration level and thus edit the systemtray plasmoid itself pass an empty array to currentConfigGroup.
===== Edit existing widgets in systemtray =====

===== Remove a widget from systemtray =====

=== Screen Geometry ===
Read-only properties:
* ''number'' '''screenCount''': returns the number of screens connected to the computer

Functions:
* ''QRectF'' '''screenGeometry(number screen)''': returns a rect object representing the geometry of a screen

=== Wallpaper Plugins ===

* ''Array[String => Array[String]]'' '''knownWallpaperPlugins()''': (scripting version >= 4) returns a list of all installed wallpaper plugins. They keys of the array are the wallpaper plugin names. The values are arrays containing the modes available for that wallpaper plugin. The mode array may be empty, as most wallpaper plugins only offer one mode.

=== Locating Applications and Paths ===
* ''boolean'' '''applicationExists(String name)''': (scripting version >= 4) searches $PATH first, then tries in the application menu system by application storage name (aka the .desktop file name), then Name= entries for apps with installed .desktop files, then GenericName= entries for same
* ''mixed'' '''defaultApplication(String kind [, boolean storageId = false])''': (scripting version >= 4) returns the executable (or if storageId is true, then the the app menu system id, e.g. its .desktop file name) of the default app. The "kind" parameter may be a well-known application type including "browser", "mailer", "filemanager", "terminal", "imClient" and "windowmanager" (or any other entry in share/apps/kcm_componentchooser/kcm_*.desktop); it may also be a mimetype (e.g. "application/pdf"). On failure, it returns false.
* ''String'' '''applicationPath(String name)''': (scripting version >= 4) returns the full local path to a given application or .desktop file if it exists.
* ''String'' '''userDataPath([String type, String path])''': (scripting version >= 4) returns the default path for user data. Called with no parameters, it returns the user's home directory. If only one string is passed in, the standard directory for that type of data in the user's home directory will be located; the following values are recognized:
** documents
** music
** video
** downloads
** pictures
** autostart
** desktop (should be considered deprecated for Plasma workspaces)

If a second string is passed in, it is considered a request for a specific path and the following types are recognized:
** apps - Applications menu (.desktop files).
** autostart - Autostart directories (both XDG and kde-specific)
** cache - Cached information (e.g. favicons, web-pages)
** cgi - CGIs to run from kdehelp.
** config - Configuration files.
** data - Where applications store data.
** emoticons - Emoticons themes
** exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
** html - HTML documentation.
** icon - Icons, see KIconLoader.
** kcfg - KConfigXT config files.
** lib - Libraries.
** locale - Translation files for KLocale.
** mime - Mime types defined by KDE-specific .desktop files.
** module - Module (dynamically loaded library).
** qtplugins - Qt plugins (dynamically loaded objects for Qt)
** services - Services.
** servicetypes - Service types.
** sound - Application sounds.
** templates - Templates for the "Create new file" functionality.
** wallpaper - Wallpapers.
** tmp - Temporary files (specific for both current host and current user)
** socket - UNIX Sockets (specific for both current host and current user)
** xdgconf-menu - Freedesktop.org standard location for menu layout (.menu) files.
** xdgdata-apps - Freedesktop.org standard location for application desktop files.
** xdgdata-dirs - Freedesktop.org standard location for menu descriptions (.directory files).
** xdgdata-mime - Freedesktop.org standard location for MIME type definitions.
** xdgdata-icon - Freedesktop.org standard location for icons.
** xdgdata-pixmap - Gnome-compatibility location for pixmaps.

The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").

=== Misc. Global Properties and Functions ===
Read-write properties:
* ''boolean'' '''locked''': whether the desktop shell and widgets are locked or not (settable)
* ''string'' '''theme''': (scripting version >= 3) the name of the desktop theme to use for the interface, e.g. default, Air, Oxygen, etc.

Read-only properties:
* ''boolean'' '''hasBattery''': whether or not the system has the ability to run on battery power, e.g. a laptop or mobile device
* ''boolean'' '''multihead''': (scripting version >= 3) true if the system is running with multiple screens in a "Xaphod" multiple display server configuration
* ''int'' '''multiheadScreen''': (scripting version >= 3) if multihead is true, contains the (real) screen id of the current screen

Functions:
* '''sleep(number ms)''': sleeps the script for the specified number of millseconds

=== QRectF ===
A rectangle class is also provided for use with Widget, Panel and screen geometry properties and functions.

Read-only properites:
* ''boolean'' '''empty''': true if the rectangle's width or height is less than, or equal to, 0; an empty rectangle is also invalid
* ''boolean'' '''null''': true if the rectangle has both the width and the height set to 0; a null rectangle is also empty and not valid
* ''boolean'' '''valid''': true if the rectangle has a width > 0 and height 0.

Read-write properties:
* ''number'' '''left'''
* ''number'' '''top'''
* ''number'' '''bottom'''
* ''number'' '''right'''
* ''number'' '''height'''
* ''number'' '''width'''
* ''number'' '''x'''
* ''number'' '''y'''

Constructors:
* '''QRectF'''
* '''QRectF(number x, number y, number width, number height)''': Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

Functions:
* '''adjust(number dx1, number dy1, number dx2, number dy2)''': adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle
* ''QRectF'' '''adjusted(number dx1, number dy1, number dx2, number dy2)''': returns a new QRectF with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of the rectangle
* '''translate(number dx, number dy)''': translates the rect by dx, dy
* '''setCoords(number x1, number y1, number x2, number y2)''': sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).
* '''setRect(number x, number y, number width, number height)''': sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.
* ''boolean'' '''contains(number x, number y)''': returns true if the rect contains the point (x, y)
* '''moveBottom(number delta)'': moves the bottom by delta pixels
* '''moveLeft(number delta)''': moves the left by delta pixels
* '''moveRight(number delta)''': moves the right by delta pixels
* '''moveTo(number x, number y)''': moves the top left of the rect to point (x, y)
* '''moveTop(number delta)''': moves the top by delta pixels

KDE System Administration/PlasmaDesktopScripting

2011-05-05T14:02:19Z

Broulik: Added list of configuration keys for folderview

== ECMA Script Interaction With Plasma Shells ==

It is possible to control and interact with a Plasma user interface shell such as a plasma-desktop or (starting in KDE SC 4.5) plasma-netbook session using ECMA Script (aka JavaScript). This scripting mechanism exposes containments (Desktop Activities and Panels), widgets and various other aspects of plasma-desktop configuration using the widely known and used ECMA Script language. The QtScript engine is used for the runtime environment.

This document describes the API that is provided along with how to
run such scripts in plasma-desktop.

== Examples ==

A set of examples can be found [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/plasma/javascript/plasma-shell-scripting here] that demonstrate the use of various aspects of Plasma shell scripting.

Contributions of additional examples are welcome and an be sent to the Plasma development mailing list (plasma-devel at kde.org) for inclusion if you do not have commit rights to the kdeexamples module.

== Running Scripts ==
There are three ways that scripts can be executed in plasma-desktop:

* '''on first run''': when plasma-desktop is started without any pre-existing configuration, any scripts in $APPDATA/plasma-desktop/init/ with a ".js" suffix are run. If there is more than one script, they are run sequentially in the alphabetical order of the file names.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''on update''': when plasma-desktop is started, it will check in
`kde4-config --path data`/plasma-desktop/updates/
with a ".js" suffix for scripts that have not yet been run. If there is more than one script which has not been run yet they will be executed serially in the alphabetical order of the file names.

A record of which update scripts have been run is kept in the application's config file in the [Updates] group. This means that if the plasma-desktop configuraiton file is removed, all the update scripts will be run again.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''interactively''': an interactive scripting dialog can be requested either via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "desktop console" as the search term. It can also be triggered directly via dbus with <code bash>qdbus org.kde.plasma-desktop /MainApplication showInteractiveConsole</code>

{{note|This method is not available for plasma-netbook.}}

:ECMA Script may be entered directly into this window for execution and output appears in the lower half of the window. Ctrl+E is a shortcut to run scripts, and scripts can be saved to and loaded from disk.

:Scripts from files can also be loaded using KRunner with "desktop console /path/to/file" or via dbus with
<code bash>qdbus org.kde.plasma-desktop /MainApplication loadScriptInInteractiveConsole /path/to/file</code>

== Templates ==

Templates are named packages that contain scripts. This provides a way for common functionality to be easily reused, helping to increase consistency and lower maintenance costs. Templates can be loaded from other scripts by name and they are also used to populate some parts of the user interface, such as the entries in the Add Panels menu.

A template is a small set of files in a specified file hierarchy (or, in Plasma terms, a "Package"). In particular, a Template package contains the following files:

* metadata.desktop: a .desktop file describing the template
* contents/layout.js: a Javascript file containing the actual script

Templates are stored under share/apps/plasma/layout-templates and may be installed using `plasmapkg -t layout-template -i /path/to/package`. Template packages may also be provided as a .zip file with a .plasmalayout suffix.

The metadata.desktop file contains the usual .desktop entries such as Name and Icon but must also contain Type=Service and ServiceTypes=Plasma/LayoutTemplate entries. If the layout is specific to a given Plasma application, such as plasma-desktop, this can be specific using X-Plasma-Shell. X-Plasma-ContainmentCategories defines what kind of layout it is with possible values being panel and desktop. Finally a X-KDE-PluginInfo-Name entry is required to provide a globally unique internal name for the Template. Here is an example of a Template that provides a Panel layout for Plasma Netbook:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Panel
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-netbook
X-Plasma-ContainmentCategories=panel
X-KDE-PluginInfo-Author=Aaron Seigo
X-KDE-PluginInfo-Email=aseigo@kde.org
X-KDE-PluginInfo-Name=org.kde.CoolNetbookPanel
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma.kde.org/
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

When running a template, two global variables will be accessible in read-only mode: templateName and templateComment. They will contain the Name and Comment fields of the above desktop file, and are translated if a localization is available.

=== Examples of Usage ===

==== Creating panels ====
A good example of the use of templates is the use case that triggered the creation of this feature: the desire to make it easy for users to re-create the default panel that is created on first start. There is a Template called org.kde.plasma-desktop.defaultPanel that ships with the KDE Plasma Workspace which contains the layout for the initial default panel. This is referenced by the default Plasma Desktop init script and, because it is marked as a Panel Template in the metadata.desktop file it also shows up to the user in the Add Panels menu. When selected by the user from the menu, the exact same panel that is created on desktop start up is created for them, complete with Plasma Widgets and configuration.

==== Automating tasks ====
Another example of the usefulness of templates is the "Find Widgets" template. This template, which first shipped with Plasma Desktop v4.5, provides a function for finding widgets by name. It appears in the toolbar "Load" and "Use" menus in the Desktop Console in plasma-desktop, and makes finding widgets as simple as:

<code javascript>
var template = loadTemplate('org.kde.plasma-desktop.findWidgets')
template.findWidgets('systemtray')
</code>

==== Activity templates ====
Probably the most user visible use of templates are "Activity templates". The structure of Activity templates is similar to the other use of templates, but a few extra features are provided in the metadata.desktop file. Here is an example of such an activity template:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Activity Template
Icon=user-desktop
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-desktop
X-Plasma-ContainmentCategories=desktop
X-Plasma-ContainmentLayout-ExecuteOnCreation=dolphin $desktop, gwenview $pictures
X-Plasma-ContainmentLayout-ShowAsExisting=true
X-KDE-PluginInfo-Author=John Doe
X-KDE-PluginInfo-Email=john@doe.org
X-KDE-PluginInfo-Name=org.kde.plasma-desktop.CoolTemplate
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://john.doe.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

The layout itself is still created from the layout.js file as usual, but this template also shows as a precreated activity to the user thanks to the X-Plasma-ContainmentLayout-ShowAsExisting key. Additionally, it starts applications in the newly created activity using the X-Plasma-ContainmentLayout-ExecuteOnCreation key.

That key is a list of commands to execute, and it supports the following variables:
* $desktop
* $autostart
* $documents
* $music
* $video
* $downloads
* $pictures

They all expand into the path toward the user corresponding default folder.

== API ==

In addition to the normal ECMA Script API and the Qt-specific extensions (such as signal/slot support) provided by QtScript, the following API is provided for use by scripts.

All of the API below, unless otherwise noted with a version noticed, appear as below in the KDE Software Compilation v4.4.0 and later. API that is not noted as being part of a given class or object is part of the global namespace.

{{note|API compatibility is guaranteed from version to version starting with KDE Software Compilation v4.4.0.}}

=== Version Numbers ===

Starting with KDE SC 4.5, the version number of both the scripting API and the application is available to the script via the following read-only properties:

* ''String'' '''applicationVersion''': the version of the application, e.g. 0.3
* ''String'' '''platformVersion''': the version of the KDE Platform, e.g. 0.3
* ''number'' '''scriptingVersion''': the version of the scripting API; e.g. in KDE SC 4.5 this is 2

=== Activities ===
Activities are the desktop layer in a plasma-desktop session and may contain widgts. In sightly more technical terms, they are desktop containments. Activities can be created, enumerated, modified and destroyed.

New Activities can be created using the Activity constructor, like this:

var activity = new Activity("folderview")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file). See the documentation on the Containment object class below.

Read-only properties:
* ''Array[number]'' '''activityIds''': returns a list of integer ids of all existing Plasma activities
* ''Array[String]'' '''knownActivityTypes''': (scripting version >= 2) a list of types of activities that can be created. This is useful to check if an Activity type is available on the system before trying to construct one.

Functions:
* ''Activity'' '''activityById(number id)''': return an object representing the activity with the given id
* ''Activity'' '''activityForScreen(number screen[, number dekstop])''': returns an object representing the activity currently associated with the given screen and, optionally, the given desktop.
* ''Array[Activity]'' '''activities()''': returns an array of all activities that currently exist

=== Panels ===
Panels can be created, enumerated, modified and destroyed. A panel object combines both a containment as well as the container itself, allowing for full control of things such as where it appears on screen and the hiding features associated with them.

New Panels can be created using the Panel constructor, like this:

var panel = new Panel("dock")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file).

Read-only properties:
* ''Array[number]'' '''panelIds''': returns a list of integer ids of all existing Plasma panels
* ''Array[String]'' '''knownPanelTypes''': (scripting version >= 2) a list of types of panels that can be created. This is useful to check if a Panel type is available on the system before trying to construct one.

Functions:
* ''Panel'' '''panelById(int id)''': returns an object representing the Panel that matches the given id
* ''Array[Panels]'' '''panels()''': returns an array of all panels that currently exist

=== Activities and Panels ===
Activity and Panel objects, once created by the script, or as returned by activityById, activityForScreen,
or panelById) provide the following read-only properties:

* ''number'' '''id: the integer id of this activity
* ''String'' '''formFactor''': returns the form factor of the activity, e.g. "planar" for most desktop activities,"mediacenter" for media centers and either "horizontal" or "vertical" for panels.
* ''Array[number]'' '''widgetIds''': a list of integer ids of all the widgets in this Activity
* ''Array[String]'' '''configKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current configuration group
* ''Array[String]'' '''configGroups''': (scriptingVersion >= 2) a list of all the groups in the current configuration group
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group

as well as the following read/write properties:

* ''number'' '''desktop''': the virtual desktop this activity is associated with, or -1 for none
* ''number'' '''screen''': the screen this activity is associated with, or -1 for none
* ''String'' '''name''': the name of this activity
* ''String'' '''wallpaperPlugin''': (scriptingVersion >= 2) the wallpaper plugin to use with the Activity
* ''String'' '''wallpaperMode''': (scriptingVersion >= 2) the wallpaper plugin mode to use with the Activity
* ''Array[String]'' '''currentConfigGroup''': (scriptingVersion >= 2) the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

and the following methods:

* '''remove()''': deletes this activity and all widgets inside of it
* ''Widget'' '''widgetById(number id)''': returns an object representing the widget with the given id
* ''Widget'' '''addWidget(String name)''': adds a new widget to the activity; the name maps to the X-KDE-PluginInfo-Name= entry
in the widget's .desktop file
* ''Widget'' '''addWidget(Widget widget)''': adds an existing widget to this activity; useful for moving widgets between Activities and Panels
* '''showConfigurationInteface()''': shows the configuration user interface for this Activity or Panel on the screen
* '''readConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the config with default for the default value
* '''writeConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': (scriptingVersion >= 2) causes the Activity or Panel to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of panels and activities of the same type.
* ''Array[Widget]'' '''widgets([String type])''': (scriptingVersion >= 2) returns all the widgets in the Panel or Activity. If the optional type is specified, only widgets matching that type will be returned.

In addition to all of the above properties and functions, Panel objects also provide the folowing read/write properties:
* ''number'' '''length''': the number of pixels along the screen edge used
* ''number'' '''height''': the height (or for vertical panels, the width) of the panel
* ''String'' '''hiding''': the hiding mode of the panel, one of "none" (for no hiding), "autohide", "windowscover" or "windowsbelow"
* ''String'' '''alignment''': right, left or center alignment of the panel (for vertical panels, right corrsponds to top and left to bottom)
* ''String'' '''location''': returns the location of the activity (only relevant for Panels); valid values include "top", "bottom", "left", "right" and "floating"

=== Widgets ===
Widgets may be enumerated by calling the widgetIds property on a Activity or Panel object. With a widget id in hand, a Widget object can be retrieved by calling widgetById(id) on an Activity or Panel object. New Widgets can be created with add addWidget(String) function provided by Activity and Panel objects.

A list of all installed widget types can be retrieved the following read-only property:

* ''Array[String]'' '''knownWidgetTypes''' (scripting version >= 2)

A Widget object provides the following read-only properties:

* ''number'' '''id''': the id of the widget
* ''String'' '''type''': the plugin type of this widget
* ''Array[String]'' '''configKeys''': a list of all keys that are set in the current configuration
* ''Array[String]'' '''configGroups''': a list of all the groups in the current configuration
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

as well as the following read-write properties:

* ''Array[String]'' '''currentConfigGroup''': the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of widgets of the same type.
* ''QRectF'' '''geometry''': the geometry of the widget (settable)
* ''String'' '''globalShortcut''': the shortcut sequence (in the format used by QKeySequence, e.g. "Alt+F1") associated with this widget
* ''number'' '''index''': the layout index of the widget; in a Panel this corresponds to the order the widget appears in. Changing the value of the index will change the position of the widget in Panels and may do so in some Activities as well.

and the following methods:

* '''remove()''': deletes this widget
* '''readConfig(String key, any default)''': reads the value of key in the config with default
for the default value
* '''writeConfig(String key, any value)''': sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': causes the widget to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* '''showConfigurationInteface()''': shows the configuration user interface for this widget on the screen

==== Configuration keys ====
Here you find a list of common and most used configuration keys to use with '''writeConfig''' command.
===== Global configuration keys (keys that are likely to be applicable on all widgets) =====
* '''Share''' (true/false): Whether or not the widget is to be announces throughout the network (Share tab)

===== Digital clock (digital-clock) =====
* '''announceInterval''' (number ≥ 0): Interval in minutes that the time is read out loud
* '''calendarType''' (local/coptic/ethopian/gregorian/gregorian-proleptic/hebrew/hijri/indian-national/jalali/japanese/julian/minguo/thai): Calendar system to be used, defaults to local
* '''defaultTimezone''' (Local/…): Time zone to be used
* '''displayHolidays''' (true/false): Whether holidays are to be displayed
* '''holidayRegions''' (tbd): tbd
* '''holidayRegionaDaysOff''' (tbd): tbd
* '''plainClockColor''' (rrr,ggg,bbb): Color set for clock font (e. g. 192,0,0 - to be used with useCustomColor=true!)
* '''plainClockDrawShadow''' (true/false): Whether a shadow is to bed drawn (defaults to true)
* '''plainClockShadowColor''' (rrr,ggg,bbb): Color set for clock shadow (e. g. 64,97,128 - to be used with useCustomShadowColor=true!)
* '''plainClockFont''' (tbd): Font to be used for clock (e. g. Serif,12,-1,5,75,0,0,0,0,0)
* '''showDate''' (true/false): self-explanatory
* '''showDay''' (true/false): self-explanatory
* '''showSeconds''' (true/false): self-explanatory
* '''showTimezone''' (true/false): self-explanatory
* '''showYear''' (true/false): self-explanatory
* '''timeZones''' (Europe/Andorra,…): Comma-separated list of timezones to be used (e. g. Europe/Andorra,Indian/Antananarivo,Asia/Aqtau)
* '''useCustomColor''' (true/false): Whether or not a custom color is to be used (use with plainClockColor=rrr,ggg,bbb!)
* '''useCustomShadowColor''' (true/false): Whether or not a custom shadow color is to be used (use with plainClockShadowColor=rrr,ggg,bbb!)
===== Folderview (folderview) =====
* '''alignToGrid''' (true/false): self-explanatory
* '''customIconSize''' (16/22/24/32/48/…): Use custom icon size for files/folders (use only default/common icon sizes, powers of 2)
* '''customLabel''': Use custom title rather than default path or place name
* '''drawShadows''' (true/false): Whether or not file labels are to draw shadows
* '''filter''' (0/1/2): Defines whether a filter is to be used or not (0 = No filter, 1 = Show only matching files, 2 = Hide matching files)
* '''filterFiles''': Wildcard filter to filter file names
* '''mimeFilter''': Comma-separated list of mimetypes to be filtered (shown/hidden depends on filter-setting)
* '''iconsLocked''' (true/false): Whether or not icons can be moved
* '''numTextLines''' (number > 0): Amount of lines a file name can have before it is truncated
* '''url''': Folder URL to be displayed (e. g. desktop:/// or file:///home/yourusername)
* '''sortColumn''' (-1/0/1/2/3/4/5): The way files and folders are sorted (-1 = No sorting, 0 = By name, 1 = By size, 2 = By type, 3 = By date)
* '''sortDirsFirst''' (true/false): Whether or not folders are displayed before files (defaults to true)
* '''textColor''' (rrr,ggg,bbb): Color the icon labels will have
===== Kickoff menu (launcher) =====
* '''SwitchTabsOnHover''' (true/false): self-explanatory
* '''ShowAppsByName''' (true/false): Apps are sorted by name rather than by description
===== Taskbar (tasks) =====
* '''groupingStrategy''' (0/1/2): Defines how taskbar entries are to be grouped (0 = Never, 1 = Manually, 2 = By Program Name)
* '''groupWhenFull''' (true/false): Only group when taskbar is full (to be used with groupingStrategy=2 only!)
* '''highlightWindows''' (true/false): Highlight a window if your mouse cursor is hovering its taskbar entry (requires Desktop Compositing and “Highlight windows” effect enabled to work)
* '''maxRows''' (number > 0): Amount of rows taskbar entries can take
* '''forceRows''' (true/false): Force row setting for taskbar entries
* '''showOnlyCurrentActivity''' (true/false): Show only windows from current activity
* '''showOnlyCurrentDesktop''' (true/false): Show only windows from current virtual desktop
* '''showOnlyCurrentScreen''' (true/false): Show only windows from current screen (multi monitor setup)
* '''showTooltip''' (true/false): Whether or not tooltips are to be shown
* '''sortingStrategy''' (0/1/2/3): How taskbar entries are to be sorted (0 = Never, 1 = Manually, 2 = Alphabetically, 3 = By Desktop)

=== System Tray ===
The System Tray has some odd behaviors since it can host widgets and configuring it (i. e. add and remove widgets) is not as easy as above. This paragraph will help you deal with its specific behavior.

=== Screen Geometry ===
Read-only properties:
* ''number'' '''screenCount''': returns the number of screens connected to the computer

Functions:
* ''QRectF'' '''screenGeometry(number screen)''': returns a rect object representing the geometry of a screen

=== Wallpaper Plugins ===

* ''Array[String => Array[String]]'' '''knownWallpaperPlugins()''': (scripting version >= 4) returns a list of all installed wallpaper plugins. They keys of the array are the wallpaper plugin names. The values are arrays containing the modes available for that wallpaper plugin. The mode array may be empty, as most wallpaper plugins only offer one mode.

=== Locating Applications and Paths ===
* ''boolean'' '''applicationExists(String name)''': (scripting version >= 4) searches $PATH first, then tries in the application menu system by application storage name (aka the .desktop file name), then Name= entries for apps with installed .desktop files, then GenericName= entries for same
* ''mixed'' '''defaultApplication(String kind [, boolean storageId = false])''': (scripting version >= 4) returns the executable (or if storageId is true, then the the app menu system id, e.g. its .desktop file name) of the default app. The "kind" parameter may be a well-known application type including "browser", "mailer", "filemanager", "terminal", "imClient" and "windowmanager" (or any other entry in share/apps/kcm_componentchooser/kcm_*.desktop); it may also be a mimetype (e.g. "application/pdf"). On failure, it returns false.
* ''String'' '''applicationPath(String name)''': (scripting version >= 4) returns the full local path to a given application or .desktop file if it exists.
* ''String'' '''userDataPath([String type, String path])''': (scripting version >= 4) returns the default path for user data. Called with no parameters, it returns the user's home directory. If only one string is passed in, the standard directory for that type of data in the user's home directory will be located; the following values are recognized:
** documents
** music
** video
** downloads
** pictures
** autostart
** desktop (should be considered deprecated for Plasma workspaces)

If a second string is passed in, it is considered a request for a specific path and the following types are recognized:
** apps - Applications menu (.desktop files).
** autostart - Autostart directories (both XDG and kde-specific)
** cache - Cached information (e.g. favicons, web-pages)
** cgi - CGIs to run from kdehelp.
** config - Configuration files.
** data - Where applications store data.
** emoticons - Emoticons themes
** exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
** html - HTML documentation.
** icon - Icons, see KIconLoader.
** kcfg - KConfigXT config files.
** lib - Libraries.
** locale - Translation files for KLocale.
** mime - Mime types defined by KDE-specific .desktop files.
** module - Module (dynamically loaded library).
** qtplugins - Qt plugins (dynamically loaded objects for Qt)
** services - Services.
** servicetypes - Service types.
** sound - Application sounds.
** templates - Templates for the "Create new file" functionality.
** wallpaper - Wallpapers.
** tmp - Temporary files (specific for both current host and current user)
** socket - UNIX Sockets (specific for both current host and current user)
** xdgconf-menu - Freedesktop.org standard location for menu layout (.menu) files.
** xdgdata-apps - Freedesktop.org standard location for application desktop files.
** xdgdata-dirs - Freedesktop.org standard location for menu descriptions (.directory files).
** xdgdata-mime - Freedesktop.org standard location for MIME type definitions.
** xdgdata-icon - Freedesktop.org standard location for icons.
** xdgdata-pixmap - Gnome-compatibility location for pixmaps.

The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").

=== Misc. Global Properties and Functions ===
Read-write properties:
* ''boolean'' '''locked''': whether the desktop shell and widgets are locked or not (settable)
* ''string'' '''theme''': (scripting version >= 3) the name of the desktop theme to use for the interface, e.g. default, Air, Oxygen, etc.

Read-only properties:
* ''boolean'' '''hasBattery''': whether or not the system has the ability to run on battery power, e.g. a laptop or mobile device
* ''boolean'' '''multihead''': (scripting version >= 3) true if the system is running with multiple screens in a "Xaphod" multiple display server configuration
* ''int'' '''multiheadScreen''': (scripting version >= 3) if multihead is true, contains the (real) screen id of the current screen

Functions:
* '''sleep(number ms)''': sleeps the script for the specified number of millseconds

=== QRectF ===
A rectangle class is also provided for use with Widget, Panel and screen geometry properties and functions.

Read-only properites:
* ''boolean'' '''empty''': true if the rectangle's width or height is less than, or equal to, 0; an empty rectangle is also invalid
* ''boolean'' '''null''': true if the rectangle has both the width and the height set to 0; a null rectangle is also empty and not valid
* ''boolean'' '''valid''': true if the rectangle has a width > 0 and height 0.

Read-write properties:
* ''number'' '''left'''
* ''number'' '''top'''
* ''number'' '''bottom'''
* ''number'' '''right'''
* ''number'' '''height'''
* ''number'' '''width'''
* ''number'' '''x'''
* ''number'' '''y'''

Constructors:
* '''QRectF'''
* '''QRectF(number x, number y, number width, number height)''': Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

Functions:
* '''adjust(number dx1, number dy1, number dx2, number dy2)''': adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle
* ''QRectF'' '''adjusted(number dx1, number dy1, number dx2, number dy2)''': returns a new QRectF with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of the rectangle
* '''translate(number dx, number dy)''': translates the rect by dx, dy
* '''setCoords(number x1, number y1, number x2, number y2)''': sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).
* '''setRect(number x, number y, number width, number height)''': sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.
* ''boolean'' '''contains(number x, number y)''': returns true if the rect contains the point (x, y)
* '''moveBottom(number delta)'': moves the bottom by delta pixels
* '''moveLeft(number delta)''': moves the left by delta pixels
* '''moveRight(number delta)''': moves the right by delta pixels
* '''moveTo(number x, number y)''': moves the top left of the rect to point (x, y)
* '''moveTop(number delta)''': moves the top by delta pixels

KDE System Administration/PlasmaDesktopScripting

2011-05-05T13:37:43Z

Broulik: Added list of configuration keys for taskbar

== ECMA Script Interaction With Plasma Shells ==

It is possible to control and interact with a Plasma user interface shell such as a plasma-desktop or (starting in KDE SC 4.5) plasma-netbook session using ECMA Script (aka JavaScript). This scripting mechanism exposes containments (Desktop Activities and Panels), widgets and various other aspects of plasma-desktop configuration using the widely known and used ECMA Script language. The QtScript engine is used for the runtime environment.

This document describes the API that is provided along with how to
run such scripts in plasma-desktop.

== Examples ==

A set of examples can be found [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/plasma/javascript/plasma-shell-scripting here] that demonstrate the use of various aspects of Plasma shell scripting.

Contributions of additional examples are welcome and an be sent to the Plasma development mailing list (plasma-devel at kde.org) for inclusion if you do not have commit rights to the kdeexamples module.

== Running Scripts ==
There are three ways that scripts can be executed in plasma-desktop:

* '''on first run''': when plasma-desktop is started without any pre-existing configuration, any scripts in $APPDATA/plasma-desktop/init/ with a ".js" suffix are run. If there is more than one script, they are run sequentially in the alphabetical order of the file names.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''on update''': when plasma-desktop is started, it will check in
`kde4-config --path data`/plasma-desktop/updates/
with a ".js" suffix for scripts that have not yet been run. If there is more than one script which has not been run yet they will be executed serially in the alphabetical order of the file names.

A record of which update scripts have been run is kept in the application's config file in the [Updates] group. This means that if the plasma-desktop configuraiton file is removed, all the update scripts will be run again.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''interactively''': an interactive scripting dialog can be requested either via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "desktop console" as the search term. It can also be triggered directly via dbus with <code bash>qdbus org.kde.plasma-desktop /MainApplication showInteractiveConsole</code>

{{note|This method is not available for plasma-netbook.}}

:ECMA Script may be entered directly into this window for execution and output appears in the lower half of the window. Ctrl+E is a shortcut to run scripts, and scripts can be saved to and loaded from disk.

:Scripts from files can also be loaded using KRunner with "desktop console /path/to/file" or via dbus with
<code bash>qdbus org.kde.plasma-desktop /MainApplication loadScriptInInteractiveConsole /path/to/file</code>

== Templates ==

Templates are named packages that contain scripts. This provides a way for common functionality to be easily reused, helping to increase consistency and lower maintenance costs. Templates can be loaded from other scripts by name and they are also used to populate some parts of the user interface, such as the entries in the Add Panels menu.

A template is a small set of files in a specified file hierarchy (or, in Plasma terms, a "Package"). In particular, a Template package contains the following files:

* metadata.desktop: a .desktop file describing the template
* contents/layout.js: a Javascript file containing the actual script

Templates are stored under share/apps/plasma/layout-templates and may be installed using `plasmapkg -t layout-template -i /path/to/package`. Template packages may also be provided as a .zip file with a .plasmalayout suffix.

The metadata.desktop file contains the usual .desktop entries such as Name and Icon but must also contain Type=Service and ServiceTypes=Plasma/LayoutTemplate entries. If the layout is specific to a given Plasma application, such as plasma-desktop, this can be specific using X-Plasma-Shell. X-Plasma-ContainmentCategories defines what kind of layout it is with possible values being panel and desktop. Finally a X-KDE-PluginInfo-Name entry is required to provide a globally unique internal name for the Template. Here is an example of a Template that provides a Panel layout for Plasma Netbook:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Panel
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-netbook
X-Plasma-ContainmentCategories=panel
X-KDE-PluginInfo-Author=Aaron Seigo
X-KDE-PluginInfo-Email=aseigo@kde.org
X-KDE-PluginInfo-Name=org.kde.CoolNetbookPanel
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma.kde.org/
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

When running a template, two global variables will be accessible in read-only mode: templateName and templateComment. They will contain the Name and Comment fields of the above desktop file, and are translated if a localization is available.

=== Examples of Usage ===

==== Creating panels ====
A good example of the use of templates is the use case that triggered the creation of this feature: the desire to make it easy for users to re-create the default panel that is created on first start. There is a Template called org.kde.plasma-desktop.defaultPanel that ships with the KDE Plasma Workspace which contains the layout for the initial default panel. This is referenced by the default Plasma Desktop init script and, because it is marked as a Panel Template in the metadata.desktop file it also shows up to the user in the Add Panels menu. When selected by the user from the menu, the exact same panel that is created on desktop start up is created for them, complete with Plasma Widgets and configuration.

==== Automating tasks ====
Another example of the usefulness of templates is the "Find Widgets" template. This template, which first shipped with Plasma Desktop v4.5, provides a function for finding widgets by name. It appears in the toolbar "Load" and "Use" menus in the Desktop Console in plasma-desktop, and makes finding widgets as simple as:

<code javascript>
var template = loadTemplate('org.kde.plasma-desktop.findWidgets')
template.findWidgets('systemtray')
</code>

==== Activity templates ====
Probably the most user visible use of templates are "Activity templates". The structure of Activity templates is similar to the other use of templates, but a few extra features are provided in the metadata.desktop file. Here is an example of such an activity template:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Activity Template
Icon=user-desktop
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-desktop
X-Plasma-ContainmentCategories=desktop
X-Plasma-ContainmentLayout-ExecuteOnCreation=dolphin $desktop, gwenview $pictures
X-Plasma-ContainmentLayout-ShowAsExisting=true
X-KDE-PluginInfo-Author=John Doe
X-KDE-PluginInfo-Email=john@doe.org
X-KDE-PluginInfo-Name=org.kde.plasma-desktop.CoolTemplate
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://john.doe.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

The layout itself is still created from the layout.js file as usual, but this template also shows as a precreated activity to the user thanks to the X-Plasma-ContainmentLayout-ShowAsExisting key. Additionally, it starts applications in the newly created activity using the X-Plasma-ContainmentLayout-ExecuteOnCreation key.

That key is a list of commands to execute, and it supports the following variables:
* $desktop
* $autostart
* $documents
* $music
* $video
* $downloads
* $pictures

They all expand into the path toward the user corresponding default folder.

== API ==

In addition to the normal ECMA Script API and the Qt-specific extensions (such as signal/slot support) provided by QtScript, the following API is provided for use by scripts.

All of the API below, unless otherwise noted with a version noticed, appear as below in the KDE Software Compilation v4.4.0 and later. API that is not noted as being part of a given class or object is part of the global namespace.

{{note|API compatibility is guaranteed from version to version starting with KDE Software Compilation v4.4.0.}}

=== Version Numbers ===

Starting with KDE SC 4.5, the version number of both the scripting API and the application is available to the script via the following read-only properties:

* ''String'' '''applicationVersion''': the version of the application, e.g. 0.3
* ''String'' '''platformVersion''': the version of the KDE Platform, e.g. 0.3
* ''number'' '''scriptingVersion''': the version of the scripting API; e.g. in KDE SC 4.5 this is 2

=== Activities ===
Activities are the desktop layer in a plasma-desktop session and may contain widgts. In sightly more technical terms, they are desktop containments. Activities can be created, enumerated, modified and destroyed.

New Activities can be created using the Activity constructor, like this:

var activity = new Activity("folderview")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file). See the documentation on the Containment object class below.

Read-only properties:
* ''Array[number]'' '''activityIds''': returns a list of integer ids of all existing Plasma activities
* ''Array[String]'' '''knownActivityTypes''': (scripting version >= 2) a list of types of activities that can be created. This is useful to check if an Activity type is available on the system before trying to construct one.

Functions:
* ''Activity'' '''activityById(number id)''': return an object representing the activity with the given id
* ''Activity'' '''activityForScreen(number screen[, number dekstop])''': returns an object representing the activity currently associated with the given screen and, optionally, the given desktop.
* ''Array[Activity]'' '''activities()''': returns an array of all activities that currently exist

=== Panels ===
Panels can be created, enumerated, modified and destroyed. A panel object combines both a containment as well as the container itself, allowing for full control of things such as where it appears on screen and the hiding features associated with them.

New Panels can be created using the Panel constructor, like this:

var panel = new Panel("dock")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file).

Read-only properties:
* ''Array[number]'' '''panelIds''': returns a list of integer ids of all existing Plasma panels
* ''Array[String]'' '''knownPanelTypes''': (scripting version >= 2) a list of types of panels that can be created. This is useful to check if a Panel type is available on the system before trying to construct one.

Functions:
* ''Panel'' '''panelById(int id)''': returns an object representing the Panel that matches the given id
* ''Array[Panels]'' '''panels()''': returns an array of all panels that currently exist

=== Activities and Panels ===
Activity and Panel objects, once created by the script, or as returned by activityById, activityForScreen,
or panelById) provide the following read-only properties:

* ''number'' '''id: the integer id of this activity
* ''String'' '''formFactor''': returns the form factor of the activity, e.g. "planar" for most desktop activities,"mediacenter" for media centers and either "horizontal" or "vertical" for panels.
* ''Array[number]'' '''widgetIds''': a list of integer ids of all the widgets in this Activity
* ''Array[String]'' '''configKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current configuration group
* ''Array[String]'' '''configGroups''': (scriptingVersion >= 2) a list of all the groups in the current configuration group
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group

as well as the following read/write properties:

* ''number'' '''desktop''': the virtual desktop this activity is associated with, or -1 for none
* ''number'' '''screen''': the screen this activity is associated with, or -1 for none
* ''String'' '''name''': the name of this activity
* ''String'' '''wallpaperPlugin''': (scriptingVersion >= 2) the wallpaper plugin to use with the Activity
* ''String'' '''wallpaperMode''': (scriptingVersion >= 2) the wallpaper plugin mode to use with the Activity
* ''Array[String]'' '''currentConfigGroup''': (scriptingVersion >= 2) the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

and the following methods:

* '''remove()''': deletes this activity and all widgets inside of it
* ''Widget'' '''widgetById(number id)''': returns an object representing the widget with the given id
* ''Widget'' '''addWidget(String name)''': adds a new widget to the activity; the name maps to the X-KDE-PluginInfo-Name= entry
in the widget's .desktop file
* ''Widget'' '''addWidget(Widget widget)''': adds an existing widget to this activity; useful for moving widgets between Activities and Panels
* '''showConfigurationInteface()''': shows the configuration user interface for this Activity or Panel on the screen
* '''readConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the config with default for the default value
* '''writeConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': (scriptingVersion >= 2) causes the Activity or Panel to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of panels and activities of the same type.
* ''Array[Widget]'' '''widgets([String type])''': (scriptingVersion >= 2) returns all the widgets in the Panel or Activity. If the optional type is specified, only widgets matching that type will be returned.

In addition to all of the above properties and functions, Panel objects also provide the folowing read/write properties:
* ''number'' '''length''': the number of pixels along the screen edge used
* ''number'' '''height''': the height (or for vertical panels, the width) of the panel
* ''String'' '''hiding''': the hiding mode of the panel, one of "none" (for no hiding), "autohide", "windowscover" or "windowsbelow"
* ''String'' '''alignment''': right, left or center alignment of the panel (for vertical panels, right corrsponds to top and left to bottom)
* ''String'' '''location''': returns the location of the activity (only relevant for Panels); valid values include "top", "bottom", "left", "right" and "floating"

=== Widgets ===
Widgets may be enumerated by calling the widgetIds property on a Activity or Panel object. With a widget id in hand, a Widget object can be retrieved by calling widgetById(id) on an Activity or Panel object. New Widgets can be created with add addWidget(String) function provided by Activity and Panel objects.

A list of all installed widget types can be retrieved the following read-only property:

* ''Array[String]'' '''knownWidgetTypes''' (scripting version >= 2)

A Widget object provides the following read-only properties:

* ''number'' '''id''': the id of the widget
* ''String'' '''type''': the plugin type of this widget
* ''Array[String]'' '''configKeys''': a list of all keys that are set in the current configuration
* ''Array[String]'' '''configGroups''': a list of all the groups in the current configuration
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

as well as the following read-write properties:

* ''Array[String]'' '''currentConfigGroup''': the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of widgets of the same type.
* ''QRectF'' '''geometry''': the geometry of the widget (settable)
* ''String'' '''globalShortcut''': the shortcut sequence (in the format used by QKeySequence, e.g. "Alt+F1") associated with this widget
* ''number'' '''index''': the layout index of the widget; in a Panel this corresponds to the order the widget appears in. Changing the value of the index will change the position of the widget in Panels and may do so in some Activities as well.

and the following methods:

* '''remove()''': deletes this widget
* '''readConfig(String key, any default)''': reads the value of key in the config with default
for the default value
* '''writeConfig(String key, any value)''': sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': causes the widget to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* '''showConfigurationInteface()''': shows the configuration user interface for this widget on the screen

==== Configuration keys ====
Here you find a list of common and most used configuration keys to use with '''writeConfig''' command.
===== Global configuration keys (keys that are likely to be applicable on all widgets) =====
* '''Share''' (true/false): Whether or not the widget is to be announces throughout the network (Share tab)

===== Digital clock (digital-clock) =====
* '''announceInterval''' (number ≥ 0): Interval in minutes that the time is read out loud
* '''calendarType''' (local/coptic/ethopian/gregorian/gregorian-proleptic/hebrew/hijri/indian-national/jalali/japanese/julian/minguo/thai): Calendar system to be used, defaults to local
* '''defaultTimezone''' (Local/…): Time zone to be used
* '''displayHolidays''' (true/false): Whether holidays are to be displayed
* '''holidayRegions''' (tbd): tbd
* '''holidayRegionaDaysOff''' (tbd): tbd
* '''plainClockColor''' (rrr,ggg,bbb): Color set for clock font (e. g. 192,0,0 - to be used with useCustomColor=true!)
* '''plainClockDrawShadow''' (true/false): Whether a shadow is to bed drawn (defaults to true)
* '''plainClockShadowColor''' (rrr,ggg,bbb): Color set for clock shadow (e. g. 64,97,128 - to be used with useCustomShadowColor=true!)
* '''plainClockFont''' (tbd): Font to be used for clock (e. g. Serif,12,-1,5,75,0,0,0,0,0)
* '''showDate''' (true/false): self-explanatory
* '''showDay''' (true/false): self-explanatory
* '''showSeconds''' (true/false): self-explanatory
* '''showTimezone''' (true/false): self-explanatory
* '''showYear''' (true/false): self-explanatory
* '''timeZones''' (Europe/Andorra,…): Comma-separated list of timezones to be used (e. g. Europe/Andorra,Indian/Antananarivo,Asia/Aqtau)
* '''useCustomColor''' (true/false): Whether or not a custom color is to be used (use with plainClockColor=rrr,ggg,bbb!)
* '''useCustomShadowColor''' (true/false): Whether or not a custom shadow color is to be used (use with plainClockShadowColor=rrr,ggg,bbb!)
===== Kickoff menu (launcher) =====
* '''SwitchTabsOnHover''' (true/false): self-explanatory
* '''ShowAppsByName''' (true/false): Apps are sorted by name rather than by description
===== Taskbar (tasks) =====
* '''groupingStrategy''' (0/1/2): Defines how taskbar entries are to be grouped (0 = Never, 1 = Manually, 2 = By Program Name)
* '''groupWhenFull''' (true/false): Only group when taskbar is full (to be used with groupingStrategy=2 only!)
* '''highlightWindows''' (true/false): Highlight a window if your mouse cursor is hovering its taskbar entry (requires Desktop Compositing and “Highlight windows” effect enabled to work)
* '''maxRows''' (number > 0): Amount of rows taskbar entries can take
* '''forceRows''' (true/false): Force row setting for taskbar entries
* '''showOnlyCurrentActivity''' (true/false): Show only windows from current activity
* '''showOnlyCurrentDesktop''' (true/false): Show only windows from current virtual desktop
* '''showOnlyCurrentScreen''' (true/false): Show only windows from current screen (multi monitor setup)
* '''showTooltip''' (true/false): Whether or not tooltips are to be shown
* '''sortingStrategy''' (0/1/2/3): How taskbar entries are to be sorted (0 = Never, 1 = Manually, 2 = Alphabetically, 3 = By Desktop)

=== System Tray ===
The System Tray has some odd behaviors since it can host widgets and configuring it (i. e. add and remove widgets) is not as easy as above. This paragraph will help you deal with its specific behavior.

=== Screen Geometry ===
Read-only properties:
* ''number'' '''screenCount''': returns the number of screens connected to the computer

Functions:
* ''QRectF'' '''screenGeometry(number screen)''': returns a rect object representing the geometry of a screen

=== Wallpaper Plugins ===

* ''Array[String => Array[String]]'' '''knownWallpaperPlugins()''': (scripting version >= 4) returns a list of all installed wallpaper plugins. They keys of the array are the wallpaper plugin names. The values are arrays containing the modes available for that wallpaper plugin. The mode array may be empty, as most wallpaper plugins only offer one mode.

=== Locating Applications and Paths ===
* ''boolean'' '''applicationExists(String name)''': (scripting version >= 4) searches $PATH first, then tries in the application menu system by application storage name (aka the .desktop file name), then Name= entries for apps with installed .desktop files, then GenericName= entries for same
* ''mixed'' '''defaultApplication(String kind [, boolean storageId = false])''': (scripting version >= 4) returns the executable (or if storageId is true, then the the app menu system id, e.g. its .desktop file name) of the default app. The "kind" parameter may be a well-known application type including "browser", "mailer", "filemanager", "terminal", "imClient" and "windowmanager" (or any other entry in share/apps/kcm_componentchooser/kcm_*.desktop); it may also be a mimetype (e.g. "application/pdf"). On failure, it returns false.
* ''String'' '''applicationPath(String name)''': (scripting version >= 4) returns the full local path to a given application or .desktop file if it exists.
* ''String'' '''userDataPath([String type, String path])''': (scripting version >= 4) returns the default path for user data. Called with no parameters, it returns the user's home directory. If only one string is passed in, the standard directory for that type of data in the user's home directory will be located; the following values are recognized:
** documents
** music
** video
** downloads
** pictures
** autostart
** desktop (should be considered deprecated for Plasma workspaces)

If a second string is passed in, it is considered a request for a specific path and the following types are recognized:
** apps - Applications menu (.desktop files).
** autostart - Autostart directories (both XDG and kde-specific)
** cache - Cached information (e.g. favicons, web-pages)
** cgi - CGIs to run from kdehelp.
** config - Configuration files.
** data - Where applications store data.
** emoticons - Emoticons themes
** exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
** html - HTML documentation.
** icon - Icons, see KIconLoader.
** kcfg - KConfigXT config files.
** lib - Libraries.
** locale - Translation files for KLocale.
** mime - Mime types defined by KDE-specific .desktop files.
** module - Module (dynamically loaded library).
** qtplugins - Qt plugins (dynamically loaded objects for Qt)
** services - Services.
** servicetypes - Service types.
** sound - Application sounds.
** templates - Templates for the "Create new file" functionality.
** wallpaper - Wallpapers.
** tmp - Temporary files (specific for both current host and current user)
** socket - UNIX Sockets (specific for both current host and current user)
** xdgconf-menu - Freedesktop.org standard location for menu layout (.menu) files.
** xdgdata-apps - Freedesktop.org standard location for application desktop files.
** xdgdata-dirs - Freedesktop.org standard location for menu descriptions (.directory files).
** xdgdata-mime - Freedesktop.org standard location for MIME type definitions.
** xdgdata-icon - Freedesktop.org standard location for icons.
** xdgdata-pixmap - Gnome-compatibility location for pixmaps.

The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").

=== Misc. Global Properties and Functions ===
Read-write properties:
* ''boolean'' '''locked''': whether the desktop shell and widgets are locked or not (settable)
* ''string'' '''theme''': (scripting version >= 3) the name of the desktop theme to use for the interface, e.g. default, Air, Oxygen, etc.

Read-only properties:
* ''boolean'' '''hasBattery''': whether or not the system has the ability to run on battery power, e.g. a laptop or mobile device
* ''boolean'' '''multihead''': (scripting version >= 3) true if the system is running with multiple screens in a "Xaphod" multiple display server configuration
* ''int'' '''multiheadScreen''': (scripting version >= 3) if multihead is true, contains the (real) screen id of the current screen

Functions:
* '''sleep(number ms)''': sleeps the script for the specified number of millseconds

=== QRectF ===
A rectangle class is also provided for use with Widget, Panel and screen geometry properties and functions.

Read-only properites:
* ''boolean'' '''empty''': true if the rectangle's width or height is less than, or equal to, 0; an empty rectangle is also invalid
* ''boolean'' '''null''': true if the rectangle has both the width and the height set to 0; a null rectangle is also empty and not valid
* ''boolean'' '''valid''': true if the rectangle has a width > 0 and height 0.

Read-write properties:
* ''number'' '''left'''
* ''number'' '''top'''
* ''number'' '''bottom'''
* ''number'' '''right'''
* ''number'' '''height'''
* ''number'' '''width'''
* ''number'' '''x'''
* ''number'' '''y'''

Constructors:
* '''QRectF'''
* '''QRectF(number x, number y, number width, number height)''': Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

Functions:
* '''adjust(number dx1, number dy1, number dx2, number dy2)''': adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle
* ''QRectF'' '''adjusted(number dx1, number dy1, number dx2, number dy2)''': returns a new QRectF with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of the rectangle
* '''translate(number dx, number dy)''': translates the rect by dx, dy
* '''setCoords(number x1, number y1, number x2, number y2)''': sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).
* '''setRect(number x, number y, number width, number height)''': sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.
* ''boolean'' '''contains(number x, number y)''': returns true if the rect contains the point (x, y)
* '''moveBottom(number delta)'': moves the bottom by delta pixels
* '''moveLeft(number delta)''': moves the left by delta pixels
* '''moveRight(number delta)''': moves the right by delta pixels
* '''moveTo(number x, number y)''': moves the top left of the rect to point (x, y)
* '''moveTop(number delta)''': moves the top by delta pixels

KDE System Administration/PlasmaDesktopScripting

2011-05-05T13:28:57Z

Broulik: Added list of configuration keys for kickoff and digital-clock

== ECMA Script Interaction With Plasma Shells ==

It is possible to control and interact with a Plasma user interface shell such as a plasma-desktop or (starting in KDE SC 4.5) plasma-netbook session using ECMA Script (aka JavaScript). This scripting mechanism exposes containments (Desktop Activities and Panels), widgets and various other aspects of plasma-desktop configuration using the widely known and used ECMA Script language. The QtScript engine is used for the runtime environment.

This document describes the API that is provided along with how to
run such scripts in plasma-desktop.

== Examples ==

A set of examples can be found [https://projects.kde.org/projects/kde/kdeexamples/repository/revisions/master/show/plasma/javascript/plasma-shell-scripting here] that demonstrate the use of various aspects of Plasma shell scripting.

Contributions of additional examples are welcome and an be sent to the Plasma development mailing list (plasma-devel at kde.org) for inclusion if you do not have commit rights to the kdeexamples module.

== Running Scripts ==
There are three ways that scripts can be executed in plasma-desktop:

* '''on first run''': when plasma-desktop is started without any pre-existing configuration, any scripts in $APPDATA/plasma-desktop/init/ with a ".js" suffix are run. If there is more than one script, they are run sequentially in the alphabetical order of the file names.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''on update''': when plasma-desktop is started, it will check in
`kde4-config --path data`/plasma-desktop/updates/
with a ".js" suffix for scripts that have not yet been run. If there is more than one script which has not been run yet they will be executed serially in the alphabetical order of the file names.

A record of which update scripts have been run is kept in the application's config file in the [Updates] group. This means that if the plasma-desktop configuraiton file is removed, all the update scripts will be run again.

{{note|For security reasons, scripts located in the user's home directory will '''not''' be run during this phase.}}

* '''interactively''': an interactive scripting dialog can be requested either via the KRunner window (Alt+F2, by default, or via the "Run Command" entry in various desktop menus) by entering "desktop console" as the search term. It can also be triggered directly via dbus with <code bash>qdbus org.kde.plasma-desktop /MainApplication showInteractiveConsole</code>

{{note|This method is not available for plasma-netbook.}}

:ECMA Script may be entered directly into this window for execution and output appears in the lower half of the window. Ctrl+E is a shortcut to run scripts, and scripts can be saved to and loaded from disk.

:Scripts from files can also be loaded using KRunner with "desktop console /path/to/file" or via dbus with
<code bash>qdbus org.kde.plasma-desktop /MainApplication loadScriptInInteractiveConsole /path/to/file</code>

== Templates ==

Templates are named packages that contain scripts. This provides a way for common functionality to be easily reused, helping to increase consistency and lower maintenance costs. Templates can be loaded from other scripts by name and they are also used to populate some parts of the user interface, such as the entries in the Add Panels menu.

A template is a small set of files in a specified file hierarchy (or, in Plasma terms, a "Package"). In particular, a Template package contains the following files:

* metadata.desktop: a .desktop file describing the template
* contents/layout.js: a Javascript file containing the actual script

Templates are stored under share/apps/plasma/layout-templates and may be installed using `plasmapkg -t layout-template -i /path/to/package`. Template packages may also be provided as a .zip file with a .plasmalayout suffix.

The metadata.desktop file contains the usual .desktop entries such as Name and Icon but must also contain Type=Service and ServiceTypes=Plasma/LayoutTemplate entries. If the layout is specific to a given Plasma application, such as plasma-desktop, this can be specific using X-Plasma-Shell. X-Plasma-ContainmentCategories defines what kind of layout it is with possible values being panel and desktop. Finally a X-KDE-PluginInfo-Name entry is required to provide a globally unique internal name for the Template. Here is an example of a Template that provides a Panel layout for Plasma Netbook:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Panel
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-netbook
X-Plasma-ContainmentCategories=panel
X-KDE-PluginInfo-Author=Aaron Seigo
X-KDE-PluginInfo-Email=aseigo@kde.org
X-KDE-PluginInfo-Name=org.kde.CoolNetbookPanel
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://plasma.kde.org/
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

When running a template, two global variables will be accessible in read-only mode: templateName and templateComment. They will contain the Name and Comment fields of the above desktop file, and are translated if a localization is available.

=== Examples of Usage ===

==== Creating panels ====
A good example of the use of templates is the use case that triggered the creation of this feature: the desire to make it easy for users to re-create the default panel that is created on first start. There is a Template called org.kde.plasma-desktop.defaultPanel that ships with the KDE Plasma Workspace which contains the layout for the initial default panel. This is referenced by the default Plasma Desktop init script and, because it is marked as a Panel Template in the metadata.desktop file it also shows up to the user in the Add Panels menu. When selected by the user from the menu, the exact same panel that is created on desktop start up is created for them, complete with Plasma Widgets and configuration.

==== Automating tasks ====
Another example of the usefulness of templates is the "Find Widgets" template. This template, which first shipped with Plasma Desktop v4.5, provides a function for finding widgets by name. It appears in the toolbar "Load" and "Use" menus in the Desktop Console in plasma-desktop, and makes finding widgets as simple as:

<code javascript>
var template = loadTemplate('org.kde.plasma-desktop.findWidgets')
template.findWidgets('systemtray')
</code>

==== Activity templates ====
Probably the most user visible use of templates are "Activity templates". The structure of Activity templates is similar to the other use of templates, but a few extra features are provided in the metadata.desktop file. Here is an example of such an activity template:

<code ini>
[Desktop Entry]
Encoding=UTF-8
Name=Cool Activity Template
Icon=user-desktop
Type=Service
ServiceTypes=Plasma/LayoutTemplate
X-Plasma-Shell=plasma-desktop
X-Plasma-ContainmentCategories=desktop
X-Plasma-ContainmentLayout-ExecuteOnCreation=dolphin $desktop, gwenview $pictures
X-Plasma-ContainmentLayout-ShowAsExisting=true
X-KDE-PluginInfo-Author=John Doe
X-KDE-PluginInfo-Email=john@doe.org
X-KDE-PluginInfo-Name=org.kde.plasma-desktop.CoolTemplate
X-KDE-PluginInfo-Version=1.0
X-KDE-PluginInfo-Website=http://john.doe.org
X-KDE-PluginInfo-Category=
X-KDE-PluginInfo-Depends=
X-KDE-PluginInfo-License=GPL
X-KDE-PluginInfo-EnabledByDefault=true
</code>

The layout itself is still created from the layout.js file as usual, but this template also shows as a precreated activity to the user thanks to the X-Plasma-ContainmentLayout-ShowAsExisting key. Additionally, it starts applications in the newly created activity using the X-Plasma-ContainmentLayout-ExecuteOnCreation key.

That key is a list of commands to execute, and it supports the following variables:
* $desktop
* $autostart
* $documents
* $music
* $video
* $downloads
* $pictures

They all expand into the path toward the user corresponding default folder.

== API ==

In addition to the normal ECMA Script API and the Qt-specific extensions (such as signal/slot support) provided by QtScript, the following API is provided for use by scripts.

All of the API below, unless otherwise noted with a version noticed, appear as below in the KDE Software Compilation v4.4.0 and later. API that is not noted as being part of a given class or object is part of the global namespace.

{{note|API compatibility is guaranteed from version to version starting with KDE Software Compilation v4.4.0.}}

=== Version Numbers ===

Starting with KDE SC 4.5, the version number of both the scripting API and the application is available to the script via the following read-only properties:

* ''String'' '''applicationVersion''': the version of the application, e.g. 0.3
* ''String'' '''platformVersion''': the version of the KDE Platform, e.g. 0.3
* ''number'' '''scriptingVersion''': the version of the scripting API; e.g. in KDE SC 4.5 this is 2

=== Activities ===
Activities are the desktop layer in a plasma-desktop session and may contain widgts. In sightly more technical terms, they are desktop containments. Activities can be created, enumerated, modified and destroyed.

New Activities can be created using the Activity constructor, like this:

var activity = new Activity("folderview")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file). See the documentation on the Containment object class below.

Read-only properties:
* ''Array[number]'' '''activityIds''': returns a list of integer ids of all existing Plasma activities
* ''Array[String]'' '''knownActivityTypes''': (scripting version >= 2) a list of types of activities that can be created. This is useful to check if an Activity type is available on the system before trying to construct one.

Functions:
* ''Activity'' '''activityById(number id)''': return an object representing the activity with the given id
* ''Activity'' '''activityForScreen(number screen[, number dekstop])''': returns an object representing the activity currently associated with the given screen and, optionally, the given desktop.
* ''Array[Activity]'' '''activities()''': returns an array of all activities that currently exist

=== Panels ===
Panels can be created, enumerated, modified and destroyed. A panel object combines both a containment as well as the container itself, allowing for full control of things such as where it appears on screen and the hiding features associated with them.

New Panels can be created using the Panel constructor, like this:

var panel = new Panel("dock")

The string passed into the constructor maps to the X-KDE-PluginInfo-Name= entry
in the plugin's .desktop file).

Read-only properties:
* ''Array[number]'' '''panelIds''': returns a list of integer ids of all existing Plasma panels
* ''Array[String]'' '''knownPanelTypes''': (scripting version >= 2) a list of types of panels that can be created. This is useful to check if a Panel type is available on the system before trying to construct one.

Functions:
* ''Panel'' '''panelById(int id)''': returns an object representing the Panel that matches the given id
* ''Array[Panels]'' '''panels()''': returns an array of all panels that currently exist

=== Activities and Panels ===
Activity and Panel objects, once created by the script, or as returned by activityById, activityForScreen,
or panelById) provide the following read-only properties:

* ''number'' '''id: the integer id of this activity
* ''String'' '''formFactor''': returns the form factor of the activity, e.g. "planar" for most desktop activities,"mediacenter" for media centers and either "horizontal" or "vertical" for panels.
* ''Array[number]'' '''widgetIds''': a list of integer ids of all the widgets in this Activity
* ''Array[String]'' '''configKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current configuration group
* ''Array[String]'' '''configGroups''': (scriptingVersion >= 2) a list of all the groups in the current configuration group
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group

as well as the following read/write properties:

* ''number'' '''desktop''': the virtual desktop this activity is associated with, or -1 for none
* ''number'' '''screen''': the screen this activity is associated with, or -1 for none
* ''String'' '''name''': the name of this activity
* ''String'' '''wallpaperPlugin''': (scriptingVersion >= 2) the wallpaper plugin to use with the Activity
* ''String'' '''wallpaperMode''': (scriptingVersion >= 2) the wallpaper plugin mode to use with the Activity
* ''Array[String]'' '''currentConfigGroup''': (scriptingVersion >= 2) the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

and the following methods:

* '''remove()''': deletes this activity and all widgets inside of it
* ''Widget'' '''widgetById(number id)''': returns an object representing the widget with the given id
* ''Widget'' '''addWidget(String name)''': adds a new widget to the activity; the name maps to the X-KDE-PluginInfo-Name= entry
in the widget's .desktop file
* ''Widget'' '''addWidget(Widget widget)''': adds an existing widget to this activity; useful for moving widgets between Activities and Panels
* '''showConfigurationInteface()''': shows the configuration user interface for this Activity or Panel on the screen
* '''readConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the config with default for the default value
* '''writeConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': (scriptingVersion >= 2) causes the Activity or Panel to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of panels and activities of the same type.
* ''Array[Widget]'' '''widgets([String type])''': (scriptingVersion >= 2) returns all the widgets in the Panel or Activity. If the optional type is specified, only widgets matching that type will be returned.

In addition to all of the above properties and functions, Panel objects also provide the folowing read/write properties:
* ''number'' '''length''': the number of pixels along the screen edge used
* ''number'' '''height''': the height (or for vertical panels, the width) of the panel
* ''String'' '''hiding''': the hiding mode of the panel, one of "none" (for no hiding), "autohide", "windowscover" or "windowsbelow"
* ''String'' '''alignment''': right, left or center alignment of the panel (for vertical panels, right corrsponds to top and left to bottom)
* ''String'' '''location''': returns the location of the activity (only relevant for Panels); valid values include "top", "bottom", "left", "right" and "floating"

=== Widgets ===
Widgets may be enumerated by calling the widgetIds property on a Activity or Panel object. With a widget id in hand, a Widget object can be retrieved by calling widgetById(id) on an Activity or Panel object. New Widgets can be created with add addWidget(String) function provided by Activity and Panel objects.

A list of all installed widget types can be retrieved the following read-only property:

* ''Array[String]'' '''knownWidgetTypes''' (scripting version >= 2)

A Widget object provides the following read-only properties:

* ''number'' '''id''': the id of the widget
* ''String'' '''type''': the plugin type of this widget
* ''Array[String]'' '''configKeys''': a list of all keys that are set in the current configuration
* ''Array[String]'' '''configGroups''': a list of all the groups in the current configuration
* ''Array[String]'' '''globalConfigKeys''': (scriptingVersion >= 2) a list of all keys that are set in the current global configuration group
* ''Array[String]'' '''globalConfigGroups''': (scriptingVersion >= 2) a list of all the groups in the current global configuration group
* ''String'' '''version''': (scriptingVersion >= 2) the version of the Activity or Panel

as well as the following read-write properties:

* ''Array[String]'' '''currentConfigGroup''': the current configuration group path, with each entry in the array representing a sub-group. This allows one to access trees of groups with code such as: widget.currentConfigGroup = new Array('topGroup', 'subGroupOfTopGroup'). An empty Array means the default (top-level) configuration group for the widget
* ''Array[String]'' '''currentGlobalConfigGroup''': (scriptingVersion >= 2) the current global configuration group path, with each entry in the array representing a sub-group, similar to currentConfigGroup. However, global configuration is shared by all instances of widgets of the same type.
* ''QRectF'' '''geometry''': the geometry of the widget (settable)
* ''String'' '''globalShortcut''': the shortcut sequence (in the format used by QKeySequence, e.g. "Alt+F1") associated with this widget
* ''number'' '''index''': the layout index of the widget; in a Panel this corresponds to the order the widget appears in. Changing the value of the index will change the position of the widget in Panels and may do so in some Activities as well.

and the following methods:

* '''remove()''': deletes this widget
* '''readConfig(String key, any default)''': reads the value of key in the config with default
for the default value
* '''writeConfig(String key, any value)''': sets key to value in the config
* '''readGlobalConfig(String key, any default)''': (scriptingVersion >= 2) reads the value of key in the global config with default
for the default value
* '''writeGlobalConfig(String key, any value)''': (scriptingVersion >= 2) sets key to value in the global config
* '''reloadConfig()''': causes the widget to reload its configuration; reaction to configuration changes made using readConfig are usually activated on script exit, but this can be triggered earlier on a per-widget basis using this method
* '''showConfigurationInteface()''': shows the configuration user interface for this widget on the screen

==== Configuration keys ====
Here you find a list of common and most used configuration keys to use with '''writeConfig''' command.
===== Global configuration keys (keys that are likely to be applicable on all widgets) =====
* '''Share''' (true/false): Whether or not the widget is to be announces throughout the network (Share tab)

===== Digital clock (digital-clock) =====
* '''announceInterval''' (number > 0): Interval in minutes that the time is read out loud
* '''calendarType''' (local/coptic/ethopian/gregorian/gregorian-proleptic/hebrew/hijri/indian-national/jalali/japanese/julian/minguo/thai): Calendar system to be used, defaults to local
* '''defaultTimezone''' (Local/…): Time zone to be used
* '''displayHolidays''' (true/false): Whether holidays are to be displayed
* '''holidayRegions''' (tbd): tbd
* '''holidayRegionaDaysOff''' (tbd): tbd
* '''plainClockColor''' (rrr,ggg,bbb): Color set for clock font (e. g. 192,0,0 - to be used with useCustomColor=true!)
* '''plainClockDrawShadow''' (true/false): Whether a shadow is to bed drawn (defaults to true)
* '''plainClockShadowColor''' (rrr,ggg,bbb): Color set for clock shadow (e. g. 64,97,128 - to be used with useCustomShadowColor=true!)
* '''plainClockFont''' (tbd): Font to be used for clock (e. g. Serif,12,-1,5,75,0,0,0,0,0)
* '''showDate''' (true/false): self-explanatory
* '''showDay''' (true/false): self-explanatory
* '''showSeconds''' (true/false): self-explanatory
* '''showTimezone''' (true/false): self-explanatory
* '''showYear''' (true/false): self-explanatory
* '''timeZones''' (Europe/Andorra,…): Comma-separated list of timezones to be used (e. g. Europe/Andorra,Indian/Antananarivo,Asia/Aqtau)
* '''useCustomColor''' (true/false): Whether or not a custom color is to be used (use with plainClockColor=rrr,ggg,bbb!)
* '''useCustomShadowColor''' (true/false): Whether or not a custom shadow color is to be used (use with plainClockShadowColor=rrr,ggg,bbb!)
===== Kickoff menu (launcher) =====
* '''SwitchTabsOnHover''' (true/false): self-explanatory
* '''ShowAppsByName''' (true/false): Apps are sorted by name rather than by description

=== System Tray ===
The System Tray has some odd behaviors since it can host widgets and configuring it (i. e. add and remove widgets) is not as easy as above. This paragraph will help you deal with its specific behavior.

=== Screen Geometry ===
Read-only properties:
* ''number'' '''screenCount''': returns the number of screens connected to the computer

Functions:
* ''QRectF'' '''screenGeometry(number screen)''': returns a rect object representing the geometry of a screen

=== Wallpaper Plugins ===

* ''Array[String => Array[String]]'' '''knownWallpaperPlugins()''': (scripting version >= 4) returns a list of all installed wallpaper plugins. They keys of the array are the wallpaper plugin names. The values are arrays containing the modes available for that wallpaper plugin. The mode array may be empty, as most wallpaper plugins only offer one mode.

=== Locating Applications and Paths ===
* ''boolean'' '''applicationExists(String name)''': (scripting version >= 4) searches $PATH first, then tries in the application menu system by application storage name (aka the .desktop file name), then Name= entries for apps with installed .desktop files, then GenericName= entries for same
* ''mixed'' '''defaultApplication(String kind [, boolean storageId = false])''': (scripting version >= 4) returns the executable (or if storageId is true, then the the app menu system id, e.g. its .desktop file name) of the default app. The "kind" parameter may be a well-known application type including "browser", "mailer", "filemanager", "terminal", "imClient" and "windowmanager" (or any other entry in share/apps/kcm_componentchooser/kcm_*.desktop); it may also be a mimetype (e.g. "application/pdf"). On failure, it returns false.
* ''String'' '''applicationPath(String name)''': (scripting version >= 4) returns the full local path to a given application or .desktop file if it exists.
* ''String'' '''userDataPath([String type, String path])''': (scripting version >= 4) returns the default path for user data. Called with no parameters, it returns the user's home directory. If only one string is passed in, the standard directory for that type of data in the user's home directory will be located; the following values are recognized:
** documents
** music
** video
** downloads
** pictures
** autostart
** desktop (should be considered deprecated for Plasma workspaces)

If a second string is passed in, it is considered a request for a specific path and the following types are recognized:
** apps - Applications menu (.desktop files).
** autostart - Autostart directories (both XDG and kde-specific)
** cache - Cached information (e.g. favicons, web-pages)
** cgi - CGIs to run from kdehelp.
** config - Configuration files.
** data - Where applications store data.
** emoticons - Emoticons themes
** exe - Executables in $prefix/bin. findExe() for a function that takes $PATH into account.
** html - HTML documentation.
** icon - Icons, see KIconLoader.
** kcfg - KConfigXT config files.
** lib - Libraries.
** locale - Translation files for KLocale.
** mime - Mime types defined by KDE-specific .desktop files.
** module - Module (dynamically loaded library).
** qtplugins - Qt plugins (dynamically loaded objects for Qt)
** services - Services.
** servicetypes - Service types.
** sound - Application sounds.
** templates - Templates for the "Create new file" functionality.
** wallpaper - Wallpapers.
** tmp - Temporary files (specific for both current host and current user)
** socket - UNIX Sockets (specific for both current host and current user)
** xdgconf-menu - Freedesktop.org standard location for menu layout (.menu) files.
** xdgdata-apps - Freedesktop.org standard location for application desktop files.
** xdgdata-dirs - Freedesktop.org standard location for menu descriptions (.directory files).
** xdgdata-mime - Freedesktop.org standard location for MIME type definitions.
** xdgdata-icon - Freedesktop.org standard location for icons.
** xdgdata-pixmap - Gnome-compatibility location for pixmaps.

The second parameter should be a specific resource to find the path to. An example might be userDataPath("data", "plasma-desktop").

=== Misc. Global Properties and Functions ===
Read-write properties:
* ''boolean'' '''locked''': whether the desktop shell and widgets are locked or not (settable)
* ''string'' '''theme''': (scripting version >= 3) the name of the desktop theme to use for the interface, e.g. default, Air, Oxygen, etc.

Read-only properties:
* ''boolean'' '''hasBattery''': whether or not the system has the ability to run on battery power, e.g. a laptop or mobile device
* ''boolean'' '''multihead''': (scripting version >= 3) true if the system is running with multiple screens in a "Xaphod" multiple display server configuration
* ''int'' '''multiheadScreen''': (scripting version >= 3) if multihead is true, contains the (real) screen id of the current screen

Functions:
* '''sleep(number ms)''': sleeps the script for the specified number of millseconds

=== QRectF ===
A rectangle class is also provided for use with Widget, Panel and screen geometry properties and functions.

Read-only properites:
* ''boolean'' '''empty''': true if the rectangle's width or height is less than, or equal to, 0; an empty rectangle is also invalid
* ''boolean'' '''null''': true if the rectangle has both the width and the height set to 0; a null rectangle is also empty and not valid
* ''boolean'' '''valid''': true if the rectangle has a width > 0 and height 0.

Read-write properties:
* ''number'' '''left'''
* ''number'' '''top'''
* ''number'' '''bottom'''
* ''number'' '''right'''
* ''number'' '''height'''
* ''number'' '''width'''
* ''number'' '''x'''
* ''number'' '''y'''

Constructors:
* '''QRectF'''
* '''QRectF(number x, number y, number width, number height)''': Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

Functions:
* '''adjust(number dx1, number dy1, number dx2, number dy2)''': adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle
* ''QRectF'' '''adjusted(number dx1, number dy1, number dx2, number dy2)''': returns a new QRectF with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of the rectangle
* '''translate(number dx, number dy)''': translates the rect by dx, dy
* '''setCoords(number x1, number y1, number x2, number y2)''': sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).
* '''setRect(number x, number y, number width, number height)''': sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.
* ''boolean'' '''contains(number x, number y)''': returns true if the rect contains the point (x, y)
* '''moveBottom(number delta)'': moves the bottom by delta pixels
* '''moveLeft(number delta)''': moves the left by delta pixels
* '''moveRight(number delta)''': moves the right by delta pixels
* '''moveTo(number x, number y)''': moves the top left of the rect to point (x, y)
* '''moveTop(number delta)''': moves the top by delta pixels