KServiceAction

Search for usage in LXR

KServiceAction Class Reference

#include <KServiceAction>

Public Member Functions

 KServiceAction ()
 
 KServiceAction (const KServiceAction &other)
 
 KServiceAction (const QString &name, const QString &text, const QString &icon, const QString &exec, bool noDisplay, const KServicePtr &service)
 
 ~KServiceAction ()
 
QVariant data () const
 
QString exec () const
 
QString icon () const
 
bool isSeparator () const
 
QString name () const
 
bool noDisplay () const
 
KServiceActionoperator= (const KServiceAction &other)
 
template<typename T >
property (const QString &name) const
 
KServicePtr service () const
 
void setData (const QVariant &userData)
 
QString text () const
 

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 30 of file kserviceaction.h.

Constructor & Destructor Documentation

◆ KServiceAction() [1/3]

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() [2/3]

KServiceAction::KServiceAction ( )

Needed for operator>>

Definition at line 39 of file kserviceaction.cpp.

◆ ~KServiceAction()

KServiceAction::~KServiceAction ( )

Destroys a KServiceAction.

Definition at line 50 of file kserviceaction.cpp.

◆ KServiceAction() [3/3]

KServiceAction::KServiceAction ( const KServiceAction & other)

Copy constructor.

Definition at line 54 of file kserviceaction.cpp.

Member Function Documentation

◆ data()

QVariant KServiceAction::data ( ) const
Returns
the action's internal data.

Definition at line 65 of file kserviceaction.cpp.

◆ exec()

QString KServiceAction::exec ( ) const
Returns
the action's exec command, as defined by the Exec key in the desktop action group

Definition at line 90 of file kserviceaction.cpp.

◆ icon()

QString KServiceAction::icon ( ) const
Returns
the action's icon, as defined by the Icon key in the desktop action group

Definition at line 85 of file kserviceaction.cpp.

◆ isSeparator()

bool KServiceAction::isSeparator ( ) const

Returns whether the action is a separator.

This is true when the Actions key contains "_SEPARATOR_".

Definition at line 100 of file kserviceaction.cpp.

◆ name()

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 75 of file kserviceaction.cpp.

◆ noDisplay()

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 95 of file kserviceaction.cpp.

◆ operator=()

KServiceAction & KServiceAction::operator= ( const KServiceAction & other)

Assignment operator.

Definition at line 59 of file kserviceaction.cpp.

◆ property()

template<typename T >
T KServiceAction::property ( const QString & name) const
inline

Returns the requested property.

Template Parameters
Tthe type of the requested property
Parameters
namethe name of the requested property
Returns
the property
Since
6.0

Definition at line 120 of file kserviceaction.h.

◆ service()

KServicePtr KServiceAction::service ( ) const

Returns the service that this action comes from.

Since
5.69

Definition at line 105 of file kserviceaction.cpp.

◆ setData()

void KServiceAction::setData ( const QVariant & userData)

Sets the action's internal data to the given userData.

Definition at line 70 of file kserviceaction.cpp.

◆ text()

QString KServiceAction::text ( ) const
Returns
the action's text, as defined by the Name key in the desktop action group

Definition at line 80 of file kserviceaction.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 12 2024 11:55:04 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.