synaptiks::SynaptiksDaemon Class Reference

The synaptiks daemon module. More...

Public Slots
Q_SCRIPTABLE void	reparseConfiguration ()
	Reparse the daemon and the touchpad configuration.
Q_SCRIPTABLE bool	isTouchpadAvailable () const
	Check whether a configurable touchpad is available.
Q_SCRIPTABLE QString	touchpadNotAvailableMessage () const
	Return a human-readable error message if no touchpad is available.
Public Member Functions
	SynaptiksDaemon (QObject *parent, const QList< QVariant > &args)
	Create a new daemon module.
virtual	~SynaptiksDaemon ()
	Destroy this module.

Detailed Description

The synaptiks daemon module.

This module manages the touchpad and exports a convenient DBus API for touchpad configuration and management.

It registers the service "org.kde.synaptiks" and exports the following objects on this service:

/modules/synaptiks – this object
/MouseDevicesMonitor – an instance of synaptiks::MouseDevicesMonitor
/TouchpadManager – an instance of synaptiks::TouchpadManager (use this object to switch the touchpad on or off!)
/Touchpad – the touchpad object itself (an instance of synaptiks::Touchpad)

Note:: The two latter objects are only exported, if a configurable touchpad was found, so use isTouchpadAvailable() before accessing these objects to make sure, that a touchpad is available.

SynaptiksDaemon::SynaptiksDaemon	(	QObject *	parent,
		const QList< QVariant > &	args
	)

Create a new daemon module.

Parameters:

	parent	the parent object
	args	ignored, required by KPlugin signature

bool SynaptiksDaemon::isTouchpadAvailable ( ) const [slot]

Check whether a configurable touchpad is available.

Exported over D-Bus.

Call touchpadNotAvailableMessage() to get a human-readable error message, if this returns false.

void SynaptiksDaemon::reparseConfiguration ( ) [slot]

Reparse the daemon and the touchpad configuration.

If called, this method will re-configure this module, and update the touchpad properties according to the configuration file contents.

This function is exported on DBus.

QString SynaptiksDaemon::touchpadNotAvailableMessage ( ) const [slot]

Return a human-readable error message if no touchpad is available.

Exported over D-Bus.

Returns:: a human-readable error message, if no touchpad is available, empty QString() otherwise.

The documentation for this class was generated from the following files: