Solid::Button Class Reference

#include <button.h>

Inheritance diagram for Solid::Button:

Public Types
enum	ButtonType {   LidButton, PowerButton, SleepButton, UnknownButtonType,   TabletButton }
Public Types inherited from Solid::DeviceInterface
enum	Type {   Unknown = 0, GenericInterface = 1, Processor = 2, Block = 3,   StorageAccess = 4, StorageDrive = 5, OpticalDrive = 6, StorageVolume = 7,   OpticalDisc = 8, Camera = 9, PortableMediaPlayer = 10, NetworkInterface = 11,   AcAdapter = 12, Battery = 13, Button = 14, AudioInterface = 15,   DvbInterface = 16, Video = 17, SerialInterface = 18, SmartCardReader = 19,   InternetGateway = 20, NetworkShare = 21, Last = 0xffff }

Signals
void	pressed (Solid::Button::ButtonType type, const QString &udi)

Public Member Functions
virtual	~Button ()
bool	hasState () const
bool	stateValue () const
ButtonType	type () const
Public Member Functions inherited from Solid::DeviceInterface
virtual	~DeviceInterface ()
bool	isValid () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Static Public Member Functions
static Type	deviceInterfaceType ()
Static Public Member Functions inherited from Solid::DeviceInterface
static Type	stringToType (const QString &type)
static QString	typeDescription (Type type)
static QString	typeToString (Type type)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Properties
bool	hasState
bool	stateValue
ButtonType	type
Properties inherited from QObject
	objectName

Additional Inherited Members
Protected Member Functions inherited from Solid::DeviceInterface
	DeviceInterface (DeviceInterfacePrivate &dd, QObject *backendObject)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Protected Attributes inherited from Solid::DeviceInterface
DeviceInterfacePrivate *	d_ptr

Detailed Description

This device interface is available on button devices.

A button is a device, like power button or lid switch, that can be pressed by user. Some buttons can have two states (Enabled/Disabled, On/Off ...), other buttons haven't state.

Author

Davide Bettio david.nosp@m.e.be.nosp@m.ttio@.nosp@m.kdem.nosp@m.ail.n.nosp@m.et

Definition at line 42 of file button.h.

Member Enumeration Documentation

enum Solid::Button::ButtonType

This enum type defines the type of button.

• LidButton : The switch on a laptop that senses whether the lid is open or closed.
• PowerButton : The main power button on the computer.
• SleepButton : The sleep button on a computer capable of putting the computer into a suspend state.

TabletButton : The tablet switch on a laptop that senses if the monitor is rotated or not.

• UnknownButtonType : The type of the button is unknow.

Enumerator
LidButton
PowerButton
SleepButton
UnknownButtonType
TabletButton

Definition at line 62 of file button.h.

Constructor & Destructor Documentation

Solid::Button::~Button ( )

virtual

Destroys a Button object.

Definition at line 35 of file button.cpp.

Member Function Documentation

static Type Solid::Button::deviceInterfaceType ( )

inlinestatic

Get the Solid::DeviceInterface::Type of the Button device interface.

Returns

the Button device interface type

See also

Solid::DeviceInterface::Type

Definition at line 88 of file button.h.

bool Solid::Button::hasState

(

)

const

Indicates if the button mantains state (Can toggled on/off).

Returns

true if the button maintains state, false otherwise.

See also

stateValue()

void Solid::Button::pressed ( Solid::Button::ButtonType  type, const QString &  udi  )

signal

This signal is emitted when the button is pressed.

Parameters

type	the type of button device, it's one of the type Solid::Button::ButtonType

See also

Solid::Button::ButtonType

Parameters

udi	the UDI of the button

bool Solid::Button::stateValue

(

)

const

Retrieves the state of the button.

A button can have two states (Enabled/Disabled, On/Off ...). Available only if hasState is true.

Returns

true if the button is enabled, false otherwise.

See also

hasState()

ButtonType Solid::Button::type

(

)

const

Retrieves the type of button device.

Returns

the type of button device.

See also

Solid::Button::ButtonType

Property Documentation

bool Solid::Button::hasState

read

Definition at line 47 of file button.h.

bool Solid::Button::stateValue

read

Definition at line 48 of file button.h.

Solid::Button::ButtonType Solid::Button::type

read

Definition at line 46 of file button.h.

---

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

• button.h
• button.cpp