KService Class Reference
#include <kservice.h>
Detailed Description
Represent a service, i.e.an application bound to one or several mimetypes (or servicetypes) as written in its desktop entry file.
A service may be a library, too. The starting point you need is often the static methods. Service types are stored as desktop files in the "service" resource..
- See also:
- KServiceType
- Author:
- Torben Weis <weis@kde.org>
Definition at line 48 of file kservice.h.
Public Types | |
typedef KSharedPtr< KService > | Ptr |
typedef QValueList< Ptr > | List |
enum | DCOPServiceType_t { DCOP_None = 0, DCOP_Unique, DCOP_Multi, DCOP_Wait } |
Public Member Functions | |
KService (const QString &_name, const QString &_exec, const QString &_icon) | |
KService (const QString &_fullpath) | |
KService (KDesktopFile *config) | |
KService (QDataStream &_str, int offset) | |
virtual | ~KService () |
virtual QString | type () const |
virtual QString | name () const |
QString | exec () const |
QString | library () const |
QString | init () const |
QString | icon () const |
QPixmap | pixmap (KIcon::Group _group, int _force_size=0, int _state=0, QString *_path=0L) const |
bool | terminal () const |
QString | terminalOptions () const |
bool | substituteUid () const |
QString | username () const |
QString | desktopEntryPath () const |
QString | desktopEntryName () const |
QString | menuId () const |
QString | storageId () const |
DCOPServiceType_t | DCOPServiceType () const |
QString | path () const |
QString | comment () const |
QString | genericName () const |
QString | untranslatedGenericName () const |
QStringList | keywords () const |
QStringList | categories () const |
QStringList | serviceTypes () const |
bool | hasServiceType (const QString &_service) const |
bool | allowAsDefault () const |
bool | allowMultipleFiles () const |
int | initialPreference () const |
int | initialPreferenceForMimeType (const QString &mimeType) const |
void | setInitialPreference (int i) |
bool | noDisplay () const |
QString | parentApp () const |
virtual QVariant | property (const QString &_name) const |
QVariant | property (const QString &_name, QVariant::Type t) const |
virtual QStringList | propertyNames () const |
bool | isValid () const |
QString | locateLocal () |
virtual void | load (QDataStream &) |
virtual void | save (QDataStream &) |
void | setMenuId (const QString &menuId) |
void | setTerminal (bool b) |
void | setTerminalOptions (const QString &options) |
Static Public Member Functions | |
static Ptr | serviceByName (const QString &_name) |
static Ptr | serviceByDesktopPath (const QString &_path) |
static Ptr | serviceByDesktopName (const QString &_name) |
static Ptr | serviceByMenuId (const QString &_menuId) |
static Ptr | serviceByStorageId (const QString &_storageId) |
static List | allServices () |
static List | allInitServices () |
static QString | newServicePath (bool showInMenu, const QString &suggestedName, QString *menuId=0, const QStringList *reservedMenuIds=0) |
static void | rebuildKSycoca (QWidget *parent) |
Protected Member Functions | |
void | init (KDesktopFile *config) |
QStringList & | accessServiceTypes () |
virtual void | virtual_hook (int id, void *data) |
Friends | |
class | KBuildSycoca |
Member Enumeration Documentation
|
Describes the DCOP type of the service.
Definition at line 213 of file kservice.h. |
Constructor & Destructor Documentation
|
Construct a temporary service with a given name, exec-line and icon.
Definition at line 63 of file kservice.cpp. |
|
Construct a service and take all information from a config file.
Definition at line 79 of file kservice.cpp. |
|
Construct a service and take all information from a desktop file.
Definition at line 87 of file kservice.cpp. |
Member Function Documentation
|
Returns all services that require initialisation. Only needed by "kcminit"
Definition at line 668 of file kservice.cpp. |
|
Set to true if it is allowed to use this service as the default (main) action for the files it supports (e.g. Left Click in a file manager, or KRun in general). If not, then this service is only available in RMB popups, so it must be selected explicitely by the user in order to be used. Note that servicemenus supersede this functionality though, at least in konqueror.
Definition at line 292 of file kservice.h. |
|
Checks whether this service can handle several files as startup arguments.
Definition at line 738 of file kservice.cpp. |
|
Returns the whole list of services. Useful for being able to to display them in a list box, for example. More memory consuming than the ones above, don't use unless really necessary.
Definition at line 610 of file kservice.cpp. |
|
Returns a list of VFolder categories.
Definition at line 747 of file kservice.cpp. |
|
Returns the descriptive comment for the service, if there is one.
Definition at line 233 of file kservice.h. |
|
Returns the DCOPServiceType supported by this service.
Definition at line 219 of file kservice.h. |
|
Returns the filename of the service desktop entry without any extension. E.g. "kppp"
Definition at line 182 of file kservice.h. |
|
Returns the path to the location where the service desktop entry is stored. This is a relative path if the desktop entry was found in any of the locations pointed to by $KDEDIRS (e.g. "Internet/kppp.desktop") It is a full path if the desktop entry originates from another location.
Definition at line 174 of file kservice.h. |
|
Returns the executable.
Definition at line 104 of file kservice.h. |
|
Returns the generic name for the service, if there is one (e.g. "Mail Client").
Definition at line 241 of file kservice.h. |
|
Checks whether the service supports this service type.
Definition at line 352 of file kservice.cpp. |
|
Returns the name of the icon.
Definition at line 125 of file kservice.h. |
|
Returns the name of the init function to call (KControl modules).
Definition at line 118 of file kservice.h. |
|
What preference to associate with this service initially (before the user has had any chance to define a profile for it). The bigger the value, the most preferred the service is.
Definition at line 308 of file kservice.h. |
|
What preference to associate with this service initially for handling the specified mimetype. (before the user has had any chance to define a profile for it). The bigger the value, the most preferred the service is.
Definition at line 385 of file kservice.cpp. |
|
Checks whether the service is valid.
Definition at line 375 of file kservice.h. |
|
Returns a list of descriptive keywords the service, if there are any.
Definition at line 257 of file kservice.h. |
|
Returns the name of the service's library.
Definition at line 111 of file kservice.h. |
|
Returns a path that can be used for saving changes to this service.
Definition at line 769 of file kservice.cpp. |
|
Returns the menu ID of the service desktop entry. The menu ID is used to add or remove the entry to a menu.
Definition at line 752 of file kservice.cpp. |
|
Returns the name of the service.
Definition at line 98 of file kservice.h. |
|
Returns a path that can be used to create a new KService based on
Definition at line 778 of file kservice.cpp. |
|
Whether the entry should be suppressed in menus.
Definition at line 690 of file kservice.cpp. |
|
Name of the application this service belongs to. (Useful for e.g. plugins)
Definition at line 728 of file kservice.cpp. |
|
Returns the working directory to run the program in.
Definition at line 226 of file kservice.h. |
|
Returns the pixmap that represents the icon.
Definition at line 279 of file kservice.cpp. |
|
Returns the requested property.
Definition at line 490 of file kservice.cpp. |
|
Returns the requested property. Some often used properties have convenience access functions like exec(), serviceTypes etc. It depends upon the serviceTypes() of this service which properties a service can have.
Definition at line 475 of file kservice.cpp. |
|
Returns the list of all properties that this service can have. That means, that some of these properties may be empty.
Definition at line 581 of file kservice.cpp. |
|
Rebuild KSycoca and show a progress dialog while doing so.
Definition at line 834 of file kservice.cpp. |
|
Find a service by the name of its desktop file, not depending on its actual location (as long as it's under the applnk or service directories). For instance "konqbrowser" or "kcookiejar". Note that the ".desktop" extension is implicit. This is the recommended method (safe even if the user moves stuff) but note that it assumes that no two entries have the same filename.
Definition at line 627 of file kservice.cpp. |
|
Find a service based on its path as returned by desktopEntryPath(). It's usually better to use serviceByStorageId() instead.
Definition at line 621 of file kservice.cpp. |
|
Find a service by its menu-id.
Definition at line 635 of file kservice.cpp. |
|
Find a service by name, i.e. the translated Name field. You should really not use this method, since the name is translated.
Definition at line 615 of file kservice.cpp. |
|
Find a service by its storage-id or desktop-file path. This function will try very hard to find a matching service.
Definition at line 641 of file kservice.cpp. |
|
Returns the service types that this service supports.
Definition at line 270 of file kservice.h. |
|
Returns a normalized ID suitable for storing in configuration files. It will be based on the menu-id when available and otherwise falls back to desktopEntryPath()
Definition at line 762 of file kservice.cpp. |
|
Checks whether the service runs with a different user id.
Definition at line 673 of file kservice.cpp. |
|
Checks whethe the service should be run in a terminal.
Definition at line 138 of file kservice.h. |
|
Returns any options associated with the terminal the service runs in, if it requires a terminal. The service must be a tty-oriented program.
Definition at line 147 of file kservice.h. |
|
Returns the type of the service.
Definition at line 92 of file kservice.h. |
|
Returns the untranslated (US English) generic name for the service, if there is one (e.g. "Mail Client").
Definition at line 723 of file kservice.cpp. |
|
Returns the user name, if the service runs with a different user id.
Definition at line 678 of file kservice.cpp. |
The documentation for this class was generated from the following files: