KServiceAction
#include <KServiceAction>
Public Member Functions | |
KServiceAction (const QString &name, const QString &text, const QString &icon, const QString &exec, bool noDisplay=false) | |
KServiceAction (const QString &name, const QString &text, const QString &icon, const QString &exec, bool noDisplay, const KServicePtr &service) | |
KServiceAction () | |
KServiceAction (const KServiceAction &other) | |
~KServiceAction () | |
QVariant | data () const |
QString | exec () const |
QString | icon () const |
bool | isSeparator () const |
QString | name () const |
bool | noDisplay () const |
KServiceAction & | operator= (const KServiceAction &other) |
KServicePtr | service () const |
void | setData (const QVariant &userData) |
QString | text () const |
Friends | |
KSERVICE_EXPORT QDataStream & | operator<< (QDataStream &str, const KServiceAction &act) |
KSERVICE_EXPORT QDataStream & | operator>> (QDataStream &str, KServiceAction &act) |
Detailed Description
Represents an action in a .desktop file Actions are defined with the config key Actions in the [Desktop Entry] group, followed by one group per action, as per the desktop entry standard.
- See also
- KService::actions
Definition at line 28 of file kserviceaction.h.
Constructor & Destructor Documentation
KServiceAction::KServiceAction | ( | const QString & | name, |
const QString & | text, | ||
const QString & | icon, | ||
const QString & | exec, | ||
bool | noDisplay = false |
||
) |
Creates a KServiceAction.
Normally you don't have to do this, KService creates the actions when parsing the .desktop file.
- Deprecated:
- Since 5.69, use the 6-args constructor
Definition at line 36 of file kserviceaction.cpp.
KServiceAction::KServiceAction | ( | const QString & | name, |
const QString & | text, | ||
const QString & | icon, | ||
const QString & | exec, | ||
bool | noDisplay, | ||
const KServicePtr & | service | ||
) |
Creates a KServiceAction.
Normally you don't have to do this, KService creates the actions when parsing the .desktop file.
- Since
- 5.69
Definition at line 44 of file kserviceaction.cpp.
KServiceAction::KServiceAction | ( | ) |
Needed for operator>>
Definition at line 30 of file kserviceaction.cpp.
KServiceAction::~KServiceAction | ( | ) |
Destroys a KServiceAction.
Definition at line 52 of file kserviceaction.cpp.
KServiceAction::KServiceAction | ( | const KServiceAction & | other | ) |
Copy constructor.
Definition at line 56 of file kserviceaction.cpp.
Member Function Documentation
QVariant KServiceAction::data | ( | ) | const |
- Returns
- the action's internal data.
Definition at line 67 of file kserviceaction.cpp.
QString KServiceAction::exec | ( | ) | const |
- Returns
- the action's exec command, as defined by the Exec key in the desktop action group
Definition at line 92 of file kserviceaction.cpp.
QString KServiceAction::icon | ( | ) | const |
- Returns
- the action's icon, as defined by the Icon key in the desktop action group
Definition at line 87 of file kserviceaction.cpp.
bool KServiceAction::isSeparator | ( | ) | const |
Returns whether the action is a separator.
This is true when the Actions key contains "_SEPARATOR_".
Definition at line 102 of file kserviceaction.cpp.
QString KServiceAction::name | ( | ) | const |
- Returns
- the action's internal name For instance Actions=Setup;... and the group [Desktop Action Setup] define an action with the name "Setup".
Definition at line 77 of file kserviceaction.cpp.
bool KServiceAction::noDisplay | ( | ) | const |
Returns whether the action should be suppressed in menus.
This is useful for having actions with a known name that the code looks for explicitly, like Setup and Root for kscreensaver actions, and which should not appear in popup menus.
- Returns
- true to suppress this service
Definition at line 97 of file kserviceaction.cpp.
KServiceAction & KServiceAction::operator= | ( | const KServiceAction & | other | ) |
Assignment operator.
Definition at line 61 of file kserviceaction.cpp.
KServicePtr KServiceAction::service | ( | ) | const |
Returns the service that this action comes from.
- Since
- 5.69
Definition at line 107 of file kserviceaction.cpp.
void KServiceAction::setData | ( | const QVariant & | userData | ) |
Sets the action's internal data to the given userData
.
Definition at line 72 of file kserviceaction.cpp.
QString KServiceAction::text | ( | ) | const |
- Returns
- the action's text, as defined by the Name key in the desktop action group
Definition at line 82 of file kserviceaction.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed Jan 20 2021 22:51:23 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.