Solid
#include <button.h>

Public Types | |
enum | ButtonType { LidButton , PowerButton , SleepButton , UnknownButtonType , TabletButton } |
![]() | |
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 |
![]() | |
virtual | ~DeviceInterface () |
bool | isValid () const |
Static Public Member Functions | |
static Type | deviceInterfaceType () |
![]() | |
static Type | stringToType (const QString &type) |
static QString | typeDescription (Type type) |
static QString | typeToString (Type type) |
Properties | |
bool | hasState |
bool | stateValue |
ButtonType | type |
Additional Inherited Members | |
![]() | |
DeviceInterface (DeviceInterfacePrivate &dd, QObject *backendObject) | |
![]() | |
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.
Member Enumeration Documentation
◆ 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 |
Constructor & Destructor Documentation
◆ ~Button()
|
virtual |
Destroys a Button object.
Definition at line 35 of file button.cpp.
Member Function Documentation
◆ deviceInterfaceType()
|
inlinestatic |
Get the Solid::DeviceInterface::Type of the Button device interface.
- Returns
- the Button device interface type
- See also
- Solid::DeviceInterface::Type
◆ hasState()
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()
Definition at line 46 of file button.cpp.
◆ pressed
|
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
◆ stateValue()
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()
Definition at line 52 of file button.cpp.
◆ type()
Solid::Button::ButtonType Solid::Button::type | ( | ) | const |
Retrieves the type of button device.
- Returns
- the type of button device.
- See also
- Solid::Button::ButtonType
Definition at line 40 of file button.cpp.
Property Documentation
◆ hasState
◆ stateValue
◆ type
|
read |
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.