KDE API Referencekremotecontrol
#include <remotecontrolbutton.h>
Public Types | |
| enum | ButtonId { Unknown = -1, Number0, Number1, Number2, Number3, Number4, Number5, Number6, Number7, Number8, Number9, Play, Pause, PlayPause, Stop, Forward, Backward, FastForward, Rewind, ChannelDown, ChannelUp, VolumeDown, VolumeUp, Mute, Info, Eject, Power, Up, Down, Left, Right, Select, Back, Menu, Aux, CD, DVD, EPG, Favorites, Help, Home, Music, Text, TV, Blue, Green, Red, Yellow } |
Public Member Functions | |
| RemoteControlButton (const QString &remoteName, ButtonId id, int repeatCounter=0) | |
| RemoteControlButton (const QString &remoteName, const QString &name, int repeatCounter=0) | |
| RemoteControlButton (const RemoteControlButton &other) | |
| ~RemoteControlButton () | |
| QString | description () const |
| ButtonId | id () const |
| QString | name () const |
| QString | remoteName () const |
| int | repeatCounter () const |
Detailed Description
Definition at line 30 of file remotecontrolbutton.h.
Member Enumeration Documentation
Definition at line 33 of file remotecontrolbutton.h.
Constructor & Destructor Documentation
| RemoteControlButton::RemoteControlButton | ( | const QString & | remoteName, |
| ButtonId | id, | ||
| int | repeatCounter = 0 |
||
| ) |
Creates a new RemoteControlButton object.
The buttons name and description are set according to the id.
- Parameters
-
remoteName the name of the RemoteControl this button comes from id the ID of the button repeatCounter the repeat counter. Increase this if a button is held pressed down. Reset it to zero if the button is released
Definition at line 25 of file remotecontrolbutton.cpp.
| RemoteControlButton::RemoteControlButton | ( | const QString & | remoteName, |
| const QString & | name, | ||
| int | repeatCounter = 0 |
||
| ) |
Creates a new RemoteControlButton object.
If name is a known buttonname, the id will be set accordingly. Else the ID will be Unknown.
- Parameters
-
remoteName the name of the RemoteControl this button comes from name the name of the button repeatCounter the repeat counter. Increase this if a button is held pressed down. Reset it to zero if the button is released
Definition at line 185 of file remotecontrolbutton.cpp.
| RemoteControlButton::RemoteControlButton | ( | const RemoteControlButton & | other | ) |
Copies a RemoteControlButton.
Definition at line 296 of file remotecontrolbutton.cpp.
| RemoteControlButton::~RemoteControlButton | ( | ) |
Destroys a RemoteControlButton object.
Definition at line 300 of file remotecontrolbutton.cpp.
Member Function Documentation
| QString RemoteControlButton::description | ( | ) | const |
Retrieves the description of the Button.
If the button ID is a valid ButtonID ( not ButtonID::Unknown ) this will contain a human readable, nice formatted and translated string. If the id() is Unknown this name contains the button name defined by the backend. Use this to display button names to to the user.
- Returns
- Returns the name of the button
Definition at line 320 of file remotecontrolbutton.cpp.
| RemoteControlButton::ButtonId RemoteControlButton::id | ( | ) | const |
Retrieves the ID of the Button.
If the ID is ButtonID::Unknown name() will still contain the name of the button.
- Returns
- Returns the the ID of the button
Definition at line 310 of file remotecontrolbutton.cpp.
| QString RemoteControlButton::name | ( | ) | const |
Retrieves the name of the Button.
If the button ID is a valid ButtonID ( not ButtonID::Unknown ) this will contain a the buttons name string. If the id() is Unknown this name contains the button name defined by the backend. Use this if you need to store buttons in config files or compare buttons with ButtonID::Unknown
- Returns
- Returns the name of the button
Definition at line 315 of file remotecontrolbutton.cpp.
| QString RemoteControlButton::remoteName | ( | ) | const |
Retrieves the name of the RemoteControl this button comes from.
- Returns
- Returns the name of the RemoteControl this button comes from
Definition at line 305 of file remotecontrolbutton.cpp.
| int RemoteControlButton::repeatCounter | ( | ) | const |
Retrieves the repeat count for the buttonpress.
If this is greater 0 the button is held down. This can be useful to prevent accidental navigation through menus while still being able to navigate fast through long playlists.
- Returns
- Returns the the ID of the Button
Definition at line 434 of file remotecontrolbutton.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:07:43 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
