< Development‎ | Tutorials‎ | Plasma4
Revision as of 06:01, 31 October 2007 by Aseigo (talk | contribs) (The Plasma::AbstractRunner Superclass)
Creating Runners
Tutorial Series   Plasma
Previous   None
What's Next   n/a
Further Reading   n/a


The Plasma workspace provides an application called KRunner which, among other things, allows one to type into a text area which causes various actions and information that match the text appear as the text is being typed.

This functionality is provided via plugins called "runners". These plugins can be used by any application that links again libplasma. This tutorial explores how to create a runner.

The Plasma::AbstractRunner Superclass

Part of libplasma, Plasma::AbstractRunner is the base class of all runners. It provides API for the following functionality:

  • Register matches for a given search term
  • Take action on a given match registered by the runner
  • Show configuration options

The interface it provides is licensed under the LGPL and can therefore be linked to by a code on a variety of Free/Open Source as well as proprietary licenses.

The SearchContext and SearchAction Classes

Setting up a Runner Plugin Project

The CMakeLists.txt File

The .desktop Servies File

The header file

Registering Matches

Taking Action On Matches

Configuration Interfaces

Runner Options

Match Result Options

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