KDE TechBase - User contributions [en]

Projects/PIM

2013-04-29T15:50:56Z

Agateau: fix broken link to ML

KDE PIM is a package that contains personal information management tools.

The KDEPIM team develops the main application Kontact with all its plugins like KMail, KNode, KOrganizer, KAddressbook, Akregator, KJots and others.

To join the team, simply email the [https://mail.kde.org/mailman/listinfo/kde-pim kde-pim] mailing list, and join the irc://freenode.net/kontact IRC channel.

==Resources==
*[[/PIMsters | Who are we?]]
*[http://kdepim.kde.org Homepage of the KDE PIM]
*[http://kontact.kde.org/ Homepage of Kontact]
*[mailto:kdepim-users@kde.org kdepim-users@kde.org] mailing list (for users): [https://mail.kde.org/mailman/listinfo/kdepim-users subscribe], [http://lists.kde.org/?l=kdepim-users&r=1&w=2 archives]
*[mailto:kde-pim@kde.org kde-pim@kde.org] mailing list (for developers): [https://mail.kde.org/mailman/listinfo/kde-pim subscribe], [http://lists.kde.org/?l=kde-pim&r=1&w=2 archives]

==Development==
Much of the infrastructure of KDE PIM has been moved to kdepimlibs module as a framework for all KDE applications. Therefore we have two main modules within the KDE SVN: '''kdepim''' and '''kdepimlibs'''. The latter contains code that provides public APIs.

Current development focus as of January 2009 is on the Akonadi service and porting existing applications to Akonadi and KMime and other frameworks.

'''If you're looking into starting KMail development, have a look at the [[Projects/PIM/KMail Junior Jobs|list of KMail junior jobs]].'''

===Documentation===
The KMail handbook is currently being rewritten, for more information look at the [[Projects/Documentation/KDE4/kdepim/kmail|documentation wiki page]].
===KDE PIM 4===
*README documents stored in the KDE GIT:
:*kdepim:
::*[https://projects.kde.org/projects/kde/kdepim/repository/revisions/master/entry/README README]
::*[https://projects.kde.org/projects/kde/kdepim/repository/revisions/master/entry/kmail/HACKING KMail's HACKING file]

:*kdepimlibs
::*[https://projects.kde.org/projects/kde/kdepimlibs/repository/revisions/master/entry/README README]
::*[https://projects.kde.org/projects/kde/kdepimlibs/repository/revisions/master/entry/POLICIES POLICIES]
::*[https://projects.kde.org/projects/kde/kdepimlibs/repository/revisions/master/entry/PLAN PLAN]
*[http://api.kde.org/4.x-api/kdepimlibs-apidocs/ KDE PIM LIBS API Reference]
*[http://api.kde.org/4.x-api/kdepim-apidocs/ KDE PIM API Reference]
*[[/KDE 4-related bugs|List of KDE 4-specific bugs, regressions and junior jobs]]
*[[/KMail_SoC_regressions|List of regressions after the merge of the KMail SoC branch]]
*[[/MS Windows|MS Windows topics]]
*[[Development/Tutorials/Writing_kontact_plugins|Tutorial for writing a Kontact plugin]]

====Planning====
*[[Schedules/KDE4/4.2_Feature_Plan#kdepim|Feature Plan]] (see also [[Schedules/KDE4/4.2_Feature_Plan#kdepimlibs|KDEPIMlibs feature plan]])
*Akonadi: [[Projects/PIM/Akonadi|Feature Plan]], [http://lists.kde.org/?l=kde-pim&m=120216697126489&w=2 Osnabrück Meeting Notes]
*[[Projects/PIM/Ideas|Ideas]]:

===Other===
*[[/Development/SingleFileResourceRefactoring|SingleFileResource refactoring plan]]
* [[Projects/PIM/Mobile|KDE PIM for mobile devices]]

===KDE PIM 3===

The KDE PIM 3 branch is frozen and no longer actively maintained. Use the KDE 3 enterprise branch for a version of Kontact that is still being updated.

*[[/Features_3.5.9|New Features included with KDE 3.5.9]]
*[[/Installing the KDE PIM 3.5.5+ feature branch|Installing the KDE PIM 3.5.5+ feature branch]]

===Enterprise branches===
Kontact is the primary [http://kolab.org/ Kolab] client. There are different release cycles for the Kolab clients and for KDE, and therefore there are so-called enterprise branches in SVN where the Kolab versions are maintained. Changes in the enterprise branches are regularly merged back to SVN trunk.
The enterprise branches are maintained by [http://www.klaralvdalens-datakonsult.se/ KDAB].

More information about the enterprise branches can be found at:
*[http://websvn.kde.org/branches/kdepim/ KDEPIM branches in SVN (notably enterprise and enterprise4)]
*[http://wiki.kolab.org/index.php/Kontact_for_Windows_(beta-huge-debug) Kontact on Windows (enterprise4 branch)]
*[http://kolab.org/roadmap.html Roadmap for the Kolab clients]
*[http://kolab.org/download.html Downloads of the Kolab clients]
*[http://wiki.kolab.org/index.php/Kontact Kontact wiki page]
*[http://kolab.org/documentation.html Various Kolab documents]
*[[Development/Tools/svnmerge.py|Merge Tracking with svnmerge.py]]
*[[Projects/PIM/Enterprise_Translation_Howto|Enterprise Translation Howto]]

===Other Links===
*[http://techbase.kde.org/Category:PIM List of all KDE PIM related articles on TechBase]
*[[Projects/Oxygen/Missing_Icons#KDE_main_modules|Missing Icons in KDE PIM]]
*[http://www.englishbreakfastnetwork.org/krazy/index.php?component=kde-4.x&module=kdepimlibs KDE PIM libraries at the Krazy code checker]
*[http://www.englishbreakfastnetwork.org/krazy/index.php?component=kde-4.x&module=kdepim KDE PIM at the Krazy code checker]
*[http://cia.vc/stats/project/kde/kdepim KDE PIM on CIA]
*[http://cia.vc/account/bots/6503/ CIA commit bot for #kontact (account needed)]
*[http://cia.vc/account/bots/12872/ CIA commit bot for #akonadi (account needed)]
*[http://www.ohloh.net/p/kmail KMail on ohloh.net]
*[http://freshmeat.net/projects/kmail/ Totally outdated KMail freshmeat page]

*[http://forum.kde.org/office-personal-information-management-f-20.html KDE PIM in the KDE forums]
*[http://userbase.kde.org/Applications/Office#Kontact KDE PIM on UserBase]
*[http://userbase.kde.org/Tutorials#In_Kontact KDE PIM tutorials on UserBase]
*[http://en.wikipedia.org/wiki/KDE_Personal_Information_Management KDE PIM on Wikipedia]

===PIM SoC 2008 projects===
*[[/RSS_framework_for_Akonadi|RSS framework for Akonadi]]
[[Category:PIM]]

===Technologies used in KDE PIM===

This list is quite incomplete.

* http://doc.trolltech.com/4.4/richtext.html - Used for the KMail composer. See also [http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKRichTextWidget.html KRichTextWidget].
* http://doc.trolltech.com/4.4/model-view-programming.html - Used throughout KDEPIM including KMail tree views etc.
* Akonadi: [[Projects/PIM/Akonadi|Wiki]], [http://www.akonadi-project.org/ Website], [http://download.akonadi-project.org/ Tarballs]

Projects/Nepomuk/QuickStart

2013-01-08T15:51:03Z

Agateau: typo--

<languages />
<translate>

== Scope of this page == 


This page serves as a very simple overview to '''Nepomuk'''. It focuses on getting started with '''Nepomuk''' and tries not to deal with internal '''Nepomuk''' concepts. Please keep in the mind that the processes described here are targeted to the general use case. If you have a more specialized use case in mind, this might not be the best way to use the '''Nepomuk''' libraries.

==Libraries and Headers== 


Most of the non graphic parts of '''Nepomuk''' are present in the [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core NepomukCore repository]. It is shipped with KDE 4.9, and should be provided by your distribution. When starting with '''Nepomuk''' development, it would be better to stick with your distribution version.


With KDE 4.9, the '''Nepomuk''' libraries moved to the Nepomuk2 namespace. The headers also follow a similar convention.

=== Headers === 


All the '''Nepomuk''' headers in are preceded by Nepomuk2. Here are some common '''Nepomuk''' includes that are frequently used -


<syntaxhighlight lang="cpp-qt">
#include <Nepomuk2/Tag>
#include <Nepomuk2/Resource>
#include <Nepomuk2/ResourceManager>
#include <Nepomuk2/File>
</syntaxhighlight>

=== CMake === 


KDE Projects generally use cmake as a build tool. '''Nepomuk''' is no different. In order to use '''Nepomuk''' you need to add the relevant macros for '''Nepomuk''' in your CMakeLists.txt.


<syntaxhighlight lang="cmake">
find_package(NepomukCore REQUIRED)
target_link_libraries(myfile ${NEPOMUK_CORE_LIBRARY} )
</syntaxhighlight>

== Basic Terminology == 


At the lowest level '''Nepomuk''' is just a database which many applications use to store data. The main difference is that the data is not stored in rows and columns like traditional relational databases. Instead '''Nepomuk''' can be viewed as something similar to an object or document store. We store a large number of objects, and each of these objects have (key, value) pairs attached to them.


Each object in our database is called a Resource. Everything in '''Nepomuk''' revolves around resources. All the higher level concepts such as files, tags, contacts, music albums, actors, etc. they are all Resources. Each of these resources has a number of (key, value) pairs associated with it. In the '''Nepomuk''' world, the keys are called properties or predicates, and have already been defined.


'''Nepomuk''' is also based around a concept called the Semantic Web. However, understanding the ideas and details behind the Semantic Web is not necessary.

== Tags and Ratings == 


Every tag in '''Nepomuk''' is a Resource. In fact the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Tag.html Tag class] is also derived from the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html Resource class].

=== Setting Tags === 


<syntaxhighlight lang="cpp-qt">
Nepomuk2::Tag tag( "Awesome-Tag-Name" );
Nepomuk2::Resource res( url );
res.addTag( tag );
</syntaxhighlight>


The [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Tag.html <tt>Nepomuk2::Tag</tt>] class will automatically look for a tag called "Awesome-Tag-Name", if it finds it then [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a3c58ca2096f8424e12f31ddd73369597 Tag::exists()] will return true. Otherwise, the tag will be saved the first time the tag is used. In our case, when we add the tag to the Resource via [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a649e935b3557d0c5015ab7728f623f66 Resource::addTag()], the tag will be saved.

=== Retrieving Tags === 


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


Resource res( url );
QList<Tag> tags = res.tags();
foreach(const Tag& tag, tags)
kDebug() << tag.genericLabel();
</syntaxhighlight>


Every resource has a predefined function for retrieving all the Tags any resource is tagged with - [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a286c2e37f975e58e38aaa83903040910 Resource::tags()]. The [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#ad8d16485bdc9788de60bf5784141bcac Resource::genericLabel()] function tries to find a presentable name for any resource. In the case of tags, it returns the tags name.

=== Listing Tags === 


The simplest way to list all the tags that are present in '''Nepomuk''' is via a static function - [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Tag.html#a03bc6a42a14003aca17e8c3e02f43d17 Tag::allTags()]. You, however, need to be careful using this in a production environment as it executes a blocking query in the background. Depending on the number of tags on the system, it could take some time.


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


QList<Tag> tags = Tag::allTags();
foreach(const Tag& tag, tags)
kDebug() << tag.genericLabel();
</syntaxhighlight>


There are also convenience functions to list all the resources that have been assigned a particular tag - [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Tag.html#a04256e4dda504e5b021afcab0ba4b714 Tag::tagOf]


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


Tag tag("Awesome-Tag-Name");
QList<Resource> taggedResources = tag.tagOf();


foreach(const Resource& res, taggedResources)
kDebug() << res.genericLabel();
</syntaxhighlight>

=== Ratings === 


Every resource in Nepomuk can be given a numeric rating. It is generally done on a scale of 0-10.


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


File fileRes( urlOfTheFile );
int rating = fileRes.rating();


rating = rating + 1;
fileRes.setRating( rating );
</syntaxhighlight>

== Dealing with files == 


Every file in Nepomuk is represented as a resource. Since dealing with files is very common, we provide a special [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1File.html File class] which is derived from the Resource class. We also provide convenience functions for checking if a resource is a file.


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


File fileRes( urlOfTheFile );
kDebug() << fileRes.url();


Resource res( urlOfTheFile );
if( res.isFile() )
kDebug() << res.toFile().url();


</syntaxhighlight>


Internally Nepomuk Files are not very different from other Resources.

== Working Example == 


We understand that using a new framework such as '''Nepomuk''' can be quite intimidating at times. Therefore, we though it would be nice to have a working example for you to get started with - [http://quickgit.kde.org/index.php?p=kdeexamples.git&a=tree&h=eddcb1707a9e600db49fafdcb5ed8e8a195bcaba&hb=80a322af2bc5975c01c704173e937ccb8df605e3&f=nepomuk%2Ftest kdeexamples/nepomuk/test]. This example does nothing but it creates an executable called <code>nepomuk-test</code>. It serves as a simple starting point to '''Nepomuk''' where all the boiler plate code has been taken care of.


[[Category: Documentation]]
[[Category: Development]]
[[Category: Tutorials]]
</translate>

Projects/Nepomuk/QuickStart

2013-01-08T15:12:33Z

Agateau: typo--

<languages />
<translate>

== Scope of this page == 


This page serves as a very simple overview to '''Nepomuk'''. It focuses on getting started with '''Nepomuk''' and tries not to deal with internal '''Nepomuk''' concepts. Please keep in the mind that the processes described here are targeted to the general use case. If you have a more specialized use case in mind, this might not be the best way to use the '''Nepomuk''' libraries.

==Libraries and Headers== 


Most of the non graphic parts of '''Nepomuk''' are present in the [https://projects.kde.org/projects/kde/kdelibs/nepomuk-core NepomukCore repository]. It is shipped with KDE 4.9, and should be provided by your distribution. When starting with '''Nepomuk''' development, it would be better to stick with your distribution version.


With KDE 4.9, the '''Nepomuk''' libraries moved to the Nepomuk2 namespace. The headers also follow a similar convention.

=== Headers === 


All the '''Nepomuk''' headers in are preceded by Nepomuk2. Here are some common '''Nepomuk''' includes that are frequently used -


<syntaxhighlight lang="cpp-qt">
#include <Nepomuk2/Tag>
#include <Nepomuk2/Resource>
#include <Nepomuk2/ResourceManager>
#include <Nepomuk2/File>
</syntaxhighlight>

=== CMake === 


KDE Projects generally use cmake as a build tool. '''Nepomuk''' is no different. In order to use '''Nepomuk''' you need to add the relevant macros for '''Nepomuk''' in your CMakeLists.txt.


<syntaxhighlight lang="cmake">
find_package(NepomukCore REQUIRED)
target_link_libraries(myfile ${NEPOMUK_CORE_LIBRARY} )
</syntaxhighlight>

== Basic Terminology == 


At the lowest level '''Nepomuk''' is just a database which many applications use to store data. The main difference is that the data is not stored in rows and columns like traditional relational databases. Instead '''Nepomuk''' can be viewed as something similar to an object or document store. We store a large number of objects, and each of these objects have (key, value) pairs attached to them.


Each object in our database is called a Resource. Everything in '''Nepomuk''' revolves around resources. All the higher level concepts such as files, tags, contacts, music albums, actors, etc. they are all Resources. Each of these resources has a number of (key, value) pairs associated with it. In the '''Nepomuk''' world, the keys are called properties or predicates, and have already been defined.


'''Nepomuk''' is also based around a concept called the Semantic Web. However, understanding the ideas and details behind the Semantic Web is not necessary.

== Tags and Ratings == 


Every tag in '''Nepomuk''' is a Resource. In fact the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Tag.html Tag class] is also derived from the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html Resource class].

=== Setting Tags === 


<syntaxhighlight lang="cpp-qt">
Nepomuk2::Tag tag( "Awesome-Tag-Name" );
Nepomuk2::Resource res( url );
res.addTag( tag );
</syntaxhighlight>


The [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Tag.html <tt>Nepomuk2::Tag</tt>] class will automatically look for a tag called "Awesome-Tag-Name", if it finds it then [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a3c58ca2096f8424e12f31ddd73369597 Tag::exists()] will return true. Otherwise, the tag will be saved the first time the tag is used. In our case, when we add the tag to the Resource via [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a649e935b3557d0c5015ab7728f623f66 Resource::addTag()], the tag will be saved.

=== Retrieving Tags === 


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


Resource res( url );
QList<Tag> tags = res.tags();
foreach(const Tag& tag, tags)
kDebug() << tag.genericLabel();
</syntaxhighlight>


Every resource has a predefined function for retrieving all the Tags any resource is tagged with - [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a286c2e37f975e58e38aaa83903040910 Resource::tags()]. The [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#ad8d16485bdc9788de60bf5784141bcac Resource::genericLabel()] function tries to find a presentable name for any resource. In the case of tags, it returns the tags name.

=== Listing Tags === 


The simplest way to list all the tags that are present in '''Nepomuk''' is via a static function - [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Tag.html#a03bc6a42a14003aca17e8c3e02f43d17 Tag::allTags()]. You, however, need to be careful using this in a production environment as it executes a blocking query in the background. Depending on the number of tags on the system, it could take some time.


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


QList<Tag> tags = Tag::allTags();
foreach(const Tag& tag, tags)
kDebug() << tag.genericLabel();
</syntaxhighlight>


There are also convenience functions to list all the resources that have been assigned a particular tag - [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Tag.html#a04256e4dda504e5b021afcab0ba4b714 Tag::tagOf]


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


Tag tag("Awesome-Tag-Name");
QList<Resoruce> taggedResources = tag.tagOf();


foreach(const Resource& res, taggedResources)
kDebug() << res.genericLabel();
</syntaxhighlight>

=== Ratings === 


Every resource in Nepomuk can be given a numeric rating. It is generally done on a scale of 0-10.


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


File fileRes( urlOfTheFile );
int rating = fileRes.rating();


rating = rating + 1;
fileRes.setRating( rating );
</syntaxhighlight>

== Dealing with files == 


Every file in Nepomuk is represented as a resource. Since dealing with files is very common, we provide a special [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1File.html File class] which is derived from the Resource class. We also provide convenience functions for checking if a resource is a file.


<syntaxhighlight lang="cpp-qt">
using namespace Nepomuk2;


File fileRes( urlOfTheFile );
kDebug() << fileRes.url();


Resource res( urlOfTheFile );
if( res.isFile() )
kDebug() << res.toFile().url();


</syntaxhighlight>


Internally Nepomuk Files are not very different from other Resources.

== Working Example == 


We understand that using a new framework such as '''Nepomuk''' can be quite intimidating at times. Therefore, we though it would be nice to have a working example for you to get started with - [http://quickgit.kde.org/index.php?p=kdeexamples.git&a=tree&h=eddcb1707a9e600db49fafdcb5ed8e8a195bcaba&hb=80a322af2bc5975c01c704173e937ccb8df605e3&f=nepomuk%2Ftest kdeexamples/nepomuk/test]. This example does nothing but it creates an executable called <code>nepomuk-test</code>. It serves as a simple starting point to '''Nepomuk''' where all the boiler plate code has been taken care of.


[[Category: Documentation]]
[[Category: Development]]
[[Category: Tutorials]]
</translate>

Schedules/KDE4/4.10 Feature Plan

2012-11-21T15:01:25Z

Agateau: /* kdegraphics */ update gwenview features

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

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

= kde-runtime =

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

! Status
! Project
! Description
! Contact

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

= kde-workspace =

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

! Status
! Project
! Description
! Contact

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


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

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}
 

= kdeedu =

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

! Status
! Project
! Description
! Contact

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

= kdegames=

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

! Status
! Project
! Description
! Contact

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

= kdegraphics=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact

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

|}
 

= kdepim =

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

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

= kdeplasma-addons =

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

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

Getting Started/Using Project Neon to contribute to KDE

2012-11-20T14:54:01Z

Agateau: /* Using Project Neon version of KDE Workspace */ project-neon-session -> project-neon-base

[https://launchpad.net/project-neon Project Neon] is a nightly build of the latest KDE trunk for Ubuntu. It is an easy way for new contributors to KDE to get started without having to download and build the entire KDE source code tree. Additionally, dependencies are automatically handled and updated. This is suitable for new developers, translators, usability designers, documenters, promoters, bug triagers, etc. This process makes the steps detailed on [[Getting_Started/Build|this page]].

However, for developers, it may at some point become necessary to build more components from source code as you become more involved in the project. The [[Getting_Started/Build/kdesrc-build|kdesrc-build]] script is an easy way to build all or parts of KDE from its source code repositories.

== Requirements ==

Project Neon always requires either the latest stable Kubuntu release or the development release. Previous versions of Kubuntu are not supported.

== Installing Project Neon ==

To use Project Neon, add the following PPA (Personal Package Archive) to your <tt>sources.list</tt> using your preferred method:

<syntaxhighlight lang="bash">
sudo add-apt-repository ppa:neon/ppa
</syntaxhighlight>
or
<pre>
# Project neon nightly KDE4 build
deb http://ppa.launchpad.net/neon/ppa/ubuntu maverick main

#above repository is PGP signed, refer to below link for getting PGP key
https://launchpad.net/~neon/+archive/ppa
</pre>

After that, you can simply install the nightly package of whichever modules you want to work on. The packages are named project-neon-<git/svn module name>. The packages are installed in /opt/project-neon/ and won't affect your stable KDE install.

You can install all of the packages or just the ones you are interested in, depending on what you want to use them for.

=== Using Project Neon version of KDE Workspace ===

To use Project Neon version of KDE Workspace, install the <tt>project-neon-base</tt> package. You can then log out, select the "Project Neon" session in KDM session list and log in.

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-base
</syntaxhighlight>

You can also install other KDE Workspace goodies, such as extra plasmoids, with:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdeplasma-addons
</syntaxhighlight>

=== Testing individual applications ===

If you are only interested in application development in another module, you can install just the module package.

First install <tt>project-neon-utils</tt>. This package contains a number of utilities among which <tt>neon-env</tt>, which is needed to run Project Neon applications:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-utils
</syntaxhighlight>

You can then install the package for the module you are interested in. For example to test the latest version of kdepim applications:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdepim
</syntaxhighlight>

That command will also install the <tt>kdelibs</tt>, <tt>kdepimlibs</tt> and other dependencies too. In your regular (stable) KDE session you can now set up Project Neon environment and run the nightly version of your chosen application.

<syntaxhighlight lang="bash">
neon-env
kmail
</syntaxhighlight>

<tt>neon-env</tt> will setup the environment and start a subshell from which you can work with your project neon installation.
This will correctly use the nightly version of libraries instead of using the stable versions, so no other changes are necessary to your library path etc.
You'll need to close the terminal session for the settings to be undone.

Note that settings for applications that you run from project neon do not conflict with your regular application settings and data. <tt>.project-neon-kde/</tt> is used instead of <tt>.kde/</tt>

== Using Project Neon for development ==

If you are joining one of the development teams in KDE, you will need a real SVN/GIT checkout in order to contribute your code back to the project and create patches easily. If you only code for KDE every now and then, Project Neon provides some extra tools for this purpose in the package <tt>project-neon-utils</tt>:

NOTE: both neon-cmake and neonmake require neon-env to be run first!

* <tt>neon-env</tt> - sets up the necessary environment settings for project neon builds and opens a subshell.
* <tt>neon-cmake</tt> - cmake wrapper with neon environment settings for cmake, same synopsis as cmake and passes arguments to cmake
* <tt>neonmake</tt> - convenience script which will create a build folder, configure the source, build it and install it in /opt/project-neon/ so you can test your changes.
* <tt>neon-clean</tt> - script that resets any changes you made to /opt/project-neon after installing the packages. Since this script reinstalls the packages it might require a working internet connection.
* <tt>neonbuild</tt> - pbuilder/pdebuild wrapper to rebuild a neon package in a chroot. Takes the same options as pbuilder. If no pbuilder action is given pdebuild is run instead.

=== Options for cmake/make ===
You can change the cmake and make options used by setting these variables in ~/.neonrc:

* <tt>NEON_CMAKE_OPTS=""</tt> - Here you can add additional cmake options that should be used together with the default neon options.
* <tt>NEON_CMAKE_OVERRIDE=""</tt> - If you set this variable cmake will ignore the default neon options and only use the ones in NEON_CMAKE_OVERRIDE.
* <tt>NEON_MAKE_OVERRIDE=""</tt> - If you set this variable make in neonmake will only use your options. By default make uses '-j CPUs+1'

=== Debugging symbols ===
The debugging symbols for every package are in its corresponding <code>-dbg</code> package, so to install the debugging symbols for kdelibs you can use
<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdelibs-dbg
</syntaxhighlight>

If you are already using a nightly package of the module you want to develop for, you should remove that and checkout the development version. For example:

<pre>
# Remove the packaged nightly version
sudo apt-get purge project-neon-kdepim

# Add below Project Neon source code repository to sources.list if you didn't use add-apt-repository
deb-src http://ppa.launchpad.net/neon/ppa/ubuntu maverick main

# Get the dependencies for building kdepim
sudo apt-get build-dep project-neon-kdepim
cd ~
# You may choose to do your development in a different folder.
cd Development
# Gets the latest version of the kdepim module.
git clone git://anongit.kde.org/kdepim
cd kdepim
# Set up neon environment
neon-env
# Shortcut provided by Project Neon to make the module
# and install it to the prefix /opt/project-neon/
neonmake
</pre>

Note that you should usually checkout a module from KDE, not an application. Most modules contain libraries shared within the module and which are necessary to build the applications in the module.

Also note that when using apt-get build-dep it will always get all build-depends, so watch out that it doesn't install a component you want to build yourself as that would overwrite your changes should you install the packages after installing your build.

== Using Project Neon for translation ==

The Project Neon nightly packages include English language strings only. Translated packages are not available. However, if you are translating KDE applications, you can install the translations from KDE SVN in your normal workflow.

<syntaxhighlight lang="bash">
cd ~
cd Translations
# The -N switch checks out only the top level directory from svn.
svn co -N svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4
cd l10n-kde4
# scripts necessary to build translations.
svn up scripts
# Get the German translations
svn up de
# Generate the build files for the German language pack - if you get a message
# that revpath couldn't be found you need to install the xutils-dev package
./scripts/autogen.sh de
cd de
neon-env
neonmake
</syntaxhighlight>

After building the translations it is possible to either change the language in system settings, or run applications in another language using the environment variable <tt>KDE_LANG</tt>.

<syntaxhighlight lang="bash">
switchtonightly # or neon-env
KDE_LANG=de kmail
</syntaxhighlight>

Exit the shell to reset the settings.

== Using Project Neon for documentation ==

The Project Neon nightly source packages include the official KDE User Documentation in English.

TODO: How to build user docs from SVN.

== Using Project Neon for promotion ==

If you are creating screenshots or screencasts of the latest version of KDE, project Neon is a simple and fast way of getting a default KDE4 session.

The KDE Promotion team recommends using the default background, theme, icons etc when preparing official promotional materials (unless the feature you are showing is related to configuring KDE artwork). Project Neon uses the default artwork that comes with KDE4, so it is useful for creating promo materials.

Here is a shortcut to get all available modules from the PPA:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-all
</syntaxhighlight>

The application [http://ariya.blogspot.com/2008/06/creating-fancy-screenshots-with.html screenie] is provided since Kubuntu 8.10 as <tt>screenie-qt</tt>.

<syntaxhighlight lang="bash">
sudo apt-get install screenie-qt
</syntaxhighlight>

== Contact the Team ==

You can reach the Project Neon team on IRC in
<syntaxhighlight lang="text">#project-neon on irc.freenode.net</syntaxhighlight>
by mail at <syntaxhighlight lang="text">neon@lists.launchpad.net</syntaxhighlight>
or you can ask a question on [https://answers.launchpad.net/project-neon launchpad]

If you think there is a bug in our packaging of the provided software you can file a bug on [https://bugs.launchpad.net/project-neon launchpad]

[https://wiki.kubuntu.org/Kubuntu/ProjectNeon Team page in the Kubuntu Wiki]

Development/Tutorials/KIO Slaves/Hello World

2012-11-20T12:34:19Z

Agateau: /* Compile the stuff */ fix typo & use generic way to find Qt include dir

= Understanding =
A kioslave allows you to represent any kind of storage in a way you want. As an example, the kio_http kioslave loads data from the network over the http (protocol) and shows it rendered as html. Technically, a kioslave is a shared object plus its description. E.g. the imap4 kioslave consist of the following files:
<syntaxhighlight lang="text">
tweedleburg:/usr/local # find -iname "*imap4*"
./lib/kde4/kio_imap4.so
./share/kde4/services/imap4.protocol
</syntaxhighlight>

= The files =
We want to write a "hello world" kioslave here. This can be seen as a learning exercise and as a template for future programming projects.

== CMakeLists.txt ==
<syntaxhighlight lang="cmake">
PROJECT( tutorial )
FIND_PACKAGE(KDE4 REQUIRED)
INCLUDE_DIRECTORIES( ${KDE4_INCLUDES} . )

set(kio_hello_PART_SRCS
hello.cpp)

kde4_add_plugin(kio_hello ${kio_hello_PART_SRCS})

target_link_libraries(kio_hello ${KDE4_KIO_LIBS})

install(TARGETS kio_hello DESTINATION ${PLUGIN_INSTALL_DIR})

########### install files ###############

install(FILES hello.protocol DESTINATION ${SERVICES_INSTALL_DIR})
</syntaxhighlight>

== hello.h ==
<syntaxhighlight lang="cpp-qt">
#ifndef HELLO_H
#define HELLO_H

#include <kio/slavebase.h>

/**
This class implements a hello-world kioslave
*/
class hello : public KIO::SlaveBase
{
public:
hello( const QByteArray &pool, const QByteArray &app );
void get( const KUrl &url );
};

#endif
</syntaxhighlight>

== hello.cpp ==
<syntaxhighlight lang="cpp-qt">
#include "hello.h"
#include <kdebug.h>
#include <kcomponentdata.h>

extern "C" int KDE_EXPORT kdemain( int argc, char **argv )
{
kDebug(7000) << "Entering function";
KComponentData instance( "kio_hello" );

if (argc != 4)
{
fprintf( stderr, "Usage: kio_hello protocol domain-socket1 domain-socket2\n");
exit( -1 );
}
hello slave( argv[2], argv[3] );
slave.dispatchLoop();
return 0;
}

void hello::get( const KUrl &url )
{
kDebug(7000) << "Entering function";
mimeType( "text/plain" );
QByteArray str( "Hello_world" );
data( str );
finished();
kDebug(7000) << "Leaving function";
}

hello::hello( const QByteArray &pool, const QByteArray &app )
: SlaveBase( "hello", pool, app ) {}
</syntaxhighlight>

== hello.protocol ==
<syntaxhighlight lang="text">
[Protocol]
DocPath=kioslave/kio_hello.html
exec=kio_hello
input=none
output=filesystem
protocol=hello
reading=true
</syntaxhighlight>

== Compile the stuff ==
Create a new Folder "build":
<syntaxhighlight lang="bash">
mkdir build
cd build
</syntaxhighlight>
Run cmake and make
<syntaxhighlight lang="bash">
cmake ..
make
</syntaxhighlight>

now you can install it (maybe you should use an experimental setup?)
<syntaxhighlight lang="bash">
make install
</syntaxhighlight>

If you want to do this by hand:

<syntaxhighlight lang="bash">
g++ -shared -lkdeui -lkio -lkdecore -fPIC -I$(qmake -query QT_INSTALL_HEADERS) hello.cpp -o kio_hello.so
</syntaxhighlight>

== Install the stuff ==

Now you can install it (maybe you should use an experimental setup?):
<syntaxhighlight lang="bash">
make install
</syntaxhighlight>

or if you want to install it to your system:
<syntaxhighlight lang="bash">
sudo make install
</syntaxhighlight>

Of course you can also do this by hand.

Find out where your protocols are lying:
<syntaxhighlight lang="bash">
kde4-config --path services
/usr/share/kde4/services/

kde4-config --path module
/usr/lib64/kde4/

cp kio_hello.so /usr/local/lib/kde4/
cp kio_hello.so /usr/lib64/kde4/
cp kio_hello.protocol /usr/share/kde4/services/
</syntaxhighlight>

= Test it =
== In Konqueror ==
Start kinfocenter, choose hello as protocol. If this is possible, start konqueror, type hello:/// into the URL bar.
== On the command line ==
<syntaxhighlight lang="bash">
kioclient 'cat' 'hello:///'
</syntaxhighlight>

Getting Started/Using Project Neon to contribute to KDE

2012-11-19T17:17:40Z

Agateau: /* Installing Project Neon */ splitted "workspace" and "single-app" setup a bit more

[https://launchpad.net/project-neon Project Neon] is a nightly build of the latest KDE trunk for Ubuntu. It is an easy way for new contributors to KDE to get started without having to download and build the entire KDE source code tree. Additionally, dependencies are automatically handled and updated. This is suitable for new developers, translators, usability designers, documenters, promoters, bug triagers, etc. This process makes the steps detailed on [[Getting_Started/Build|this page]].

However, for developers, it may at some point become necessary to build more components from source code as you become more involved in the project. The [[Getting_Started/Build/kdesrc-build|kdesrc-build]] script is an easy way to build all or parts of KDE from its source code repositories.

== Requirements ==

Project Neon always requires either the latest stable Kubuntu release or the development release. Previous versions of Kubuntu are not supported.

== Installing Project Neon ==

To use Project Neon, add the following PPA (Personal Package Archive) to your <tt>sources.list</tt> using your preferred method:

<syntaxhighlight lang="bash">
sudo add-apt-repository ppa:neon/ppa
</syntaxhighlight>
or
<pre>
# Project neon nightly KDE4 build
deb http://ppa.launchpad.net/neon/ppa/ubuntu maverick main

#above repository is PGP signed, refer to below link for getting PGP key
https://launchpad.net/~neon/+archive/ppa
</pre>

After that, you can simply install the nightly package of whichever modules you want to work on. The packages are named project-neon-<git/svn module name>. The packages are installed in /opt/project-neon/ and won't affect your stable KDE install.

You can install all of the packages or just the ones you are interested in, depending on what you want to use them for.

=== Using Project Neon version of KDE Workspace ===

To use Project Neon version of KDE Workspace, install the <tt>project-neon-session</tt> package. You can then log out, select the "Project Neon" session in KDM session list and log in.

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-session
</syntaxhighlight>

You can also install other KDE Workspace goodies, such as extra plasmoids, with:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdeplasma-addons
</syntaxhighlight>

=== Testing individual applications ===

If you are only interested in application development in another module, you can install just the module package.

First install <tt>project-neon-utils</tt>. This package contains a number of utilities among which <tt>neon-env</tt>, which is needed to run Project Neon applications:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-utils
</syntaxhighlight>

You can then install the package for the module you are interested in. For example to test the latest version of kdepim applications:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdepim
</syntaxhighlight>

That command will also install the <tt>kdelibs</tt>, <tt>kdepimlibs</tt> and other dependencies too. In your regular (stable) KDE session you can now set up Project Neon environment and run the nightly version of your chosen application.

<syntaxhighlight lang="bash">
neon-env
kmail
</syntaxhighlight>

<tt>neon-env</tt> will setup the environment and start a subshell from which you can work with your project neon installation.
This will correctly use the nightly version of libraries instead of using the stable versions, so no other changes are necessary to your library path etc.
You'll need to close the terminal session for the settings to be undone.

Note that settings for applications that you run from project neon do not conflict with your regular application settings and data. <tt>.project-neon-kde/</tt> is used instead of <tt>.kde/</tt>

== Using Project Neon for development ==

If you are joining one of the development teams in KDE, you will need a real SVN/GIT checkout in order to contribute your code back to the project and create patches easily. If you only code for KDE every now and then, Project Neon provides some extra tools for this purpose in the package <tt>project-neon-utils</tt>:

NOTE: both neon-cmake and neonmake require neon-env to be run first!

* <tt>neon-env</tt> - sets up the necessary environment settings for project neon builds and opens a subshell.
* <tt>neon-cmake</tt> - cmake wrapper with neon environment settings for cmake, same synopsis as cmake and passes arguments to cmake
* <tt>neonmake</tt> - convenience script which will create a build folder, configure the source, build it and install it in /opt/project-neon/ so you can test your changes.
* <tt>neon-clean</tt> - script that resets any changes you made to /opt/project-neon after installing the packages. Since this script reinstalls the packages it might require a working internet connection.
* <tt>neonbuild</tt> - pbuilder/pdebuild wrapper to rebuild a neon package in a chroot. Takes the same options as pbuilder. If no pbuilder action is given pdebuild is run instead.

=== Options for cmake/make ===
You can change the cmake and make options used by setting these variables in ~/.neonrc:

* <tt>NEON_CMAKE_OPTS=""</tt> - Here you can add additional cmake options that should be used together with the default neon options.
* <tt>NEON_CMAKE_OVERRIDE=""</tt> - If you set this variable cmake will ignore the default neon options and only use the ones in NEON_CMAKE_OVERRIDE.
* <tt>NEON_MAKE_OVERRIDE=""</tt> - If you set this variable make in neonmake will only use your options. By default make uses '-j CPUs+1'

=== Debugging symbols ===
The debugging symbols for every package are in its corresponding <code>-dbg</code> package, so to install the debugging symbols for kdelibs you can use
<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdelibs-dbg
</syntaxhighlight>

If you are already using a nightly package of the module you want to develop for, you should remove that and checkout the development version. For example:

<pre>
# Remove the packaged nightly version
sudo apt-get purge project-neon-kdepim

# Add below Project Neon source code repository to sources.list if you didn't use add-apt-repository
deb-src http://ppa.launchpad.net/neon/ppa/ubuntu maverick main

# Get the dependencies for building kdepim
sudo apt-get build-dep project-neon-kdepim
cd ~
# You may choose to do your development in a different folder.
cd Development
# Gets the latest version of the kdepim module.
git clone git://anongit.kde.org/kdepim
cd kdepim
# Set up neon environment
neon-env
# Shortcut provided by Project Neon to make the module
# and install it to the prefix /opt/project-neon/
neonmake
</pre>

Note that you should usually checkout a module from KDE, not an application. Most modules contain libraries shared within the module and which are necessary to build the applications in the module.

Also note that when using apt-get build-dep it will always get all build-depends, so watch out that it doesn't install a component you want to build yourself as that would overwrite your changes should you install the packages after installing your build.

== Using Project Neon for translation ==

The Project Neon nightly packages include English language strings only. Translated packages are not available. However, if you are translating KDE applications, you can install the translations from KDE SVN in your normal workflow.

<syntaxhighlight lang="bash">
cd ~
cd Translations
# The -N switch checks out only the top level directory from svn.
svn co -N svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4
cd l10n-kde4
# scripts necessary to build translations.
svn up scripts
# Get the German translations
svn up de
# Generate the build files for the German language pack - if you get a message
# that revpath couldn't be found you need to install the xutils-dev package
./scripts/autogen.sh de
cd de
neon-env
neonmake
</syntaxhighlight>

After building the translations it is possible to either change the language in system settings, or run applications in another language using the environment variable <tt>KDE_LANG</tt>.

<syntaxhighlight lang="bash">
switchtonightly # or neon-env
KDE_LANG=de kmail
</syntaxhighlight>

Exit the shell to reset the settings.

== Using Project Neon for documentation ==

The Project Neon nightly source packages include the official KDE User Documentation in English.

TODO: How to build user docs from SVN.

== Using Project Neon for promotion ==

If you are creating screenshots or screencasts of the latest version of KDE, project Neon is a simple and fast way of getting a default KDE4 session.

The KDE Promotion team recommends using the default background, theme, icons etc when preparing official promotional materials (unless the feature you are showing is related to configuring KDE artwork). Project Neon uses the default artwork that comes with KDE4, so it is useful for creating promo materials.

Here is a shortcut to get all available modules from the PPA:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-all
</syntaxhighlight>

The application [http://ariya.blogspot.com/2008/06/creating-fancy-screenshots-with.html screenie] is provided since Kubuntu 8.10 as <tt>screenie-qt</tt>.

<syntaxhighlight lang="bash">
sudo apt-get install screenie-qt
</syntaxhighlight>

== Contact the Team ==

You can reach the Project Neon team on IRC in
<syntaxhighlight lang="text">#project-neon on irc.freenode.net</syntaxhighlight>
by mail at <syntaxhighlight lang="text">neon@lists.launchpad.net</syntaxhighlight>
or you can ask a question on [https://answers.launchpad.net/project-neon launchpad]

If you think there is a bug in our packaging of the provided software you can file a bug on [https://bugs.launchpad.net/project-neon launchpad]

[https://wiki.kubuntu.org/Kubuntu/ProjectNeon Team page in the Kubuntu Wiki]

Getting Started/Using Project Neon to contribute to KDE

2012-11-19T16:36:20Z

Agateau: /* Installing Project Neon */ Clarify where neon-env comes from (got bitten by that)

[https://launchpad.net/project-neon Project Neon] is a nightly build of the latest KDE trunk for Ubuntu. It is an easy way for new contributors to KDE to get started without having to download and build the entire KDE source code tree. Additionally, dependencies are automatically handled and updated. This is suitable for new developers, translators, usability designers, documenters, promoters, bug triagers, etc. This process makes the steps detailed on [[Getting_Started/Build|this page]].

However, for developers, it may at some point become necessary to build more components from source code as you become more involved in the project. The [[Getting_Started/Build/kdesrc-build|kdesrc-build]] script is an easy way to build all or parts of KDE from its source code repositories.

== Requirements ==

Project Neon always requires either the latest stable Kubuntu release or the development release. Previous versions of Kubuntu are not supported.

== Installing Project Neon ==

To use Project Neon, add the following PPA (Personal Package Archive) to your <tt>sources.list</tt> using your preferred method:

<syntaxhighlight lang="bash">
sudo add-apt-repository ppa:neon/ppa
</syntaxhighlight>
or
<pre>
# Project neon nightly KDE4 build
deb http://ppa.launchpad.net/neon/ppa/ubuntu maverick main

#above repository is PGP signed, refer to below link for getting PGP key
https://launchpad.net/~neon/+archive/ppa
</pre>

After that, you can simply install the nightly package of whichever modules you want to work on. The packages are named project-neon-<git/svn module name>. The packages are installed in /opt/project-neon/ and won't affect your stable KDE install.

You can install all of the packages or just the ones you are interested in, depending on what you want to use them for. For example if you want to install the KDE Workspace with the extra plasmoids, you would install the <tt>project-neon-kdeplasma-addons</tt> and <tt>project-neon-session</tt> so you get KDM support for Project Neon.

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdeplasma-addons project-neon-session
</syntaxhighlight>

If you are only interested in application development in another module, you can install just the module package.

First install <tt>project-neon-utils</tt>. This package installs a number of utilities, among which <tt>neon-env</tt>, which is needed to run Project Neon applications:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-utils
</syntaxhighlight>

You can then install the package for the module you are interested in. For example to test the latest version of kdepim applications:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdepim
</syntaxhighlight>

That command will also install the <tt>kdelibs</tt>, <tt>kdepimlibs</tt> and other dependencies too. In your regular (stable) KDE session you can now set up Project Neon environment and run the nightly version of your chosen application.

<syntaxhighlight lang="bash">
neon-env
kmail
</syntaxhighlight>

<tt>neon-env</tt> will setup the environment and start a subshell from which you can work with your project neon installation.
This will correctly use the nightly version of libraries instead of using the stable versions, so no other changes are necessary to your library path etc.
You'll need to close the terminal session for the settings to be undone.

Note that settings for applications that you run from project neon do not conflict with your regular application settings and data. <tt>.project-neon-kde/</tt> is used instead of <tt>.kde/</tt>

== Using Project Neon for development ==

If you are joining one of the development teams in KDE, you will need a real SVN/GIT checkout in order to contribute your code back to the project and create patches easily. If you only code for KDE every now and then, Project Neon provides some extra tools for this purpose in the package <tt>project-neon-utils</tt>:

NOTE: both neon-cmake and neonmake require neon-env to be run first!

* <tt>neon-env</tt> - sets up the necessary environment settings for project neon builds and opens a subshell.
* <tt>neon-cmake</tt> - cmake wrapper with neon environment settings for cmake, same synopsis as cmake and passes arguments to cmake
* <tt>neonmake</tt> - convenience script which will create a build folder, configure the source, build it and install it in /opt/project-neon/ so you can test your changes.
* <tt>neon-clean</tt> - script that resets any changes you made to /opt/project-neon after installing the packages. Since this script reinstalls the packages it might require a working internet connection.
* <tt>neonbuild</tt> - pbuilder/pdebuild wrapper to rebuild a neon package in a chroot. Takes the same options as pbuilder. If no pbuilder action is given pdebuild is run instead.

=== Options for cmake/make ===
You can change the cmake and make options used by setting these variables in ~/.neonrc:

* <tt>NEON_CMAKE_OPTS=""</tt> - Here you can add additional cmake options that should be used together with the default neon options.
* <tt>NEON_CMAKE_OVERRIDE=""</tt> - If you set this variable cmake will ignore the default neon options and only use the ones in NEON_CMAKE_OVERRIDE.
* <tt>NEON_MAKE_OVERRIDE=""</tt> - If you set this variable make in neonmake will only use your options. By default make uses '-j CPUs+1'

=== Debugging symbols ===
The debugging symbols for every package are in its corresponding <code>-dbg</code> package, so to install the debugging symbols for kdelibs you can use
<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdelibs-dbg
</syntaxhighlight>

If you are already using a nightly package of the module you want to develop for, you should remove that and checkout the development version. For example:

<pre>
# Remove the packaged nightly version
sudo apt-get purge project-neon-kdepim

# Add below Project Neon source code repository to sources.list if you didn't use add-apt-repository
deb-src http://ppa.launchpad.net/neon/ppa/ubuntu maverick main

# Get the dependencies for building kdepim
sudo apt-get build-dep project-neon-kdepim
cd ~
# You may choose to do your development in a different folder.
cd Development
# Gets the latest version of the kdepim module.
git clone git://anongit.kde.org/kdepim
cd kdepim
# Set up neon environment
neon-env
# Shortcut provided by Project Neon to make the module
# and install it to the prefix /opt/project-neon/
neonmake
</pre>

Note that you should usually checkout a module from KDE, not an application. Most modules contain libraries shared within the module and which are necessary to build the applications in the module.

Also note that when using apt-get build-dep it will always get all build-depends, so watch out that it doesn't install a component you want to build yourself as that would overwrite your changes should you install the packages after installing your build.

== Using Project Neon for translation ==

The Project Neon nightly packages include English language strings only. Translated packages are not available. However, if you are translating KDE applications, you can install the translations from KDE SVN in your normal workflow.

<syntaxhighlight lang="bash">
cd ~
cd Translations
# The -N switch checks out only the top level directory from svn.
svn co -N svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4
cd l10n-kde4
# scripts necessary to build translations.
svn up scripts
# Get the German translations
svn up de
# Generate the build files for the German language pack - if you get a message
# that revpath couldn't be found you need to install the xutils-dev package
./scripts/autogen.sh de
cd de
neon-env
neonmake
</syntaxhighlight>

After building the translations it is possible to either change the language in system settings, or run applications in another language using the environment variable <tt>KDE_LANG</tt>.

<syntaxhighlight lang="bash">
switchtonightly # or neon-env
KDE_LANG=de kmail
</syntaxhighlight>

Exit the shell to reset the settings.

== Using Project Neon for documentation ==

The Project Neon nightly source packages include the official KDE User Documentation in English.

TODO: How to build user docs from SVN.

== Using Project Neon for promotion ==

If you are creating screenshots or screencasts of the latest version of KDE, project Neon is a simple and fast way of getting a default KDE4 session.

The KDE Promotion team recommends using the default background, theme, icons etc when preparing official promotional materials (unless the feature you are showing is related to configuring KDE artwork). Project Neon uses the default artwork that comes with KDE4, so it is useful for creating promo materials.

Here is a shortcut to get all available modules from the PPA:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-all
</syntaxhighlight>

The application [http://ariya.blogspot.com/2008/06/creating-fancy-screenshots-with.html screenie] is provided since Kubuntu 8.10 as <tt>screenie-qt</tt>.

<syntaxhighlight lang="bash">
sudo apt-get install screenie-qt
</syntaxhighlight>

== Contact the Team ==

You can reach the Project Neon team on IRC in
<syntaxhighlight lang="text">#project-neon on irc.freenode.net</syntaxhighlight>
by mail at <syntaxhighlight lang="text">neon@lists.launchpad.net</syntaxhighlight>
or you can ask a question on [https://answers.launchpad.net/project-neon launchpad]

If you think there is a bug in our packaging of the provided software you can file a bug on [https://bugs.launchpad.net/project-neon launchpad]

[https://wiki.kubuntu.org/Kubuntu/ProjectNeon Team page in the Kubuntu Wiki]

Getting Started/Using Project Neon to contribute to KDE

2012-11-19T16:07:24Z

Agateau: typos--

[https://launchpad.net/project-neon Project Neon] is a nightly build of the latest KDE trunk for Ubuntu. It is an easy way for new contributors to KDE to get started without having to download and build the entire KDE source code tree. Additionally, dependencies are automatically handled and updated. This is suitable for new developers, translators, usability designers, documenters, promoters, bug triagers, etc. This process makes the steps detailed on [[Getting_Started/Build|this page]].

However, for developers, it may at some point become necessary to build more components from source code as you become more involved in the project. The [[Getting_Started/Build/kdesrc-build|kdesrc-build]] script is an easy way to build all or parts of KDE from its source code repositories.

== Requirements ==

Project Neon always requires either the latest stable Kubuntu release or the development release. Previous versions of Kubuntu are not supported.

== Installing Project Neon ==

To use Project Neon, add the following PPA (Personal Package Archive) to your <tt>sources.list</tt> using your preferred method:

<syntaxhighlight lang="bash">
sudo add-apt-repository ppa:neon/ppa
</syntaxhighlight>
or
<pre>
# Project neon nightly KDE4 build
deb http://ppa.launchpad.net/neon/ppa/ubuntu maverick main

#above repository is PGP signed, refer to below link for getting PGP key
https://launchpad.net/~neon/+archive/ppa
</pre>

After that, you can simply install the nightly package of whichever modules you want to work on. The packages are named project-neon-<git/svn module name>. The packages are installed in /opt/project-neon/ and won't affect your stable KDE install.

You can install all of the packages or just the ones you are interested in, depending on what you want to use them for. For example if you want to install the KDE Workspace with the extra plasmoids, you would install the <tt>project-neon-kdeplasma-addons</tt> and <tt>project-neon-session</tt> so you get KDM support for Project Neon.

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdeplasma-addons project-neon-session
</syntaxhighlight>

If you are only interested in application development in another module, you can install just the module package.

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdepim project-neon-utils
</syntaxhighlight>

That command will also install the <tt>kdelibs</tt>, <tt>kdepimlibs</tt> and other dependencies too. In your regular (stable) KDE session you can then run the nightly version of your chosen application after setting up the environment.

<syntaxhighlight lang="bash">
neon-env
kmail
</syntaxhighlight>

<tt>neon-env</tt> will setup the environment and start a subshell from which you can work with your project neon installation.
This will correctly use the nightly version of libraries instead of using the stable versions, so no other changes are necessary to your library path etc.
You'll need to close the terminal session for the settings to be undone.

Note that settings for applications that you run from project neon do not conflict with your regular application settings and data. <tt>.project-neon-kde/</tt> is used instead of <tt>.kde/</tt>

== Using Project Neon for development ==

If you are joining one of the development teams in KDE, you will need a real SVN/GIT checkout in order to contribute your code back to the project and create patches easily. If you only code for KDE every now and then, Project Neon provides some extra tools for this purpose in the package <tt>project-neon-utils</tt>:

NOTE: both neon-cmake and neonmake require neon-env to be run first!

* <tt>neon-env</tt> - sets up the necessary environment settings for project neon builds and opens a subshell.
* <tt>neon-cmake</tt> - cmake wrapper with neon environment settings for cmake, same synopsis as cmake and passes arguments to cmake
* <tt>neonmake</tt> - convenience script which will create a build folder, configure the source, build it and install it in /opt/project-neon/ so you can test your changes.
* <tt>neon-clean</tt> - script that resets any changes you made to /opt/project-neon after installing the packages. Since this script reinstalls the packages it might require a working internet connection.
* <tt>neonbuild</tt> - pbuilder/pdebuild wrapper to rebuild a neon package in a chroot. Takes the same options as pbuilder. If no pbuilder action is given pdebuild is run instead.

=== Options for cmake/make ===
You can change the cmake and make options used by setting these variables in ~/.neonrc:

* <tt>NEON_CMAKE_OPTS=""</tt> - Here you can add additional cmake options that should be used together with the default neon options.
* <tt>NEON_CMAKE_OVERRIDE=""</tt> - If you set this variable cmake will ignore the default neon options and only use the ones in NEON_CMAKE_OVERRIDE.
* <tt>NEON_MAKE_OVERRIDE=""</tt> - If you set this variable make in neonmake will only use your options. By default make uses '-j CPUs+1'

=== Debugging symbols ===
The debugging symbols for every package are in its corresponding <code>-dbg</code> package, so to install the debugging symbols for kdelibs you can use
<syntaxhighlight lang="bash">
sudo apt-get install project-neon-kdelibs-dbg
</syntaxhighlight>

If you are already using a nightly package of the module you want to develop for, you should remove that and checkout the development version. For example:

<pre>
# Remove the packaged nightly version
sudo apt-get purge project-neon-kdepim

# Add below Project Neon source code repository to sources.list if you didn't use add-apt-repository
deb-src http://ppa.launchpad.net/neon/ppa/ubuntu maverick main

# Get the dependencies for building kdepim
sudo apt-get build-dep project-neon-kdepim
cd ~
# You may choose to do your development in a different folder.
cd Development
# Gets the latest version of the kdepim module.
git clone git://anongit.kde.org/kdepim
cd kdepim
# Set up neon environment
neon-env
# Shortcut provided by Project Neon to make the module
# and install it to the prefix /opt/project-neon/
neonmake
</pre>

Note that you should usually checkout a module from KDE, not an application. Most modules contain libraries shared within the module and which are necessary to build the applications in the module.

Also note that when using apt-get build-dep it will always get all build-depends, so watch out that it doesn't install a component you want to build yourself as that would overwrite your changes should you install the packages after installing your build.

== Using Project Neon for translation ==

The Project Neon nightly packages include English language strings only. Translated packages are not available. However, if you are translating KDE applications, you can install the translations from KDE SVN in your normal workflow.

<syntaxhighlight lang="bash">
cd ~
cd Translations
# The -N switch checks out only the top level directory from svn.
svn co -N svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4
cd l10n-kde4
# scripts necessary to build translations.
svn up scripts
# Get the German translations
svn up de
# Generate the build files for the German language pack - if you get a message
# that revpath couldn't be found you need to install the xutils-dev package
./scripts/autogen.sh de
cd de
neon-env
neonmake
</syntaxhighlight>

After building the translations it is possible to either change the language in system settings, or run applications in another language using the environment variable <tt>KDE_LANG</tt>.

<syntaxhighlight lang="bash">
switchtonightly # or neon-env
KDE_LANG=de kmail
</syntaxhighlight>

Exit the shell to reset the settings.

== Using Project Neon for documentation ==

The Project Neon nightly source packages include the official KDE User Documentation in English.

TODO: How to build user docs from SVN.

== Using Project Neon for promotion ==

If you are creating screenshots or screencasts of the latest version of KDE, project Neon is a simple and fast way of getting a default KDE4 session.

The KDE Promotion team recommends using the default background, theme, icons etc when preparing official promotional materials (unless the feature you are showing is related to configuring KDE artwork). Project Neon uses the default artwork that comes with KDE4, so it is useful for creating promo materials.

Here is a shortcut to get all available modules from the PPA:

<syntaxhighlight lang="bash">
sudo apt-get install project-neon-all
</syntaxhighlight>

The application [http://ariya.blogspot.com/2008/06/creating-fancy-screenshots-with.html screenie] is provided since Kubuntu 8.10 as <tt>screenie-qt</tt>.

<syntaxhighlight lang="bash">
sudo apt-get install screenie-qt
</syntaxhighlight>

== Contact the Team ==

You can reach the Project Neon team on IRC in
<syntaxhighlight lang="text">#project-neon on irc.freenode.net</syntaxhighlight>
by mail at <syntaxhighlight lang="text">neon@lists.launchpad.net</syntaxhighlight>
or you can ask a question on [https://answers.launchpad.net/project-neon launchpad]

If you think there is a bug in our packaging of the provided software you can file a bug on [https://bugs.launchpad.net/project-neon launchpad]

[https://wiki.kubuntu.org/Kubuntu/ProjectNeon Team page in the Kubuntu Wiki]

Schedules/KDE4/4.10 Feature Plan

2012-10-24T17:11:31Z

Agateau: /* kdegraphics */ add Gwenview tasks

User:Agateau

2012-09-23T12:59:58Z

Agateau:

I am Gwenview main developer, and also try to help out polishing overall desktop experience in KDE.

* blog: http://agateau.com
* mail: agateau (a) kde dot org

== Drafts ==

* [[User:Agateau/TooManyToolbars|Too Many Toolbars]]

User:Agateau/KidMP

2012-09-23T12:59:06Z

Agateau:

Moved to http://agateau.com/projects/kidmp

User:Agateau/KidMP

2012-09-03T21:15:21Z

Agateau:

KidMP is a kid-friendly media player.

Learn more about it in the [http://quickgit.kde.org/index.php?p=scratch%2Fgateau%2Fkidmp.git&a=blob_plain&f=README.md README], then get a release from [http://kde-apps.org/content/show.php?content=153787 kde-apps.org] or clone the [http://quickgit.kde.org/index.php?p=scratch%2Fgateau%2Fkidmp.git&a=summary git repository].

User:Agateau/KidMP

2012-09-03T20:13:09Z

Agateau: Created page with "KidMP is a kid-friendly media player. Learn more about it in the [http://quickgit.kde.org/index.php?p=scratch%2Fgateau%2Fkidmp.git&a=blob_plain&f=README.md README], then get ..."

KidMP is a kid-friendly media player.

Learn more about it in the [http://quickgit.kde.org/index.php?p=scratch%2Fgateau%2Fkidmp.git&a=blob_plain&f=README.md README], then get a release from [http://kde-apps.org/ kde-apps.org] or clone the [http://quickgit.kde.org/index.php?p=scratch%2Fgateau%2Fkidmp.git&a=summary git repository].

User:Agateau

2012-09-03T20:04:36Z

Agateau:

I am Gwenview main developer, and also try to help out polishing overall desktop experience in KDE.

* blog: http://agateau.com
* mail: agateau (a) kde dot org

== Other Projects ==

* [[User:Agateau/KidMP|KidMP]]

== Drafts ==

* [[User:Agateau/TooManyToolbars|Too Many Toolbars]]

User:Agateau

2012-09-03T20:04:06Z

Agateau:

I am Gwenview main developer, and also try to help out polishing overall desktop experience in KDE.

* blog: http://agateau.com
* mail: agateau (a) kde dot org

== Other Projects ==

* [[KidMP|KidMP]]

== Drafts ==

* [[User:Agateau/TooManyToolbars|Too Many Toolbars]]

User:Agateau

2012-09-03T19:59:31Z

Agateau:

Development/Tutorials/Localization/i18n Build Systems

2012-08-03T15:31:49Z

Agateau: Document how to test Messages.sh scripts

{{TutorialBrowser|

series=Localization|

name=Building KDE's l10n Module|

pre=[[../i18n|Writing Applications With Localization in Mind]]|
next=[[../Language Change|Dealing with language changes]]|
}}

== Abstract ==

Now that your application is ready to be localized, we next look at how to incorporate the necessary mechanisms into the CMake build system of your application.

First we'll explain the "theory" of the steps that need to happen from extracting message strings to installing the generated .po files. After that we'll look at how to implement those steps ([[#Theory: The xgettext toolchain]]). If your application is developed in KDE's subversion repository, many of those steps will happen automatically (see [[#handling i18n in KDE's subversion repository]]). Else you will want to read on in the [[#handling i18n in third party applications]] section.

== Theory: The xgettext toolchain ==

Making translations work consists of the following steps:
# Extract the translatable strings
# Merge the new or changed strings with existing translations
# Compile the translations into message catalogs
# Install the message catalogs
# Use the message catalogs in the application

=== Extracting the strings ===

In this step, all the strings you marked as i18n()/ki18n()/etc. in your sources need to be collected into a translation template (.pot) file. Some translateable strings are also contained in .ui, .rc, or .kcfg files. Also tips-of-the-day need to be collected into the .pot file.

These steps are handled by {{path|xgettext}}, {{path|extractrc}}, and {{path|preparetips}} programs, respectively. In some cases you may also need {{path|extractattr}}.

=== Merging translations ===

Generally, only a few translatable string will change at a time, in an application. Some will be removed, some will be added, some will be changed into different strings, and some will be moved around in the source files. These changes need to be reflected in the translations, but of course it would be a huge effort to redo the entire translation every time a string was changed. Rather the changes should be merged with the existing translations. This is the job of the {{path|msgmerge}} tool.

=== Compiling the translations ===

In order to make message lookup fast, the .po files need to be compiled into so-called "message catalogs" (.mo / .gmo). This is done using the {{path|msgfmt}} tool.

=== Installing the message catalogs ===

The compiled message catalogs need to be installed alongside the application. In KDE, the standard location for message catalogs is {{path|$KDEDIR/share/locale/xx/LC_MESSAGES/}}.

=== Using the message catalogs ===

Finally, when the application is run, it needs to load the appropriate message catalog in order to be able to look up and show translated strings. In KDE applications, this is the job of the {{class|KLocale}} class, and in the great majority of cases happens automatically.

For some special cases, such as plugins, look at [[#Runtime Loading Of Catalogs]].

== handling i18n in KDE's subversion repository ==

If your application is developed inside KDE's subversion repository, most of the steps outlined above are automated. In this case, generally, all you will need to do is provide a simple script called {{path|Messages.sh}}, which we will look at below.

In addition, if your top-level folder and .pot file have the same name, the svn2dist script will automatically include .po files when you use it to make a source tarball for your app.

Of course, for the curious, a more detailed account of what happens behind the scenes is also provided.

=== Writing a Messages.sh script ===

Basically, the only thing that is necessary to prepare and install translations for applications in KDE's subversion repository, is to provide information, which sources, ui-files or tips need to be translated. For this purpose, you write a small script called {{path|Messages.sh}} and place it in your sources. Here is an example with inline comments:

<syntaxhighlight lang="cpp-qt">
#!bin/sh

# invoke the extractrc script on all .ui, .rc, and .kcfg files in the sources
# the results are stored in a pseudo .cpp file to be picked up by xgettext.
$EXTRACTRC `find . -name \*.rc -o -name \*.ui -o -name \*.kcfg` >> rc.cpp
# if your application contains tips-of-the-day, call preparetips as well.
$PREPARETIPS > tips.cpp
# call xgettext on all source files. If your sources have other filename
# extensions besides .cc, .cpp, and .h, just add them in the find call.
$XGETTEXT `find . -name \*.cc -o -name \*.cpp -o -name \*.h -name \*.qml` -o $podir/APPNAME.pot
</syntaxhighlight>

As you can see, this script contains only three actual lines of code, and not all may even be needed. The $XGETTEXT, $PREPARETIPS, $EXTRACTRC, and $podir environment variables are predefined, you do not need to worry about setting these. The only thing that you will need to do is to replace "APPNAME" with the name of your application (but see [[#Naming .pot Files]] for exceptions).

Translatable strings are automatically extracted from C++ files. For non-C++ files, the following scripts are used
* $EXTRACTRC - Extract translatable strings from xml configuration and ui files.
* $EXTRACT_GRANTLEE_TEMPLATE_STRINGS - Extract translatable strings from Grantlee template files.

Try to make sure your Messages.sh script collects only those messages that are really needed. If in doubt, look at other Messages.sh files in the KDE subversion repository for inspiration, or -- of course -- ask.

=== What's happening behind the scenes ===

{{tip|If your application is in the KDE code repository, all this happens automatically. If your code is not in the KDE repository, you must perform these steps yourself. See [[#handling i18n in third party applications]].}}

Periodically, the script {{path|extract-messages.sh}} (a.k.a. scripty) runs on the KDE server. This program basically calls all Messages.sh scripts in the repository with the appropriate parameters. The extracted messages are stored in template (.pot) files in the templates folder of the l10n module. See [[What Is Scripty]] for more information.

The KDE translation teams translate the messages and commit them into a messages folder corresponding to the language, which is further broken down by module. For example, German translated messages for konqueror are committed to {{path|l10n/de/messages/kdebase/konqueror.po}}.

When the l10n module is built, the .po files are compiled into a binary format for fast lookup and installed as .mo files to {{path|$KDEDIR/share/locale/xx/LC_MESSAGES/}}, where xx is the two-letter ISO 639 code for the language. These are called the message catalogs.

At runtime, the <tt>i18n(...)</tt> function, using the original string you coded, looks up the string in the message catalog of the user's desktop language and returns the translated string. If the message catalog is missing, or the specific string is not found, <tt>i18n(...)</tt> falls back to the original string in your code.

.desktop files in your project are handled separately. {{path|makemessages}} extracts strings, such as Name and Comment from the .desktop files and places them into a file named {{path|desktop_mmmm.pot}}, where mmmm is the module name, in the templates folder. Once translators have translated this file, makemessages inserts the translated strings back into the .desktop files. The list of strings extracted is in {{path|l10n/scripts/apply.cc}}. Here's the code that checks for them:

<syntaxhighlight lang="cpp-qt">
if (checkTag("Name", in, argc, argv, newFile))
continue;
if (checkTag("Comment", in, argc, argv, newFile))
continue;
if (checkTag("Language", in, argc, argv, newFile))
continue;
if (checkTag("Keywords", in, argc, argv, newFile))
continue;
if (checkTag("About", in, argc, argv, newFile))
continue;
if (checkTag("Description", in, argc, argv, newFile))
continue;
if (checkTag("GenericName", in, argc, argv, newFile))
continue;
if (checkTag("Query", in, argc, argv, newFile))
continue;
if (checkTag("ExtraNames", in, argc, argv, newFile))
continue;
</syntaxhighlight>

=== Testing your Messages.sh script ===

To test your Messages.sh script, you need a checkout of [http://websvn.kde.org/trunk/l10n-kde4/scripts/ the l10n scripts]. To get one:

svn checkout svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4/scripts

You can then go to your project dir and run:

mkdir po
bash /path/to/l10n-kde4/scripts/extract-messages.sh

When it is done, the po/ dir should contain the generated .pot files.

== handling i18n in third party applications ==

If your application is developed outside of KDE's subversion repository, you need to take care of generating and installing message catalogs yourself. This is not too hard to do, but you should make sure you have a basic understanding of all steps involved, so you will probably want to read [[#Theory: The xgettext toolchain]], first.

Also, there is more than one way to deal with i18n in your application. We will outline one approach to do so for simple applications, but you may want to diverge from this, if you like to.

=== General considerations ===

The i18n generation process can roughly be divided into two steps:

# Extracting and merging messages
# Compiling and installing message catalogs

The first step really concerns the ''sources'', while the second step is a natural part of compiling and installing an application. Hence, while the second step should definitely be incorporated into the build system for your application (we assume CMake, here), there is no striking reason for the first step to be handled by the build system.

In fact, the extraction and merging of messages does not map well onto the CMake concept of out-of-source builds, and CMake can't provide too much help for this step, either.

Hence, in this tutorial, we will handle the first step with a standalone shell script, and only the second step will be handled by CMake.

=== Extracting and merging messages ===

If you have read the section [[#handling i18n in KDE's subversion repository]] you will know that in the KDE repository, message extraction and merging is handled by a simple script called Messages.sh, which is invoked by a script called {{path|extract-messages.sh}}. Outside of KDE's repository, you will need to take care of both parts, but fortunately, this is easy enough. Here's a sample script:

<syntaxhighlight lang="bash">
#!/bin/sh
BASEDIR="../rkward/" # root of translatable sources
PROJECT="rkward" # project name
BUGADDR="http://sourceforge.net/tracker/?group_id=50231&atid=459007" # MSGID-Bugs
WDIR=`pwd` # working dir

echo "Preparing rc files"
cd ${BASEDIR}
# we use simple sorting to make sure the lines do not jump around too much from system to system
find . -name '*.rc' -o -name '*.ui' -o -name '*.kcfg' | sort > ${WDIR}/rcfiles.list
xargs --arg-file=${WDIR}/rcfiles.list extractrc > ${WDIR}/rc.cpp
# additional string for KAboutData
echo 'i18nc("NAME OF TRANSLATORS","Your names");' >> ${WDIR}/rc.cpp
echo 'i18nc("EMAIL OF TRANSLATORS","Your emails");' >> ${WDIR}/rc.cpp
cd ${WDIR}
echo "Done preparing rc files"

echo "Extracting messages"
cd ${BASEDIR}
# see above on sorting
find . -name '*.cpp' -o -name '*.h' -o -name '*.c' | sort > ${WDIR}/infiles.list
echo "rc.cpp" >> ${WDIR}/infiles.list
cd ${WDIR}
xgettext --from-code=UTF-8 -C -kde -ci18n -ki18n:1 -ki18nc:1c,2 -ki18np:1,2 -ki18ncp:1c,2,3 -ktr2i18n:1 \
-kI18N_NOOP:1 -kI18N_NOOP2:1c,2 -kaliasLocale -kki18n:1 -kki18nc:1c,2 -kki18np:1,2 -kki18ncp:1c,2,3 \
--msgid-bugs-address="${BUGADDR}" \
--files-from=infiles.list -D ${BASEDIR} -D ${WDIR} -o ${PROJECT}.pot || { echo "error while calling xgettext. aborting."; exit 1; }
echo "Done extracting messages"

echo "Merging translations"
catalogs=`find . -name '*.po'`
for cat in $catalogs; do
echo $cat
msgmerge -o $cat.new $cat ${PROJECT}.pot
mv $cat.new $cat
done
echo "Done merging translations"

echo "Cleaning up"
cd ${WDIR}
rm rcfiles.list
rm infiles.list
rm rc.cpp
echo "Done"
</syntaxhighlight>

Of course you will want to adjust the variable definitions at the top, and -- if needed -- add code to extract tips-of-the-day or other additional strings.

The example script assumes that all .po files and the .pot file are kept in a single directory, which is appropriate for most projects.

=== Compiling and installing message catalogs ===

Assuming you use the script from the previous section, you can place the following CMakeLists.txt in the directory containing the .po files:

<pre>
FIND_PROGRAM(GETTEXT_MSGFMT_EXECUTABLE msgfmt)

IF(NOT GETTEXT_MSGFMT_EXECUTABLE)
MESSAGE(
"------
NOTE: msgfmt not found. Translations will *not* be installed
------")
ELSE(NOT GETTEXT_MSGFMT_EXECUTABLE)

SET(catalogname rkward)

ADD_CUSTOM_TARGET(translations ALL)

FILE(GLOB PO_FILES *.po)

FOREACH(_poFile ${PO_FILES})
GET_FILENAME_COMPONENT(_poFileName ${_poFile} NAME)
STRING(REGEX REPLACE "^${catalogname}_?" "" _langCode ${_poFileName} )
STRING(REGEX REPLACE "\\.po$" "" _langCode ${_langCode} )

IF( _langCode )
GET_FILENAME_COMPONENT(_lang ${_poFile} NAME_WE)
SET(_gmoFile ${CMAKE_CURRENT_BINARY_DIR}/${_lang}.gmo)

ADD_CUSTOM_COMMAND(TARGET translations
COMMAND ${GETTEXT_MSGFMT_EXECUTABLE} --check -o ${_gmoFile} ${_poFile}
DEPENDS ${_poFile})
INSTALL(FILES ${_gmoFile} DESTINATION ${LOCALE_INSTALL_DIR}/${_langCode}/LC_MESSAGES/ RENAME ${catalogname}.mo)
ENDIF( _langCode )

ENDFOREACH(_poFile ${PO_FILES})

ENDIF(NOT GETTEXT_MSGFMT_EXECUTABLE)
</pre>

This iterates over all .po files in the directory, compiles them using msgfmt, and installs them to the standard location. You will want to change "catalogname" to the name of your application.

=== Getting translations ===

Now you just have to find translators to translate the extracted messages into the various languages. As your application gets used by more people, you will find that translators will volunteer to do this. Translated PO files then have to be stored in the po folder with the naming scheme <languagecode>.po.

=== Translating .desktop Files ===

Translating .desktop files is a bit tricky because the translation of .desktop files isn't fetched from .po/.gmo files, but must be part of the .desktop file itself. So we have 2 tasks:

* extract messages from the .desktop file
* merge the translations in the .desktop file

Our friends from Gnome provide the [http://freedesktop.org/wiki/Software/intltool intltool] package. While this tools is mainly written for the old autotools build system (but KDE uses CMake since KDE 4), we can use this package nevertheless for our purpose. Here is a step-by-step guide:

# Install the [http://freedesktop.org/wiki/Software/intltool intltool] package
# We assume that your .desktop file is named "MYPROGRAM.desktop".
# Make a copy of "MYPROGRAM.desktop" which is named "MYPROGRAM.desktop.template".
# In MYPROGRAM.desktop.template substitute the keys "Name" by "_Name", "GenericName" by "_GenericName" and "Comment" by "_Comment".
# Remove all translations from "MYPROGRAM.desktop.template".
# Add the following lines to the above described build script, at the end of the section "Preparing rc files":
<syntaxhighlight lang="bash">
intltool-extract --quiet --type=gettext/ini PATH/MYPROGRAM.desktop.template
cat PATH/MYPROGRAM.desktop.template.h >> ${WDIR}/rc.cpp
rm PATH/MYPROGRAM.desktop.template.h
cd ${WDIR}
</syntaxhighlight>
intltool-extract will create a dummy C++ header (PATH/MYPROGRAM.desktop.template.h) with the strings whose key starts with "_". We append the content of this header file into our "rc.cpp" and remove remove the file than. (We assume that "PATH" is the path to "MYPROGRAM.desktop.template", relative to the working directory of the script.)
# Add "-kN_:1" as additional parameter to the xgettext call in the section "Extracting messages". This is necessary because dummy code that intltool-extract produces uses "N_()" instead of "i18n()".
# Add the following lines to the above described build script, at the end of the section "Merging translations":
<syntaxhighlight lang="bash">
cd ${WDIR}
intltool-merge --quiet --desktop-style ${WDIR} PATH/MYPROGRAM.desktop.template PATH2/MYPROGRAM.desktop
</syntaxhighlight>
This will produce MYPROGRAM.desktop from MYPROGRAM.desktop.template, inserting all available translations in the .po files in the directory ${WDIR}. (We assume that "PATH" is the path to "MYPROGRAM.desktop.template", relative to the working directory of the script. We assume that "PATH2" is the path to the final location of "MYPROGRAM.desktop", relative to the working directory of the script.)

{{note|Names of .po files):For intltool, it is ''required'' that the .po files have the name <languagecode>.po without other characters (NOT programname_<languagecode>.po). This is important because intltool-merge simply uses the .po file name (without ".po") as language key in the .desktop file.}}

== Special cases (plugins, multiple catalogs, etc.) ==

=== Runtime Loading Of Catalogs ===

To have translations show up properly in an application, the name of the .pot file must match the name of the message catalog (.mo) file that your application will read at runtime. But what name will be used at runtime?

In general, it will be the value returned by <tt>{{class|KGlobal}}::instance()->instanceName()</tt>. But what will that be? The general rules for standalone applications are:
* the message catalog will default to the name of the application passed as the first argument to {{class|KAboutData}}
* if your code calls <tt>{{class|KLocale}}::setMainCatalog()</tt>, that name will be used instead
* if your code calls <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt>, the specified catalog will also be searched in addition to the main catalog

If your code does not call either of the {{class|KLocale}} methods mentioned above and your application is a plugin, it gets a little more complicated. If your code exports your plugin using the <tt>K_EXPORT_COMPONENT_FACTORY</tt> macro, like this:

<syntaxhighlight lang="cpp-qt">
K_EXPORT_COMPONENT_FACTORY( libkhtmlkttsdplugin, KGenericFactory<KHTMLPluginKTTSD>("khtmlkttsd") )
</syntaxhighlight>

then the catalog name will be the name passed in the {{class|KGenericFactory}} constructor - in the example above that woudl be <tt>khtmlkttsd</tt>. This is because the macro creates a {{class|Kinstance}} for you with the specified name.

However, some classes, such as <tt>KTextEditor</tt> create a <tt>KPart</tt> containing your component and the name passed in the macro is not used. In this case, you should call <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt> in the component's constructor.

If in doubt, the safest thing to do is to call <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt>.

{{tip|If you are not using the export macro for your plugin, you probably should be. See the API documentation of KGenericFactory for more information.}}

Calling <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt> if the catalog has already been inserted does nothing. However, calling <tt>{{class|KLocale}}::removeCatalog(const QString&)</tt> removes the catalog no matter how many times it has been inserted. Therefore, take care that you do not inadvertently remove the catalog when multiple components are sharing a single catalog. For example, the following sequence will break translations:

<syntaxhighlight lang="cpp-qt">
// Component A loads and uses catalog xyz by calling
insertCatalogue("xyz");
// Component B loads and also uses the same catalog.
insertCatalogue("xyz");
// component B unloads and calls
removeCatalogue("xyz")
// Component A now doesn't translate properly.
</syntaxhighlight>

Notice that a sequence such as above will occur automatically if both components A and B are loaded using the <tt>K_EXPORT_COMPONENT_FACTORY</tt> macro and pass the same name argument to the KGenericFactory constructor.

=== Naming .pot Files ===

The name that you settle on for both the .pot file and catalog should be governed by where your code resides. If it is a component of another application and resides in that application's source tree, you'll want to share the main catalog of the application.

If is a component of another application but resides elsewhere in the code repository, you will probably have to create a separate .pot, but keep in mind that .pot filenames must be unique across all of KDE.

If it is a component of another application, but resides in the source tree of a second application, you should share with the second application. For example, the KDE text-to-speach daemon (KTTSD) includes a plugin for embedded Kate in {{path|kdeaccessibility/kttsd}} source tree. Since the plugin is not installed unless kttsd is installed, it shares its catalog with kttsd and calls <tt>{{class|KLocale}}::insertCatalog("kttsd")</tt> to do this.

==== Declarative plasmoids ====
For plasmoids written in pure qml, the .pot file must be names the same as its plugin name (with '''plasma_applet_''' prefix), specified in its desktop file as '''X-KDE-PluginInfo-Name'''. For instance if we have '''X-KDE-PluginInfo-Name=org.kde.active.activityscreen''' the .pot file will be called '''plasma_applet_org.kde.active.activityscreen.pot'''. The KLocale::insertCatalog() call is performed by the declarative scriptengine itself, so the developer of the qml plasmoid doesn't have to worry about that.

If the qml files are developed in the form of package instead of an autonomous plasmoid (for instance a package loaded by a C++ plasmoid) the .pot file will have the prefix '''plasma_package_''' instead.

== Handbooks ==

Handbooks, which are written in docbook format, are handled different from applications. The translated Handbooks are committed into the l10n module in the docs folder under each language. In addition, the docs folder is broken down by module and application. For example, the German Kate Handbook is committed to the {{path|l10n-kde4/de/docs/kde-baseapps/kate/}} folder. When compiled, the German Kate Handbook is installed to {{path|$KDEDIR/share/doc/HTML/de/kate/index.cache.bz2}}.

Note that it is up to each translation team to generate the translated Handbook when they feel it is complete.

[[Category:Programming]]

Development/Tutorials/Localization/i18n Build Systems

2012-08-03T15:03:09Z

Agateau: /* Declarative plasmoids */ typo--

{{TutorialBrowser|

series=Localization|

name=Building KDE's l10n Module|

pre=[[../i18n|Writing Applications With Localization in Mind]]|
next=[[../Language Change|Dealing with language changes]]|
}}

== Abstract ==

Now that your application is ready to be localized, we next look at how to incorporate the necessary mechanisms into the CMake build system of your application.

First we'll explain the "theory" of the steps that need to happen from extracting message strings to installing the generated .po files. After that we'll look at how to implement those steps ([[#Theory: The xgettext toolchain]]). If your application is developed in KDE's subversion repository, many of those steps will happen automatically (see [[#handling i18n in KDE's subversion repository]]). Else you will want to read on in the [[#handling i18n in third party applications]] section.

== Theory: The xgettext toolchain ==

Making translations work consists of the following steps:
# Extract the translatable strings
# Merge the new or changed strings with existing translations
# Compile the translations into message catalogs
# Install the message catalogs
# Use the message catalogs in the application

=== Extracting the strings ===

In this step, all the strings you marked as i18n()/ki18n()/etc. in your sources need to be collected into a translation template (.pot) file. Some translateable strings are also contained in .ui, .rc, or .kcfg files. Also tips-of-the-day need to be collected into the .pot file.

These steps are handled by {{path|xgettext}}, {{path|extractrc}}, and {{path|preparetips}} programs, respectively. In some cases you may also need {{path|extractattr}}.

=== Merging translations ===

Generally, only a few translatable string will change at a time, in an application. Some will be removed, some will be added, some will be changed into different strings, and some will be moved around in the source files. These changes need to be reflected in the translations, but of course it would be a huge effort to redo the entire translation every time a string was changed. Rather the changes should be merged with the existing translations. This is the job of the {{path|msgmerge}} tool.

=== Compiling the translations ===

In order to make message lookup fast, the .po files need to be compiled into so-called "message catalogs" (.mo / .gmo). This is done using the {{path|msgfmt}} tool.

=== Installing the message catalogs ===

The compiled message catalogs need to be installed alongside the application. In KDE, the standard location for message catalogs is {{path|$KDEDIR/share/locale/xx/LC_MESSAGES/}}.

=== Using the message catalogs ===

Finally, when the application is run, it needs to load the appropriate message catalog in order to be able to look up and show translated strings. In KDE applications, this is the job of the {{class|KLocale}} class, and in the great majority of cases happens automatically.

For some special cases, such as plugins, look at [[#Runtime Loading Of Catalogs]].

== handling i18n in KDE's subversion repository ==

If your application is developed inside KDE's subversion repository, most of the steps outlined above are automated. In this case, generally, all you will need to do is provide a simple script called {{path|Messages.sh}}, which we will look at below.

In addition, if your top-level folder and .pot file have the same name, the svn2dist script will automatically include .po files when you use it to make a source tarball for your app.

Of course, for the curious, a more detailed account of what happens behind the scenes is also provided.

=== Writing a Messages.sh script ===

Basically, the only thing that is necessary to prepare and install translations for applications in KDE's subversion repository, is to provide information, which sources, ui-files or tips need to be translated. For this purpose, you write a small script called {{path|Messages.sh}} and place it in your sources. Here is an example with inline comments:

<syntaxhighlight lang="cpp-qt">
#!bin/sh

# invoke the extractrc script on all .ui, .rc, and .kcfg files in the sources
# the results are stored in a pseudo .cpp file to be picked up by xgettext.
$EXTRACTRC `find . -name \*.rc -o -name \*.ui -o -name \*.kcfg` >> rc.cpp
# if your application contains tips-of-the-day, call preparetips as well.
$PREPARETIPS > tips.cpp
# call xgettext on all source files. If your sources have other filename
# extensions besides .cc, .cpp, and .h, just add them in the find call.
$XGETTEXT `find . -name \*.cc -o -name \*.cpp -o -name \*.h -name \*.qml` -o $podir/APPNAME.pot
</syntaxhighlight>

As you can see, this script contains only three actual lines of code, and not all may even be needed. The $XGETTEXT, $PREPARETIPS, $EXTRACTRC, and $podir environment variables are predefined, you do not need to worry about setting these. The only thing that you will need to do is to replace "APPNAME" with the name of your application (but see [[#Naming .pot Files]] for exceptions).

Translatable strings are automatically extracted from C++ files. For non-C++ files, the following scripts are used
* $EXTRACTRC - Extract translatable strings from xml configuration and ui files.
* $EXTRACT_GRANTLEE_TEMPLATE_STRINGS - Extract translatable strings from Grantlee template files.

Try to make sure your Messages.sh script collects only those messages that are really needed. If in doubt, look at other Messages.sh files in the KDE subversion repository for inspiration, or -- of course -- ask.

=== What's happening behind the scenes ===

{{tip|If your application is in the KDE code repository, all this happens automatically. If your code is not in the KDE repository, you must perform these steps yourself. See [[#handling i18n in third party applications]].}}

Periodically, the script {{path|extract-messages.sh}} (a.k.a. scripty) runs on the KDE server. This program basically calls all Messages.sh scripts in the repository with the appropriate parameters. The extracted messages are stored in template (.pot) files in the templates folder of the l10n module. See [[What Is Scripty]] for more information.

The KDE translation teams translate the messages and commit them into a messages folder corresponding to the language, which is further broken down by module. For example, German translated messages for konqueror are committed to {{path|l10n/de/messages/kdebase/konqueror.po}}.

When the l10n module is built, the .po files are compiled into a binary format for fast lookup and installed as .mo files to {{path|$KDEDIR/share/locale/xx/LC_MESSAGES/}}, where xx is the two-letter ISO 639 code for the language. These are called the message catalogs.

At runtime, the <tt>i18n(...)</tt> function, using the original string you coded, looks up the string in the message catalog of the user's desktop language and returns the translated string. If the message catalog is missing, or the specific string is not found, <tt>i18n(...)</tt> falls back to the original string in your code.

.desktop files in your project are handled separately. {{path|makemessages}} extracts strings, such as Name and Comment from the .desktop files and places them into a file named {{path|desktop_mmmm.pot}}, where mmmm is the module name, in the templates folder. Once translators have translated this file, makemessages inserts the translated strings back into the .desktop files. The list of strings extracted is in {{path|l10n/scripts/apply.cc}}. Here's the code that checks for them:

<syntaxhighlight lang="cpp-qt">
if (checkTag("Name", in, argc, argv, newFile))
continue;
if (checkTag("Comment", in, argc, argv, newFile))
continue;
if (checkTag("Language", in, argc, argv, newFile))
continue;
if (checkTag("Keywords", in, argc, argv, newFile))
continue;
if (checkTag("About", in, argc, argv, newFile))
continue;
if (checkTag("Description", in, argc, argv, newFile))
continue;
if (checkTag("GenericName", in, argc, argv, newFile))
continue;
if (checkTag("Query", in, argc, argv, newFile))
continue;
if (checkTag("ExtraNames", in, argc, argv, newFile))
continue;
</syntaxhighlight>

== handling i18n in third party applications ==

If your application is developed outside of KDE's subversion repository, you need to take care of generating and installing message catalogs yourself. This is not too hard to do, but you should make sure you have a basic understanding of all steps involved, so you will probably want to read [[#Theory: The xgettext toolchain]], first.

Also, there is more than one way to deal with i18n in your application. We will outline one approach to do so for simple applications, but you may want to diverge from this, if you like to.

=== General considerations ===

The i18n generation process can roughly be divided into two steps:

# Extracting and merging messages
# Compiling and installing message catalogs

The first step really concerns the ''sources'', while the second step is a natural part of compiling and installing an application. Hence, while the second step should definitely be incorporated into the build system for your application (we assume CMake, here), there is no striking reason for the first step to be handled by the build system.

In fact, the extraction and merging of messages does not map well onto the CMake concept of out-of-source builds, and CMake can't provide too much help for this step, either.

Hence, in this tutorial, we will handle the first step with a standalone shell script, and only the second step will be handled by CMake.

=== Extracting and merging messages ===

If you have read the section [[#handling i18n in KDE's subversion repository]] you will know that in the KDE repository, message extraction and merging is handled by a simple script called Messages.sh, which is invoked by a script called {{path|extract-messages.sh}}. Outside of KDE's repository, you will need to take care of both parts, but fortunately, this is easy enough. Here's a sample script:

<syntaxhighlight lang="bash">
#!/bin/sh
BASEDIR="../rkward/" # root of translatable sources
PROJECT="rkward" # project name
BUGADDR="http://sourceforge.net/tracker/?group_id=50231&atid=459007" # MSGID-Bugs
WDIR=`pwd` # working dir

echo "Preparing rc files"
cd ${BASEDIR}
# we use simple sorting to make sure the lines do not jump around too much from system to system
find . -name '*.rc' -o -name '*.ui' -o -name '*.kcfg' | sort > ${WDIR}/rcfiles.list
xargs --arg-file=${WDIR}/rcfiles.list extractrc > ${WDIR}/rc.cpp
# additional string for KAboutData
echo 'i18nc("NAME OF TRANSLATORS","Your names");' >> ${WDIR}/rc.cpp
echo 'i18nc("EMAIL OF TRANSLATORS","Your emails");' >> ${WDIR}/rc.cpp
cd ${WDIR}
echo "Done preparing rc files"

echo "Extracting messages"
cd ${BASEDIR}
# see above on sorting
find . -name '*.cpp' -o -name '*.h' -o -name '*.c' | sort > ${WDIR}/infiles.list
echo "rc.cpp" >> ${WDIR}/infiles.list
cd ${WDIR}
xgettext --from-code=UTF-8 -C -kde -ci18n -ki18n:1 -ki18nc:1c,2 -ki18np:1,2 -ki18ncp:1c,2,3 -ktr2i18n:1 \
-kI18N_NOOP:1 -kI18N_NOOP2:1c,2 -kaliasLocale -kki18n:1 -kki18nc:1c,2 -kki18np:1,2 -kki18ncp:1c,2,3 \
--msgid-bugs-address="${BUGADDR}" \
--files-from=infiles.list -D ${BASEDIR} -D ${WDIR} -o ${PROJECT}.pot || { echo "error while calling xgettext. aborting."; exit 1; }
echo "Done extracting messages"

echo "Merging translations"
catalogs=`find . -name '*.po'`
for cat in $catalogs; do
echo $cat
msgmerge -o $cat.new $cat ${PROJECT}.pot
mv $cat.new $cat
done
echo "Done merging translations"

echo "Cleaning up"
cd ${WDIR}
rm rcfiles.list
rm infiles.list
rm rc.cpp
echo "Done"
</syntaxhighlight>

Of course you will want to adjust the variable definitions at the top, and -- if needed -- add code to extract tips-of-the-day or other additional strings.

The example script assumes that all .po files and the .pot file are kept in a single directory, which is appropriate for most projects.

=== Compiling and installing message catalogs ===

Assuming you use the script from the previous section, you can place the following CMakeLists.txt in the directory containing the .po files:

<pre>
FIND_PROGRAM(GETTEXT_MSGFMT_EXECUTABLE msgfmt)

IF(NOT GETTEXT_MSGFMT_EXECUTABLE)
MESSAGE(
"------
NOTE: msgfmt not found. Translations will *not* be installed
------")
ELSE(NOT GETTEXT_MSGFMT_EXECUTABLE)

SET(catalogname rkward)

ADD_CUSTOM_TARGET(translations ALL)

FILE(GLOB PO_FILES *.po)

FOREACH(_poFile ${PO_FILES})
GET_FILENAME_COMPONENT(_poFileName ${_poFile} NAME)
STRING(REGEX REPLACE "^${catalogname}_?" "" _langCode ${_poFileName} )
STRING(REGEX REPLACE "\\.po$" "" _langCode ${_langCode} )

IF( _langCode )
GET_FILENAME_COMPONENT(_lang ${_poFile} NAME_WE)
SET(_gmoFile ${CMAKE_CURRENT_BINARY_DIR}/${_lang}.gmo)

ADD_CUSTOM_COMMAND(TARGET translations
COMMAND ${GETTEXT_MSGFMT_EXECUTABLE} --check -o ${_gmoFile} ${_poFile}
DEPENDS ${_poFile})
INSTALL(FILES ${_gmoFile} DESTINATION ${LOCALE_INSTALL_DIR}/${_langCode}/LC_MESSAGES/ RENAME ${catalogname}.mo)
ENDIF( _langCode )

ENDFOREACH(_poFile ${PO_FILES})

ENDIF(NOT GETTEXT_MSGFMT_EXECUTABLE)
</pre>

This iterates over all .po files in the directory, compiles them using msgfmt, and installs them to the standard location. You will want to change "catalogname" to the name of your application.

=== Getting translations ===

Now you just have to find translators to translate the extracted messages into the various languages. As your application gets used by more people, you will find that translators will volunteer to do this. Translated PO files then have to be stored in the po folder with the naming scheme <languagecode>.po.

=== Translating .desktop Files ===

Translating .desktop files is a bit tricky because the translation of .desktop files isn't fetched from .po/.gmo files, but must be part of the .desktop file itself. So we have 2 tasks:

* extract messages from the .desktop file
* merge the translations in the .desktop file

Our friends from Gnome provide the [http://freedesktop.org/wiki/Software/intltool intltool] package. While this tools is mainly written for the old autotools build system (but KDE uses CMake since KDE 4), we can use this package nevertheless for our purpose. Here is a step-by-step guide:

# Install the [http://freedesktop.org/wiki/Software/intltool intltool] package
# We assume that your .desktop file is named "MYPROGRAM.desktop".
# Make a copy of "MYPROGRAM.desktop" which is named "MYPROGRAM.desktop.template".
# In MYPROGRAM.desktop.template substitute the keys "Name" by "_Name", "GenericName" by "_GenericName" and "Comment" by "_Comment".
# Remove all translations from "MYPROGRAM.desktop.template".
# Add the following lines to the above described build script, at the end of the section "Preparing rc files":
<syntaxhighlight lang="bash">
intltool-extract --quiet --type=gettext/ini PATH/MYPROGRAM.desktop.template
cat PATH/MYPROGRAM.desktop.template.h >> ${WDIR}/rc.cpp
rm PATH/MYPROGRAM.desktop.template.h
cd ${WDIR}
</syntaxhighlight>
intltool-extract will create a dummy C++ header (PATH/MYPROGRAM.desktop.template.h) with the strings whose key starts with "_". We append the content of this header file into our "rc.cpp" and remove remove the file than. (We assume that "PATH" is the path to "MYPROGRAM.desktop.template", relative to the working directory of the script.)
# Add "-kN_:1" as additional parameter to the xgettext call in the section "Extracting messages". This is necessary because dummy code that intltool-extract produces uses "N_()" instead of "i18n()".
# Add the following lines to the above described build script, at the end of the section "Merging translations":
<syntaxhighlight lang="bash">
cd ${WDIR}
intltool-merge --quiet --desktop-style ${WDIR} PATH/MYPROGRAM.desktop.template PATH2/MYPROGRAM.desktop
</syntaxhighlight>
This will produce MYPROGRAM.desktop from MYPROGRAM.desktop.template, inserting all available translations in the .po files in the directory ${WDIR}. (We assume that "PATH" is the path to "MYPROGRAM.desktop.template", relative to the working directory of the script. We assume that "PATH2" is the path to the final location of "MYPROGRAM.desktop", relative to the working directory of the script.)

{{note|Names of .po files):For intltool, it is ''required'' that the .po files have the name <languagecode>.po without other characters (NOT programname_<languagecode>.po). This is important because intltool-merge simply uses the .po file name (without ".po") as language key in the .desktop file.}}

== Special cases (plugins, multiple catalogs, etc.) ==

=== Runtime Loading Of Catalogs ===

To have translations show up properly in an application, the name of the .pot file must match the name of the message catalog (.mo) file that your application will read at runtime. But what name will be used at runtime?

In general, it will be the value returned by <tt>{{class|KGlobal}}::instance()->instanceName()</tt>. But what will that be? The general rules for standalone applications are:
* the message catalog will default to the name of the application passed as the first argument to {{class|KAboutData}}
* if your code calls <tt>{{class|KLocale}}::setMainCatalog()</tt>, that name will be used instead
* if your code calls <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt>, the specified catalog will also be searched in addition to the main catalog

If your code does not call either of the {{class|KLocale}} methods mentioned above and your application is a plugin, it gets a little more complicated. If your code exports your plugin using the <tt>K_EXPORT_COMPONENT_FACTORY</tt> macro, like this:

<syntaxhighlight lang="cpp-qt">
K_EXPORT_COMPONENT_FACTORY( libkhtmlkttsdplugin, KGenericFactory<KHTMLPluginKTTSD>("khtmlkttsd") )
</syntaxhighlight>

then the catalog name will be the name passed in the {{class|KGenericFactory}} constructor - in the example above that woudl be <tt>khtmlkttsd</tt>. This is because the macro creates a {{class|Kinstance}} for you with the specified name.

However, some classes, such as <tt>KTextEditor</tt> create a <tt>KPart</tt> containing your component and the name passed in the macro is not used. In this case, you should call <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt> in the component's constructor.

If in doubt, the safest thing to do is to call <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt>.

{{tip|If you are not using the export macro for your plugin, you probably should be. See the API documentation of KGenericFactory for more information.}}

Calling <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt> if the catalog has already been inserted does nothing. However, calling <tt>{{class|KLocale}}::removeCatalog(const QString&)</tt> removes the catalog no matter how many times it has been inserted. Therefore, take care that you do not inadvertently remove the catalog when multiple components are sharing a single catalog. For example, the following sequence will break translations:

<syntaxhighlight lang="cpp-qt">
// Component A loads and uses catalog xyz by calling
insertCatalogue("xyz");
// Component B loads and also uses the same catalog.
insertCatalogue("xyz");
// component B unloads and calls
removeCatalogue("xyz")
// Component A now doesn't translate properly.
</syntaxhighlight>

Notice that a sequence such as above will occur automatically if both components A and B are loaded using the <tt>K_EXPORT_COMPONENT_FACTORY</tt> macro and pass the same name argument to the KGenericFactory constructor.

=== Naming .pot Files ===

The name that you settle on for both the .pot file and catalog should be governed by where your code resides. If it is a component of another application and resides in that application's source tree, you'll want to share the main catalog of the application.

If is a component of another application but resides elsewhere in the code repository, you will probably have to create a separate .pot, but keep in mind that .pot filenames must be unique across all of KDE.

If it is a component of another application, but resides in the source tree of a second application, you should share with the second application. For example, the KDE text-to-speach daemon (KTTSD) includes a plugin for embedded Kate in {{path|kdeaccessibility/kttsd}} source tree. Since the plugin is not installed unless kttsd is installed, it shares its catalog with kttsd and calls <tt>{{class|KLocale}}::insertCatalog("kttsd")</tt> to do this.

==== Declarative plasmoids ====
For plasmoids written in pure qml, the .pot file must be names the same as its plugin name (with '''plasma_applet_''' prefix), specified in its desktop file as '''X-KDE-PluginInfo-Name'''. For instance if we have '''X-KDE-PluginInfo-Name=org.kde.active.activityscreen''' the .pot file will be called '''plasma_applet_org.kde.active.activityscreen.pot'''. The KLocale::insertCatalog() call is performed by the declarative scriptengine itself, so the developer of the qml plasmoid doesn't have to worry about that.

If the qml files are developed in the form of package instead of an autonomous plasmoid (for instance a package loaded by a C++ plasmoid) the .pot file will have the prefix '''plasma_package_''' instead.

== Handbooks ==

Handbooks, which are written in docbook format, are handled different from applications. The translated Handbooks are committed into the l10n module in the docs folder under each language. In addition, the docs folder is broken down by module and application. For example, the German Kate Handbook is committed to the {{path|l10n-kde4/de/docs/kde-baseapps/kate/}} folder. When compiled, the German Kate Handbook is installed to {{path|$KDEDIR/share/doc/HTML/de/kate/index.cache.bz2}}.

Note that it is up to each translation team to generate the translated Handbook when they feel it is complete.

[[Category:Programming]]

Development/Tutorials/Localization/i18n Build Systems

2012-08-03T14:45:49Z

Agateau: /* handling i18n in KDE's subversion repository */ typo--

{{TutorialBrowser|

series=Localization|

name=Building KDE's l10n Module|

pre=[[../i18n|Writing Applications With Localization in Mind]]|
next=[[../Language Change|Dealing with language changes]]|
}}

== Abstract ==

Now that your application is ready to be localized, we next look at how to incorporate the necessary mechanisms into the CMake build system of your application.

First we'll explain the "theory" of the steps that need to happen from extracting message strings to installing the generated .po files. After that we'll look at how to implement those steps ([[#Theory: The xgettext toolchain]]). If your application is developed in KDE's subversion repository, many of those steps will happen automatically (see [[#handling i18n in KDE's subversion repository]]). Else you will want to read on in the [[#handling i18n in third party applications]] section.

== Theory: The xgettext toolchain ==

Making translations work consists of the following steps:
# Extract the translatable strings
# Merge the new or changed strings with existing translations
# Compile the translations into message catalogs
# Install the message catalogs
# Use the message catalogs in the application

=== Extracting the strings ===

In this step, all the strings you marked as i18n()/ki18n()/etc. in your sources need to be collected into a translation template (.pot) file. Some translateable strings are also contained in .ui, .rc, or .kcfg files. Also tips-of-the-day need to be collected into the .pot file.

These steps are handled by {{path|xgettext}}, {{path|extractrc}}, and {{path|preparetips}} programs, respectively. In some cases you may also need {{path|extractattr}}.

=== Merging translations ===

Generally, only a few translatable string will change at a time, in an application. Some will be removed, some will be added, some will be changed into different strings, and some will be moved around in the source files. These changes need to be reflected in the translations, but of course it would be a huge effort to redo the entire translation every time a string was changed. Rather the changes should be merged with the existing translations. This is the job of the {{path|msgmerge}} tool.

=== Compiling the translations ===

In order to make message lookup fast, the .po files need to be compiled into so-called "message catalogs" (.mo / .gmo). This is done using the {{path|msgfmt}} tool.

=== Installing the message catalogs ===

The compiled message catalogs need to be installed alongside the application. In KDE, the standard location for message catalogs is {{path|$KDEDIR/share/locale/xx/LC_MESSAGES/}}.

=== Using the message catalogs ===

Finally, when the application is run, it needs to load the appropriate message catalog in order to be able to look up and show translated strings. In KDE applications, this is the job of the {{class|KLocale}} class, and in the great majority of cases happens automatically.

For some special cases, such as plugins, look at [[#Runtime Loading Of Catalogs]].

== handling i18n in KDE's subversion repository ==

If your application is developed inside KDE's subversion repository, most of the steps outlined above are automated. In this case, generally, all you will need to do is provide a simple script called {{path|Messages.sh}}, which we will look at below.

In addition, if your top-level folder and .pot file have the same name, the svn2dist script will automatically include .po files when you use it to make a source tarball for your app.

Of course, for the curious, a more detailed account of what happens behind the scenes is also provided.

=== Writing a Messages.sh script ===

Basically, the only thing that is necessary to prepare and install translations for applications in KDE's subversion repository, is to provide information, which sources, ui-files or tips need to be translated. For this purpose, you write a small script called {{path|Messages.sh}} and place it in your sources. Here is an example with inline comments:

<syntaxhighlight lang="cpp-qt">
#!bin/sh

# invoke the extractrc script on all .ui, .rc, and .kcfg files in the sources
# the results are stored in a pseudo .cpp file to be picked up by xgettext.
$EXTRACTRC `find . -name \*.rc -o -name \*.ui -o -name \*.kcfg` >> rc.cpp
# if your application contains tips-of-the-day, call preparetips as well.
$PREPARETIPS > tips.cpp
# call xgettext on all source files. If your sources have other filename
# extensions besides .cc, .cpp, and .h, just add them in the find call.
$XGETTEXT `find . -name \*.cc -o -name \*.cpp -o -name \*.h -name \*.qml` -o $podir/APPNAME.pot
</syntaxhighlight>

As you can see, this script contains only three actual lines of code, and not all may even be needed. The $XGETTEXT, $PREPARETIPS, $EXTRACTRC, and $podir environment variables are predefined, you do not need to worry about setting these. The only thing that you will need to do is to replace "APPNAME" with the name of your application (but see [[#Naming .pot Files]] for exceptions).

Translatable strings are automatically extracted from C++ files. For non-C++ files, the following scripts are used
* $EXTRACTRC - Extract translatable strings from xml configuration and ui files.
* $EXTRACT_GRANTLEE_TEMPLATE_STRINGS - Extract translatable strings from Grantlee template files.

Try to make sure your Messages.sh script collects only those messages that are really needed. If in doubt, look at other Messages.sh files in the KDE subversion repository for inspiration, or -- of course -- ask.

=== What's happening behind the scenes ===

{{tip|If your application is in the KDE code repository, all this happens automatically. If your code is not in the KDE repository, you must perform these steps yourself. See [[#handling i18n in third party applications]].}}

Periodically, the script {{path|extract-messages.sh}} (a.k.a. scripty) runs on the KDE server. This program basically calls all Messages.sh scripts in the repository with the appropriate parameters. The extracted messages are stored in template (.pot) files in the templates folder of the l10n module. See [[What Is Scripty]] for more information.

The KDE translation teams translate the messages and commit them into a messages folder corresponding to the language, which is further broken down by module. For example, German translated messages for konqueror are committed to {{path|l10n/de/messages/kdebase/konqueror.po}}.

When the l10n module is built, the .po files are compiled into a binary format for fast lookup and installed as .mo files to {{path|$KDEDIR/share/locale/xx/LC_MESSAGES/}}, where xx is the two-letter ISO 639 code for the language. These are called the message catalogs.

At runtime, the <tt>i18n(...)</tt> function, using the original string you coded, looks up the string in the message catalog of the user's desktop language and returns the translated string. If the message catalog is missing, or the specific string is not found, <tt>i18n(...)</tt> falls back to the original string in your code.

.desktop files in your project are handled separately. {{path|makemessages}} extracts strings, such as Name and Comment from the .desktop files and places them into a file named {{path|desktop_mmmm.pot}}, where mmmm is the module name, in the templates folder. Once translators have translated this file, makemessages inserts the translated strings back into the .desktop files. The list of strings extracted is in {{path|l10n/scripts/apply.cc}}. Here's the code that checks for them:

<syntaxhighlight lang="cpp-qt">
if (checkTag("Name", in, argc, argv, newFile))
continue;
if (checkTag("Comment", in, argc, argv, newFile))
continue;
if (checkTag("Language", in, argc, argv, newFile))
continue;
if (checkTag("Keywords", in, argc, argv, newFile))
continue;
if (checkTag("About", in, argc, argv, newFile))
continue;
if (checkTag("Description", in, argc, argv, newFile))
continue;
if (checkTag("GenericName", in, argc, argv, newFile))
continue;
if (checkTag("Query", in, argc, argv, newFile))
continue;
if (checkTag("ExtraNames", in, argc, argv, newFile))
continue;
</syntaxhighlight>

== handling i18n in third party applications ==

If your application is developed outside of KDE's subversion repository, you need to take care of generating and installing message catalogs yourself. This is not too hard to do, but you should make sure you have a basic understanding of all steps involved, so you will probably want to read [[#Theory: The xgettext toolchain]], first.

Also, there is more than one way to deal with i18n in your application. We will outline one approach to do so for simple applications, but you may want to diverge from this, if you like to.

=== General considerations ===

The i18n generation process can roughly be divided into two steps:

# Extracting and merging messages
# Compiling and installing message catalogs

The first step really concerns the ''sources'', while the second step is a natural part of compiling and installing an application. Hence, while the second step should definitely be incorporated into the build system for your application (we assume CMake, here), there is no striking reason for the first step to be handled by the build system.

In fact, the extraction and merging of messages does not map well onto the CMake concept of out-of-source builds, and CMake can't provide too much help for this step, either.

Hence, in this tutorial, we will handle the first step with a standalone shell script, and only the second step will be handled by CMake.

=== Extracting and merging messages ===

If you have read the section [[#handling i18n in KDE's subversion repository]] you will know that in the KDE repository, message extraction and merging is handled by a simple script called Messages.sh, which is invoked by a script called {{path|extract-messages.sh}}. Outside of KDE's repository, you will need to take care of both parts, but fortunately, this is easy enough. Here's a sample script:

<syntaxhighlight lang="bash">
#!/bin/sh
BASEDIR="../rkward/" # root of translatable sources
PROJECT="rkward" # project name
BUGADDR="http://sourceforge.net/tracker/?group_id=50231&atid=459007" # MSGID-Bugs
WDIR=`pwd` # working dir

echo "Preparing rc files"
cd ${BASEDIR}
# we use simple sorting to make sure the lines do not jump around too much from system to system
find . -name '*.rc' -o -name '*.ui' -o -name '*.kcfg' | sort > ${WDIR}/rcfiles.list
xargs --arg-file=${WDIR}/rcfiles.list extractrc > ${WDIR}/rc.cpp
# additional string for KAboutData
echo 'i18nc("NAME OF TRANSLATORS","Your names");' >> ${WDIR}/rc.cpp
echo 'i18nc("EMAIL OF TRANSLATORS","Your emails");' >> ${WDIR}/rc.cpp
cd ${WDIR}
echo "Done preparing rc files"

echo "Extracting messages"
cd ${BASEDIR}
# see above on sorting
find . -name '*.cpp' -o -name '*.h' -o -name '*.c' | sort > ${WDIR}/infiles.list
echo "rc.cpp" >> ${WDIR}/infiles.list
cd ${WDIR}
xgettext --from-code=UTF-8 -C -kde -ci18n -ki18n:1 -ki18nc:1c,2 -ki18np:1,2 -ki18ncp:1c,2,3 -ktr2i18n:1 \
-kI18N_NOOP:1 -kI18N_NOOP2:1c,2 -kaliasLocale -kki18n:1 -kki18nc:1c,2 -kki18np:1,2 -kki18ncp:1c,2,3 \
--msgid-bugs-address="${BUGADDR}" \
--files-from=infiles.list -D ${BASEDIR} -D ${WDIR} -o ${PROJECT}.pot || { echo "error while calling xgettext. aborting."; exit 1; }
echo "Done extracting messages"

echo "Merging translations"
catalogs=`find . -name '*.po'`
for cat in $catalogs; do
echo $cat
msgmerge -o $cat.new $cat ${PROJECT}.pot
mv $cat.new $cat
done
echo "Done merging translations"

echo "Cleaning up"
cd ${WDIR}
rm rcfiles.list
rm infiles.list
rm rc.cpp
echo "Done"
</syntaxhighlight>

Of course you will want to adjust the variable definitions at the top, and -- if needed -- add code to extract tips-of-the-day or other additional strings.

The example script assumes that all .po files and the .pot file are kept in a single directory, which is appropriate for most projects.

=== Compiling and installing message catalogs ===

Assuming you use the script from the previous section, you can place the following CMakeLists.txt in the directory containing the .po files:

<pre>
FIND_PROGRAM(GETTEXT_MSGFMT_EXECUTABLE msgfmt)

IF(NOT GETTEXT_MSGFMT_EXECUTABLE)
MESSAGE(
"------
NOTE: msgfmt not found. Translations will *not* be installed
------")
ELSE(NOT GETTEXT_MSGFMT_EXECUTABLE)

SET(catalogname rkward)

ADD_CUSTOM_TARGET(translations ALL)

FILE(GLOB PO_FILES *.po)

FOREACH(_poFile ${PO_FILES})
GET_FILENAME_COMPONENT(_poFileName ${_poFile} NAME)
STRING(REGEX REPLACE "^${catalogname}_?" "" _langCode ${_poFileName} )
STRING(REGEX REPLACE "\\.po$" "" _langCode ${_langCode} )

IF( _langCode )
GET_FILENAME_COMPONENT(_lang ${_poFile} NAME_WE)
SET(_gmoFile ${CMAKE_CURRENT_BINARY_DIR}/${_lang}.gmo)

ADD_CUSTOM_COMMAND(TARGET translations
COMMAND ${GETTEXT_MSGFMT_EXECUTABLE} --check -o ${_gmoFile} ${_poFile}
DEPENDS ${_poFile})
INSTALL(FILES ${_gmoFile} DESTINATION ${LOCALE_INSTALL_DIR}/${_langCode}/LC_MESSAGES/ RENAME ${catalogname}.mo)
ENDIF( _langCode )

ENDFOREACH(_poFile ${PO_FILES})

ENDIF(NOT GETTEXT_MSGFMT_EXECUTABLE)
</pre>

This iterates over all .po files in the directory, compiles them using msgfmt, and installs them to the standard location. You will want to change "catalogname" to the name of your application.

=== Getting translations ===

Now you just have to find translators to translate the extracted messages into the various languages. As your application gets used by more people, you will find that translators will volunteer to do this. Translated PO files then have to be stored in the po folder with the naming scheme <languagecode>.po.

=== Translating .desktop Files ===

Translating .desktop files is a bit tricky because the translation of .desktop files isn't fetched from .po/.gmo files, but must be part of the .desktop file itself. So we have 2 tasks:

* extract messages from the .desktop file
* merge the translations in the .desktop file

Our friends from Gnome provide the [http://freedesktop.org/wiki/Software/intltool intltool] package. While this tools is mainly written for the old autotools build system (but KDE uses CMake since KDE 4), we can use this package nevertheless for our purpose. Here is a step-by-step guide:

# Install the [http://freedesktop.org/wiki/Software/intltool intltool] package
# We assume that your .desktop file is named "MYPROGRAM.desktop".
# Make a copy of "MYPROGRAM.desktop" which is named "MYPROGRAM.desktop.template".
# In MYPROGRAM.desktop.template substitute the keys "Name" by "_Name", "GenericName" by "_GenericName" and "Comment" by "_Comment".
# Remove all translations from "MYPROGRAM.desktop.template".
# Add the following lines to the above described build script, at the end of the section "Preparing rc files":
<syntaxhighlight lang="bash">
intltool-extract --quiet --type=gettext/ini PATH/MYPROGRAM.desktop.template
cat PATH/MYPROGRAM.desktop.template.h >> ${WDIR}/rc.cpp
rm PATH/MYPROGRAM.desktop.template.h
cd ${WDIR}
</syntaxhighlight>
intltool-extract will create a dummy C++ header (PATH/MYPROGRAM.desktop.template.h) with the strings whose key starts with "_". We append the content of this header file into our "rc.cpp" and remove remove the file than. (We assume that "PATH" is the path to "MYPROGRAM.desktop.template", relative to the working directory of the script.)
# Add "-kN_:1" as additional parameter to the xgettext call in the section "Extracting messages". This is necessary because dummy code that intltool-extract produces uses "N_()" instead of "i18n()".
# Add the following lines to the above described build script, at the end of the section "Merging translations":
<syntaxhighlight lang="bash">
cd ${WDIR}
intltool-merge --quiet --desktop-style ${WDIR} PATH/MYPROGRAM.desktop.template PATH2/MYPROGRAM.desktop
</syntaxhighlight>
This will produce MYPROGRAM.desktop from MYPROGRAM.desktop.template, inserting all available translations in the .po files in the directory ${WDIR}. (We assume that "PATH" is the path to "MYPROGRAM.desktop.template", relative to the working directory of the script. We assume that "PATH2" is the path to the final location of "MYPROGRAM.desktop", relative to the working directory of the script.)

{{note|Names of .po files):For intltool, it is ''required'' that the .po files have the name <languagecode>.po without other characters (NOT programname_<languagecode>.po). This is important because intltool-merge simply uses the .po file name (without ".po") as language key in the .desktop file.}}

== Special cases (plugins, multiple catalogs, etc.) ==

=== Runtime Loading Of Catalogs ===

To have translations show up properly in an application, the name of the .pot file must match the name of the message catalog (.mo) file that your application will read at runtime. But what name will be used at runtime?

In general, it will be the value returned by <tt>{{class|KGlobal}}::instance()->instanceName()</tt>. But what will that be? The general rules for standalone applications are:
* the message catalog will default to the name of the application passed as the first argument to {{class|KAboutData}}
* if your code calls <tt>{{class|KLocale}}::setMainCatalog()</tt>, that name will be used instead
* if your code calls <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt>, the specified catalog will also be searched in addition to the main catalog

If your code does not call either of the {{class|KLocale}} methods mentioned above and your application is a plugin, it gets a little more complicated. If your code exports your plugin using the <tt>K_EXPORT_COMPONENT_FACTORY</tt> macro, like this:

<syntaxhighlight lang="cpp-qt">
K_EXPORT_COMPONENT_FACTORY( libkhtmlkttsdplugin, KGenericFactory<KHTMLPluginKTTSD>("khtmlkttsd") )
</syntaxhighlight>

then the catalog name will be the name passed in the {{class|KGenericFactory}} constructor - in the example above that woudl be <tt>khtmlkttsd</tt>. This is because the macro creates a {{class|Kinstance}} for you with the specified name.

However, some classes, such as <tt>KTextEditor</tt> create a <tt>KPart</tt> containing your component and the name passed in the macro is not used. In this case, you should call <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt> in the component's constructor.

If in doubt, the safest thing to do is to call <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt>.

{{tip|If you are not using the export macro for your plugin, you probably should be. See the API documentation of KGenericFactory for more information.}}

Calling <tt>{{class|KLocale}}::insertCatalog(const QString&)</tt> if the catalog has already been inserted does nothing. However, calling <tt>{{class|KLocale}}::removeCatalog(const QString&)</tt> removes the catalog no matter how many times it has been inserted. Therefore, take care that you do not inadvertently remove the catalog when multiple components are sharing a single catalog. For example, the following sequence will break translations:

<syntaxhighlight lang="cpp-qt">
// Component A loads and uses catalog xyz by calling
insertCatalogue("xyz");
// Component B loads and also uses the same catalog.
insertCatalogue("xyz");
// component B unloads and calls
removeCatalogue("xyz")
// Component A now doesn't translate properly.
</syntaxhighlight>

Notice that a sequence such as above will occur automatically if both components A and B are loaded using the <tt>K_EXPORT_COMPONENT_FACTORY</tt> macro and pass the same name argument to the KGenericFactory constructor.

=== Naming .pot Files ===

The name that you settle on for both the .pot file and catalog should be governed by where your code resides. If it is a component of another application and resides in that application's source tree, you'll want to share the main catalog of the application.

If is a component of another application but resides elsewhere in the code repository, you will probably have to create a separate .pot, but keep in mind that .pot filenames must be unique across all of KDE.

If it is a component of another application, but resides in the source tree of a second application, you should share with the second application. For example, the KDE text-to-speach daemon (KTTSD) includes a plugin for embedded Kate in {{path|kdeaccessibility/kttsd}} source tree. Since the plugin is not installed unless kttsd is installed, it shares its catalog with kttsd and calls <tt>{{class|KLocale}}::insertCatalog("kttsd")</tt> to do this.

==== Declarative plasmoids ====
For plasmoids written in pure qml, the .pot file must be names the same as its plugin name (with '''plasma_applet_''' prefix), specified in its desktop file as '''X-KDE-PluginInfo-Name'''. For instance if we have '''X-KDE-PluginInfo-Name=org.kde.active.ativityscreen''' the .pot file will be called '''plasma_applet_org.kde.active.ativityscreen.pot'''. The KLocale::insertCatalog() call is performed by the declarative scriptengine itself, so the developer of the qml plasmoid doesn't have to worry about that.

If the qml files are developed in the form of package instead of an automous plasmoid (for instance a package loaded by a C++ plasmoid) the .pot file will have the prefix '''plasma_package_''' instead.

== Handbooks ==

Handbooks, which are written in docbook format, are handled different from applications. The translated Handbooks are committed into the l10n module in the docs folder under each language. In addition, the docs folder is broken down by module and application. For example, the German Kate Handbook is committed to the {{path|l10n-kde4/de/docs/kde-baseapps/kate/}} folder. When compiled, the German Kate Handbook is installed to {{path|$KDEDIR/share/doc/HTML/de/kate/index.cache.bz2}}.

Note that it is up to each translation team to generate the translated Handbook when they feel it is complete.

[[Category:Programming]]

Contribute/Bugsquad

2012-07-27T13:41:39Z

Agateau: /* Articles */ typo--

[[File:Bugweeks_ladybug.png]]

==What is BugSquad?==

The '''KDE BugSquad''' keeps track of incoming bugs in KDE software, and goes through old bugs. We verify that a bug exists, and is reproducible, and that the reporter has given enough information. When applicable, we write testcases. ''Our end goal is to help developers notice valid bugs quicker, and to save their time.''

You do not need any programming knowledge to be in the Bugsquad, and it is a great way to give practical support to the KDE community. If you are just starting to learn programming, it is a great way to gain familiarity with the components.

==Bug Days==

We have regular days where we pick a software package and look through all the old Bugzilla bugs to see if they are still valid. Sort of a Bugzilla cleaning day.

{{:Contribute/Bugsquad/NextBugDay}}

[[:Contribute/Bugsquad/OrganizingABugDay|How to organize a BugDay]]

The results of all past bug days can be found [[/BugDays|here]].

===Bug Weeks===

Our team has recently launched a new iniciative named "Bug Weeks", as an evolution of the traditional BugDays. All the workflow is based on the [http://forum.kde.org/ KDE Community Forums].

You can find more information about it at [http://forum.kde.org/viewtopic.php?f=4&t=84473 its official announcement]

The first bugweek was about triaging Plasma Desktop bug reports. You can find more information in the [http://forum.kde.org/viewtopic.php?f=148&t=84713 BugWeek Session 0 article]. (A summary article is yet to come)

{{note|We don't just do bugs on BugDays! Don't hesitate to join us at '''#kde-bugs''' on irc.freenode.net, we have plenty for you to do. ;) Check the topic to see what we are currently working on. And if you are new, please read the "how to triage bugs" page.}}

==How to help==

Read the [[/Guide_To_BugTriaging|ultimate guide to BugTriaging for KDE Projects]] (Recommended)

or ...

Read this [[/Guide|guide]] and join us for one of our [[#Bug_Days|bug days]] or [[#Bug_Weeks|bug weeks]]. We meet on IRC in the #kde-bugs channel on irc.freenode.org. You can easily get started by having your questions answered there, and having someone guide you as to general bug triaging philosophy. Someone in IRC will usually be able to help you. Although we do sleep sometimes!

A summary of the BugSquad guide is provided below to give you a quick idea of how you can help:

* Confirming bugs. Bugs with the UNCONFIRMED status should get the NEW status once someone else is able to reproduce the bug reliably.
* Finding bug duplicates. Many bugs entered into Bugzilla are duplicates of other bugs. Sometimes it's hard to recognize these as duplicates but multiple people checking can make the duplicates bubble to the top of the pile. The following remarks may help you identifying them:
** Using the Similar Bugs link to look if there are duplicates.
** In the case of crashes, use the link below the comment field to look for crash reports with the same backtrace. The backtrace must be in the body of the report in order to look for similar reports. This tool does not look in attachments with backtraces.
* Close bugs which have insufficient information and which have been open for a long time (e.g. reporter does not respond to a need-more-info request). Usually a timeout of one month or more is considered to be an "information timeout".
* Categorize bugs into the right components. Many bug reports can be further categorized into components. For example, Konqueror reports can be assigned to KHTML and kfm components.
* Labeling bugs which contain testcases as such in the title. Ideally, testcases contain the minimal amount of code (HTML, scripts, C++ etc.) necessary to reproduce a bug.
* Writing testcases. Very useful and saves developers' time.

==Getting started==
The sheer number of open bugs can be overwhelming at the start. Here are some hints on getting started more smoothly:
* Look at a single product at a time. For large applications (like Konqueror), you may want to further limit your search to a particular component.
* Don't try to find duplicates early on. Finding duplicates is hard until you have become familiar with the bugs in a component. Start out with verifying UNCONFIRMED bugs as described above. That's valuable work, and a great way to familiarize yourself with the bug database.
* Avoid very old bugs with many comments, and also bugs with many votes. This may seem counter-intuitive, but in most cases these bugs are hard, have gotten a lot of attention, and are probably on a developer's TODO list already. If it is from an older version of KDE, and there are no recent comments, verify them, make a notation, and move on.
* Don't be afraid to ask the reporter for more info. It's something you can even do without Bugzilla permissions. And reporters will generally prefer being asked one question too many, instead of their report never being dealt with. Just remember to be polite. Ask yourself how you would feel if you got the message you are thinking about sending to a user.
* Look at the incoming Bugzilla bugs. Or find the oldest bugs for your favorite software application.
* Look through the rest of our documentation for more information!

==Articles==

* [[/Guide_To_BugTriaging|Dario's Guide to Bug Triaging]] - Extensive guide on how to perform bug triagers tasks

* [[/Quick_Introduction_to_Bugzilla|Quick introduction to Bugzilla]] - This article explains the basics about the bugtracking software that KDE uses: "Bugzilla". It includes the description of a bug reports fields and the workflow of most common tasks like searching into the database.

* [https://bugs.kde.org/page.cgi?id=fields.html A Bug's Life Cycle] - This article describes the possible status of a bug report and when each should be used.

* [[/How to triage bugs|How to triage bugs]] - This article gives step-by-step what you do during a BugDay, or how to start triaging on your own in our "ongoing triage" (usually for old Konqueror bugs; see #kde-bugs for the current link).

* [[Projects/SystemSettings#Bug_Triaging|How to triage System Settings bugs]] - Explains how System Settings works from a bug squasher's perspective.

* [http://forum.kde.org/viewtopic.php?f=9&t=84475 Preparing a testing environment] - This article from the BugWeeks initiative describes how to properly configure and setup a KDE SC environment in order to test the bugs.

* [[/How to create useful crash reports|How to create useful crash reports]] - This article helps users to prepare their KDE packages such they can create detailed backtraces.

* [[User:DarioAndres/Basic_Guide_about_Crash_Reporting|Basic guide about crash reports]] - This article is a basic/simplified version of the previous one.

* [http://community.kde.org/Getinvolved/Extra_Mile Extra Mile] - This article presents the Extra Mile initiative, whose goal is to help KDE applications and workspaces "walk the extra mile". The Extra Mile initiative uses Bugzilla to track extra mile bugs.

==External links==
*[http://bugs.kde.org/ Bug Tracker]
*[http://bugs.kde.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=wishlist&bugidtype=include&bug_id=&votes=100&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailtype2=substring&email2=&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&newqueryname=&order=bugs.votes,bugs.priority%2C%20bugs.bug_severity%2C%20bugs.bug_status%2C%20bugs.bug_id%20desc Feature Requests, sorted by popularity]
*[https://mail.kde.org/mailman/listinfo/bugsquad Subscribe to our mailinglist]
*[http://forum.kde.org/viewforum.php?f=148 BugWeeks subforum]
*[http://gitweb.kde.org/scratch/darioandres/bugsquad.git DarioAndres BugSquad GIT repo with useful scripts (including the batch generation for events)]

Contribute/Bugsquad

2012-07-27T13:41:23Z

Agateau: /* Articles */ Add link to Extra Mile initiative

[[File:Bugweeks_ladybug.png]]

==What is BugSquad?==

The '''KDE BugSquad''' keeps track of incoming bugs in KDE software, and goes through old bugs. We verify that a bug exists, and is reproducible, and that the reporter has given enough information. When applicable, we write testcases. ''Our end goal is to help developers notice valid bugs quicker, and to save their time.''

You do not need any programming knowledge to be in the Bugsquad, and it is a great way to give practical support to the KDE community. If you are just starting to learn programming, it is a great way to gain familiarity with the components.

==Bug Days==

We have regular days where we pick a software package and look through all the old Bugzilla bugs to see if they are still valid. Sort of a Bugzilla cleaning day.

{{:Contribute/Bugsquad/NextBugDay}}

[[:Contribute/Bugsquad/OrganizingABugDay|How to organize a BugDay]]

The results of all past bug days can be found [[/BugDays|here]].

===Bug Weeks===

Our team has recently launched a new iniciative named "Bug Weeks", as an evolution of the traditional BugDays. All the workflow is based on the [http://forum.kde.org/ KDE Community Forums].

You can find more information about it at [http://forum.kde.org/viewtopic.php?f=4&t=84473 its official announcement]

The first bugweek was about triaging Plasma Desktop bug reports. You can find more information in the [http://forum.kde.org/viewtopic.php?f=148&t=84713 BugWeek Session 0 article]. (A summary article is yet to come)

{{note|We don't just do bugs on BugDays! Don't hesitate to join us at '''#kde-bugs''' on irc.freenode.net, we have plenty for you to do. ;) Check the topic to see what we are currently working on. And if you are new, please read the "how to triage bugs" page.}}

==How to help==

Read the [[/Guide_To_BugTriaging|ultimate guide to BugTriaging for KDE Projects]] (Recommended)

or ...

Read this [[/Guide|guide]] and join us for one of our [[#Bug_Days|bug days]] or [[#Bug_Weeks|bug weeks]]. We meet on IRC in the #kde-bugs channel on irc.freenode.org. You can easily get started by having your questions answered there, and having someone guide you as to general bug triaging philosophy. Someone in IRC will usually be able to help you. Although we do sleep sometimes!

A summary of the BugSquad guide is provided below to give you a quick idea of how you can help:

* Confirming bugs. Bugs with the UNCONFIRMED status should get the NEW status once someone else is able to reproduce the bug reliably.
* Finding bug duplicates. Many bugs entered into Bugzilla are duplicates of other bugs. Sometimes it's hard to recognize these as duplicates but multiple people checking can make the duplicates bubble to the top of the pile. The following remarks may help you identifying them:
** Using the Similar Bugs link to look if there are duplicates.
** In the case of crashes, use the link below the comment field to look for crash reports with the same backtrace. The backtrace must be in the body of the report in order to look for similar reports. This tool does not look in attachments with backtraces.
* Close bugs which have insufficient information and which have been open for a long time (e.g. reporter does not respond to a need-more-info request). Usually a timeout of one month or more is considered to be an "information timeout".
* Categorize bugs into the right components. Many bug reports can be further categorized into components. For example, Konqueror reports can be assigned to KHTML and kfm components.
* Labeling bugs which contain testcases as such in the title. Ideally, testcases contain the minimal amount of code (HTML, scripts, C++ etc.) necessary to reproduce a bug.
* Writing testcases. Very useful and saves developers' time.

==Getting started==
The sheer number of open bugs can be overwhelming at the start. Here are some hints on getting started more smoothly:
* Look at a single product at a time. For large applications (like Konqueror), you may want to further limit your search to a particular component.
* Don't try to find duplicates early on. Finding duplicates is hard until you have become familiar with the bugs in a component. Start out with verifying UNCONFIRMED bugs as described above. That's valuable work, and a great way to familiarize yourself with the bug database.
* Avoid very old bugs with many comments, and also bugs with many votes. This may seem counter-intuitive, but in most cases these bugs are hard, have gotten a lot of attention, and are probably on a developer's TODO list already. If it is from an older version of KDE, and there are no recent comments, verify them, make a notation, and move on.
* Don't be afraid to ask the reporter for more info. It's something you can even do without Bugzilla permissions. And reporters will generally prefer being asked one question too many, instead of their report never being dealt with. Just remember to be polite. Ask yourself how you would feel if you got the message you are thinking about sending to a user.
* Look at the incoming Bugzilla bugs. Or find the oldest bugs for your favorite software application.
* Look through the rest of our documentation for more information!

==Articles==

* [[/Guide_To_BugTriaging|Dario's Guide to Bug Triaging]] - Extensive guide on how to perform bug triagers tasks

* [[/Quick_Introduction_to_Bugzilla|Quick introduction to Bugzilla]] - This article explains the basics about the bugtracking software that KDE uses: "Bugzilla". It includes the description of a bug reports fields and the workflow of most common tasks like searching into the databse.

* [https://bugs.kde.org/page.cgi?id=fields.html A Bug's Life Cycle] - This article describes the possible status of a bug report and when each should be used.

* [[/How to triage bugs|How to triage bugs]] - This article gives step-by-step what you do during a BugDay, or how to start triaging on your own in our "ongoing triage" (usually for old Konqueror bugs; see #kde-bugs for the current link).

* [[Projects/SystemSettings#Bug_Triaging|How to triage System Settings bugs]] - Explains how System Settings works from a bug squasher's perspective.

* [http://forum.kde.org/viewtopic.php?f=9&t=84475 Preparing a testing environment] - This article from the BugWeeks initiative describes how to properly configure and setup a KDE SC environment in order to test the bugs.

* [[/How to create useful crash reports|How to create useful crash reports]] - This article helps users to prepare their KDE packages such they can create detailed backtraces.

* [[User:DarioAndres/Basic_Guide_about_Crash_Reporting|Basic guide about crash reports]] - This article is a basic/simplified version of the previous one.

* [http://community.kde.org/Getinvolved/Extra_Mile Extra Mile] - This article presents the Extra Mile initiative, whose goal is to help KDE applications and workspaces "walk the extra mile". The Extra Mile initiative uses Bugzilla to track extra mile bugs.

==External links==
*[http://bugs.kde.org/ Bug Tracker]
*[http://bugs.kde.org/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr&long_desc=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=wishlist&bugidtype=include&bug_id=&votes=100&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailtype2=substring&email2=&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&newqueryname=&order=bugs.votes,bugs.priority%2C%20bugs.bug_severity%2C%20bugs.bug_status%2C%20bugs.bug_id%20desc Feature Requests, sorted by popularity]
*[https://mail.kde.org/mailman/listinfo/bugsquad Subscribe to our mailinglist]
*[http://forum.kde.org/viewforum.php?f=148 BugWeeks subforum]
*[http://gitweb.kde.org/scratch/darioandres/bugsquad.git DarioAndres BugSquad GIT repo with useful scripts (including the batch generation for events)]

Development/Tutorials/Plasma/QML/API

2012-07-18T10:41:18Z

Agateau: /* QtExtraComponents */ add import line, improve FillMode doc, rm fillMode from QIconItem

= Introduction to the Plasmoid QML Declarative API =

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

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

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

== What Is a Declarative Plasmoid? ==

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

X-Plasma-API=declarativeappletscript

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

== fetching data from the plasmoid package ==

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

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

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

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

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

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

= Main Plasma QML Classes =

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

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

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

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

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

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

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

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

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

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

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

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

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

<syntaxhighlight lang="javascript">

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

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

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

</syntaxhighlight>

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

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

Example:

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

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

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

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

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

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

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

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

Why, that's easy.

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

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

To:

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

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

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

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

== Plasma Themes ==

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

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

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]
* bool '''usingRenderingCache'''

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

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

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

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

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

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

Sample Code:

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

width: 300
height: 3

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

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

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

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

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

Sample Code:

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

== Top Level windows ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

For QPixmapItem, possible values are:

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

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

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

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height

Development/Tutorials/Plasma/QML/API

2012-07-12T14:38:34Z

Agateau: /* Dialog */ fix code snippet formatting

= Introduction to the Plasmoid QML Declarative API =

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

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

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

== What Is a Declarative Plasmoid? ==

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

X-Plasma-API=declarativeappletscript

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

== fetching data from the plasmoid package ==

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

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

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

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

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

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

= Main Plasma QML Classes =

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

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

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

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

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

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

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

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

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

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

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

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

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

<syntaxhighlight lang="javascript">

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

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

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

</syntaxhighlight>

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

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

Example:

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

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

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

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

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

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

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

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

Why, that's easy.

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

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

To:

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

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

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

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

== Plasma Themes ==

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

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

=== Svg ===
Declaring a Svg element instantiates a Plasma Svg instance. This class doesn't draw anything. For drawing, SvgItem is used.
Properties:
* QSize '''size'''
* bool '''multipleImages'''
* String '''imagePath''' can be anything in the '''desktoptheme/''' folder. For more information on what is available, see [http://techbase.kde.org/Projects/Plasma/Theme#Current_Theme_Elements Plasma Theme Elements]
* bool '''usingRenderingCache'''

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

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

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

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

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

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

Sample Code:

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

width: 300
height: 3

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

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

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

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

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

Sample Code:

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

== Top Level windows ==

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

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

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

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

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

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

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

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

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

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

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

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

enum FillMode {
Stretch, // the image is scaled to fit
PreserveAspectFit, // the image is scaled uniformly to fit without cropping
PreserveAspectCrop, // the image is scaled uniformly to fill, cropping if necessary
Tile, // the image is duplicated horizontally and vertically
TileVertically, // the image is stretched horizontally and tiled vertically
TileHorizontally //the image is stretched vertically and tiled horizontally
};

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

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

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

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

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

Properties:
* QIcon/QString '''icon''': If you provide a QIcon it uses that directly. If you provide a string it uses a KIcon internally!
* bool '''smooth''': Set to true to render smooth.
* int '''nativeWidth''': (verification needed) The QPixmap width
* int '''nativeHeight''': (verification needed) The QPixmap height
* FillMode '''fillMode'''

Development/Tutorials/Plasma

2012-07-12T14:17:15Z

Agateau: typos--

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

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

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

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

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

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

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

== C++ ==

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

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

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

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

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

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

=== DataEngines ===

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

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

=== PackageStructures ===

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

=== Runners ===

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

=== Wallpapers ===

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

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

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

=== Plasma Shells ===

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

== JavaScript ==

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

=== Plasmoids ===

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

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

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

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

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

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

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

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

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

== Python ==

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

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

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

=== DataEngines ===

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

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

=== Runners ===

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

== Ruby ==

=== Plasmoids ===

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

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

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

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

=== DataEngines ===

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

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

== Plasma integration for applications ==

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

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

== Packages ==

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

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

== Themes ==

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

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

== Activity Templates ==

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

== Resources ==

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

Schedules/KDE4/4.9 Feature Plan

2012-05-14T07:32:12Z

Agateau: /* kdegraphics */

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

See also:

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

 Legend:

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

__TOC__

 

= kdelibs =

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

! Status
! Project
! Description
! Contact
{{FeatureDone|KGlobalSettings|Make KGlobalSettings reread locale settings before calling settingsChanged().|lamarque@kde.org|Lamarque V. Souza}}
{{FeatureDone|Kate Part|Reworked Color Configuration|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|KActivities|Encryption for private activities (not available via UI).|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|KActivities|Linking files to activities in Dolphin, Konqueror, Folder View.|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|KActivities|Activities KIO.|ivan.cukic@kde.org|Ivan Čukić}}
|}
 

= kde-runtime =

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

! Status
! Project
! Description
! Contact

{{FeatureDone|Thumbnail|fix for bookmarks|sebas@kde.org|Sebastian Kügler}}

|}
 

= kde-workspace =

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

! Status
! Project
! Description
! Contact
{{FeatureDone|ksmserver|Port shutdown dialog to QML|lamarque@kde.org|Lamarque V. Souza}}
{{FeatureInProgress|ksmserver|Merge the new qml based screen locker|mart@kde.org|Marco Martin}}
{{FeatureDone|plasma|MPRIS2 dataengine|alex.merry@kdemail.net|Alex Merry}}

{{FeatureTodo|kwin|windows that are moved to another desktop should be treated as sticky windows (Bug 213847)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Quick Tile shortcuts should be toggle buttons (Bug 263755)|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|Display application menu and title bar side by side for maximized windows (Bug 102607)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|No reason given why some desktop effects cannot be activated (Bug 209213, Review 104847)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Add support for appmenu-qt (Bug 266596)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Decoration KCM should show comment for decoration (Bug 296041)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Lanczos Filter broken after screen size changes (Bug 296065)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|DesktopThumbnailItem for QML (Bug 296067)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Packages for Desktop Switching Layouts (Bug 296068)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Walk Through Desktop layout rendering desktop previews (Bug 296069)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Move ThumbnailBar from BoxSwitch to CoverSwitch (Bug 296070)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Drop BoxSwitch effect (Bug 296071, Review 104454)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Different binary name for KWin Active (Bug 296084)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Import Scripted Effect from All Effets Tab (Bug 296772)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|GHNS support for Scripted Effects (Bug 296773)|kwin-bugs-null@kde.org}}
{{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}}
{{FeatureTodo|kwin|GHNS support for Window Switching Layouts (Bug 297636)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Request category for Window Switcher Layouts on kde-(look<nowiki>|</nowiki>app).org (Bug 297637)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Update Documentation for Window Switcher Layouts (Bug 297638)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Window Switcher KCM needs to be reworked (Bug 297639, Review 104525)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|ThumbnailItem allows upscaling of Windows (Bug 297864)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Redesign the kwin's kcm "All effects" (Bug 298991, Review 104849)|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|Add ABI check to KDecorations (Bug 299141)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|New Window Decoration for Thin Clients (Bug 299143)|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|Improve VSync strategy (Bug 299274)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Screen Edge bindings for KWin Scripting (Bug 299275)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Support Plasma API Extensions in KWin Scripting (Bug 299276)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Move Workspace's compositing functionality to own class Compositor (Bug 299277, Review 102420)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Better QML selection list for Window Switcher layout (Bug 299278)|kwin-bugs-null@kde.org}}
{{FeatureInProgress|kwin|Default Bindings for Switching between Windows of current Application (Bug 299308, Review 104730)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Useraction menu closes when focus passes to another window (Bug 81743)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: change focus only when moving mouse (Bug 92290)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: kwin fulscreen / un-fullscreen system notifications (Bug 124612, Review 104457)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Insufficient stacking order handling for deleted windows (Bug 158262, Review 104519)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Use arrow keys to control cover switch. (Bug 178595, Review 104438)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Dragging a title bar against a bottom panel twice makes it go under the panel on the second time (Bug 210926)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Wobbly windows wobbles strange after quick-maximization (Bug 222102)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|"Move" command should allow off-screen window moving same as Alt + click trick (Bug 229942)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Bug with shading always inactive windows (Bug 242217)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Change title of menu item "Configure window behaviour..." (Bug 249486)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Task switcher message when no windows looks ugly with stars (Bug 260938)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Placement Policy 'under mouse' (Bug 272162)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|JJ: Synchronize Show Desktop wording in all tabbox effects (Bug 273478, Review 104436)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|closing session crash (Bug 282933, Review 104690)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Window Specific Settings dialog has no help function (Bug 286783)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add "Present Windows - Window Class" to "Screen Edges" functions (Bug 288960)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|[JJ] Select next window with arrow key in Alt+Tab (Bug 291916)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashed when I was switching windows (Bug 292614)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Kill helper should be out of process (Bug 295940)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Synchronize user actions menu with libtaskmanager (Bug 296056)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Document global JavaScript methods in KWin Scripting API documentation (Bug 297640)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Elevate windows in addition to highlight (Bug 297809)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|KWin crashes when interacting with Plasma (Bug 298669, Review 104714)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Effects cannot be configured (Bug 299163)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Adding proper window thumbnail clipping to the QML tabbox (Bug 299198)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Add layout specification to D-Bus call for invoking TabBox (Bug 299279, Review 104838)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Make desktop focus chains activities aware (Bug 299309, Review 104649)|kwin-bugs-null@kde.org}}
{{FeatureDone|kwin|Desktop Zoom should be saved between sessions (Bug 189956, Review 104597)|kwin-bugs-null@kde.org}}
{{FeatureTodo|kwin|Settings to show windows on specific activities (like we have vor vds)|ivan.cukic@kde.org}}

|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo|FolderView|Refactor into PopupApplet and Containment|ignat.semenov@blue-systems.com|Ignat Semenov}}
{{FeatureDone|Dolphin|Allow to show any kind of metadata like ratings, tags, comments, image-sizes, music-artist, ... beside each item of the view.|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Use KMessageWidget for information- and error-messages (see http://agateau.com/2011/04/21/kde-ux-2011/ for details)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Optionally remember the column-widths of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to disable the expandable folders of the details view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Implement inline renaming for the new view-engine|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Allow to optionally set a maximum number of lines for the icons-view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Dolphin|Implement files quick preview feature (named Klook) |evgeniy.augin@osinit.ru|Evgeniy Auzhin}}
{{FeatureDone|Konsole|Add command line options for controlling the visibility of menubar and tabbar|adaptee@gmail.com|Jekyll Wu}}

|}
 

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{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}}
{{FeatureTodo|Marble|Marble Touch on Android|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Support for loading geolocated photos (e.g. in a Gallery activity in Marble Touch)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Layer Management (by the user: Toggle layer visibility; maybe move layers from legend and layers in menus to one central place/tab)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Extend graph data structure to support overlay graphs|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureDone|Rocs|Stepped execution of algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|General unit test cleanup and overhauling|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|New Project Wizard - guided creation based on loaded plugins|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Project journal files|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|New Add-Node/Add-Link Toolbar for data types and pointer types|rocs-devel@kde.org|Rocs Developers}}
{{FeatureTodo|Kig|Improve Cancel Construction and Undo actions|david.narvaez@computer.org|David E. Narváez}}
{{FeatureDone|Pairs|New memory game|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra Mobile|Many improvements, including Android and better Active 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|libkdegames|[http://community.kde.org/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|Granatier|improve config UI for player and arena selection|m-hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Kajongg|tooltips giving playings hints|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|new config option: propose what to do|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|make it possible to replay a game from a screen shot (for better debugging)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|improve Robot AI|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Add default voices|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Players can chat with each other from within kajongg|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Define a central game server, making it easier to play over the internet (no more tweaking of firewalls for the server side)|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureInProgress|Kajongg|Add support for other rule variants, starting with Classical Chinese variants|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Print rulesets, also more than one in parallel for comparisons|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Add the Gold Rush II championship game (20 levels), contributed by Gabriel Miltschitzky|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add solution files to some KGoldrunner games|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Simplify the XML descriptions of puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for seven new two-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Add XML and Desktop files for three new three-dimensional puzzle shapes|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Improve the quality and relevance of KSudoku hints|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make Load and Save work correctly for all puzzle types, including display of small markers/notes and restart of the puzzle clock from a saved value|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Integrate the new generator/solver and the old KSudoku code more closely|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KSudoku|Make puzzle features easier to see and use by improving highlighting, control and settings in both 2-D and 3-D puzzles and adding keyboard input to 3-D puzzles|iandw.au@gmail.com|Ian Wadham}}
|}
 

= kdegraphics=

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

! Status
! Project
! Description
! Contact

{{FeatureDone|Gwenview|Fullscreen browse|agateau@kde.org|Aurélien Gâteau}}

|}
 

= kdemultimedia =

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

! Status
! Project
! Description
! Contact

{{FeatureDone|JuK|last.fm scrobbling|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureDone|JuK|cover-fetching from last.fm|martin.sandsmark@kde.org|Martin Sandsmark}}
{{FeatureInProgress|JuK|MPRIS2 support|alex.merry@kmail.net|Alex Merry}}
{{FeatureDone|Dragon|MPRIS2 support|hein@kde.org|Eike Hein}}
|}
 

= kdenetwork=

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

! Status
! Project
! Description
! Contact
{{FeatureDone|Kopete|Add option to group all offline users into a "Offline Users" group|kopete-devel@kde.org|Kopete Developers}}
{{FeatureDone|Kopete|Show contact's status change in chat window|igor.poboiko@gmail.com|Igor Poboiko}}
{{FeatureDone|Kopete|Add context option "rename" to contacts and allow changing custom display name inline.|kopete-devel@kde.org|Kopete Developers}}
|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact

{{FeatureDone|Akonadi Google Resources|Move contacts and calendars resources from Akonadi Google project to kdepim-runtime|dan@progdan.cz|Dan Vratil}}

{{FeatureDone|KTnef|Bring back KTnef from the KDE3 days. KTnef is a standalone TNEF attachment viewer|winter@kde.org|Allen Winter}}

{{FeatureTodo|Akonadi Kolab Resources|Kolab resource using the Kolab libraries to kdepim-runtime|chrigi_1@fastmail.fm|Christian Mollekopf}}

{{FeatureTodo|Extend Akonotes Format|Extend the akonotes format to support features required by zanshin and kolab|chrigi_1@fastmail.fm|Christian Mollekopf}}

{{FeatureDone|Import pim data|ImportWizard allows to import settings/mails/filters/calendar/addressbook from thunderbird/evolution/etc. when exists.|montel@kde.org|Laurent Montel}}

|}
 

= 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
{{FeatureDone|Now Playing|replace with QML version|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|Microblog|replace with QML version|sebas@kde.org|Sebastian Kügler}}
{{FeatureInProgress|StackFolder|Add applet for quick browse the stack of folders|ural.mullabaev@rosalab.ru|Ural Mullabaev}}
|}
 

= kdesdk =

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

 

= kdeutils=

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

! Status
! Project
! Description
! Contact

|}

Schedules/KDE4/4.9 Feature Plan

2012-04-10T15:37:45Z

Agateau: /* kdegraphics */

Development/Tutorials/KAuth/KCM HowTo

2012-04-10T12:28:54Z

Agateau: header: Add link to KCM HowTo

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

{{TutorialBrowser|

series=KAuth Tutorial|

name=Creating a KCM requiring authorization upon saving|

pre=[[Development/Tutorials/KAuth/KAuth_Actions|How to use KAuth Actions]], [[Development/Tutorials/KAuth/Helper_HowTo|Creating a KAuth helper]], [[Development/Tutorials/KCM_HowTo|Basic knowledge in creating a KCModule]]|

next=|

reading=[http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKCModule.html KCModule Class Reference]
}}

==Introduction==
A very common use case for KAuth helper are KCModules, which sometimes need to obtain high privileges upon saving. For this reason, KAuth has been integrated into KCModule API and kcmshell's appearance, to grant developers an extremely easy way to deploy privileged KCMs, and at the same time a very consistent and usable interface to your users.

==Creating a KCModule with KAuth==
The coding part is extremely easy, although this comes at the price of following some strict conventions, which also help KCM permission handling to stay consistent.

===Creating the save action===
The action name has to follow this format:

org.kde.kcontrol.<modulename>.save

Where <modulename> is the output of aboutData()->appName(), also known as the very first parameter you supply to ''KAboutData'' constructor.

Following this format is '''compulsory''' to make the KCM work.

===Adding the needed code in your KCModule's constructor===
In your KCModule's constructor, supposing you created the action as described above, you have to do the following:

<syntaxhighlight lang="cpp">setNeedsAuthorization(true);</syntaxhighlight>

This function automatically does the following:

*Creates the needed action
*Crafts the ''Apply'' and ''Ok'' buttons (if any) into KPushButtons integrated with the action
*Adds some visual elements to the KCM to notify the user about the status of the action (for example, if he needs to authenticate or if he's not authorized at all).

So everything is done for you. The only requirement is that ''setNeedsAuthorization'' should be called '''after''' ''setAboutData'' and ''setButtons'', otherwise it will fail.

===Adding the needed code to the save() function===
To save your module, here's what needs to be done in the ''save()'' function of your KCM:

<syntaxhighlight lang="cpp">
void MyKCM::save()
{
QVariantMap helperargs;
// Populate....

Action *action = authAction();
action->setArguments(helperargs);

ActionReply reply = action->execute();

if (reply.failed())
{
if (reply.type() == ActionReply::KAuthError) {
// There has been an internal KAuth error
KMessageBox::error(this, i18n("Unable to authenticate/execute the action: %1, %2", reply.errorCode(), reply.errorDescription()));
} else {
// Our helper triggered a custom error
// Act accordingly...
}
}
}
</syntaxhighlight>

The only difference you'll find with what you [[Development/Tutorials/KAuth/KAuth_Actions|are used to do when executing KAuth Actions]] is the ''authAction()'' method. This method belongs to KCModule's API and returns the action internally created by ''setNeedsAuthorization(true)'', or 0 if no action was created.

This action is already associated to the correct helper (see below) and ready to be executed: you just have to supply any additional arguments to it.

===Creating the helper===
You should already [[Development/Tutorials/KAuth/Helper_HowTo|know how to create a KAuth helper]], so this part won't be covered here. There are, however, some strict requirements to the helper format, just like for the action name.

*The helper id must be '''org.kde.kcontrol.<modulename>''', just like in the action
*The helper '''must''' implement the ''save'' action, but can also implement any other actions (for example, some KCMs require privileges when loading as well: you still can do it in the same helper)

===CMake and additional macros===
No additional macros are needed, except the [[Development/Tutorials/KAuth/Helper_HowTo|ones already shown to build the helper]].

==Conclusion==
As you have seen, there are almost no differences with a KCM not requiring high privileges, especially when deploying and building the module.

Porting a module requiring high privileges to KAuth is extremely easy and strongly advised, both for security and consistency, since your user will be provided with a better and more integrated overall experience.

Development/Tutorials

2012-04-10T12:27:40Z

Agateau: /* Plugins and KParts */ Add KCM HowTo

<languages />
<translate>

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


Tutorials are the fastest way of finding out what KDE will do for you, and how to do it. Here is a list of currently available tutorials '''for KDE4'''. Material for KDE3 and KDE2 is available on the bottom of this page.

== Basics of KDE 4 Programming == 


Are you interested in writing applications with KDE 4? This tutorial series is aimed at those completely new to KDE programming.
</translate>
;[[Special:myLanguage/Development/Tutorials/First program|<translate>
Hello World</translate>]]
:<translate>
An introduction to the very basics of KDE4 programming</translate>
;[[Special:myLanguage/Development/Tutorials/Using KXmlGuiWindow|<translate>
Creating the Main Window</translate>]]
:<translate>
This tutorial shows you the magic of an application's most important thing: The main window.</translate>
;[[Special:myLanguage/Development/Tutorials/Using KActions|<translate>
Using KActions</translate>]]
:<translate>
How to add actions to the menus and toolbars. Based on the MainWindow tutorial.</translate>
;[[Special:myLanguage/Development/Tutorials/Physical_Simulation|<translate>
Physical Simulation</translate>]]
:<translate>
How to perform a physical simulation: animation and diagram</translate>
;[[Special:myLanguage/Development/Tutorials/Saving and loading|<translate>
Saving and Loading</translate>]]
:<translate>
Introduces the KIO library while adding loading and saving support to our application.</translate>
;[[Special:myLanguage/Development/Tutorials/SqLite|<translate>
Using SqLite databases and QtSq</translate>l]]
:<translate>
Integrated databases without the need for a database server</translate>
;[[Special:myLanguage/Development/Tutorials/KCmdLineArgs|<translate>
Command line arguments</translate>]]
:<translate>
Adds the ability to specify which file to open from the command line to our text editor.</translate>
;[[Special:myLanguage/Development/Tutorials/CMake|<translate>
Introduction to CMake</translate>]]
:<translate>
How to use the CMake build system used by KDE4.</translate>
;[[Special:myLanguage/Development/Tutorials/Common Programming Mistakes|<translate>
Common Programming Mistakes</translate>]]
:<translate>
Various common mistakes made while developing Qt and KDE applications and how to avoid them.</translate>
;[[Special:myLanguage/Development/Tutorials/Debugging Linker Errors|<translate>
Debugging Linker Errors</translate>]]
:<translate>
How to understand and debug errors from the linker, at compile time.</translate>
;[[Special:myLanguage/Development/Tutorials/Using Qt Creator|<translate>
Using Qt Creator to develop your KDE program</translate>]]
:<translate>
How to use Qt Creator as an [http://en.wikipedia.org/wiki/Integrated_development_environment IDE] to develop KDE programs</translate>
;[[Special:myLanguage/Development/Tutorials/Creating Libraries|<translate>
Creating Libraries to share code</translate>]]
:<translate>
How to add the library to the buildsystem and how to prepare the source code.</translate>
;[[Special:myLanguage/Development/Tutorials/Session_Management|<translate>
Session Management</translate>]]
:<translate>
Make your application aware of X sessions</translate>
;[[Special:myLanguage/Development/Tutorial/Icons|<translate>
Icons</translate>]]
:<translate>
Deliver your application with icons that are automatically installed to the right places. Based on the [[Development/Tutorials/Using_KActions|Kaction Tutorial]].</translate>
;[[Special:myLanguage/Development/Tutorials/Desktop_File|<translate>
Desktop File</translate>]]
:<translate>
Let your application show up in the K menu and in application menus. Based on the Icons Tutorial.

== Testing And Debugging == 

</translate>
;[[Special:myLanguage/Development/Tutorials/Debugging|<translate>
Debugging your application</translate>]]
:<translate>
Tips, tools and techniques to apply when debugging your KDE application</translate>
;[[Special:myLanguage/Development/Tutorials/Unittests|<translate>
Writing Unittests for Qt4 and KDE4 with QTestLib</translate>]] ([http://developer.kde.org/documentation/tutorials/writingunittests/writingunittests.html <translate>
Original link</translate>])
:<translate>
Tutorial by [mailto:bradh@frogmouth.net Brad Hards] that describes how to write unit tests using the QTestLib framework. It is presented as an example based tutorial, and is still under development.</translate>
;[[Special:myLanguage/Development/Tutorials/Code_Checking|<translate>
Semi-automatic ways to detect code errors</translate>]]
<translate>
:Techniques you can use to detect errors in KDE code

== Managing Configuration Data With KConfig == 

</translate>
;[[Special:myLanguage/Development/Tutorials/KConfig|<translate>
Introduction To KConfig</translate>]]
:<translate>
An overview of the KConfig classes and how to use them in your application code</translate>
;[[Special:myLanguage/Development/Tutorials/Using KConfig XT|<translate>
Using KConfig XT</translate>]]
:<translate>
Tutorial on how to efficiently use the KConfig XT framework.</translate>
;[[Special:myLanguage/Development/Tutorials/Updating KConfig Files|<translate>
Updating KConfig Files</translate>]]
:<translate>
Tutorial on how to write an update script to keep changes in your application's config file format in sync with the user's already existing config file

== Services: Applications and Plugins == 
</translate>

;[[Special:myLanguage/Development/Tutorials/Services/Introduction|<translate>
Introduction to the Services Framework]]
:An overview of the services framework in KDE and what it provides the application developer. Covers the system configuration cache (SyCoCa), the source data files and what the indexed information can be used for.</translate>
;[[Special:myLanguage/Development/Tutorials/Services/Traders|<translate>
Finding Services Using Trader Queries</translate>]]
:<translate>
How to find services, such as plugins or mimetypes, that are indexed in the SyCoCa using Trader Query Syntax</translate>
;[[Special:myLanguage/Development/Tutorials/Services/Plugins|<translate>
Creating and Loading Plugins Using KService]]
:Learn how to define custom plugin types, find installed plugins (including 3rd party plugins) and load them in an easy and portable fashion using KService.

== Localization == 


See also [[Special:myLanguage/Localization|Localization portal]].
</translate>
;[[Development/Tutorials/Localization/Unicode|<translate>
Introduction To Unicode]]
:An introduction to what Unicode is as well as how to handle Unicode data in KDE applications.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n|<translate>
Writing Applications With Localization In Mind</translate>]]
:<translate>
This tutorial covers what localization is, why it's important and how to ensure your application is ready to be localized. A must read for all application developers.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Mistakes|<translate>
Avoiding Common Localization Pitfalls</translate>]]
:<translate>
There are several common mistakes that prevent applications from being properly localized. Find out what they are and how to easily avoid them in this tutorial.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/Building KDE's l10n Module|<translate>
Building KDE's Localization Module</translate>]]
:<translate>
Building and installing language support from KDE's localization (l10n) module is a good idea for those working on applications in the main KDE repository. Doing so will allow you to test your application in another language and spot problem areas. Learn how to do just that in this tutorial.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Build Systems|<translate>
Incorporating i18n Into the Build System</translate>]]
:<translate>
Once your application is ready to be localized, the next step is to ensure that translation files are built automatically and kept up to date. This tutorial covers the necessary CMakeFiles.txt additions as well the process of distributing the resulting message catalogs with your application.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Challenges|<translate>
Common i18n Challenges and Solutions</translate>]]
:<translate>
This tutorial covers challenges that you may eventually run into such as translating handbooks and other data that exists outside of the source code, merging and handling obsolete .po files, dealing with freezes, coding in languages other than English and creating independent releases of or moving applications between KDE modules.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n_Semantics|<translate>
Semantic Markup of Messages</translate>]]
:<translate>
To ensure consistent presentation and more meaningful representations of messages in applications, semantic markup can be applied to messages marked for translation using the KUIT system. This tutorial describes how this system works.</translate>
; [[Special:myLanguage/Development/Tutorials/Localization/i18n Krazy|<translate>
Automated i18n Code Checking</translate>]]
:<translate>
The Krazy code checker scans KDE's code and reports common i18n mistakes.

== Documentation == 
</translate>

;[[Special:myLanguage/Development/Tutorials/API_Documentation|<translate>
API Documentation</translate>]]
:<translate>
This tutorial explains how to document your APIs properly.</translate>
;[[Special:myLanguage/Development/Tutorials/Man_Pages|<translate>
Man Pages</translate>]]
:<translate>
Writing and Generating Reference Manual Pages.
;Source Code</translate>
: http://quickgit.kde.org
: http://websvn.kde.org

== Accessibility ==

;[[Special:myLanguage/Development/Tutorials/Accessibility|<translate>
Accessibility Overview</translate>]]
:<translate>
A list of accessibility tutorials and general information.</translate>
;[[Special:myLanguage/Development/Tutorials/Accessibility/Checklist|<translate>
Accessibility Checklist</translate>]]
:<translate>
What to look for in your application to make it accessible for as many people as possible.</translate>
;[[Special:myLanguage/Development/Tutorials/Accessibility/Screen_Reader_Setup|<translate>
Screen Reader</translate>]]
:<translate>
This tutorial will explain some details about using screen readers with KDE applications.</translate>
;[[Special:myLanguage/Development/Tutorials/Text-To-Speech|<translate>
Text-To-Speech</translate>]]
:<translate>
How to utilize Jovie text-to-speech service in your application.

== Application Automation and Scripting == 

=== D-Bus === 
</translate>
; [[Special:myLanguage/Development/Tutorials/D-Bus/Introduction|<translate>
Introduction to D-Bus</translate>]]
:<translate>
A straight-forward introduction to the core concepts in D-Bus from an application developer's perspective, this tutorial covers what D-Bus is and how it can be used by applications.</translate>
; [[Special:myLanguage/Development/Tutorials/D-Bus/Accessing Interfaces|<translate>
Accessing D-Bus Interfaces</translate>]]
:<translate>
A step-by-step guide to calling D-Bus methods and connecting to D-Bus signals using QtDBus.</translate>
; [[Special:myLanguage/Development/Tutorials/D-Bus/Intermediate_D-Bus|<translate>
Intermediate D-Bus</translate>]]
:<translate>
Tips to make use of QtDBus when faced with problematic real-world interfaces.</translate>
; [[Special:myLanguage/Development/Tutorials/D-Bus/Creating Interfaces|<translate>
Creating D-Bus Interfaces</translate>]]
:<translate>
Learn how to expose functionality in your application by creating and using custom D-Bus interfaces. Covers generating the XML descriptions, instantiating interfaces at run time and setting up the build system with CMake.</translate>
; [[Special:myLanguage/Development/Tutorials/D-Bus/CustomTypes|<translate>
Using Custom Types with D-Bus</translate>]]
:<translate> 
Learn how to use your own types in classes exported on D-Bus. Covers marhaling and unmarshaling of objects, the integration of custom types into XML descriptions and registering the custom types with the Qt Meta Object system.</translate>
; [[Special:myLanguage/Development/Tutorials/D-Bus/Autostart Services|<translate>
D-Bus Autostart Services</translate>]]
:<translate>
Turn your application into a D-Bus autostart service with this tutorial. This D-Bus feature, also known as "D-Bus service activation", will ensure that even when your application isn't running that D-Bus calls made to it will work by relying on the D-Bus daemon itself to start your app if and when needed.</translate>
; [[Special:myLanguage/Development/Tutorials/Porting_to_D-Bus|<translate>
Porting from DCOP to D-Bus</translate>]]
:<translate> 
Port your applications from DCOP to D-Bus with this handy guide.

=== Konqueror === 
</translate>
; [[Special:myLanguage/Development/Tutorials/Creating Konqueror Service Menus|<translate>
Creating Konqueror Service Menus</translate>]]
:<translate>
This tutorial shows you how to create mimetype-specific actions in Konqueror's context menu (aka "servicemenus").</translate>

=== Kross ===

; [[Special:myLanguage/Development/Tutorials/Kross/Introduction|<translate>
Introduction to Kross</translate>]]
:<translate>
An introduction to the Kross Scripting Framework.</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Hello_World|<translate>
Hello World</translate>]]
:<translate>
A first application with working kross code.</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Call_Functions_in_Kross|<translate>
Calling Functions in Kross</translate>]]
:<translate>
Simple demonstration of calling scripting functions</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Connecting_Signals_and_slots_in_Kross|<translate>
Connecting Signals and Slots in Kross</translate>]]
:<translate>
Simple demonstration of connecting object signals with script slots</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Scripts-as-Plugins|<translate>
Scripts as Plugins with Kross</translate>]]
:<translate>
This tutorial provides a step-by-step introduction how to integrate scripts as plugins into a KDE application.</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/Script-Actions|<translate>
Placing script actions in your application menus </translate>]]
:<translate>
Simple demonstration on how to extend you application menus to execute script files.</translate>
; [[Special:myLanguage/Development/Tutorials/Kross/ActionCollections|<translate>
How to use an ActionCollection ]</translate>]
:<translate>
A small Tutorial on How to use Kross::ActionCollections.
{{:KOffice/Plugin Tutorials}}

=== SuperKaramba === 
</translate>

; [[Special:myLanguage/Development/Tutorials/SuperKaramba|<translate>
SuperKaramba Tutorial</translate>]]
:<translate>
This tutorial provides an overview of SuperKaramba, theme files and scripting with Python, Ruby and JavaScript.

=== System Activity === 
</translate>

: [[Special:myLanguage/Development/Tutorials/SystemActivity/Scripting|<translate>
Writing script actions for the process's context menu</translate>]]
:<translate>
This tutorial shows how to add a context menu action to show custom information about a process.

=== KWin === 
</translate>

: [[Special:myLanguage/Development/Tutorials/KWin/Scripting<translate>
|KWin Scripting Tutorial</translate>]]
:<translate>
This tutorial shows how to write a useful script for KWin.

== Plugins and KParts == 
</translate>

; [[Special:myLanguage/Development/Tutorials/Using KParts|<translate>
Using KParts</translate>]]
:<translate>
A kPart is a plugin that you can just load into your application. For example, it is easy to integrate an editor (the katePart) or a console (the konsolePart) into your application's window.</translate>
; [[Special:myLanguage/Development/Tutorials/Writing kontact plugins|<translate>
Writing kontact plugins</translate>]]
:<translate>
Kontact plugins are KParts. This tutorial describes how you can write one.</translate>
; [[Special:myLanguage/Development/Tutorials/Writing Qt Designer Plugins|<translate>
Writing Qt Designer Plugins</translate>]]
<translate>
:Add your widgets to Qt Designer and thus make them usable in UI files.
; [[Special:myLanguage/Development/Tutorials/KCM_HowTo|KCM HowTo]]
:KCM are plugins which are loaded by System Settings to display configuration elements. They can also be used within an application.

== Search and Metadata == 

=== Strigi === 
</translate>

; [[Special:myLanguage/Development/Tutorials/Writing file analyzers|<translate>
Writing file analyzers</translate>]]
:<translate>File analyzers extract data from files to display in the file dialogs and file managers. The data gathered this way is also used to search for files. KDE4 allows the use of multiple analyzers per file type. This tutorial describes how you can write new analyzers.
=== [http://nepomuk.kde.org Nepomuk] === 


See [[Special:myLanguage/Development/Tutorials/Metadata/Nepomuk|Nepomuk tutorials]].

== Hardware Awareness (Solid) == 
</translate>

;[[Special:myLanguage/Development/Tutorials/Solid/Introduction|<translate>
Introduction to Solid</translate>]]
:<translate>
An introduction to the Solid effort in general and it library in particular.</translate>
;[[Special:myLanguage/Development/Tutorials/Solid/Device_Discovery|<translate>
Listing Devices</translate>]]
:<translate>
How to use the Solid core library to discover the hardware and interact with the system.</translate>
;[[Special:myLanguage/Development/Tutorials/Solid/Network_Management|<translate>
Accessing Network Information</translate>]]
:<translate>
How to use the Solid system to get information about the network</translate>
;[[Special:myLanguage/Development/Tutorials/Solid/Device_Actions|<translate>
Creating a Device Action</translate>]]
:<translate>
When your application is interested in registering actions with the system for removable hardware

== Authorization and Privilege escalation (KAuth) == 
</translate>

; [[Special:myLanguage/Development/Tutorials/KAuth/KAuth_Basics|<translate>
KAuth Basics</translate>]]
:<translate>
An overview of concepts and basic knowledge required to understand and use KAuth effectively</translate>
; [[Special:myLanguage/Development/Tutorials/KAuth/KAuth_Actions|<translate>
Using KAuth actions in your application</translate>]]
:<translate>
How to execute KAuth actions in your application, and how to integrate them tightly into your UI</translate>
; [[Special:myLanguage/Development/Tutorials/KAuth/Helper_HowTo|<translate>
Creating a KAuth helper to perform a privileged action</translate>]]
:<translate>
You will learn how to use KAuth's helpers and escalation facilities, and how to seamlessly make a privileged and non privileged portion of your application interact</translate>
; [[Special:myLanguage/Development/Tutorials/KAuth/KCM_HowTo|<translate>
Creating a KCM requiring authorization upon saving</translate>]]
:<translate>
Learn how to use the high level KCModule API to create KCModules handling authorization, and its UI integration, on their own

== Multimedia (Phonon) == 
</translate>

;[[Special:myLanguage/Development/Tutorials/Phonon/Introduction|<translate>
Phonon</translate>]]
:<translate>
The ;[[Special:myLanguage/Development/Tutorials/Phonon/Introduction|Introduction to Phonon]] tells how to compile and run the code. If you like to work in Python, try [[Development/Tutorials/Phonon/Introduction/Python|this version]] of the same tutorial</translate>
;[[Special:myLanguage/Development/Tutorials/Phonon/Backends|<translate>
Writing Backends</translate>]]
:<translate>
How to start creating a new backend for the multimedia API</translate>
<translate>
;Resources</translate>
<translate>
:Please have a look at the [http://api.kde.org/kdesupport-api/kdesupport-apidocs/phonon-git/html/ online documentation] for information on the Phonon API. If you prefer using Qt Assistant or Qt Creator you can also use our [http://mts.ms/phonon-4.4.2.qch offline documentation].

== Plasma == 
</translate>

See [[Special:myLanguage/Development/Tutorials/Plasma|<translate>
Plasma tutorials</translate>]].

<translate>
== Personal Information Management (Akonadi) == 
</translate>

;[[Special:myLanguage/Development/Tutorials/Akonadi/Application|<translate>
Using Akonadi in Applications</translate>]]
:<translate>
Displaying and modifying data provided by Akonadi</translate>
;[[Special:myLanguage/Development/Tutorials/Akonadi/Resources|<translate>
Developing Akonadi Resources</translate>]]
:<translate>
Akonadi Resources are agent programs which transport PIM data between Akonadi and a backend (files, servers, etc)</translate>
;[[Special:myLanguage/Development/Tutorials/Akonadi/SerializerPlugin|<translate>
Using custom data types with Akonadi</translate>]]
:<translate>
Akonadi can handle arbitrary data as item payloads through the use of a plugin based serialization framework</translate>
;[[Special:myLanguage/Development/AkonadiPorting|<translate>
Porting Applications which use KResource API</translate>]]
:<translate>
Applications using KDE's now deprecated KResource APIs, e.g. KABC or KCal, need to be ported to use their Akonadi equivalents

== Kate / Kwrite == 
</translate>

;[[Special:myLanguage/Development/Tutorials/Kate/KTextEditor Plugins|<translate>
Getting started with KTextEditor plugins</translate>]]
:<translate>
Creating your first KTextEditor plugin</translate>
;[[Special:myLanguage/Development/Tutorials/Kate/KTextEditor_Plugins_Advanced|<translate>
Developing a plugin with configuration dialog</translate>]]
:<translate>
Adding a configuration dialog to the Time & Date example</translate>
;[[Special:myLanguage/Development/Tutorials/Kate/KTextEditor_Example|<translate>
A small Editor</translate>]]
:<translate>
Create a small application using KTextEditor

== KDevelop == 
</translate>

;[[Special:myLanguage/Development/KDevelop-PG-Qt_Introduction|<translate>
KDevelop-PG-Qt Introduction</translate>]]
:<translate>
Information on the KDevelop parser generator, useful for language plugins.

==Printing== 


KDE mostly uses the [http://doc.qt.nokia.com/latest/printing.html Qt Printing infrastructure].
</translate>

;[[Special:myLanguage/Development/Tutorials/Printing Hello World|<translate>
Hello World</translate>]]
:<translate>
Introduction to the KDE printing system

== kioslaves == 
</translate>

* [[Special:myLanguage/Development/Tutorials/KIO Slaves/Using KIO Slaves in your Program|<translate>
Using kioslaves in your Program</translate>]]
* [[Special:myLanguage/Development/Tutorials/KIO Slaves/Hello World|<translate>
Creating a Hello-World kioslave</translate>]]
<translate>
== Collaboration == 

=== Open Collaboration Services (libattica) === 
</translate>
;[[Special:myLanguage/Development/Tutorials/Collaboration/Attica/Introduction|<translate>
Introduction to Attica</translate>]]
:<translate>
In this tutorial a simple widget showing information about a Person on the server is created.

=== Get Hot New Stuff === 
</translate>

;[[Special:myLanguage/Development/Tutorials/Collaboration/HotNewStuff/Introduction|<translate>
Get Hot New Stuff 3 - Download</translate>]]
:<translate>
How to use KHotNewStuff3 in your application.</translate>
;[[Special:myLanguage/Development/Tutorials/Collaboration/HotNewStuff/Updates|<translate>
Get Hot New Stuff 3 - Checking for Updates</translate>]]
:<translate>
How to check whether updates for installed stuff are available without showing the dialog/widget.</translate>
;[[Special:myLanguage/Development/Tutorials/Collaboration/HotNewStuff/Upload|<translate>
Get Hot New Stuff 3 - Upload</translate>]]
:<translate>
How to add an upload dialog to your application.


Old links for KNS2 and KNS1 content: 
</translate>
;[[Special:myLanguage/Development/Tutorials/K Hot New Stuff2|<translate>
Introduction to Get Hot New Stuff 2</translate>]]
:<translate>
A short tutorial about how to use KHotNewStuff2 in your application. Deprecated, use version 3 </translate>
;[[Special:myLanguage/Development/Tutorials/Introduction to Get Hot New Stuff|<translate>
Introduction to Get Hot New Stuff</translate>]]
:<translate>
An introduction to the developer-friendly network update system that allows KDE applications to fetch new application data at runtime in a user friendly manner.</translate>
;[[Special:myLanguage/Development/Tutorials/KNewStuffSecure|<translate>
KNewStuff Secure</translate>]] ([http://developer.kde.org/documentation/tutorials/knewstuffsecure/index.html <translate>
Original Link</translate>])
:<translate>
Tutorial showing how to share resources in a secured way (KDE 3.4 and later). By András Mantia <amantia@kde.org>.

== Goya == 
</translate>
; [[Special:myLanguage/Development/Tutorials/Introduction to Goya usage|<translate>
Introduction to Goya usage</translate>]]
:<translate>
An introduction for the Goya subsystem usage, which allows you to easily add widgets to your itemviews and connect their signals to your code, as they were real widgets.</translate>
; [[Special:myLanguage/Development/Tutorials/Introduction to Goya usage 2|<translate>
Introduction to Goya usage (part 2)</translate>]]
:<translate>
The second part of the tutorial, with a slightly more complex example than the first part.

== Other programming languages == 

=== Python === 
</translate>
;[http://www.learningpython.com/2008/09/20/an-introduction-to-pyqt/ <translate>
An Introduction to PyQt</translate>]
:<translate>
Starting off</translate>
;[http://lateral.netmanagers.com.ar/stories/BBS47.html<translate> 
PyQt by Example</translate>]
:<translate>
Another introduction to PyQt</translate>
;[[Special:myLanguage/Development/Languages/Python/PyKDE_WebKit_Tutorial|<translate>
PyKDE WebKit Tutorial</translate>]]
:<translate>
A simple web browser application in PyKDE</translate>
;[[Special:myLanguage/Development/Tutorials/Python introduction to signals and slots|<translate>
101 Introduction to signals and slots</translate>]]
:<translate>
A simple introduction to Qt's signal and slot architecture.</translate>
;[[Special:myLanguage/Development/Languages/Python/PyKDE_DBus_Tutorial|<translate>
PyKDE DBus Tutorial</translate>]]
:<translate>
An introduction to DBus communication using PyKDE</translate>
;[[Special:myLanguage/Development/Languages/Python/PyKDE_Knotify_Tutorial|<translate>
PyKDE KNotify Tutorial]]
:An introduction to Knotify (Notifications and KJobs) using PyKDE

=== Ruby === 
</translate>

;[http://developer.kde.org/language-bindings/ruby/kde3tutorial/index.html <translate>
KDE Ruby Korundum tutorial</translate>]
:<translate>
A ruby version of Antonio Larrosa Jiménez's KDE tutorial by Richard Dale. See the [[Development/Languages/Ruby|Ruby Developers Corner]] for Qt tutorials and other info.</translate>
;[[Special:myLanguage/Development/Tutorials/Qt4_Ruby_Tutorial|<translate>
Qt4 Ruby Tutorial</translate>]]
:<translate>
Nokia's fabulous introductory tutorial to Qt, translated to Ruby.</translate>
;[[Special:myLanguage/Development/Tutorials/Plasma/RubyApplet|<translate>
Creating a Plasma Widget in Ruby</translate>]]
:<translate>
Tutorial that shows how to create your first Plasma Applet using the Ruby language.</translate>
;[[Special:myLanguage/Development/Tutorials/Developing_Qt4_Applications_using_Qt_Designer_and_Ruby_on_Kubuntu|<translate>
Developing Qt4 Applications using Qt Designer and Ruby on Kubuntu</translate>]]
:<translate>
Tutorial that shows how to design a simple User Interface in Qt Designer and then use the resulting widget in a Qt Ruby application we build from scratch.</translate>
;[[Special:myLanguage/Development/Languages/Ruby/Ruby-Qt/KDE_Book|<translate>
Ruby-Qt/KDE Book]]
:There is also an approach to create an Ruby-Qt/KDE Book under a free license. The content will be created in this wiki.

=== Shell === 
</translate>

;[[Special:myLanguage/Development/Tutorials/Shell_Scripting_with_KDE_Dialogs|<translate>
Shell Scripting with KDE dialogs</translate>]] ([http://developer.kde.org/documentation/tutorials/kdialog/t1.html <translate>
Original Link</translate>])
:<translate>
Tutorial by [mailto:bradh@frogmouth.net Brad Hards] that describes how to use KDE dialogs in shell scripts with kdialog. It is presented as an example based tutorial.

== Graphics Programming == 
</translate>

;[[Special:myLanguage/Development/Tutorials/Graphics/Performance|<translate>
QPainter Perfomance</translate>]]
:<translate>
Hints on avoiding common mistakes leading to poor performance when using QPainter

== Using the KDE Games Libraries == 
</translate>

;[[Special:myLanguage/Development/Tutorials/Games/KStandardGameAction|<translate> 
KStandardGameAction</translate>]]
:<translate>
Using libkdegames to make your game fit the kdegames standard</translate>
;[[Special:myLanguage/Development/Tutorials/Games/Highscores| <translate>
Highscores</translate>]]
:<translate>
Implementing a simple highscore table into your game</translate>
;[[Special:myLanguage/Development/Tutorials/Games/Theme Selector|<translate> 
Theme Selector</translate>]]
:<translate>
Using the libkdegames theme selection dialog</translate>
;[[Special:myLanguage/Development/Tutorials/Games/Palapeli Patterns|<translate> 
Palapeli Slicers</translate>]]
:<translate>
Creating a slicer plugin for Palapeli

=== KGLEngine === 
</translate>

;[[Special:myLanguage/Development/Tutorials/Games/kglengine/kglengine-simpleBox|<translate> 
Installation and your first KGLItem</translate>]]
:<translate>
start your first kglengine application</translate>
;[[Special:myLanguage/Development/Tutorials/Games/KGLEngine2d| kglpong]]
:<translate>
Now use our knowledge to make a pong</translate>

== Using the KDE PIM Libraries ==

;[[Special:myLanguage/Development/Tutorials/PIM/ical|<translate> 
iCalendar functionality</translate>]]
:<translate>
Using kcal to manage iCalendar files</translate>

<translate>== Other tutorials == 

=== 2D Plotting (KPlotWidget) === 
</translate>

;[[Special:myLanguage/Development/Tutorials/KPlotWidget|<translate>
Using the KDE data-plotting widget</translate>]]
:<translate>
This tutorial introduces KPlotWidget, which is used for 2-D data plotting. It includes information on simple usage of the widget (including adding and modifying data sets, and customizing the plot axes and labels), and advanced customization (including extending the widget through sub-classing).

=== Spelling and Grammar Checking (Sonnet) === 
</translate>

;[[Special:myLanguage/Development/Tutorials/Sonnet/SonnetTutorial|<translate>
Adding spell-checking or grammar-checking to KDE applications</translate>]]
:<translate>
This tutorial introduces Sonnet and how one may use it to add language correction to your KDE application. Sonnet's auxiliary features shall be described in a separate tutorial.

=== Pixmap cache (KPixmapCache) === 
</translate>

;[[Special:myLanguage/Development/Tutorials/KPixmapCache|<translate>
Using the KDE pixmap cache</translate>]]
:<translate>
This tutorial shows how to use KPixmapCache to cache e.g. pixmaps generated from SVGs or some data.

=== Using MarbleWidget (Marble) === 
</translate>

;[[Special:myLanguage/Development/Tutorials/MarbleWidget|<translate>
Using MarbleWidget</translate>]]
:<translate>
This short tutorial describes how to use the MarbleWidget in your project

=== Using local SCM for KDE development === 
</translate>
;[[Special:myLanguage/Development/Git|<translate>
Using Git to develop for KDE</translate>]]
:<translate>
Here you find how to use Git to develop for KDE

=== Kwin effect tutorial (blog) === 


;[http://blog.martin-graesslin.com/blog/?p=258 blog by Martin Graesslin]
:This tutorial guides you through the development of a simple KWin effect

=== Implementing KSysGuard sensors and adding them === 
</translate>

;[[Special:myLanguage/Development/Tutorials/Sensors|<translate>
Sensors Tutorial</translate>]]
:<translate>
This tutorial shows how to write and KSysGuard sensor and connect it to the systray. </translate>
Runners

<translate>
=== Porting an application from KSystemTrayIcon to KStatusNotifierItem === 
</translate>

;[[Special:myLanguage/Development/Tutorials/PortToKStatusNotifierItem|<translate>
Porting from KSystemTrayIcon to KStatusNotifierItem</translate>]]
:<translate>
This tutorials shows how to port an application using KSystemTrayIcon to KStatusNotifierItem

=== Using the KDE Wallet API for safe storage === 
</translate>

;[[Special:myLanguage/Development/Tutorials/KWallet|<translate>
KWallet</translate>]]
:<translate>
"Brief introduction to the KWallet API which can be used for storing all kinds of sensitive information."

===How to edit a wiki with Libmediawiki === 
</translate>
;[[Special:myLanguage/Development/Tutorials/Libmediawiki|<translate>
Libmediawiki</translate>]]
:<translate>
This tutorial present how to edit a wiki with Libmediawiki.

== KDE2 and KDE3 Materials == 
</translate>
;[[Special:myLanguage/Development/Tutorials/KWallet|<translate>
KWallet]]</translate>
;[[Special:myLanguage/Development/Tutorials/KDE4 Porting Guide|<translate>
Porting Your Application from KDE 3 to KDE 4</translate>]]
:<translate>
These tutorials cover topics related to the migration from KDE 3 to KDE 4.</translate>
;[[Special:myLanguage/Development/Tutorials/KDE3|<translate>
KDE3 Tutorials</translate>]]
:<translate>
These tutorials cover topics related to KDE3.</translate>
;[[Special:myLanguage/Development/Tutorials/KDE2|<translate>
KDE2 Tutorials</translate>]]
:<translate>
These tutorials cover topics related to KDE2.


[[Category:KDE4]]
[[Category:Tutorials]]
</translate>

Development/Tutorials/KCM HowTo

2012-04-10T12:20:42Z

Agateau:

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

{{TutorialBrowser|

series=Plugins and KParts|

name=KCM HowTo|

pre=|

next=|

reading=[http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKCModule.html KCModule Class Reference]
}}

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo" /* kcm name */, "kcm_foo" /* catalog name */))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

Possible values at the time of this writing are:
* settings-lost-and-found
* settings-hardware
* settings-network-and-connectivity
* settings-system-administration
* settings-application-appearance-and-behavior
* settings-workspace-appearance-and-behavior

You can get a list of possible categories with this command, which lists all toplevel categories:

<pre>
ktraderclient --servicetype SystemSettingsCategory --constraint "[X-KDE-System-Settings-Parent-Category] == ''" | grep DesktopEntryName
</pre>

Just do not use the "settings-lost-and-found" entry.

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library. If you only have one KCModule in a library this key is not needed. If you have several KCMs in one library you will need a desktop file for each KCM.

For example, if you have a library named: kcm_frog.so with two modules, named "kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example, the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init but don't want the module to show up in System Settings.

You can also make the value of this key depend on the output of a program, using the "[$e]" key suffix. For example:

<pre>
Hidden[$e]=$(if test -e /dev/js*; then echo "false"; else echo "true"; fi)
</pre>

This example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-10T12:20:02Z

Agateau: Add nav bar and tutorial browser

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

{{TutorialBrowser|

series=Plugins and KParts|

name=KCM HowTo

pre=|

next=|

reading=[http://api.kde.org/4.x-api/kdelibs-apidocs/kdeui/html/classKCModule.html KCModule Class Reference]
}}

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo" /* kcm name */, "kcm_foo" /* catalog name */))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

Possible values at the time of this writing are:
* settings-lost-and-found
* settings-hardware
* settings-network-and-connectivity
* settings-system-administration
* settings-application-appearance-and-behavior
* settings-workspace-appearance-and-behavior

You can get a list of possible categories with this command, which lists all toplevel categories:

<pre>
ktraderclient --servicetype SystemSettingsCategory --constraint "[X-KDE-System-Settings-Parent-Category] == ''" | grep DesktopEntryName
</pre>

Just do not use the "settings-lost-and-found" entry.

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library. If you only have one KCModule in a library this key is not needed. If you have several KCMs in one library you will need a desktop file for each KCM.

For example, if you have a library named: kcm_frog.so with two modules, named "kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example, the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init but don't want the module to show up in System Settings.

You can also make the value of this key depend on the output of a program, using the "[$e]" key suffix. For example:

<pre>
Hidden[$e]=$(if test -e /dev/js*; then echo "false"; else echo "true"; fi)
</pre>

This example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-10T12:15:32Z

Agateau: moved User:Agateau/KCM HowTo to Development/Tutorials/KCM HowTo: Proof-read by Ben Cooksley, can be integrated.

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo" /* kcm name */, "kcm_foo" /* catalog name */))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

Possible values at the time of this writing are:
* settings-lost-and-found
* settings-hardware
* settings-network-and-connectivity
* settings-system-administration
* settings-application-appearance-and-behavior
* settings-workspace-appearance-and-behavior

You can get a list of possible categories with this command, which lists all toplevel categories:

<pre>
ktraderclient --servicetype SystemSettingsCategory --constraint "[X-KDE-System-Settings-Parent-Category] == ''" | grep DesktopEntryName
</pre>

Just do not use the "settings-lost-and-found" entry.

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library. If you only have one KCModule in a library this key is not needed. If you have several KCMs in one library you will need a desktop file for each KCM.

For example, if you have a library named: kcm_frog.so with two modules, named "kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example, the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init but don't want the module to show up in System Settings.

You can also make the value of this key depend on the output of a program, using the "[$e]" key suffix. For example:

<pre>
Hidden[$e]=$(if test -e /dev/js*; then echo "false"; else echo "true"; fi)
</pre>

This example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

User:Agateau/KCM HowTo

2012-04-10T12:15:32Z

Agateau: moved User:Agateau/KCM HowTo to Development/Tutorials/KCM HowTo: Proof-read by Ben Cooksley, can be integrated.

#REDIRECT [[Development/Tutorials/KCM HowTo]]

Development/Tutorials/KCM HowTo

2012-04-10T09:56:34Z

Agateau: Fill list of possible categories

Development/Tutorials/KCM HowTo

2012-04-05T14:07:59Z

Agateau: /* Optional keys */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo" /* kcm name */, "kcm_foo" /* catalog name */))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library. If you only have one KCModule in a library this key is not needed. If you have several KCMs in one library you will need a desktop file for each KCM.

For example, if you have a library named: kcm_frog.so with two modules, named "kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example, the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init but don't want the module to show up in System Settings.

You can also make the value of this key depend on the output of a program, using the "[$e]" key suffix. For example:

<pre>
Hidden[$e]=$(if test -e /dev/js*; then echo "false"; else echo "true"; fi)
</pre>

This example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T14:07:31Z

Agateau: /* Optional keys */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo" /* kcm name */, "kcm_foo" /* catalog name */))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library. If you only have one KCModule in a library this key is not needed. If you have several KCMs in one library you will need a desktop file for each KCM.

For example, if you have a library named: kcm_frog.so with two modules, named "kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example, the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init but don't want the module to show up in System Settings.

You can also make the value of this key depend on the output of a program, using the "[$e]" key suffix. For example:

<pre>
Hidden[$e]=$(if test -e /dev/js*; then echo "false"; else echo "true"; fi)
</pre>

The example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T14:07:14Z

Agateau: /* Optional keys */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo" /* kcm name */, "kcm_foo" /* catalog name */))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library. If you only have one KCModule in a library this key is not needed. If you have several KCMs in one library you will need a desktop file for each KCM.

For example, if you have a library named: kcm_frog.so with two modules, named "kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example, the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init but don't want the module to show up in System Settings.

You can also make the value of this key depend on the output of a program, using the "[$e]" key suffix. For example:

<syntaxhighlight>
Hidden[$e]=$(if test -e /dev/js*; then echo "false"; else echo "true"; fi)
</syntaxhighlight>

The example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T14:06:53Z

Agateau: /* Optional keys */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo" /* kcm name */, "kcm_foo" /* catalog name */))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library. If you only have one KCModule in a library this key is not needed. If you have several KCMs in one library you will need a desktop file for each KCM.

For example, if you have a library named: kcm_frog.so with two modules, named "kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example, the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init but don't want the module to show up in System Settings.

You can also make the value of this key depend on the output of a program, using the "[$e]" key suffix. For example:

<syntaxhighlight lang="ini">
Hidden[$e]=$(if test -e /dev/js*; then echo "false"; else echo "true"; fi)
</syntaxhighlight>

The example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T14:06:25Z

Agateau: /* Optional keys */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo" /* kcm name */, "kcm_foo" /* catalog name */))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library. If you only have one KCModule in a library this key is not needed. If you have several KCMs in one library you will need a desktop file for each KCM.

For example, if you have a library named: kcm_frog.so with two modules, named "kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example, the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init but don't want the module to show up in System Settings.

You can also make the value of this key depend on the output of a program, using the "[$e]" key suffix. For example:

Hidden[$e]=$(if test -e /dev/js*; then echo "false"; else echo "true"; fi)

The example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:56:14Z

Agateau: /* The shared library */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo" /* kcm name */, "kcm_foo" /* catalog name */))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example,
the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:53:07Z

Agateau: /* The shared library */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example,
the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:52:54Z

Agateau: /* Initializing on startup */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

It is possible to get code from the KCM to be run at startup by kcminit.

To do so you must declare a function named "kcminit_${module}", like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KDEEXPORT void kcminit_foo()
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init-Symbol" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example,
the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:47:30Z

Agateau: /* Optional keys */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init-Symbol
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init-Symbol is "bell", for example,
the function "kcminit_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:46:01Z

Agateau: /* Mandatory keys */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule" for most KCM. If you want to use the kcminit feature it should be "KCModule,KCModuleInit".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:40:43Z

Agateau: /* About this howto */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and refreshed for KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:40:27Z

Agateau: /* Introduction */

==Introduction==

This howto describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:39:44Z

Agateau: /* KCMultiDialog */

==Introduction==

This HOWTO describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control than starting kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:39:11Z

Agateau: /* kcmshell4 */

==Introduction==

This HOWTO describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use "kcmshell4 fonts colors".

To get a list of the available modules, use "kcmshell4 --list".

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control to the behavior and results than starting
kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:38:33Z

Agateau: /* kcmshell4 */

==Introduction==

This HOWTO describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 [module_name]". For example, to get the font and the desktop color settings, use:

kcmshell4 fonts colors

To get a list of the available modules, use "kcmshell4 --list"

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control to the behavior and results than starting
kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:38:07Z

Agateau: /* kcmshell4 */

==Introduction==

This HOWTO describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

You can run one or several modules independently with "kcmshell4 ${module_name}". For example, to get the font and the desktop color settings, use:

kcmshell4 fonts colors

To get a list of the available modules, use "kcmshell4 --list"

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control to the behavior and results than starting
kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:36:57Z

Agateau: /* Mandatory keys */

==Introduction==

This HOWTO describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
Set this to "kcontrol" if you want your KCM to show up in System Settings.

The application you put in this key determines in what situations your KCM will
show. It is crucial to select a correct ParentApp, otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.

(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the "kcm_" prefix. In our example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

Consider you want to run a module standalone. Call "kcmshell4 module". For
example, to get the font and the desktop color settings, use:

kcmshell4 fonts colors

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control to the behavior and results than starting
kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:34:24Z

Agateau: /* Initializing on startup */

==Introduction==

This HOWTO describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

You must also add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
The application you put in this entry determines in what situations it will
show. For example, if the line says "X-KDE-ParentApp=kcontrol" the module will
show up in KControl. It is very crucial the selected ParentApp is correct,
otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.
(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the kcm_ prefix. So in the example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

Consider you want to run a module standalone. Call "kcmshell4 module". For
example, to get the font and the desktop color settings, use:

kcmshell4 fonts colors

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control to the behavior and results than starting
kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:34:00Z

Agateau: /* Exporting more than one module */

==Introduction==

This HOWTO describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to declare them another way: you must create C functions named "create_${kcm_name}". For
example if your module exposes two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

Don't forget to add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
The application you put in this entry determines in what situations it will
show. For example, if the line says "X-KDE-ParentApp=kcontrol" the module will
show up in KControl. It is very crucial the selected ParentApp is correct,
otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.
(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the kcm_ prefix. So in the example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

Consider you want to run a module standalone. Call "kcmshell4 module". For
example, to get the font and the desktop color settings, use:

kcmshell4 fonts colors

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control to the behavior and results than starting
kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:32:48Z

Agateau: /* The shared library */

==Introduction==

This HOWTO describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your module is "foo", the name of the library should be
"kcm_foo.so". It should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to use the old
loader. To do so, you must declare C functions named "create_${kcm_name}". For
example if your module exposes two to declare two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

Don't forget to add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
The application you put in this entry determines in what situations it will
show. For example, if the line says "X-KDE-ParentApp=kcontrol" the module will
show up in KControl. It is very crucial the selected ParentApp is correct,
otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.
(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the kcm_ prefix. So in the example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

Consider you want to run a module standalone. Call "kcmshell4 module". For
example, to get the font and the desktop color settings, use:

kcmshell4 fonts colors

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control to the behavior and results than starting
kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T13:31:58Z

Agateau:

==Introduction==

This HOWTO describes how to write KConfig Modules (KCMs from now on). These KCM
can appear in System Settings or in the configuration dialog of individual applications.

A KCM is made of two elements:
* A shared library
* A desktop file

==The shared library==

Implementing a KCM is done by:
# Subclassing the {{class|KCModule}} class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that System Settings or kcmshell4 can find it.

The prefered way to export the module is through {{class|KPluginFactory}}. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure the constructor signature of your derived class matches
with the signature of {{class|KCModule}} constructor (the QVariantList argument matters).

If the name of your modules is 'foo', the name of the library should be
kcm_foo.so and should be installed into $KDEDIR/lib/kde4.

===Exporting more than one module===

If you need to export more than one module per library, you have to use the old
loader. To do so, you must declare C functions named "create_${kcm_name}". For
example if your module exposes two to declare two KCMs named Foo1 and Foo2, the
"create_" functions would look like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo1(QWidget *parent, const char *name)
{
return new Foo1Kcm(parent, name);
};
KCModule *create_foo2(QWidget *parent, const char *name)
{
return new Foo2Kcm(parent, name);
};
}
</syntaxhighlight>

Additionally, you will need to add "X-KDE-FactoryName" keys to your
desktop file. (see below)

===Initializing on startup===

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

Don't forget to add a "X-KDE-Init" key to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place.

Desktop files are defined in the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

===Mandatory keys===

A KCM desktop file ''must'' contains the following keys:

;Type
Should be "Service".

;X-KDE-ServiceTypes
Should be "KCModule".

;Icon
Specifies the icon for the module.

;Exec
Should be "kcmshell4 foo".

;Name
This will be used by System Settings as your KCM label.

;Comment
This text shows up in the title area in System Settings. If the module is not
grouped with other modules it will also be used as a tooltip in the KCM list
view.

;Categories
Should contain at least "Qt;KDE;X-KDE-settings-system;".

;X-KDE-ParentApp
The application you put in this entry determines in what situations it will
show. For example, if the line says "X-KDE-ParentApp=kcontrol" the module will
show up in KControl. It is very crucial the selected ParentApp is correct,
otherwise the KCM will show up in unnecessary places.

;X-KDE-System-Settings-Parent-Category
Defines where the KCM will appear in System Settings.
(FIXME: Where is the category list?)

;X-KDE-Keywords
A comma-separated list containing words the search functionality should trigger
on.

;X-KDE-Library
This is the name of the library, without the kcm_ prefix. So in the example,
it should be "foo".

===Optional keys===
Additionally the KCM desktop file ''may'' contains the following keys:

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this key is not needed. If
you have several KCMs in one library you will need a desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named
"kermit" and "quak", kcm_kermit.desktop would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

and "kcm_quak.desktop" would contain:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in System Settings or when viewed
with kcmshell4. This is useful when you need to do something at startup using X-KDE-Init
but don't want the module to show up in System Settings.

==Example CMakeLists.txt==

Here is a minimal CMakeLists.txt which builds and installs the shared library and the
desktop files at the right places:

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_SRCS
foo.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

Consider you want to run a module standalone. Call "kcmshell4 module". For
example, to get the font and the desktop color settings, use:

kcmshell4 fonts colors

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

The first option is to simply fork and call "kcmshell4 foo".

The second option is to use {{class|KCMultiDialog}}. This is a simple dialog
which can show an arbitrary number of modules in a normal {{class|KDialog}}.
This approach gives you finer control to the behavior and results than starting
kcmshell4 in a separate process.

Since your module is a simple library, you can just link to it anyway.

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility to handle modules.
The API docs explains its usage the best.

==Debugging your module==

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside System Settings, make sure
you pass --nofork to System Settings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the System Settings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau <agateau@kde.org>.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Development/Tutorials/KCM HowTo

2012-04-05T12:35:30Z

Agateau: Created page with "==Introduction== A KConfig Module is a small library with a @ref KCModule subclass containing code which builds and support a interface for configuration tasks. The module is th..."

==Introduction==

A KConfig Module is a small library with a @ref KCModule subclass containing
code which builds and support a interface for configuration tasks. The module
is then encapsulated in a parent application, for example kcmshell, System
Settings or a KCMultiDialog.

This HOWTO describes how to write KConfig Modules(KCMs from now on). This
technology was originally designed for KControl. Although KControl is the
application where the KCM tehnology is the most used, it is used in several
other places as well, such as Kopete and Kontact. This HOWTO describes how to
write config modules, regardless of where it will be used. KConfig Modules
were originally called KControl Modules.

==Implementing==

Implementing a KCM is done by:
# Subclassing the @ref KCModule class. In this documentation we assume the class inheriting from KCModule is named FooKcm.
# Exporting the module so that systemsettings or kcmshell can find it.

The prefered way to export the module is through KPluginFactory. Here is how to
do it:

<syntaxhighlight lang="cpp">
#include <KPluginFactory>

K_PLUGIN_FACTORY(FooKcmFactory, registerPlugin<FooKcm>();)
K_EXPORT_PLUGIN(FooKcmFactory("kcm_foo", "kcm_foo"))
</syntaxhighlight>

If you get errors, make sure that the constructor of your derived class equals
the one of the KCModule baseclass (the QStringList argument matters).

If you need to export more than one module per library, you have to use the
old loader. That is, you need to create a function like this:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *create_foo(QWidget *parent, const char *name)
{
return new FooKcm(parent, name);
};
}
</syntaxhighlight>

This function and the implementation of the module is then compiled as a
shared library. If the name of your modules is 'foo', the name of the library
should be kcm_foo.so and should be installed into $KDEDIR/lib/kde4 (see @ref kcm_install).

==Initializing on startup==

If your module needs to initialize on KDE session startup, you must have a
construct like:

<syntaxhighlight lang="cpp">
extern "C"
{
KCModule *init_foo(QWidget *parent, const char *name)
{
// Do initialization here
};
}
</syntaxhighlight>

Don't forget to add X-KDE-Init to your desktop file. (see below)

==The desktop file==

To declare a KCModule's existence a desktop file must be installed in the proper place (see @ref kcm_install).

It could be a good idea to have a look at the [http://www.freedesktop.org/Standards/desktop-entry-spec desktop file specification].

A KCM's .desktop file supports the following .desktop directives:

;X-KDE-Library
This is the name of the library, without the kcm_ prefix. So in the example,
the library name would be "foo".

;X-KDE-FactoryName
This entry can be used to set the name of the factory function in the library.
If you only have one KCModule in a library this directive is not needed. If
you have several KCMs in one library you will need a .desktop file for each
KCM.

For example, if you have a library named: kcm_frog.so with two modules, named "kermit" and "quak", you would have:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=kermit
</syntaxhighlight>

in one of the .desktop files, and in the other:

<syntaxhighlight lang="ini">
X-KDE-Library=frog
X-KDE-FactoryName=quak
</syntaxhighlight>

The module loader would then call the "create_kermit" and "create_quak" functions respectively.

;X-KDE-RootOnly
If this is set to "true", the module must be executed with root permissions.
The module loader will then show the module in greyed-out (disabled) state
with a warning until the "modify" button is pressed which allows running the
module in an root environment using kdesu and QXEmbed.

;X-KDE-ParentApp
The application you put in this entry determines in what situations it will
show. For example, if the line says "X-KDE-ParentApp=kcontrol" the module will
show up in KControl. It is very crucial the selected ParentApp is correct,
otherwise the KCM will show up in unnecessary places.

;X-KDE-Init
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;X-KDE-Test-Module
If the module has to perform some action at system startup, use this entry to
build the name of a function to call. if X-KDE-Init is "bell", for example,
the function "init_bell" is called in the library indicated by X-KDE-Library.

;NoDisplay
If this is set to true the module will not show up in kcontrol or when viewed
with kcmshell. This is usable when you need to do something at startup(X-KDE-
Init etc.) but don't want the module to show up in kcontrol, eg. the module
has no GUI.

;Name
This is 'labels' for the KCMs and fill the nodes in the three view. Please see
the KCM Guidelines on how to pick a good Name.

;Comment
This directive shows up in the main area in KControl if you select a top node
in the three view. See the same section as for Name in the KCM Guidelines for
how to pick a good phrase.

;Categories
This describes where the KCM should be put in KControl's navigation. It should
look like "Categories=QT;KDE;X;" where X is the category. A list of available
categories, as well as which one to choose is found in the KCM Guidelines.

;Icon
Specifies the icon for the module.

;Exec
Should say "Exec=kcmshell4 modulename".

;Type
Should say "Type=Application".

;Keywords
A semi colon separated list containing words/phrases search functionality
should trigger on.

To summarize, a valid KCM .desktop file ''must'' contain these directives:

* Name
* Icon
* Type=Application
* Exec=kcmshell modulename
* Categories=Qt;KDE;X; (replace X with your category)
* Keywords
* X-KDE-Library
* X-KDE-ParentApp
* Comment

Additionally, a KCM .desktop file ''may'' contain:

* X-KDE-Init
* X-KDE-Test-Module
* NoDisplay
* X-KDE-Root-Only
* X-KDE-Factory-Name
* DocPath

Any other directives (except translations) can safely be removed, since they
most likely are abundant or are left over's from old KDE versions. For example,
X-ModuleType was relevant for KDE 2.0 but not in any new versions.

==Defining a CMakeLists.txt for the KCM==

<syntaxhighlight lang="cmake">
find_package(KDE4 REQUIRED)

include(KDE4Defaults)
include(MacroLibrary)

set(FOO_KCM_SRCS
foo_kcm.cpp
# Other sources go there
)

kde4_add_plugin(kcm_foo ${FOO_KCM_SRCS})

target_link_libraries(kcm_foo
${KDE4_KDEUI_LIBS}
# Other necessary libraries go there
)

install(TARGETS kcm_foo
DESTINATION ${PLUGIN_INSTALL_DIR}
)

install(FILES kcm_foo.desktop
DESTINATION ${SERVICES_INSTALL_DIR}
)
</syntaxhighlight>

==What else do I need?==

There are a number of additional things for convenience.

===kcmshell4===

Consider you want to run a module standalone. Call "kcmshell4 module". For
example, to get the font and the desktop color settings, use:

kcmshell4 fonts colors

===KCMultiDialog===

Sometimes, you may want to reuse your KCModule inside an application. There
are two ways to accomplish this:

First option is to use {{class|KCMultiDialog}}. This is a simple dialog that
can show an abitrary number of modules in a normal {{class|KDialogBase}}. The
advantage is that you can control the behaviour and the results much easier
that with a separate process. And as your module is a simple library, you can
just link to it anyway.

Second option is to call "kcmshell4 modules".

===KCModuleContainer===

The class {{class|KCModuleContainer}} allows great flexibility with handling modules.
The API docs explains its usage the best.

===Debugging your module===

You can attach gdb, valgrind or whatever to "kcmshell4 [yourmodule]" to track
down leaks or crashes. If you need to trace it down inside systemsettings, make sure
you pass --nofork to systemsettings on startup.

You really want to use kcmshell4 for debugging as long as your debugging does
not involve debugging bad interaction with the systemsettings framework itself.

----

== About this howto ==

This howto has been imported from http://websvn.kde.org/trunk/www/sites/developer/documentation/other/kcm_howto.html?view=markup and updated to KDE4 by Aurélien Gâteau.

Original copyright header:

<pre>
Copyright (C) 2003 Daniel Molkentin <molketin@kde.org>
Copyright (C) 2004 Frans Englich <frans.englich@telia.com>

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.2 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".
</pre>

Schedules/KDE4/4.8 Feature Plan

2011-10-20T16:31:49Z

Agateau:

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

See also:

*[[Schedules/KDE4/4.8 Release Schedule]]
*[[Schedules/KDE4/4.8 Release Goals]]
*[[Schedules/KDE4/4.7 Feature Plan]] (previous major release)

 Legend:

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

__TOC__

 

= kde-workspace =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KWin|Take over screensaver/locking management from KRunner|alex.merry@kdemail.net|Alex Merry}}
{{FeatureInProgress|KCM|make mouse cursor size configurable (http://git.reviewboard.kde.org/r/101701/)|SommerLuk@gmail.com|Lukas Sommer}}
{{FeatureDone|powerdevil|Remove Desktop Effects Management|drf@kde.org|Dario Freddi}}
{{FeatureInProgress|powerdevil|Allow static profiles only|drf@kde.org|Dario Freddi}}
{{FeatureInProgress|powerdevil|Allow activity interaction|drf@kde.org|Dario Freddi}}
|}
 

= kdelibs =

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

! Status
! Project
! Description
! Contact

{{FeatureDone|Kate Part|Line modification system|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|Kate Part|Modeline Editor|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|Kate Part|Search & Replace in files plugin|kare.sars@iki.fi|Kåre Särs}}
{{FeatureDone|Kate Part|Reliable code folding|adrian.lungu89@gmail.com|Adrian Lungu}}
{{FeatureDone|Kate Part|Improved vi input mode|svatoslav1@gmail.com|Svyatoslav Kuzmich}}
|}
 

= kde-baseapps =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|Dolphin|Implement new view-engine for Dolphin 2.0 (see http://ppenz.blogspot.com/2011/08/introducing-dolphin-20.html)|peter.penz19@gmail.com|Peter Penz}}
|}
 

= kdeedu =

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

! Status
! Project
! Description
! Contact

{{FeatureInProgress|KTouch|New organisation of keyboard and lecture files according to languages|peter.ruethemann@gmail.com|Rüthemann Peter}}
{{FeatureInProgress|KTouch|New organisation of menu system: Training, Statistic, Settings|peter.ruethemann@gmail.com|Rüthemann Peter}}
{{FeatureTodo|KTouch|End of lecture statistics|peter.ruethemann@gmail.com|Rüthemann Peter}}
{{FeatureDone|Rocs|Alignment Actions to minimize crossing graph edges|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Project Files to combine graphs and algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureTodo|Rocs|Stepped Execution of Algorithms|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Resurrect import-/export-features|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|User Interface Cleanup|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Cantor|Add Qalculate backend|matteo@agostinelli.me|Matteo Agostinelli}}
{{FeatureDone|Marble|Marble Runner plugins for Parsing files|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|(GSoC) OSM file rendering|oblaukhov.konstantin@gmail.com|Konstantin Oblaukhov}}
{{FeatureDone|Marble|Marble Graphics Scene (Performance of Vector Drawing)|oblaukhov.konstantin@gmail.com|Konstantin Oblaukhov}}
{{FeatureDone|Marble|Gps Info Plugin|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureInProgress|Marble|Routing API|earthwings@gentoo.org|Dennis Nienhüser}}
|}
 

= kdepim =

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

! Status
! Project
! Description
! Contact

{{FeatureTodo
|attachment:/ kio-slave
|Implement kio-slave to access (email) attachments in Akonadi
|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureInProgress|KAlarm|Port to Akonadi|djarvie@kde.org|David Jarvie}}

{{FeatureTodo
|sieve: implement wizard
|Implement wizard to help user to create sieve script
|montel@kde.org|Montel Laurent}}

|}

 

= kdesdk =

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

 

= kdegames=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|Libkdegames|Improve graphics performance in all games by standardizing on the use of Qt Raster Graphics.|stefan.majewsky@googlemail.com|Stefan Majewsky}}{{FeatureInProgress|KSudoku|Add a new generator and solver to KSudoku, based on published algorithms. This will provide a full range of puzzle difficulties, rather than mainly easy puzzles, and will address bug 217925 and its duplicates 228614 and 237262 (now nearly two years old).|iandw.au@gmail.com|Ian Wadham}}
{{FeatureInProgress|KGoldrunner|Add the championship level "Gold Rush" game, contributed by Gabriel Miltschitzky.|iandw.au@gmail.com|Ian Wadham}}|}
 

= kdegraphics=
{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|Okular|Reset Form Action support|aacid@kde.org|Albert Astals Cid}}
{{FeatureInProgress|Gwenview|Animated image transitions|agateau@kde.org|Aurélien Gâteau}}
|}

Schedules/KDE4/4.7 Feature Plan

2011-04-27T07:42:21Z

Agateau: /* kdegraphics */

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

See also:

*[[Schedules/KDE4/4.7 Release Schedule]]
*[[Schedules/KDE4/4.7 Release Goals]]
*[[Schedules/KDE4/4.6 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

{{FeatureInProgress
|KLocale
|Number grouping support
|john@layt.net|John Layt}}

{{FeatureInProgress
|KLocale
|Narrow date name format support
|john@layt.net|John Layt}}

{{FeatureInProgress
|KLocale
|Week Numbers support
|john@layt.net|John Layt}}

{{FeatureInProgress
|KLocale
|Windows Backend
|john@layt.net|John Layt}}

{{FeatureInProgress
|KHelpMenu
|Fast action searching
|afiestas@kde.org|Alex Fiestas}}

{{FeatureInProgress
|KFilePlaces
|Activity-specific Places
|j.maceachern@gmail.com|Jeffery MacEachern}}

|}

 

= 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|Dolphin|Support Fwd/Back Mouse Buttons|sebastian@sebastian-doerner.de|Sebastian Dörner}}
{{FeatureDone|Dolphin|Polish the default user interface to minimize visual clutter (see http://ppenz.blogspot.com/2011/03/menu-bars.html)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Improve user interface for searching files and metadata|peter.penz19@gmail.com|Peter Penz}}
{{FeatureTodo|Settings|Improve proxy configuration dialog|adawit@kde.org|Dawit Alemayehu}}

{{FeatureInProgress
|Locale KCM
|Support for Number Grouping, Windows Backend, Country Subdivsions
|john@layt.net|John Layt}}

|}

 

= 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_sftp|async download support|asn@cryptomilk.org|Andreas Schneider}}
{{FeatureInProgress
|Locale definition files
|Migrate Country and Currency Codes to xml/po formats, re-arrange l10n files including settings and flags, add Subdivision code files.
|john@layt.net|John Layt}}
|}

 

= kde-workspace =

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

! Status
! Project
! Description
! Contact

{{FeatureDone|System Settings/keyboard|Allow a shortcut per keyboard layout (bug 224489)|arysin@mail.com|Andriy Rysin}}
{{FeatureDone|System Settings/keyboard|Session management for keyboard layouts (bug 52095, 174948)|arysin@mail.com|Andriy Rysin}}
|-

! style="text-align: center;" colspan="4" | Plasma
{{FeatureInProgress
|Plasma Clock/Calendar
|improve usability, settings, akonadi and holiday data. See Plasma wiki.
|john@layt.net|John Layt}}
|-

! style="text-align: center;" colspan="4" | KWin
{{FeatureDone|Compositor|OpenGL 2.x/OpenGL ES 2.0 compositing backend (see http://www.kdenews.org/2011/02/18/kwin-embraces-new-platforms-opengl-es-20-support)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|Compositor|New Shadow System (see http://blog.martin-graesslin.com/blog/2011/03/new-kwin-shadows/)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|BoxSwitch Effect|Animated Selection (see http://blog.martin-graesslin.com/blog/2011/02/is-kwin-rocket-science/)|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|libkwineffects|API cleanup|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureTodo|libkwineffects|JavaScript bindings for writing Effects|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|Mouse Emulation|Better accessibility support in mouse emulation|mgraesslin@kde.org|Martin Gräßlin}}
{{FeatureInProgress|kwin|Add multi head support|alberto@mattea.info|Alberto Mattea}}
{{FeatureInProgress|kwin|DBusMenu in Windeco|megabigbug@yahoo.fr|Lionel Chauvin}}
{{FeatureInProgress|ksplashx|Add multi head support|alberto@mattea.info|Alberto Mattea}}
{{FeatureTodo|krunner|Add multi head support|alberto@mattea.info|Alberto Mattea}}
{{FeatureInProgress|kwinrules kcm|UI cleanup (see https://git.reviewboard.kde.org/r/101041/)|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|kwincompositing kcm|Rearm unsafe OpenGL precheck (see https://git.reviewboard.kde.org/r/101061/)|thomas.luebking@gmail.com|Thomas Lübking}}
{{FeatureInProgress|PresentWindows Effect|Better highlight indication & close button handling)|thomas.luebking@gmail.com|Thomas Lübking}}
|}

 

= 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
{{FeatureDone|Marble|Bookmark Manager|earthwings@gentoo.org|Dennis Nienhüser, Thibaut Gridel}}
{{FeatureInProgress|Marble|Extended QML Bindings|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Routing API|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Offline Address Search|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureTodo|Marble|Separate thread for tile loading and texture blending (not texture mapping at the moment) for more smooth browsing|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Tile loading "read ahead" when idle, prerequisite: threaded tile loading|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Multi threaded texture mapping|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureInProgress|Marble|Manipulate Gps track data|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureInProgress|Cantor|Integrate the Qalculate backend|agostinelli@gmail.com|Matteo Agostinelli}}
{{FeatureTodo|Kalzium|Use KUnitConversion for all the Unit handling|etienne.rebetez@oberwallisch|Etienne Rebetez}}
{{FeatureTodo|KTurtle|Add getdirection command
|nielsslot@gmaildotcom|Niels Slot}}
{{FeatureTodo|KTurtle|Add modulo command
|nielsslot@gmaildotcom|Niels Slot}}
{{FeatureInProgress|Step|Copy-and-Paste of items|kde@voecking.net|Sebastian Vöcking}}
{{FeatureTodo|Step|Zoom on mouse wheel|kde@voecking.net|Sebastian Vöcking}}
{{FeatureTodo|Step|Automatic expanding canvas|kde@voecking.net|Sebastian Vöcking}}
{{FeatureInProgress|Rocs|Auto - Handling of the Canvas|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureDone|Rocs|Remove the thread for QtConcurrent on he core|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureInProgress|Rocs|Polish the User Interface|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureDone|Rocs|New Plugin for Automaticaly Graph Generation|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureInProgress|Rocs|Bugfixes in the List Plugin|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureInProgress|Rocs|Speedup in the drawing code|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureInProgress|Rocs|Kalgebra backend|tcanabrava@kde.org|Tomaz Canabrava}}
{{FeatureDone|Rocs|Transform graph edges plugin|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Rocs|Assign values to edges/nodes plugin|cola@uni-paderborn.de|Andreas Cord-Landwehr}}
{{FeatureInProgress|Kalzium|Titration calculator|TRINGALINVENT@libero.it|Luca Tringali}}
|}
 

= 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|KAlarm|Port to Akonadi|djarvie@kde.org|David Jarvie}}
{{FeatureInProgress|KAlarm|Allow reminders after the main alarm|djarvie@kde.org|David Jarvie}}
{{FeatureInProgress|KAlarm|Provide wake-from-suspend option for alarms|djarvie@kde.org|David Jarvie}}

{{FeatureInProgress
|KHolidays
|Add support for Holiday Types and Observance Types
|john@layt.net|John Layt}}

|}

 

= 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|Adjustable Clock|Plasmoid for displaying date and time in very customizable way|emdeck@gmail.com|Michał Dutkiewicz}}
{{FeatureInProgress|Comic Plasmoid|Support random comic strips|mat69@gmx.net|Matthias Fuchs}}
{{FeatureInProgress|Comic Plasmoid|Support creation of comic Comic Book Archive files|mat69@gmx.net|Matthias Fuchs}}
{{FeatureTodo|Comic Plasmoid|Highlight comics that have a new comic strip|mat69@gmx.net|Matthias Fuchs}}
{{FeatureTodo|Events Runner|Support parsing weekdays (e.g. "in next monday"|alexey.noskov@gmail.com|Alexey Noskov}}
|}

 

= 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
{{FeatureDone|KTeaTime|Port to KStatusNotifierItem|miha@noughmad.eu|Miha Čančula}}
{{FeatureInProgress|KTeaTime|New svg based status icons|kde@hilefoks.org|Stefan Böhmann}}
{{FeatureInProgress|KTeaTime|Support categories|kde@hilefoks.org|Stefan Böhmann}}
{{FeatureTodo|KTeaTime|Improved command line|kde@hilefoks.org|Stefan Böhmann}}
{{FeatureTodo|KTeaTime|Tea runner|kde@hilefoks.org|Stefan Böhmann}}
{{FeatureTodo|KTeaTime|Port to KConfigXT|kde@hilefoks.org|Stefan Böhmann}}

|}

 

= 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
{{FeatureInProgress|Lokalize|Remote translation memories|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureInProgress|Lokalize|QA: translation checks against user-specified regex-based rules|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Integrate snowball stemmer for glossary|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Continue implementing XLIFF spec|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Segmentation [editing] functionality|shafff@NOSPAMukr.net |Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Integrate with nepomuk (fast stats retrieval, tag cloud - incl sharing!)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|loading compressed files and then saving them back in the original compression format (bug 65518)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureInProgress|Okteta|Properly support strings (various Unicode encodings) in structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureTodo|Okteta|Add custom datatypes to structures tool|alex.richardson@gmx.de|Alex Richardson}}
{{FeatureInProgress|Umbrello|QDockWidget based interface|elv1313@gmail.com|Emmanuel Lepage Vallee}}
{{FeatureInProgress|Umbrello|KDE4 icon theme and eye candies|elv1313@gmail.com|Emmanuel Lepage Vallee}}
{{FeatureTodo|Umbrello|Replace the current code viewer with katepart|elv1313@gmail.com|Emmanuel Lepage Vallee}}
{{FeatureDone|Umbrello|Add a zoom widget in the statusbar|elv1313@gmail.com|Emmanuel Lepage Vallee}}

|}
 

= 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|KBreakout|Level editor|julian.helfferich@gmail.com|Julian Helfferich}}
{{FeatureInProgress|KBreakout|Load levelset option + 2 new levelsets|julian.helfferich@gmail.com|Julian Helfferich}}
{{FeatureTodo|KBreakout|Port to QGraphicsView|julian.helfferich@gmail.com|Julian Helfferich}}
{{FeatureInProgress|libtagaro|Move first version into the kdegames module|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureTodo|libtagaro|Use the new library: at least in Granatier and Kolf (to replace existing static source copies) and KDiamond|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureInProgress|Palapeli|Cleanup interface|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureDone|Palapeli|Reduce memory consumption for big puzzles|majewsky@gmx.net|Stefan Majewsky}}
|}

 

= 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|Working Mms plugin|eortiz@uci.cu|Ernesto Rodriguez Ortiz}}
{{FeatureInProgress|KGet|Support for connection limit to servers|mat69@gmx.net|Matthias Fuchs}}
|}

 

= 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|Okular|Directory support in Comic Book Generator|dpalacio@orbitalibre.org|David Palacio}}
{{FeatureInProgress|Okular|7zip support in Comic Book Generator|dpalacio@orbitalibre.org|David Palacio}}
{{FeatureTodo|libksane|Enable gui less operation|kare.sars@iki.fi|Kåre Särs}}
{{FeatureTodo|libksane|Add a way to get scanner device list|kare.sars@iki.fi|Kåre Särs}}
{{FeatureInProgress|Gwenview|Compare mode|agateau@kde.org|Aurélien Gâteau}}
{{FeatureTodo|Gwenview|Merge "Semantic Information" and "Meta Information" sidebar groups|agateau@kde.org|Aurélien Gâteau}}
|}

Schedules/KDE4/4.6 Feature Plan

2010-12-07T14:43:08Z

Agateau: /* kdegraphics */

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

See also:

*[[Schedules/KDE4/4.6 Release Schedule]]
*[[Schedules/KDE4/4.6 Release Goals]]
*[[Schedules/KDE4/4.5 Feature Plan]] (previous major release)

 Legend:

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

__TOC__

 

= kdebase-apps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|Konsole|Move to KTabWidget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureDone|Dolphin|Faceted browsing via Nepomuk|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|Dolphin|Searching support for non-indexed files|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Git-plugin (implemented by Sebastian Dörner and Johannes Steffen)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin| Resizeable columns in the column-view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin| Allow leading zeros when renaming multiple files (implemented by Matthias Fuchs)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureInProgress|nspluginviewer|Full npruntime support|maksim@kde.org|Maks Orlovich}}
{{FeatureTodo|Dolphin|Smooth scrolling|fredrik@kde.org|Fredrikh Höglund}}
|}

 

= kdebase-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Plasma|Plasma KPart|ry@n.rix.si|Ryan Rix}}
{{FeatureInProgress|Plasma|Declarative AppletScript to write QML plasmoids|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Optimize the Newspaper containment for the use with touchscreens and the Plasma KPart|mart@kde.org|Marco Martin}}
{{FeatureDone|KWin|Focus tracking for the zoom plugin (uses kaccessible)|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|KWin|Extend mouse tracking modes for the zoom plugin|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|Nepomuk Backup & Sync| Provide Backup and Sync capabilities to Nepomuk|handa.vish@gmail.com|Vishesh Handa}}
{{FeatureTodo|Web Metadata extractor| Provide a framework to get additional data about resources|handa.vish@gmail.com|Vishesh Handa}}
{{FeatureDone|Activities manager service|Merge the kded and nepomuk modules for activities into one service|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|Activities manager service|Register desktop events instead directly linking the activities to resources|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|KNotify|Add support for relative present actions in contexts|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureDone|KNotify|Add Plugin Loading Support (No UI Support For Now)|j.maceachern@gmail.com|Jeffery MacEachern}}
{{FeatureInProgress|Locale KCM|Complete re-write to improve usability, support for new localization features|john@layt.net|John Layt}}
{{FeatureInProgress|Phonon KCM|Add video input device configuration support|kiagiadakis.george@gmail.com|George Kiagiadakis}}
{{FeatureInProgress|ksecretserviced|Make it replace KWallet|lemma@confuego.org|Michael Leupold}}
|}

 

= kdebase-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
|-
! style="text-align: center;" colspan="4" | Plasma
{{FeatureDone|libtaskmanager / tasks-applet| support for Windows 7 like launchers |akreuzkamp@web.de|Anton Kreuzkamp}}
{{FeatureInProgress|notifications| rework notification applet appearance |mart@kde.org|Marco Martin}}
{{FeatureInProgress|notifications| make various dataengines use Plasma::Storage |mart@kde.org|Marco Martin}}
{{FeatureDone|plasma-desktop| UI for editing activity name and icon|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|plasma-desktop| add some default activities|fux@kde.org|Mario Fux}}
{{FeatureDone|plasma| finish support for activity templates |chani@kde.org|Chani}}
{{FeatureInProgress|plasma-devicenotifier| Improve notification support |wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureTodo|plasma-devicenotifier| Signal to the user which apps are blocking a device|wilderkde@gmail.com |Jacopo De Simoi}}
{{FeatureDone|quicklaunch| populate new applets with user's default browser, file manager, ... instead of hardcoded ones |ingomar@wesp.name|Ingomar Wesp}}
{{FeatureDone|quicklaunch| allow editing of existing launchers (including ones that do not point to a .desktop file) |ingomar@wesp.name|Ingomar Wesp}}
{{FeatureDone|libplasma|Plasma calendar supports multiple Holiday Regions.|john@layt.net|John Layt}}
{{FeatureInProgress|libplasma|Make Calendar DataEngine a Service.|john@layt.net|John Layt}}
{{FeatureDone|plasma-desktop| integrate activity-sessions|chani@kde.org|Ivan/Chani}}
{{FeatureInProgress|plasma-desktop|activity dataengine|chani@kde.org|Chani}}
|-
! style="text-align: center;" colspan="4" | KWin
{{FeatureInProgress|windowgeometry effect| compositor powered move/resize windowgeometry display |thomas.luebking@web.de|Thomas Lübking}}
{{FeatureDone|dashboard effect| new effect for Plasma dashboard |ademmer@opensuse.org|Andreas Demmer}}
{{FeatureDone|kwin/ksmserver| activity sessions |chanika@gmail.com|Chani}}
{{FeatureDone|libtaskmanager/kwin?| some activity integration in taskbar/pager |chani@kde.org|Chani}}
{{FeatureTodo|libtaskmanager/kwin] | Expose Window Tabs to taskmanager |kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|kwin|ARB Shader support|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|Aurorae|Tooltips on window tabs|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Present Windows|Close window GUI control|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Startup Feedback|Effect to replace the Startup Feedback notification|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Screenshot Effect|KSanpshot can use KWin for screenshots|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|KCM Compositing|Allow compositing even if GL is buggy/X crashes|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|KWin Killer|Use notification instead of dialog|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|Compositing|Improved platform detection|fredrik@kde.org|Fredrik Höglund}}

|-
! style="text-align: center;" colspan="4" | KDE Power Management system
{{FeatureDone|core| PowerDevil v2 core |drf@kde.org|Dario Freddi}}
{{FeatureDone|actions| Basic actions for feature parity with PowerDevil v1 |drf@kde.org|Dario Freddi}}
{{FeatureInProgress|actions| More actions for advanced users |drf@kde.org|Dario Freddi}}
{{FeatureDone|policy-handler| Create a new policy handler for handling inhibition properly, and have kdelibs' Solid API use it |drf@kde.org|Dario Freddi}}
|-
! style="text-align: center;" colspan="4" | System Settings
{{FeatureDone|keyboard| Support for "spare layouts"|arysin@gmail.com|Andriy Rysin}}
{{FeatureDone|keyboard| Support for > 4 layouts|arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|driconf|New module for configuring DRI drivers|fredrik@kde.org|Fredrik Höglund}}
|-
! style="text-align: center;" colspan="4" | Blue Devil
{{FeatureInProgress|Review| Get into kdebase|alex@eyeos.org|Alex Fiestas}}
{{FeatureInProgress|kio_obexftp| Better error handling|alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|usability|Review all the components improving hig/elegance|alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|share folders|Be able to share folders via obexftp|alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|Devices KCM|Add further information about devices, like address...|ereslibre@kde.org|Rafael Fernández López}}
{{FeatureTodo|Devices KCM|Allow to connect to devices services|ereslibre@kde.org|Rafael Fernández López}}
{{FeatureInProgress|libbluedevil|Review DBus handling|ereslibre@kde.org|Rafael Fernández López}}
{{FeatureTodo|libbluedevil|Add support for services|ereslibre@kde.org|Rafael Fernández López}}
{{FeatureInProgress|Monolithic|Fix listing problems under certain conditions|ereslibre@kde.org|Rafael Fernández López}}
|}

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|libnepomuk|Convenience operator overloads for query construction|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|libnepomuk|New query flags and improved handling of full text matching scores including sorting|trueg@kde.org|Sebastian Trueg}}
{{FeatureTodo|kdeui|Generic find bar widget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureDone|kdeui|Allow getting and setting the size of the pixmap cache in KImageCache|2kmm@gmx.de|Manuel Mommertz}}
{{FeatureDone|katepart|scripted actions|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|katepart|QAccessibleInterface's for document+cursor|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|libplasma|PluginLoader class|ry@n.rix.si|Ryan Rix}}
{{FeatureDone|libplasma|Allow SVGs to use systemcolors before rendering|2kmm@gmx.de|Manuel Mommertz}}
{{FeatureInProgress|libplasma|DeclarativeWidget to load QML scenes in Plasma|mart@kde.org|Marco Martin}}
{{FeatureInProgress|libplasma|finish up the gsoc project about Plasma::Storage service|mart@kde.org|Marco Martin}}
{{FeatureDone|libplasma|let Plasma::SVG find the best matching size hinted element if there is no exact match|ingomar@wesp.name|Ingomar Wesp (mentored by Manuel Mommertz)}}
{{FeatureDone|libnepomuk/KIO|Search excerpts|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|libnepomuk|Standardqueries for convenience|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|libnepomuk|GUI elements for resource/file searching including faceted browsing|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|libnepomuksync|Sync library to be used in BackupSync, Strigi, Akonadi, WebExtractor and Removable Media|handa.vish@gmail.com|Vishesh Handa}}
{{FeatureInProgress|kdecore|Add more possible synchronization primitives to KSharedDataCache to expand OS support. POSIX Semaphores Contributed by Alberto Villa of the FreeBSD project. Windows support may still occur as well.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|kdecore|Add fallback to QCache<QString,QByteArray> in KSharedDataCache.|mpyne@kde.org|Michael Pyne}}
{{FeatureDone|kdecore|Add cache-wide timestamp to KSharedDataCache.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|kdecore|Add ability to make KSharedDataCache strictly read-only for laptop support.|mpyne@kde.org|Michael Pyne}}
{{FeatureInProgress|kdeui|Social About Dialog|teo@kde.org|Teo Mrnjavac}}
{{FeatureDone|kdeui|Allow to hide icons in menus|christoph@maxiom.de|Christoph Feck}}
{{FeatureDone|KLocale|Auto-detect new users Country from their system country.|john@layt.net|John Layt}}
{{FeatureDone|KLocale|New configuration option for AM/PM symbols, .|john@layt.net|John Layt}}
{{FeatureDone|KLocale|Seperate backends available for each supported platform/desktop, use of platform localization in place of KDE locale planned for 4.7.|john@layt.net|John Layt}}
{{FeatureDone|KLocalizedDate|New convenience class to make date localization easy.|john@layt.net|John Layt}}
{{FeatureDone|KCalendarSystem|Add api for first/last day of year/month.|john@layt.net|John Layt}}
{{FeatureDone|KCalendarSystem|Add configuration option for Short Year Window.|john@layt.net|John Layt}}
{{FeatureDone|KCalendarSystem|Separated date / time parsing code into new private KDateTimeParser and KDateTimeFormatter classes to share with KLocale and KDateTime.|john@layt.net|John Layt}}
{{FeatureInProgress|KHTML|HTML5 postMessage.|maksim@kde.org|Maksim Orlovich}}
{{FeatureTodo|kcookiejar|New domain specific cookie policy based on patch provided in bug#54300|adawit@kde.org|Dawit A.}}
{{FeatureInProgress|kcookiejar|Implement storing cookies in KWallet|fid@gpul.org|José Millán Soto}}
{{FeatureInProgress|ksecretservice|Make KWallet::Wallet use the secrets-service API|lemma@confuego.org|Michael Leupold}}
{{FeatureInProgress|anywhere|Allow to build without deprecated symbols|ervin@kde.org|Kevin Ottens (with lots of support from David Faure)}}
{{FeatureInProgress|KIO|Use `net usershare` in KSambaShare|rclbelem@gmail.com|Rodrigo Belem}}
|}

 

= 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
{{FeatureDone|Marble|Loading of routes in .kml format (Maemo)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Route printing (map and directions, configurabe)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Route state saving and restoring|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Convert MarbleRunners to plugins|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|worldwide and offline routing|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Extend MarbleRunner interface to handle reverse geocoding and routing requests; Display of alternative routes|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Routing API|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|"Go To" dialog for Maemo|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Tile download along the route for offline usage|akssps011@gmail.com|Siddharth Srivastava}}
{{FeatureDone|Marble|Turn-by-turn navigation mode|akssps011@gmail.com|Siddharth Srivastava}}
{{FeatureDone|Marble|QtDeclarative plugin and QML examples (experimental)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Implement sun locator blendings as derived classes of Marble::Blending|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Separate thread for tile loading and texture blending (not texture mapping at the moment) for more smooth browsing|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Tile loading "read ahead" when idle, prerequisite: threaded tile loading|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Multi threaded texture mapping|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureDone|Marble|Improve GeoData API|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Convert Gps tracking to GeoDataDocument|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Provide a treeModel for GeoDataDocuments|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Draw the geometries of multiple GeoDataDocuments|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureInProgress|Marble|Load Pnt vector data files as GeoData|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureInProgress|Marble|Manipulate Gps track data|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Cantor|Backend for GNU Octave|miha.cancula@gmail.com|Miha Čančula}}
{{FeatureInProgress|Cantor|Merge R improvement branch|alexanderrieder@gmail.com|Alexander Rieder}}
{{FeatureInProgress|Cantor|Variable management panel|alexanderrieder@gmail.com|Alexander Rieder}}
{{FeatureTodo|Cantor|Formulas inside Text Entries|alexanderrieder@gmail.com| Alexander Rieder}}
{{FeatureDone|Kalzium|Port Kalzium to use QGV based periodic table widget|mhanwell@kde.org|Marcus D. Hanwell}}
{{FeatureDone|KAlgebra|Implicit functions plot|percy.camilo.ta@gmail.com|Percy Aucahuasi}}
{{FeatureDone|KAlgebra|Improved execution speed on the calculator|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|Better integration between the Console and the Plotting facilities|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|Lighter version aimed to mobile users|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureInProgress|KStars|OpenGL rendering support for KStars|akarshsimha@gmail.com|Harry de Valence, Akarsh Simha}}
{{FeatureInProgress|KStars|Better designed object database|akarshsimha@gmail.com|Victor Carbune, Akarsh Simha}}
{{FeatureInProgress|KStars|Star Hop Generator|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureDone|Kig|LaTeX/TikZ exporter|miha.cancula@gmail.com|Miha Čančula}}
|}

 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|JuK|Remove Qt/KDE3 support lib requirements|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Allow setting covers directly from URLs supported by KIO - drag/drop already allows this however|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Add MPRIS support to JuK so that the NowPlaying applet doesn't need to special-case JuK.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Update JuK's MusicBrainz support to a modern version of MusicBrainz.|mpyne@kde.org|Michael Pyne}}
{{FeatureInProgress|kmix|Improved volume OSD|fredrik@kde.org|Fredrik Höglund}}
|}

 

= kdegames =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|libkdegames|Import KGameRenderer framework and [[Projects/Games/Porting|port games]] to this unified rendering infrastructure.|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureInProgress|Kigo|Fix KNewStuff provider issues|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureDone|Palapeli|Import Goldberg slicer as the new default slicer plugin.|loehnert.kde@gmx.de|Johannes Loehnert}}
{{FeatureDone|Palapeli|Bevel effect creates three-dimensional appearance for puzzle pieces.|loehnert.kde@gmx.de|Johannes Loehnert}}
{{FeatureDone|Palapeli|Update libpala API. Improve usability of "Create new puzzle" dialog.|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureDone|Kajongg|Docbook: Describe the basic game, until now I supposed the player already knows how to play Mah Jong.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Tiles can be discarded with drag&drop.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Make robot player AI more intelligent.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Make tiles in the hand larger and the wall tiles smaller for better playability on small screens.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Make games suspendable/resumable.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Animate moving tiles.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Demo mode.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Introduce an option to only offer possible actions.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Add more rulesets like other Classical Chinese variants and the international tournament rules.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Save and restore the current control-mode, keyboard-control option and game-speed settings.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add a keyboard-mode option to start moving when a direction-key is pressed and stop when it is released. Support multiple keys being pressed.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|Klickety|An adaptation of the "clickomania" game.Rewrite the kde3 version.|shuizhuyuanluo@126.com|Ni Hui}}
{{FeatureDone|Klickety|Merge KSame into Klickety.|shuizhuyuanluo@126.com|Ni Hui}}
{{FeatureDone|Kolf|Port to KGameRenderer, cleanup all QGraphicsView- and physics-related code (and physics engine), incorporate ideas from Kolf-NG.|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureDone|Granatier|Port to KGameRenderer.|k.hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Granatier|Use TagaroAudio for sound.|k.hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Knights|New game: Chess board for KDE4|miha.cancula@gmail.com|Miha Čančula}}
|}

 

= 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
{{FeatureDone|gwenview|Simplify photo sharing|agateau@kde.org|Aurélien Gâteau}}
{{FeatureDone|gwenview|Improve resize dialog|agateau@kde.org|Aurélien Gâteau}}
|}

 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Lokalize|Integrate snowball stemmer for glossary|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Continue implementing XLIFF spec|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Segmentation [editing] functionality|shafff@NOSPAMukr.net |Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Remote translation memories|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Integrate with nepomuk (fast stats retrieval, tag cloud - incl sharing!)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|loading compressed files and then saving them back in the original compression format (bug 65518)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Nepomukshell|New Nepomukshell development tool allowing to browse and debug Nepomuk data|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|Dolphin|Git plugin|sebastian@sebastian-doerner.de|Sebastian Doerner}}
{{FeatureDone|Kate|GDB plugin|kare.sars@iki.fi|Kåre Särs}}
|}

 

= kdeutils =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Ark|Add a "Preview with..." context menu item|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Add an options dialog (maybe)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Add feedback for the latest operation in the status bar|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Get rid of the Observer code in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make error reporting work as expected in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make Kerfuffle really thread-safe (and use threads in less places)|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make the internal previewer optional|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Simplify Kerfuffle's API (jobs, interfaces etc) and try to make it stable|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Support for custom options from the compression interface (eg. a slider for selecting compression level for rar files)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Try multiple plugins for each archive type before failing|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|printer-applet|Restore feature parity with KDEPrint3 where possible.||Jonathon Riddell, John Layt}}
{{FeatureTodo|Okteta|Add view profiles|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|KGpg|Better workflow to edit encrypted files|kde@opensource.sf-tec.de|Rolf Eike Beer}}
|}

 

= 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|Kontact|Plasma-based Summary Page|ry@n.rix.si|Ryan Rix}}
{{FeatureInProgress|KHolidays|Add support for holiday types and day-off types.|john@layt.net|John Layt}}
{{FeatureInProgress|KHolidays|Holiday Region selection widget.|john@layt.net|John Layt}}
{{FeatureDone|KHolidays|Holiday duration api.|john@layt.net|John Layt}}
{{FeatureDone|KHolidays|Default Holiday Region api.|john@layt.net|John Layt}}
{{FeatureInProgress|KAlarm|Port to Akonadi|djarvie@kde.org|David Jarvie}}
{{FeatureDone|KAlarm|Option to not notify execution errors for pre-alarm actions|djarvie@kde.org|David Jarvie}}
{{FeatureInProgress|KAlarm|Allow reminders after the main alarm|djarvie@kde.org|David Jarvie}}
{{FeatureInProgress|KAlarm|Provide wake-from-suspend option for alarms|djarvie@kde.org|David Jarvie}}
|}
 

= kdeaccessibility =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none 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|KAccessible|Added a dbus-service and a QAccessibleBridgePlugin for focus tracking (used in KMagnifier and the KWin zoom plugin).|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|KMagnifier|Follow Focus Mode for Focus Tracking (uses kaccessible).|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|KAccessible|Added Screenreader (uses speech-dispatcher)|mail@dipe.org|Sebastian Sauer}}
|}

 
= kdeartwork =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|KDE Asciiquarium|Added a new ASCII sprite (a submarine). Contributed by Ryan Meldrum.|mpyne@kde.org.|Michael Pyne}}
|}

 
= 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
{{FeatureDone|Shelf|Automatic sizing of the popup|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Shelf|Setting a custom popup icon|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|Shelf|Cascading popup menus for folders|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Shelf|Keyboard navigation|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Shelf|Search completion|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|libLancelot-datamodels|Akonadi integration|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|libLancelot-datamodels|Folder contents sorting|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|Lancelot|Theme improvements, animations|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Events Runner|Event search|alexey.noskov@gmail.com|Alexey Noskov}}
{{FeatureDone|Comic plasmoid|Per comic max cache limit|mat69@gmx.net|Matthias Fuchs}}
{{FeatureDone|Comic plasmoid|Change behaviour when comic can't be found|mat69@gmx.net|Matthias Fuchs}}
{{FeatureDone|GroupingDesktop|Added two desktop containments and a panel containment with applet grouping support|giuliocamuffo@gmail.com|Giulio Camuffo}}
|}

 

= kdenetwork =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|krfb|Refactor Core to make it more maintainable/extensible|grundleborg@googlemail.com.|George Goldberg}}
{{FeatureDone|krfb|Telepathy Tubes support|grundleborg@googlemail.com.|George Goldberg}}
{{FeatureDone|krfb|UI Improvements to support new features/deal with some existing bug reports|grundleborg@googlemail.com.|George Goldberg}}
{{FeatureTodo|kget|Log for transfers|l.appelhans@gmx.de|Lukas Appelhans}}
|}

Schedules/KDE4/4.6 Feature Plan

2010-11-19T20:17:04Z

Agateau: /* kdegraphics */

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

See also:

*[[Schedules/KDE4/4.6 Release Schedule]]
*[[Schedules/KDE4/4.6 Release Goals]]
*[[Schedules/KDE4/4.5 Feature Plan]] (previous major release)

 Legend:

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

__TOC__

 

= kdebase-apps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|Konsole|Move to KTabWidget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureDone|Dolphin|Faceted browsing via Nepomuk|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|Dolphin|Searching support for non-indexed files|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin|Git-plugin (implemented by Sebastian Dörner and Johannes Steffen)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin| Resizeable columns in the column-view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin| Allow leading zeros when renaming multiple files (implemented by Matthias Fuchs)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureInProgress|nspluginviewer|Full npruntime support|maksim@kde.org|Maks Orlovich}}
{{FeatureTodo|Dolphin|Smooth scrolling|fredrik@kde.org|Fredrikh Höglund}}
|}

 

= kdebase-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Plasma|Plasma KPart|ry@n.rix.si|Ryan Rix}}
{{FeatureInProgress|Plasma|Declarative AppletScript to write QML plasmoids|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Optimize the Newspaper containment for the use with touchscreens and the Plasma KPart|mart@kde.org|Marco Martin}}
{{FeatureDone|KWin|Focus tracking for the zoom plugin (uses kaccessible)|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|KWin|Extend mouse tracking modes for the zoom plugin|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|Nepomuk Backup & Sync| Provide Backup and Sync capabilities to Nepomuk|handa.vish@gmail.com|Vishesh Handa}}
{{FeatureTodo|Web Metadata extractor| Provide a framework to get additional data about resources|handa.vish@gmail.com|Vishesh Handa}}
{{FeatureDone|Activities manager service|Merge the kded and nepomuk modules for activities into one service|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|Activities manager service|Register desktop events instead directly linking the activities to resources|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|KNotify|Add support for relative present actions in contexts|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureDone|KNotify|Add Plugin Loading Support (No UI Support For Now)|j.maceachern@gmail.com|Jeffery MacEachern}}
{{FeatureInProgress|Locale KCM|Complete re-write to improve usability, support for new localization features|john@layt.net|John Layt}}
{{FeatureInProgress|Phonon KCM|Add video input device configuration support|kiagiadakis.george@gmail.com|George Kiagiadakis}}
{{FeatureInProgress|ksecretserviced|Make it replace KWallet|lemma@confuego.org|Michael Leupold}}
|}

 

= kdebase-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
|-
! style="text-align: center;" colspan="4" | Plasma
{{FeatureDone|libtaskmanager / tasks-applet| support for Windows 7 like launchers |akreuzkamp@web.de|Anton Kreuzkamp}}
{{FeatureInProgress|notifications| rework notification applet appearance |mart@kde.org|Marco Martin}}
{{FeatureInProgress|notifications| make various dataengines use Plasma::Storage |mart@kde.org|Marco Martin}}
{{FeatureDone|plasma-desktop| UI for editing activity name and icon|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|plasma-desktop| add some default activities|fux@kde.org|Mario Fux}}
{{FeatureDone|plasma| finish support for activity templates |chani@kde.org|Chani}}
{{FeatureInProgress|plasma-devicenotifier| Improve notification support |wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureTodo|plasma-devicenotifier| Signal to the user which apps are blocking a device|wilderkde@gmail.com |Jacopo De Simoi}}
{{FeatureDone|quicklaunch| populate new applets with user's default browser, file manager, ... instead of hardcoded ones |ingomar@wesp.name|Ingomar Wesp}}
{{FeatureDone|quicklaunch| allow editing of existing launchers (including ones that do not point to a .desktop file) |ingomar@wesp.name|Ingomar Wesp}}
{{FeatureDone|libplasma|Plasma calendar supports multiple Holiday Regions.|john@layt.net|John Layt}}
{{FeatureInProgress|libplasma|Make Calendar DataEngine a Service.|john@layt.net|John Layt}}
{{FeatureDone|plasma-desktop| integrate activity-sessions|chani@kde.org|Ivan/Chani}}
{{FeatureInProgress|plasma-desktop|activity dataengine|chani@kde.org|Chani}}
|-
! style="text-align: center;" colspan="4" | KWin
{{FeatureInProgress|windowgeometry effect| compositor powered move/resize windowgeometry display |thomas.luebking@web.de|Thomas Lübking}}
{{FeatureDone|dashboard effect| new effect for Plasma dashboard |ademmer@opensuse.org|Andreas Demmer}}
{{FeatureDone|kwin/ksmserver| activity sessions |chanika@gmail.com|Chani}}
{{FeatureDone|libtaskmanager/kwin?| some activity integration in taskbar/pager |chani@kde.org|Chani}}
{{FeatureTodo|libtaskmanager/kwin] | Expose Window Tabs to taskmanager |kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|kwin|ARB Shader support|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|Aurorae|Tooltips on window tabs|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Present Windows|Close window GUI control|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Startup Feedback|Effect to replace the Startup Feedback notification|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Screenshot Effect|KSanpshot can use KWin for screenshots|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|KCM Compositing|Allow compositing even if GL is buggy/X crashes|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|KWin Killer|Use notification instead of dialog|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|Compositing|Improved platform detection|fredrik@kde.org|Fredrik Höglund}}

|-
! style="text-align: center;" colspan="4" | KDE Power Management system
{{FeatureDone|core| PowerDevil v2 core |drf@kde.org|Dario Freddi}}
{{FeatureDone|actions| Basic actions for feature parity with PowerDevil v1 |drf@kde.org|Dario Freddi}}
{{FeatureInProgress|actions| More actions for advanced users |drf@kde.org|Dario Freddi}}
{{FeatureDone|policy-handler| Create a new policy handler for handling inhibition properly, and have kdelibs' Solid API use it |drf@kde.org|Dario Freddi}}
|-
! style="text-align: center;" colspan="4" | System Settings
{{FeatureInProgress|keyboard| Support for sticky layout switching |arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|keyboard| Support for > 4 layouts|arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|driconf|New module for configuring DRI drivers|fredrik@kde.org|Fredrik Höglund}}
|-
! style="text-align: center;" colspan="4" | Blue Devil
{{FeatureInProgress|Review| Get into kdebase|alex@eyeos.org|Alex Fiestas}}
{{FeatureInProgress|kio_obexftp| Better error handling|alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|usability|Review all the components improving hig/elegance|alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|share folders|Be able to share folders via obexftp|alex@eyeos.org|Alex Fiestas}}
{{FeatureTodo|Devices KCM|Add further information about devices, like address...|ereslibre@kde.org|Rafael Fernández López}}
{{FeatureTodo|Devices KCM|Allow to connect to devices services|ereslibre@kde.org|Rafael Fernández López}}
{{FeatureTodo|libbluedevil|Review DBus handling|ereslibre@kde.org|Rafael Fernández López}}
{{FeatureTodo|libbluedevil|Add support for services|ereslibre@kde.org|Rafael Fernández López}}
{{FeatureTodo|Monolithic|Fix listing problems under certain conditions|ereslibre@kde.org|Rafael Fernández López}}
|}

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|libnepomuk|Convenience operator overloads for query construction|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|libnepomuk|New query flags and improved handling of full text matching scores including sorting|trueg@kde.org|Sebastian Trueg}}
{{FeatureTodo|kdeui|Generic find bar widget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureDone|kdeui|Allow getting and setting the size of the pixmap cache in KImageCache|2kmm@gmx.de|Manuel Mommertz}}
{{FeatureDone|katepart|scripted actions|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|katepart|QAccessibleInterface's for document+cursor|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|libplasma|PluginLoader class|ry@n.rix.si|Ryan Rix}}
{{FeatureDone|libplasma|Allow SVGs to use systemcolors before rendering|2kmm@gmx.de|Manuel Mommertz}}
{{FeatureInProgress|libplasma|DeclarativeWidget to load QML scenes in Plasma|mart@kde.org|Marco Martin}}
{{FeatureInProgress|libplasma|finish up the gsoc project about Plasma::Storage service|mart@kde.org|Marco Martin}}
{{FeatureDone|libplasma|let Plasma::SVG find the best matching size hinted element if there is no exact match|ingomar@wesp.name|Ingomar Wesp (mentored by Manuel Mommertz)}}
{{FeatureInProgress|libnepomuk/KIO|Search excerpts|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|libnepomuk|Standardqueries for convenience|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|libnepomuk|GUI elements for resource/file searching including faceted browsing|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|libnepomuksync|Sync library to be used in BackupSync, Strigi, Akonadi, WebExtractor and Removable Media|handa.vish@gmail.com|Vishesh Handa}}
{{FeatureInProgress|kdecore|Add more possible synchronization primitives to KSharedDataCache to expand OS support. POSIX Semaphores Contributed by Alberto Villa of the FreeBSD project. Windows support may still occur as well.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|kdecore|Add fallback to QCache<QString,QByteArray> in KSharedDataCache.|mpyne@kde.org|Michael Pyne}}
{{FeatureDone|kdecore|Add cache-wide timestamp to KSharedDataCache.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|kdecore|Add ability to make KSharedDataCache strictly read-only for laptop support.|mpyne@kde.org|Michael Pyne}}
{{FeatureInProgress|kdeui|Social About Dialog|teo@kde.org|Teo Mrnjavac}}
{{FeatureDone|kdeui|Allow to hide icons in menus|christoph@maxiom.de|Christoph Feck}}
{{FeatureDone|KLocale|Auto-detect new users Country from their system country.|john@layt.net|John Layt}}
{{FeatureDone|KLocale|New configuration option for AM/PM symbols, .|john@layt.net|John Layt}}
{{FeatureDone|KLocale|Seperate backends available for each supported platform/desktop, use of platform localization in place of KDE locale planned for 4.7.|john@layt.net|John Layt}}
{{FeatureDone|KLocalizedDate|New convenience class to make date localization easy.|john@layt.net|John Layt}}
{{FeatureDone|KCalendarSystem|Add api for first/last day of year/month.|john@layt.net|John Layt}}
{{FeatureDone|KCalendarSystem|Add configuration option for Short Year Window.|john@layt.net|John Layt}}
{{FeatureDone|KCalendarSystem|Separated date / time parsing code into new private KDateTimeParser and KDateTimeFormatter classes to share with KLocale and KDateTime.|john@layt.net|John Layt}}
{{FeatureInProgress|KHTML|HTML5 postMessage.|maksim@kde.org|Maksim Orlovich}}
{{FeatureTodo|kcookiejar|New domain specific cookie policy based on patch provided in bug#54300|adawit@kde.org|Dawit A.}}
{{FeatureInProgress|kcookiejar|Implement storing cookies in KWallet|fid@gpul.org|José Millán Soto}}
{{FeatureInProgress|ksecretservice|Make KWallet::Wallet use the secrets-service API|lemma@confuego.org|Michael Leupold}}
{{FeatureInProgress|anywhere|Allow to build without deprecated symbols|ervin@kde.org|Kevin Ottens (with lots of support from David Faure)}}
{{FeatureInProgress|KIO|Use `net usershare` in KSambaShare|rclbelem@gmail.com|Rodrigo Belem}}
|}

 

= 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
{{FeatureDone|Marble|Loading of routes in .kml format (Maemo)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Route printing (map and directions, configurabe)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Route state saving and restoring|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Convert MarbleRunners to plugins|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|worldwide and offline routing|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Extend MarbleRunner interface to handle reverse geocoding and routing requests; Display of alternative routes|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Routing API|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|"Go To" dialog for Maemo|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Tile download along the route for offline usage|akssps011@gmail.com|Siddharth Srivastava}}
{{FeatureDone|Marble|Turn-by-turn navigation mode|akssps011@gmail.com|Siddharth Srivastava}}
{{FeatureDone|Marble|QtDeclarative plugin and QML examples (experimental)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Implement sun locator blendings as derived classes of Marble::Blending|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Separate thread for tile loading and texture blending (not texture mapping at the moment) for more smooth browsing|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Tile loading "read ahead" when idle, prerequisite: threaded tile loading|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Multi threaded texture mapping|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureDone|Marble|Improve GeoData API|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Convert Gps tracking to GeoDataDocument|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Provide a treeModel for GeoDataDocuments|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Draw the geometries of multiple GeoDataDocuments|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureInProgress|Marble|Load Pnt vector data files as GeoData|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureInProgress|Marble|Manipulate Gps track data|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Cantor|Backend for GNU Octave|miha.cancula@gmail.com|Miha Čančula}}
{{FeatureInProgress|Cantor|Merge R improvement branch|alexanderrieder@gmail.com|Alexander Rieder}}
{{FeatureInProgress|Cantor|Variable management panel|alexanderrieder@gmail.com|Alexander Rieder}}
{{FeatureTodo|Cantor|Formulas inside Text Entries|alexanderrieder@gmail.com| Alexander Rieder}}
{{FeatureDone|Kalzium|Port Kalzium to use QGV based periodic table widget|mhanwell@kde.org|Marcus D. Hanwell}}
{{FeatureDone|KAlgebra|Implicit functions plot|percy.camilo.ta@gmail.com|Percy Aucahuasi}}
{{FeatureDone|KAlgebra|Improved execution speed on the calculator|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|Better integration between the Console and the Plotting facilities|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|Lighter version aimed to mobile users|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureInProgress|KStars|OpenGL rendering support for KStars|akarshsimha@gmail.com|Harry de Valence, Akarsh Simha}}
{{FeatureInProgress|KStars|Better designed object database|akarshsimha@gmail.com|Victor Carbune, Akarsh Simha}}
{{FeatureInProgress|KStars|Star Hop Generator|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureDone|Kig|LaTeX/TikZ exporter|miha.cancula@gmail.com|Miha Čančula}}
|}

 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|JuK|Remove Qt/KDE3 support lib requirements|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Allow setting covers directly from URLs supported by KIO - drag/drop already allows this however|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Add MPRIS support to JuK so that the NowPlaying applet doesn't need to special-case JuK.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Update JuK's MusicBrainz support to a modern version of MusicBrainz.|mpyne@kde.org|Michael Pyne}}
{{FeatureInProgress|kmix|Improved volume OSD|fredrik@kde.org|Fredrik Höglund}}
|}

 

= kdegames =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|libkdegames|Import KGameRenderer framework and [[Projects/Games/Porting|port games]] to this unified rendering infrastructure.|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureInProgress|Kigo|Fix KNewStuff provider issues|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureDone|Palapeli|Import Goldberg slicer as the new default slicer plugin.|loehnert.kde@gmx.de|Johannes Loehnert}}
{{FeatureDone|Palapeli|Update libpala API. Improve usability of "Create new puzzle" dialog.|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureDone|Kajongg|Docbook: Describe the basic game, until now I supposed the player already knows how to play Mah Jong.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Tiles can be discarded with drag&drop.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Make robot player AI more intelligent.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Make tiles in the hand larger and the wall tiles smaller for better playability on small screens.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Make games suspendable/resumable.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Animate moving tiles.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Demo mode.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Introduce an option to only offer possible actions.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Add more rulesets like other Classical Chinese variants and the international tournament rules.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Save and restore the current control-mode, keyboard-control option and game-speed settings.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add a keyboard-mode option to start moving when a direction-key is pressed and stop when it is released. Support multiple keys being pressed.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|Klickety|An adaptation of the "clickomania" game.Rewrite the kde3 version.|shuizhuyuanluo@126.com|Ni Hui}}
{{FeatureDone|Klickety|Merge KSame into Klickety.|shuizhuyuanluo@126.com|Ni Hui}}
{{FeatureInProgress|Kolf|Port to KGameRenderer, cleanup all QGraphicsView- and physics-related code (and physics engine), incorporate ideas from Kolf-NG.|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureInProgress|Granatier|Port to KGameRenderer.|k.hias@gmx.de|Mathias Kraus}}
{{FeatureInProgress|Granatier|Use TagaroAudio for sound.|k.hias@gmx.de|Mathias Kraus}}
{{FeatureDone|Knights|New game: Chess board for KDE4|miha.cancula@gmail.com|Miha Čančula}}
|}

 

= 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
{{FeatureDone|gwenview|Simplify photo sharing|agateau@kde.org|Aurélien Gâteau}}
|}

 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Lokalize|Integrate snowball stemmer for glossary|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Continue implementing XLIFF spec|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Segmentation [editing] functionality|shafff@NOSPAMukr.net |Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Remote translation memories|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Integrate with nepomuk (fast stats retrieval, tag cloud - incl sharing!)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|loading compressed files and then saving them back in the original compression format (bug 65518)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Nepomukshell|New Nepomukshell development tool allowing to browse and debug Nepomuk data|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|Dolphin|Git plugin|sebastian@sebastian-doerner.de|Sebastian Doerner}}
{{FeatureDone|Kate|GDB plugin|kare.sars@iki.fi|Kåre Särs}}
|}

 

= kdeutils =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Ark|Add a "Preview with..." context menu item|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Add an options dialog (maybe)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Add feedback for the latest operation in the status bar|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Get rid of the Observer code in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make error reporting work as expected in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make Kerfuffle really thread-safe (and use threads in less places)|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make the internal previewer optional|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Simplify Kerfuffle's API (jobs, interfaces etc) and try to make it stable|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Support for custom options from the compression interface (eg. a slider for selecting compression level for rar files)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Try multiple plugins for each archive type before failing|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|printer-applet|Restore feature parity with KDEPrint3 where possible.||Jonathon Riddell, John Layt}}
{{FeatureTodo|Okteta|Add view profiles|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|KGpg|Better workflow to edit encrypted files|kde@opensource.sf-tec.de|Rolf Eike Beer}}
|}

 

= 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|Kontact|Plasma-based Summary Page|ry@n.rix.si|Ryan Rix}}
{{FeatureInProgress|KHolidays|Add support for holiday types and day-off types.|john@layt.net|John Layt}}
{{FeatureInProgress|KHolidays|Holiday Region selection widget.|john@layt.net|John Layt}}
{{FeatureDone|KHolidays|Holiday duration api.|john@layt.net|John Layt}}
{{FeatureDone|KHolidays|Default Holiday Region api.|john@layt.net|John Layt}}
{{FeatureInProgress|KAlarm|Port to Akonadi|djarvie@kde.org|David Jarvie}}
{{FeatureDone|KAlarm|Option to not notify execution errors for pre-alarm actions|djarvie@kde.org|David Jarvie}}
{{FeatureInProgress|KAlarm|Allow reminders after the main alarm|djarvie@kde.org|David Jarvie}}
{{FeatureInProgress|KAlarm|Provide wake-from-suspend option for alarms|djarvie@kde.org|David Jarvie}}
|}
 

= kdeaccessibility =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none 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|KAccessible|Added a dbus-service and a QAccessibleBridgePlugin for focus tracking (used in KMagnifier and the KWin zoom plugin).|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|KMagnifier|Follow Focus Mode for Focus Tracking (uses kaccessible).|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|KAccessible|Added Screenreader (uses speech-dispatcher)|mail@dipe.org|Sebastian Sauer}}
|}

 
= kdeartwork =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|KDE Asciiquarium|Added a new ASCII sprite (a submarine). Contributed by Ryan Meldrum.|mpyne@kde.org.|Michael Pyne}}
|}

 
= 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
{{FeatureDone|Shelf|Automatic sizing of the popup|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Shelf|Setting a custom popup icon|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|Shelf|Cascading popup menus for folders|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Shelf|Keyboard navigation|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Shelf|Search completion|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|libLancelot-datamodels|Akonadi integration|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|libLancelot-datamodels|Folder contents sorting|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|Lancelot|Theme improvements, animations|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|Events Runner|Event search|alexey.noskov@gmail.com|Alexey Noskov}}
{{FeatureTodo|Comic plasmoid|Per comic max cache limit|mat69@gmx.net|Matthias Fuchs}}
{{FeatureTodo|Comic plasmoid|Change behaviour when comic can't be found|mat69@gmx.net|Matthias Fuchs}}
{{FeatureDone|GroupingDesktop|Added two desktop containments and a panel containment with applet grouping support|giuliocamuffo@gmail.com|Giulio Camuffo}}
|}

 

= kdenetwork =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|krfb|Refactor Core to make it more maintainable/extensible|grundleborg@googlemail.com.|George Goldberg}}
{{FeatureDone|krfb|Telepathy Tubes support|grundleborg@googlemail.com.|George Goldberg}}
{{FeatureDone|krfb|UI Improvements to support new features/deal with some existing bug reports|grundleborg@googlemail.com.|George Goldberg}}
{{FeatureTodo|kget|Log for transfers|l.appelhans@gmx.de|Lukas Appelhans}}
|}

Talk:Projects/Usability/HIG/Toggle Buttons

2010-11-13T18:41:41Z

Agateau: /* Second option: Describe the current state */

===Second option: Describe the current state===

This option presented here i think only confuses people and clashes with the first option (show what the button does). Take the example:

[[File:Toggle-button-unlocked-locked.png]]

The first thing i thought this would do was enable the Unlocked state, until i saw what happened when the button was pressed. A better option in this case would be to just put 'Lock' on the button (as in, the action) and not represent the current state on the button (or at most in the icon only). I can't think of a situation where having the current state is better than putting on the action, but i might be wrong.

--[[User:GeniusDex|GeniusDex]] 08:27, 13 November 2010 (UTC)

The fact the button label is using a verb in a passive form should be an indication that it represents the current state rather than the state which will be reached when clicked.

There are valid use cases for toggle buttons, the most common being text formatting, which is cited in this document.

--[[User:Agateau|Agateau]] 17:16, 13 November 2010 (UTC)

Thinking a bit more about it, the behavior of this button would probably be more intuitive if it came without label, only the icon. I suppose it is because without label the icon gets a more central place and we associate the button with the physical action of locking the padlock.

--[[User:Agateau|Agateau]] 18:41, 13 November 2010 (UTC)

Talk:Projects/Usability/HIG/Toggle Buttons

2010-11-13T17:16:46Z

Agateau: /* Second option: Describe the current state */

Schedules/KDE4/4.6 Feature Plan

2010-10-26T19:21:33Z

Agateau: Added kdegraphics section

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

See also:

*[[Schedules/KDE4/4.6 Release Schedule]]
*[[Schedules/KDE4/4.6 Release Goals]]
*[[Schedules/KDE4/4.5 Feature Plan]] (previous major release)

 Legend:

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

__TOC__

 

= kdebase-apps =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureInProgress|Konsole|Move to KTabWidget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureInProgress|Dolphin|Faceted browsing via Nepomuk|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|Dolphin|Searching support for non-indexed files|peter.penz19@gmail.com|Peter Penz}}
{{FeatureInProgress|Dolphin|Git-plugin (implemented by Sebastian Dörner and Johannes Steffen)|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin| Resizeable columns in the column-view|peter.penz19@gmail.com|Peter Penz}}
{{FeatureDone|Dolphin| Allow leading zeros when renaming multiple files (implemented by Matthias Fuchs)|peter.penz19@gmail.com|Peter Penz}}
|}

 

= kdebase-runtime =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Plasma|Plasma KPart|ry@n.rix.si|Ryan Rix}}
{{FeatureInProgress|Plasma|Declarative AppletScript to write QML plasmoids|mart@kde.org|Marco Martin}}
{{FeatureInProgress|Plasma|Optimize the Newspaper containment for the use with touchscreens and the Plasma KPart|mart@kde.org|Marco Martin}}
{{FeatureDone|KWin|Focus tracking for the zoom plugin (uses kaccessible)|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|KWin|Extend mouse tracking modes for the zoom plugin|mail@dipe.org|Sebastian Sauer}}
{{FeatureInProgress|Nepomuk Backup & Sync| Provide Backup and Sync capabilities to Nepomuk|handa.vish@gmail.com|Vishesh Handa}}
{{FeatureInProgress|Activities manager service|Merge the kded and nepomuk modules for activities into one service|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|Activities manager service|Register desktop events instead directly linking the activities to resources|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|KNotify|Add support for relative present actions in contexts|wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureInProgress|Locale KCM|Complete re-write to improve usability, support for new localization features|john@layt.net|John Layt}}
|}

 

= kdebase-workspace =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
|-
! style="text-align: center;" colspan="4" | Plasma
{{FeatureInProgress|libtaskmanager / tasks-applet| support for Windows 7 like launchers |akreuzkamp@web.de|Anton Kreuzkamp}}
{{FeatureInProgress|notifications| rework notification applet appearance |mart@kde.org|Marco Martin}}
{{FeatureInProgress|notifications| make various dataengines use Plasma::Storage |mart@kde.org|Marco Martin}}
{{FeatureDone|plasma-desktop| UI for editing activity name and icon|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|plasma-desktop| add some default activities|fux@kde.org|Mario Fux}}
{{FeatureTodo|plasma| finish support for activity templates | |??}}
{{FeatureInProgress|plasma-devicenotifier| Improve notification support |wilderkde@gmail.com|Jacopo De Simoi}}
{{FeatureInProgress|quicklaunch| populate new applets with user's default browser, file manager, ... instead of hardcoded ones |ingomar@wesp.name|Ingomar Wesp}}
{{FeatureInProgress|quicklaunch| allow editing of existing launchers (including ones that do not point to a .desktop file) |ingomar@wesp.name|Ingomar Wesp}}
{{FeatureInProgress|quicklaunch| better layout for desktop and media center form factors |ingomar@wesp.name|Ingomar Wesp}}
{{FeatureInProgress|libplasma|Improvements to Calendar/Clock widgets. Improved config ui. Allow multiple holidays on same day. Allow multiple Holiday Regions. Weekends. etc.|john@layt.net|John Layt}}
{{FeatureInProgress|libplasma|Make Calendar DataEngine a Service.|john@layt.net|John Layt}}
{{FeatureTodo|plasma-desktop| integrate activity-sessions|chani@kde.org|Ivan/Chani}}
{{FeatureTodo|plasma-desktop|activity dataengine?|chani@kde.org|Chani}}
|-
! style="text-align: center;" colspan="4" | KWin
{{FeatureInProgress|windowgeometry effect| compositor powered move/resize windowgeometry display |thomas.luebking@web.de|Thomas Lübking}}
{{FeatureInProgress|dashboard effect| new effect for Plasma dashboard |ademmer@opensuse.org|Andreas Demmer}}
{{FeatureInProgress|kwin/ksmserver| activity sessions |chanika@gmail.com|Chani}}
{{FeatureTodo|libtaskmanager/kwin?| combine the three window-contextmenu codebases into one | |??}}
{{FeatureTodo|libtaskmanager/kwin] | Expose Window Tabs to taskmanager |kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|kwin|ARB Shader support|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureInProgress|Aurorae|Tooltips on window tabs|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Present Windows|Close window GUI control|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Startup Feedback|Effect to replace the Startup Feedback notification|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureDone|Screenshot Effect|KSanpshot can use KWin for screenshots|kde@martin-graesslin.com|Martin Gräßlin}}
{{FeatureTodo|KCM Compositing|Allow compositing even if GL is buggy/X crashes|kde@martin-graesslin.com|Martin Gräßlin}}
|-
! style="text-align: center;" colspan="4" | KDE Power Management system
{{FeatureDone|core| PowerDevil v2 core |drf@kde.org|Dario Freddi}}
{{FeatureDone|actions| Basic actions for feature parity with PowerDevil v1 |drf@kde.org|Dario Freddi}}
{{FeatureInProgress|actions| More actions for advanced users |drf@kde.org|Dario Freddi}}
{{FeatureInProgress|policy-handler| Create a new policy handler for handling inhibition properly, and have kdelibs' Solid API use it |drf@kde.org|Dario Freddi}}
|-
! style="text-align: center;" colspan="4" | System Settings
{{FeatureInProgress|keyboard| Support for sticky layout switching |arysin@gmail.com|Andriy Rysin}}
{{FeatureInProgress|keyboard| Support for > 4 layouts|arysin@gmail.com|Andriy Rysin}}
|}

 

= kdelibs =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|libnepomuk|Convenience operator overloads for query construction|trueg@kde.org|Sebastian Trueg}}
{{FeatureDone|libnepomuk|New query flags and improved handling of full text matching scores including sorting|trueg@kde.org|Sebastian Trueg}}
{{FeatureTodo|kdeui|Generic find bar widget|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureDone|kdeui|Allow getting and setting the size of the pixmap cache in KImageCache|2kmm@gmx.de|Manuel Mommertz}}
{{FeatureDone|katepart|scripted actions|dhaumann@kde.org|Dominik Haumann}}
{{FeatureDone|katepart|QAccessibleInterface's for document+cursor|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|libplasma|PluginLoader class|ry@n.rix.si|Ryan Rix}}
{{FeatureDone|libplasma|Allow SVGs to use systemcolors before rendering|2kmm@gmx.de|Manuel Mommertz}}
{{FeatureInProgress|libplasma|DeclarativeWidget to load QML scenes in Plasma|mart@kde.org|Marco Martin}}
{{FeatureInProgress|libplasma|finish up the gsoc project about Plasma::Storage service|mart@kde.org|Marco Martin}}
{{FeatureInProgress|libnepomuk/KIO|Search excerpts|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|libnepomuk|Standardqueries for convenience|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|libnepomuk|GUI elements for resource/file searching including faceted browsing|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|libnepomuksync|Sync library to be used in BackupSync, Strigi, Akonadi, WebExtractor and Removable Media|handa.vish@gmail.com|Vishesh Handa}}
{{FeatureInProgress|kdecore|Add more possible synchronization primitives to KSharedDataCache to expand OS support. POSIX Semaphores Contributed by Alberto Villa of the FreeBSD project. Windows support may still occur as well.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|kdecore|Add fallback to QCache<QString,QByteArray> in KSharedDataCache.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|kdecore|Add cache-wide timestamp to KSharedDataCache.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|kdecore|Add ability to make KSharedDataCache strictly read-only for laptop support.|mpyne@kde.org|Michael Pyne}}
{{FeatureInProgress|kdeui|Social About Dialog|teo@kde.org|Teo Mrnjavac}}
{{FeatureTodo|KCalendarSystem||john@layt.net|John Layt}}
{{FeatureTodo|KCalendarSystem|Add astronomical calculation support classes and astronomical based calendars.|john@layt.net|John Layt}}
{{FeatureDone|KCalendarSystem|Add api for first/last day of year/month.|john@layt.net|John Layt}}
{{FeatureInProgress|KDate|New convenience class to make date localization easy.|john@layt.net|John Layt}}
{{FeatureDone|KLocale|Add configuration for AM/PM symbols.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Add default colour to optionally display negative numbers.|john@layt.net|John Layt}}
{{FeatureTodo|KLocale|Add more date formats.|john@layt.net|John Layt}}
{{FeatureInProgress|KLocale|Full POSIX compliant format support for date, time, numbers and money, including but not limited to: traditional/US week numbers, AM/PM symbols, number grouping|john@layt.net|John Layt}}
{{FeatureInProgress|KLocale|Implement separate backends for each supported platform/desktop to use platform localization in place of KDE locale.|john@layt.net|John Layt}}
{{FeatureInProgress|KLocale|Implement support for Country Code sub-regions and other country code standard conversions.|john@layt.net|John Layt}}
|}

 

= 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|GPX import of routes|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Route printing (map and directions, configurabe)|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Route state saving and restoring|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Convert MarbleRunners to plugins|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|worldwide and offline routing|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureDone|Marble|Extend MarbleRunner interface to handle reverse geocoding and routing requests; Display of alternative routes|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Routing API|earthwings@gentoo.org|Dennis Nienhüser}}
{{FeatureInProgress|Marble|Implement sun locator blendings as derived classes of Marble::Blending|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Separate thread for tile loading and texture blending (not texture mapping at the moment) for more smooth browsing|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureTodo|Marble|Tile loading "read ahead" when idle, prerequisite: threaded tile loading|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureDone|Marble|Tile download along the route for offline usage|akssps011@gmail.com|Siddharth Srivastavah}}
{{FeatureInProgress|Marble|Turn-by-turn navigation mode|akssps011@gmail.com|Siddharth Srivastavah}}
{{FeatureTodo|Marble|Multi threaded texture mapping|jmho@c-xx.com|Jens-Michael Hoffmann}}
{{FeatureDone|Marble|Improve GeoData API|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Convert Gps tracking to GeoDataDocument|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Provide a treeModel for GeoDataDocuments|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Marble|Draw the geometries of multiple GeoDataDocuments|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureInProgress|Marble|Load Pnt vector data files as GeoData|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureInProgress|Marble|Manipulate Gps track data|tgridel@freedotfr|Thibaut Gridel}}
{{FeatureDone|Cantor|Backend for GNU Octave|miha.cancula@gmail.com|Miha Čančula}}
{{FeatureInProgress|Cantor|Merge R improvement branch|alexanderrieder@gmail.com|Alexander Rieder}}
{{FeatureInProgress|Cantor|Variable management panel|alexanderrieder@gmail.com|Alexander Rieder}}
{{FeatureTodo|Cantor|Formulas inside Text Entries|alexanderrieder@gmail.com| Alexander Rieder}}
{{FeatureDone|Kalzium|Port Kalzium to use QGV based periodic table widget|mhanwell@kde.org|Marcus D. Hanwell}}
{{FeatureDone|KAlgebra|Implicit functions plot|percy.camilo.ta@gmail.com|Percy Aucahuasi}}
{{FeatureDone|KAlgebra|Improved execution speed on the calculator|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureDone|KAlgebra|Better integration between the Console and the Plotting facilities|aleixpol@kde.org|Aleix Pol Gonzalez}}
{{FeatureInProgress|KStars|OpenGL rendering support for KStars|akarshsimha@gmail.com|Harry de Valence, Akarsh Simha}}
{{FeatureInProgress|KStars|Better designed object database|akarshsimha@gmail.com|Victor Carbune, Akarsh Simha}}
{{FeatureInProgress|KStars|Star Hop Generator|akarshsimha@gmail.com|Akarsh Simha}}
{{FeatureDone|Kig|LaTeX/TikZ exporter|miha.cancula@gmail.com|Miha Čančula}}
|}

 

= kdemultimedia =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|JuK|Remove Qt/KDE3 support lib requirements|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Allow setting covers directly from URLs supported by KIO - drag/drop already allows this however|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Add MPRIS support to JuK so that the NowPlaying applet doesn't need to special-case JuK.|mpyne@kde.org|Michael Pyne}}
{{FeatureTodo|JuK|Update JuK's MusicBrainz support to a modern version of MusicBrainz.|mpyne@kde.org|Michael Pyne}}

|}

 

= kdegames =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|libkdegames|Import KGameRenderer framework and [[Projects/Games/Porting|port games]] to this unified rendering infrastructure.|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureInProgress|Kigo|Fix KNewStuff provider issues|sasch.pe@gmx.de|Sascha Peilicke}}
{{FeatureDone|Palapeli|Import Goldberg slicer as the new default slicer plugin.|loehnert.kde@gmx.de|Johannes Loehnert}}
{{FeatureDone|Palapeli|Update libpala API. Improve usability of "Create new puzzle" dialog.|majewsky@gmx.net|Stefan Majewsky}}
{{FeatureDone|Kajongg|Docbook: Describe the basic game, until now I supposed the player already knows how to play Mah Jong.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Tiles can be discarded with drag&drop.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Make robot player AI more intelligent.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Make tiles in the hand larger and the wall tiles smaller for better playability on small screens.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|Kajongg|Make games suspendable/resumable.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureInProgress|Kajongg|Animate moving tiles.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureInProgress|Kajongg|Demo mode.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Introduce an option to only offer possible actions.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureTodo|Kajongg|Add more rulesets like other Classical Chinese variants and the international tournament rules.|wolfgang@rohdewald.de|Wolfgang Rohdewald}}
{{FeatureDone|KGoldrunner|Save and restore the current control-mode, keyboard-control option and game-speed settings.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|KGoldrunner|Add a keyboard-mode option to start moving when a direction-key is pressed and stop when it is released. Support multiple keys being pressed.|iandw.au@gmail.com|Ian Wadham}}
{{FeatureDone|Klickety|An adaptation of the "clickomania" game.Rewrite the kde3 version.|shuizhuyuanluo@126.com|Ni Hui}}
{{FeatureInProgress|Klickety|IMerge KSame into Klickety.|shuizhuyuanluo@126.com|Ni Hui}}
{{FeatureInProgress|Kolf|Port to KGameRenderer, cleanup all QGraphicsView- and physics-related code (and physics engine), incorporate ideas from Kolf-NG.|majewsky@gmx.net|Stefan Majewsky}}
|}

 

= kdegraphics =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|gwenview|Simplify photo sharing|agateau@kde.org|Aurélien Gâteau}}
|}

 

= kdesdk =

{| cellspa/cing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Lokalize|Integrate snowball stemmer for glossary|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Continue implementing XLIFF spec|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Segmentation [editing] functionality|shafff@NOSPAMukr.net |Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Remote translation memories|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|Integrate with nepomuk (fast stats retrieval, tag cloud - incl sharing!)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Lokalize|loading compressed files and then saving them back in the original compression format (bug 65518)|shafff@NOSPAMukr.net|Nick Shaforostoff}}
{{FeatureTodo|Nepomukshell|New Nepomukshell development tool allowing to browse and debug Nepomuk data|trueg@kde.org|Sebastian Trueg}}
{{FeatureInProgress|Dolphin|Git plugin|sebastian@sebastian-doerner.de|Sebastian Doerner}}
|}

 

= kdeutils =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureTodo|Ark|Add a "Preview with..." context menu item|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Add an options dialog (maybe)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Add feedback for the latest operation in the status bar|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Get rid of the Observer code in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make error reporting work as expected in Kerfuffle|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make Kerfuffle really thread-safe (and use threads in less places)|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Make the internal previewer optional|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Simplify Kerfuffle's API (jobs, interfaces etc) and try to make it stable|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Ark|Support for custom options from the compression interface (eg. a slider for selecting compression level for rar files)|haraldhv@stud.ntnu.no|Harald Hvaal}}
{{FeatureTodo|Ark|Try multiple plugins for each archive type before failing|kubito@gmail.com|Raphael Kubo da Costa}}
{{FeatureTodo|Okteta|Add a general KPart adapter to Kasten, than finish port of Okteta KPart to Okteta Kasten|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add global toggle option for the offset display, hex or decimal|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Kate-like combined dialogs to query for actions on files|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add Kate-like search tool|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add Okular like embedded notifications|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for import by drop, both url and data|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for memory mapping of files and 64-bit addressing|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|add support for jobs like io, printing, string search or filter|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Add view profiles, incl. editor/manager|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|copy again puts also a value or char variant of the data to clipboard|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Improve the titels of the changes to the bytearray to be more descriptive, best using ids to avoid text string|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Make all user interaction in the KastenCore managers plugin-based|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Merge row and column widgets into one|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|Okteta|Store bookmarks and other view settings for next load|kossebau@kde.org|Friedrich W. H. Kossebau}}
{{FeatureTodo|printer-applet|Restore feature parity with KDEPrint3 where possible.||Jonathon Riddell, John Layt}}
{{FeatureTodo|Okteta|Add view profiles|kossebau@kde.org|Friedrich W. H. Kossebau}}
|}

 

= 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|Kontact|Plasma-based Summary Page|ry@n.rix.si|Ryan Rix}}
{{FeatureInProgress|KHolidays|Add support for holiday types and day-off types.|john@layt.net|John Layt}}
{{FeatureInProgress|KHolidays|Holiday Region selection widget.|john@layt.net|John Layt}}
{{FeatureDone|KHolidays|Holiday duration api.|john@layt.net|John Layt}}
{{FeatureDone|KHolidays|Default Holiday Region api.|john@layt.net|John Layt}}
|}
 

= kdeaccessibility =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none 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|KAccessible|Added a dbus-service and a QAccessibleBridgePlugin for focus tracking (used in KMagnifier and the KWin zoom plugin).|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|KMagnifier|Follow Focus Mode for Focus Tracking (uses kaccessible).|mail@dipe.org|Sebastian Sauer}}
{{FeatureDone|KAccessible|Added Screenreader (uses speech-dispatcher)|mail@dipe.org|Sebastian Sauer}}
|}

 
= kdeartwork =

{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
! Status
! Project
! Description
! Contact
{{FeatureDone|KDE Asciiquarium|Added a new ASCII sprite (a submarine). Contributed by Ryan Meldrum.|mpyne@kde.org.|Michael Pyne}}
|}

 
= 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
{{FeatureDone|Shelf|Automatic sizing of the popup|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Shelf|Setting a custom popup icon|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|Shelf|Cascading popup menus for folders|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Shelf|Keyboard navigation|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureDone|Shelf|Search completion|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|libLancelot-datamodels|Akonadi integration|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|libLancelot-datamodels|Folder contents sorting|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureInProgress|Lancelot|Theme improvements, animations|ivan.cukic@kde.org|Ivan Čukić}}
{{FeatureTodo|Events Runner|Event search|alexey.noskov@gmail.com|Alexey Noskov}}
|}

 

= 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|krfb|Refactor Core to make it more maintainable/extensible|grundleborg@googlemail.com.|George Goldberg}}
{{FeatureInProgress|krfb|Telepathy Tubes support|grundleborg@googlemail.com.|George Goldberg}}
{{FeatureInProgress|krfb|UI Improvements to support new features/deal with some existing bug reports|grundleborg@googlemail.com.|George Goldberg}}
|}

Projects/Usability/HIG

2010-08-28T15:54:27Z

Agateau: /* T */

__NOTOC__
Please add any guidelines questions or requests to the [[Projects/Usability/HIG_Questions|HIG Questions]] page.

Also see the [http://developer.kde.org/documentation/standards/kde/style/basics/index.html KDE3 User Interface Guidelines] and the draft notes for the [http://wiki.openusability.org/guidelines/ KDE4 Human Interface Guidelines].

[[Projects/Usability/HIG/SOU_Workspace|Season of Usability HIG & Design Patterns Workspace]]

==Index==
===C===
* [[Projects/Usability/HIG/Capitalization|Capitalization]]
* [[Projects/Usability/HIG/Contractions|Contractions (don't, there's, etc.)]]
* [[Projects/Usability/HIG/Check_Box|Check Box]]
* [[Projects/Usability/HIG/Combo_Box|Combo Box]]

===D===
* [[Projects/Usability/HIG/Date_Time|Date and Time]]
* [[Projects/Usability/HIG/Dialogs|Dialogs]]

===E===
* [[Projects/Usability/HIG/Ellipsis|Ellipsis]]
* [[Projects/Usability/HIG/Exclamation_points|Exclamation Points]]

===F===
* [[Projects/Usability/HIG/Form_Label_Alignment|Forms: Label Alignment]]

===K===
* [[Projects/Usability/HIG/KNS|KNewStuff Button Labels]]
* [[Projects/Usability/HIG/Keyboard_Accelerators|Keyboard Accelerators]]
* [[Projects/Usability/HIG/Keyboard_Shortcuts|Keyboard Shortcuts]]

===L===
* [[Projects/Usability/HIG/Labels|Labels]]
* [[Projects/Usability/HIG/Lists_Rich_Lists|Lists and Rich Lists]]

===M===
* [[Projects/Usability/HIG/Menu_Bar|Menu Bar]]
* [[Projects/Usability/HIG/Messages|Messages]]
===R===
* [[Projects/Usability/HIG/Radio Buttons|Radio Buttons]]
===S===
* [[Projects/Usability/HIG/Slider|Slider]]
* [[Projects/Usability/HIG/Spin_Box|Spin Box]]

===T===
* [[Projects/Usability/HIG/Tabs_Pages|Tabs and Pages in Dialogs]]
* [[Projects/Usability/HIG/Toggle_Buttons|Toggle Buttons]]

===W===
* [[Projects/Usability/HIG/Wording|Wording]]

[[Category:Usability]]

Projects/Usability/HIG/Toggle Buttons

2010-08-28T15:39:20Z

Agateau: moved User:Agateau/Toggle Button to Projects/Usability/HIG/Toggle Buttons: Validated by Celeste

==Definition==

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to Use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

[[File:Toggle-button-formatting.png]]
(Toggle buttons used in a rich text editor)

==When not to Use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a combined Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

[[File:Toggle-button-media-player.png]]

==Icon and Label==

There are two ways to label a toggle button. You can either describe the state reached when the button is down or describe the current state.

===First option: Describe the state reached when the button is down===

In this case the icon and label should not change when the button is down.

Example: We create a toggle button to toggle the visibility of a sidebar. The label of this button is "Show Sidebar". When the button is toggled down, it should still say "Show Sidebar": it should not be changed to "Hide Sidebar".

Think of the button as a check box: when you click a check box you do not expect its label to change. If it makes more sense to change the button text to "Hide Sidebar" when the sidebar is shown then you should use a normal button, not a toggle button.

It is worth noting that unlike normal buttons, the label of a toggle button does not need to contain a verb, as long as there is no ambiguity. In this example the label can be reduced to "Sidebar".

[[File:Toggle-button-summary.png]]

===Second option: Describe the current state===

In this case the label will often include a passive verb. For example a button to lock or unlock an element would say "Unlocked" when it is up and "Locked" when it is down. The icon should also change to match the label.

[[File:Toggle-button-unlocked-locked.png]]

===Which option to use===

There is no strict rule to decide which option is the best, it depends on the context of your application. Note however that the second option has one drawback: since the label change, the button width will change as well. This can be annoying if the button is in the middle of a toolbar as it will cause all buttons after it to shift horizontally.

User:Agateau/Toggle Button

2010-08-28T15:39:20Z

Agateau: moved User:Agateau/Toggle Button to Projects/Usability/HIG/Toggle Buttons: Validated by Celeste

#REDIRECT [[Projects/Usability/HIG/Toggle Buttons]]

User:Agateau

2010-08-27T21:44:15Z

Agateau: /* Drafts */

I am Gwenview main developer, and also try to help out polishing overall desktop experience in KDE.

* blog: http://agateau.wordpress.com
* mail: agateau (a) kde dot org

== Drafts ==

* [[User:Agateau/TooManyToolbars|Too Many Toolbars]]
* [[User:Agateau/Toggle_Button|Toggle Button]]

Projects/Usability/HIG/Toggle Buttons

2010-08-27T21:22:09Z

Agateau:

File:Toggle-button-media-player.png

2010-08-27T20:37:27Z

Agateau: uploaded a new version of "File:Toggle-button-media-player.png"

Projects/Usability/HIG/Toggle Buttons

2010-08-27T20:34:02Z

Agateau: /* Icon and Label */

==Definition==

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to Use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

[[File:Toggle-button-formatting.png]]
(Toggle buttons used in a rich text editor)

==When not to Use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a combined Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

[[File:Toggle-button-media-player.png]]

==Icon and Label==

There are two ways to label a toggle button:

'''First option: Describe the state which is reached when the button is down'''

In this case the icon and label should not change when the button is down.

Example: We create a toggle button to toggle the visibility of a sidebar. The label of this button is "Show Sidebar". When the button is toggled down, it should still say "Show Sidebar": it should not be changed to "Hide Sidebar".

Think of the button as a check box: when you click a check box you do not expect its label to change. If it makes more sense to change the button text to "Hide Sidebar" when the sidebar is shown then you should use a normal button, not a toggle button.

It is worth noting that unlike normal buttons, the label of a toggle button does not need to contain a verb, as long as there is no ambiguity. In this example the label can be reduced to "Sidebar".

[[File:Toggle-button-summary.png]]

'''Second option: Describe the current state'''

In this case the label will often include a passive verb. For example a button to lock or unlock an element would say "Unlocked" when it is up and "Locked" when it is down. The icon should also change to match the label.

[[File:Toggle-button-unlocked-locked.png]]

Projects/Usability/HIG/Toggle Buttons

2010-08-27T20:30:09Z

Agateau: /* Icon and Label */

==Definition==

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to Use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

[[File:Toggle-button-formatting.png]]
(Toggle buttons used in a rich text editor)

==When not to Use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a combined Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

[[File:Toggle-button-media-player.png]]

==Icon and Label==

There are two ways to label a toggle button:

'''First option: Describe the state which is reached when the button is down'''

In this case the icon and label should not change when the button is down.

For example a button to toggle the visibility of a sidebar could say "Show Sidebar". It should still say "Show Sidebar" when the button is down: it should not be changed to "Hide Sidebar". Think of the button as a check box: when you click a check box you do not expect its label to change.

If you want to change the button text to "Hide Sidebar" when the sidebar is shown then you should use a normal button, not a toggle button.

It is worth noting the label of a toggle button does not need to contain a verb, as long as there is no ambiguity. In this example the label can be reduced to "Sidebar".

[[File:Toggle-button-summary.png]]

'''Second option: Describe the current state'''

In this case the label will often include a passive verb. For example a button to lock or unlock an element would say "Unlocked" when it is up and "Locked" when it is down. The icon should also change to match the label.

[[File:Toggle-button-unlocked-locked.png]]

Projects/Usability/HIG/Toggle Buttons

2010-08-27T20:29:34Z

Agateau: /* Icon and Label */

==Definition==

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to Use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

[[File:Toggle-button-formatting.png]]
(Toggle buttons used in a rich text editor)

==When not to Use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a combined Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

[[File:Toggle-button-media-player.png]]

==Icon and Label==

There are two ways to label a toggle button:

'''First possibility: Describe the state which is reached when the button is down'''

In this case the icon and label should not change when the button is down.

For example a button to toggle the visibility of a sidebar could say "Show Sidebar". It should still say "Show Sidebar" when the button is down: it should not be changed to "Hide Sidebar". Think of the button as a check box: when you click a check box you do not expect its label to change.

If you want to change the button text to "Hide Sidebar" when the sidebar is shown then you should use a normal button, not a toggle button.

It is worth noting the label of a toggle button does not need to contain a verb, as long as there is no ambiguity. In this example the label can be reduced to "Sidebar".

[[File:Toggle-button-summary.png]]

'''Second possibility: Describe the current state'''

In this case the label will often include a passive verb. For example a button to lock or unlock an element would say "Unlocked" when it is up and "Locked" when it is down. The icon should also change to match the label.

[[File:Toggle-button-unlocked-locked.png]]

File:Toggle-button-media-player.png

2010-08-27T20:24:19Z

Agateau: uploaded a new version of "File:Toggle-button-media-player.png"

Projects/Usability/HIG/Toggle Buttons

2010-08-27T20:22:22Z

Agateau:

==Definition==

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to Use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

[[File:Toggle-button-formatting.png]]
(Toggle buttons used in a rich text editor)

==When not to Use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a combined Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

[[File:Toggle-button-media-player.png]]

==Icon and Label==

There are two ways to label a toggle button:

'''1. Describe the state which is reached when the button is down'''

In this case the icon and label should not change when the button is down.

For example a button to toggle the visibility of a sidebar could say "Show Sidebar". It should still say "Show Sidebar" when the button is down: it should not be changed to "Hide Sidebar".

If you want to change the button text to "Hide Sidebar" when the sidebar is shown then you should use a normal button, not a toggle button.

An alternative is to reduce the button to a noun if it is not ambiguous. In this example the button label could be reduced to "Sidebar".

[[File:Toggle-button-summary.png]]

'''2. Describe the current state'''

In this case the label will often include a passive verb. For example a button to lock or unlock an element would say "Unlocked" when it is up and "Locked" when it is down. The icon should match the label.

[[File:Toggle-button-unlocked-locked.png]]

File:Toggle-button-unlocked-locked.png

2010-08-27T20:21:48Z

Agateau:

Projects/Usability/HIG/Toggle Buttons

2010-08-27T20:09:08Z

Agateau:

File:Toggle-button-formatting.png

2010-08-27T20:07:16Z

Agateau: Toggle buttons used in a rich text editor

Toggle buttons used in a rich text editor

Projects/Usability/HIG/Toggle Buttons

2010-08-27T19:55:38Z

Agateau:

File:Toggle-button-media-player.png

2010-08-27T19:54:43Z

Agateau:

File:Toggle-button-summary.png

2010-08-18T22:17:25Z

Agateau: uploaded a new version of "File:Toggle-button-summary.png"

Projects/Usability/HIG/Toggle Buttons

2010-08-18T22:06:34Z

Agateau: /* Icon and Label */

Projects/Usability/HIG/Toggle Buttons

2010-08-18T22:05:31Z

Agateau: /* How to Use */

Projects/Usability/HIG/Toggle Buttons

2010-08-18T22:04:36Z

Agateau:

Projects/Usability/HIG/Toggle Buttons

2010-08-18T21:39:07Z

Agateau: /* When not to Use */

==Definition==

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to Use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

==When not to Use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a combined Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

==How to Use==

===Label Wording===

Label of toggle buttons can often be reduced to a "noun only" form instead of the classic "verb (+ noun)" used with classic buttons. The "noun only" form should be favored over the "verb (+ noun)" form whenever it does not cause any ambiguity as this form reduces clutter.

Example: A toggle button to show/hide a sidebar can be labeled either "Show Sidebar" or simply "Sidebar".

===Icon and Label===

In most cases one should never change the icon or label of a toggle button. A toggle button is very similar to a check box and should thus behave in the same way. The fact that it is pressed down is enough to indicate the current state of the element it represents.

It may make sense in some case to change the icon to reflect the '''current''' state. Think of it like an outdoor light switch with an embedded led to indicate whether the outdoor light is on.

In the "Sidebar" example, "Show Sidebar" should not be turned into "Hide Sidebar" when the sidebar is visible. If you consider it more explicit to change the icon and label of your button then you should use a normal button, not a toggle button.

[[File:Toggle-button-summary.png]]

Projects/Usability/HIG/Toggle Buttons

2010-08-18T21:38:31Z

Agateau:

==Definition==

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to Use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

==When not to Use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

==How to Use==

===Label Wording===

Label of toggle buttons can often be reduced to a "noun only" form instead of the classic "verb (+ noun)" used with classic buttons. The "noun only" form should be favored over the "verb (+ noun)" form whenever it does not cause any ambiguity as this form reduces clutter.

Example: A toggle button to show/hide a sidebar can be labeled either "Show Sidebar" or simply "Sidebar".

===Icon and Label===

In most cases one should never change the icon or label of a toggle button. A toggle button is very similar to a check box and should thus behave in the same way. The fact that it is pressed down is enough to indicate the current state of the element it represents.

It may make sense in some case to change the icon to reflect the '''current''' state. Think of it like an outdoor light switch with an embedded led to indicate whether the outdoor light is on.

In the "Sidebar" example, "Show Sidebar" should not be turned into "Hide Sidebar" when the sidebar is visible. If you consider it more explicit to change the icon and label of your button then you should use a normal button, not a toggle button.

[[File:Toggle-button-summary.png]]

Projects/Usability/HIG/Toggle Buttons

2010-08-17T23:24:43Z

Agateau:

Projects/Usability/HIG/Toggle Buttons

2010-08-17T23:01:25Z

Agateau:

==Definition==

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

==When not to use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

==How to Use==

===Label Wording===

Label of toggle buttons can often be reduced to a "noun only" form instead of the classic "verb (+ noun)" used with classic buttons. The "noun only" form should be favored over the "verb (+ noun)" form whenever it does not cause any ambiguity as this form reduces clutter.

Example: A toggle button to show/hide a sidebar can be labeled either "Show Sidebar" or simply "Sidebar".

===Changing Icon and/or Label===

Never change the icon or label of a toggle button. A toggle button is very similar to a check box and should thus behave in the same way. The fact that it is pressed down is enough to indicate the current state of the element it represents.

This means that in the previous example, "Show Sidebar" should not be turned into "Hide Sidebar" when the sidebar is visible. If you consider it more explicit to change the icon and label of your button then you should use a normal button, not a toggle button.

[[File:Toggle-button-summary.png]]

Projects/Usability/HIG/Toggle Buttons

2010-08-17T22:59:40Z

Agateau:

Projects/Usability/HIG/Toggle Buttons

2010-08-17T22:59:04Z

Agateau: /* Summary */

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

==When not to use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

==How to Use==

===Label Wording===

Label of toggle buttons can often be reduced to a "noun only" form instead of the classic "verb (+ noun)" used with classic buttons. The "noun only" form should be favored over the "verb (+ noun)" form whenever it does not cause any ambiguity as this form reduces clutter.

Example: A toggle button to show/hide a sidebar can be labeled either "Show Sidebar" or simply "Sidebar".

===Changing Icon and/or Label===

Never change the icon or label of a toggle button. A toggle button is very similar to a check box and should thus behave in the same way. The fact that it is pressed down is enough to indicate the current state of the element it represents.

This means that in the previous example, "Show Sidebar" should not be turned into "Hide Sidebar" when the sidebar is visible. If you consider it more explicit to change the icon and label of your button then you should use a normal button, not a toggle button.

===Summary===

[[File:Toggle-button-summary.png]]

File:Toggle-button-summary.png

2010-08-17T22:48:13Z

Agateau:

Projects/Usability/HIG/Toggle Buttons

2010-08-17T22:38:36Z

Agateau: /* Icon and label */

Projects/Usability/HIG/Toggle Buttons

2010-08-17T22:13:05Z

Agateau: /* Icon and label */

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to use==

Use a toggle button to indicate a '''state'''.

Example: A word processor should use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

==When not to use==

Do not use a toggle button to indicate an '''action'''.

Example: A music player should not use a toggle button to implement a Play/Pause button. It should use a normal button and adjust the icon and label to represent the action which would be performed when clicked.

==Icon and label==

Never change the icon or label of a toggle button. A toggle button is very similar to a check box. It should thus be used in the same way.

The fact that it is pressed down is enough to indicate the current state of the element it represents.

Classic buttons represents an action and their label usually starts with a verb. Label of toggle buttons on the other hand can often be reduced to a noun only. The "noun only" form should be favored over the "verb + noun" form whenever it does not cause any ambiguity as this form reduces clutter.

Example: A toggle button to show/hide a sidebar could be labeled either "Show Sidebar" or simply "Sidebar".

Projects/Usability/HIG/Toggle Buttons

2010-08-17T22:07:15Z

Agateau: /* How to use */

Projects/Usability/HIG/Toggle Buttons

2010-08-17T21:58:10Z

Agateau: /* When not to use */

Projects/Usability/HIG/Toggle Buttons

2010-08-17T21:57:44Z

Agateau:

Projects/Usability/HIG/Toggle Buttons

2010-08-17T21:50:33Z

Agateau: /* When to use */

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to use==

Use a toggle button to indicate a '''state'''. For example a word-processor would use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

==Do and don't==

Do not change the icon or label of a toggle button. The fact that it is pressed down is enough.

Since a toggle button represents a state, in most cases the label should be a noun rather than a verb.

Projects/Usability/HIG/Toggle Buttons

2010-08-17T21:49:20Z

Agateau: Created page with 'A toggle button is a button which stays down when clicked once and goes up when clicked a second time. ==When to use== Use a toggle button to indicate a ''state'' rather than a...'

A toggle button is a button which stays down when clicked once and goes up when clicked a second time.

==When to use==

Use a toggle button to indicate a ''state'' rather than an ''action''. For example a word-processor would use toggle buttons to indicate the state of "Bold", "Italic" or "Underline" formatting.

==Do and don't==

Do not change the icon or label of a toggle button. The fact that it is pressed down is enough.

Since a toggle button represents a state, in most cases the label should be a noun rather than a verb.

Projects/Usability/HIG/Form Label Alignment

2010-06-04T21:04:06Z

Agateau: /* Problems with Qt 4 */

One of the new changes in KDE 4.x since KDE 3.x is the alignment of form and widget labels. In KDE 3.x, labels were aligned to the left and widgets were aligned to the left. In KDE 4, form labels are now aligned to the right and widgets are aligned to the left, making a group of form widgets appear to be center aligned. In Qt4, using a [http://doc.trolltech.com/qformlayout.html QFormLayout] handles this correctly for you.

[[Image:Wiki-alignment-1.png|frame|Example of KDE 3 form alignment]]

[[Image:Wiki-alignment-3.png|frame|Example of KDE4 form alignment]]

== Dialog Alignment ==

In OSX, a group of widgets is center aligned. In KDE4, a group of widgets is left aligned. This aligns the labels closer to the left edge and makes use of space more efficiently.

[[Image:Wiki-alignment-2.png|frame|Example of OSX form alignment]]

[[Image:Wiki-alignment-3.png|frame|Example of KDE4 form alignment]]

The alignment of groups of widgets is independent, and so you may have different sized groups with different "centered" lines. A group of widgets consists of widgets within some type of natural separation such as a group box or separator bar.

[[Image:Wiki-alignment-4.png|frame|Example of multiple group alignment in KDE4]]

== Checkboxes ==

=== Problems with Qt 4 ===

The checkbox widget in Qt 4 is the input click box on the left and the label on the right. Unfortunately, it is difficult to create a checkbox with a label on the right of the input click box. This is a problem because there are common cases when the label on the left of the input click box is better usability. Until there is a resolution that makes configuring the checkbox label to the left of the input click box easier, use the default checkbox alignment (right aligned label), or if possible, put a right-aligned label next to the checkbox, and set the label of the checkbox to "Enabled", "On", or similar.

[[Image:Wiki-alignment-5.png|frame|Example of aligning checkboxes until there Qt offers an option to align the checkbox label to the left.]]

== Aligning Sub-Options ==

When options are subordinate to a checkbox or radiobutton (e.g. Audio level can only be set if the Activate Audio option is selected), this relation should be visualized by indenting the sub-options. There are two options to do so:

# When you are using a left-aligned checkbox or radio button, indent the sub-options by using a horizontal spacer of SizeType "Minimum".

[[Image:Wiki-alignment-7.png|frame|Example of aligning sub-options with a horizontal spacer of SizeType "Minimum".]]

# When you are using a checkbox that is placed right to its label, indent the sub-options in the same vertical axis as the checkbox.

[[Image:Wiki-alignment-5.png|frame|Example of aligning sub-options with the same vertical axis as the checkbox itself.]]

'''The contents of this guideline are under discussion. Please request guidance in #kde-usability if you have any questions regardling Form Label Alignment'''

== Grouping related options within a GroupBox ==

In some cases it may be useful to visually separate groups of related options within one GroupBox to facilitate scanning of the dialog.

In that case, put a vertical fixed size spacer of 16px height between the options.

[[Image:Wiki-alignment-6.png|frame|Example of separating groups of related options with a vertical spacer.]]

== Examples ==

[Screenshots of example dialog layouts simple and complex]

== More Information ==

[http://www.uxmatters.com/MT/archives/000107.php Label Placement in Forms]