KDesktopFileActions

KDesktopFileActions Namespace Reference

Functions

KIOWIDGETS_EXPORT QList< KServiceActionbuiltinServices (const QUrl &url)
 
KIOWIDGETS_EXPORT void executeService (const QList< QUrl > &urls, const KServiceAction &service)
 
KIOWIDGETS_EXPORT bool run (const QUrl &_url, bool _is_local)
 
KIOWIDGETS_EXPORT bool runWithStartup (const QUrl &_url, bool _is_local, const QByteArray &asn)
 
KIOWIDGETS_EXPORT QList< KServiceActionuserDefinedServices (const QString &path, bool bLocalFiles)
 
KIOWIDGETS_EXPORT QList< KServiceActionuserDefinedServices (const QString &path, const KDesktopFile &desktopFile, bool bLocalFiles, const QList< QUrl > &file_list=QList< QUrl >())
 
KIOWIDGETS_EXPORT QList< KServiceActionuserDefinedServices (const KService &service, bool bLocalFiles, const QList< QUrl > &file_list=QList< QUrl >())
 

Detailed Description

KDesktopFileActions provides a number of methods related to actions in desktop files.

Function Documentation

QList< KServiceAction > KDesktopFileActions::builtinServices ( const QUrl url)

Returns a list of services for the given .desktop file that are handled by kio itself.

Namely mount/unmount for FSDevice files.

Returns
the list of services

Definition at line 147 of file kdesktopfileactions.cpp.

void KDesktopFileActions::executeService ( const QList< QUrl > &  urls,
const KServiceAction service 
)

Execute service on the list of urls.

Parameters
urlsthe list of urls
servicethe service to execute

Definition at line 261 of file kdesktopfileactions.cpp.

bool KDesktopFileActions::run ( const QUrl _url,
bool  _is_local 
)

Invokes the default action for the desktop entry.

If the desktop entry is not local, then only false is returned. Otherwise we would create a security problem. Only types Link and Mimetype could be followed.

Parameters
_urlthe url to run
_is_localtrue if the URL is local, false otherwise
Returns
true on success and false on failure.
See also
KRun::runUrl
Deprecated:
since 5.71, use OpenUrlJob instead

Definition at line 38 of file kdesktopfileactions.cpp.

bool KDesktopFileActions::runWithStartup ( const QUrl _url,
bool  _is_local,
const QByteArray asn 
)

Invokes the default action for the desktop entry.

If the desktop entry is not local, then only false is returned. Otherwise we would create a security problem. Only types Link and Mimetype could be followed.

Use this function if a startup notification id has already been created.

Parameters
_urlthe url to run
_is_localtrue if the URL is local, false otherwise
asnApplication startup notification id, if available
Returns
true on success and false on failure.
See also
KRun::runUrl
Since
5.5
Deprecated:
since 5.71, use OpenUrlJob instead

Definition at line 45 of file kdesktopfileactions.cpp.

QList< KServiceAction > KDesktopFileActions::userDefinedServices ( const QString path,
bool  bLocalFiles 
)

Returns a list of services defined by the user as possible actions on the given .desktop file.

May include separators (see KServiceAction::isSeparator) which should appear in user-visible representations of those actions, such as separators in a menu.

Parameters
paththe path to the desktop file describing the services
bLocalFilestrue if those services are to be applied to local files only (if false, services that don't have u or U in the Exec line won't be taken into account).
Returns
the list of user defined actions

Definition at line 199 of file kdesktopfileactions.cpp.

QList< KServiceAction > KDesktopFileActions::userDefinedServices ( const QString path,
const KDesktopFile desktopFile,
bool  bLocalFiles,
const QList< QUrl > &  file_list = QList<QUrl>() 
)

Overload of userDefinedServices but also allows you to pass a list of urls for this file.

This allows for the menu to be changed depending on the exact files via the X-KDE-GetActionMenu extension.

Definition at line 205 of file kdesktopfileactions.cpp.

QList< KServiceAction > KDesktopFileActions::userDefinedServices ( const KService service,
bool  bLocalFiles,
const QList< QUrl > &  file_list = QList<QUrl>() 
)

Returns a list of services defined by the user as possible actions on the given .desktop file represented by the KService instance.

May include separators (see KServiceAction::isSeparator) which should appear in user-visible representations of those actions, such as separators in a menu.

Parameters
paththe path to the desktop file describing the services
bLocalFilestrue if those services are to be applied to local files only (if false, services that don't have u or U in the Exec line won't be taken into account).
file_listlist of urls; this allows for the menu to be changed depending on the exact files via the X-KDE-GetActionMenu extension.
Returns
the list of user defined actions

Definition at line 212 of file kdesktopfileactions.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Sep 23 2020 23:01:43 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.