← Back to branch summary

~ubuntu-branches/ubuntu/maverick/kdeutils/maverick-proposed

« back to all changes in this revision

Viewing changes to kremotecontrol/README

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2010-05-28 09:49:30 UTC
  • mfrom: (1.2.44 upstream)
  • Revision ID: james.westby@ubuntu.com-20100528094930-jzynf0obv1n2v13a
Tags: 4:4.4.80-0ubuntu1~ppa1
New upstream beta release

Show diffs side-by-side

added added

removed removed

Lines of Context:
kremotecontrol/README
 
1
KRemoteControl
 
2
===================
 
3
part of the KDE project.
 
4
 
 
5
Copyright: 2009 - 2010 Michael Zanetti <michael_zanetti@gmx.net>
 
6
           2009 - 2010 Frank Scheffold <fscheffold@googlemail.com>
 
7
 
 
8
Author/Maintainer: Michael Zanetti <michael_zanetti@gmx.net>
 
9
Author:            Frank Scheffold <fscheffold@googlemail.com>
 
10
 
 
11
Overview:
 
12
--------
 
13
KRemoteControl is a KDE frontend for your remote controls. It allows to configure
 
14
actions for button presses on remotes. All types of remotes supported by 
 
15
Solid are also supported by KRemoteControl. For usage instructions see 
 
16
the KRemoteControl handbook provided with the kdeutils module.
 
17
 
 
18
 
 
19
KRemoteControl consists of the following modules:
 
20
* libkremotecontrol:
 
21
  This lib holds all the basic data structures for handling remotes,
 
22
  modes and actions. Additionally it holds a D-Bus browser interface
 
23
  and executors for actions.
 
24
 
 
25
* kcmremotecontrol:
 
26
  This is the configuration module for systemsettings. It allows to
 
27
  create and assign actions to remote controls.
 
28
 
 
29
* kded:
 
30
  A kded module responsible for actually executing the actions on incoming
 
31
  button presses.
 
32
 
 
33
* krcdnotifieritem:
 
34
  A notifier item sitting in the notification area (aka system tray).
 
35
  Its job is to notify the user of incoming button presses by blinking
 
36
  and provides a context menu for manually switching a remotes mode.
 
37
 
 
38
* dataengine:
 
39
  This is a plasma dataengine. It allows to interact with the kded module
 
40
  within a plasmoid. There is no plasmoid provided with KRemoteControl yet.
 
41
 
 
42
 
 
43
Development:
 
44
--------------
 
45
* To create new action templates you need to create a profile. See the
 
46
  KRemoteControl handbook for a step by step guide.
 
47
 
 
48
* To add new types of supported remotes you need to create a new Solid 
 
49
  remote control backend.
 
50
 
 
51
* To add new types of actions you need to provide an Action class derived 
 
52
  from action, an executor able to execute your action and a configuration
 
53
  UI for this action.