Merge branch 'central-widget'
[krunner.git] / README
blobc8b9740a72f818f12493c971ff253cf754b31498
1 KRunner provides a set of desktop services including:
3  - a launch or "Run Command" dialog
4  - screensaver activation and screen locking
5  - application startup notification control
7 Launch Dialog
8 =============
9 The launch dialog accepts user input and passes that input through a series of
10 "runners". Each runner is a subclass of the Runner class and provides three
11 essential facilities:
13 1) whether or not it has matches for the given text input
14 2) providing a widget containing options associated with the runner, if any
15 3) activating a match
17 Runners may also be provided via plugins. See runners/search/ for an example.
19 Screensaver and screen locking
20 ==============================
21 This functionality is provided by the D-Bus service described in
22 org.freedesktop.ScreenSaver.xml and is made available on the session bus under the
23 service name org.freedesktop.ScreenSaver, path /ScreenSaver
25 The locking is managed by a small app found in lock/
27 Other Tidbits
28 =============
29 A restarting application so even a crash won't result in no krunner
30 A window for accepting search input, implemented in the Interface class
32 TODO
33 ====
34 Please read http://techbase.kde.org/Projects/Plasma/Tasks for further information.