KService Class Reference
Represent a service, i.e. More...
#include <kservice.h>
Inheritance diagram for KService:


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 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 | |
Ptr | serviceByName (const QString &_name) |
Ptr | serviceByDesktopPath (const QString &_path) |
Ptr | serviceByDesktopName (const QString &_name) |
Ptr | serviceByMenuId (const QString &_menuId) |
Ptr | serviceByStorageId (const QString &_menuId) |
List | allServices () |
List | allInitServices () |
QString | newServicePath (bool showInMenu, const QString &suggestedName, QString *menuId=0, const QStringList *reservedMenuIds=0) |
void | rebuildKSycoca (QWidget *parent) |
Protected Member Functions | |
void | init (KDesktopFile *config) |
QStringList & | accessServiceTypes () |
virtual void | virtual_hook (int id, void *data) |
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.
Member Enumeration Documentation
|
Describes the DCOP type of the service.
Referenced by DCOPServiceType(). |
Constructor & Destructor Documentation
|
Construct a temporary service with a given name, exec-line and icon.
Referenced by serviceByStorageId(). |
|
Construct a service and take all information from a config file.
References init(). |
|
Construct a service and take all information from a desktop file.
References init(). |
Member Function Documentation
|
Returns the type of the service.
|
|
Returns the name of the service.
Implements KSycocaEntry. Definition at line 98 of file kservice.h. Referenced by KRun::processDesktopExec(). |
|
Returns the executable.
Referenced by KRun::processDesktopExec(). |
|
Returns the name of the service's library.
|
|
Returns the name of the init function to call (KControl modules).
Referenced by KService(). |
|
Returns the name of the icon.
|
|
Returns the pixmap that represents the icon.
References KIconLoader::addExtraDesktopThemes(), KIconLoader::extraDesktopThemesAdded(), KGlobal::iconLoader(), KIconLoader::loadIcon(), and pixmap(). Referenced by pixmap(). |
|
Checks whethe the service should be run in a terminal.
Referenced by KRun::processDesktopExec(). |
|
Returns any options associated with the terminal the service runs in, if it requires a terminal. The service must be a tty-oriented program.
Referenced by KRun::processDesktopExec(). |
|
Checks whether the service runs with a different user id.
References property(). Referenced by KRun::processDesktopExec(). |
|
Returns the user name, if the service runs with a different user id.
References property(). Referenced by KRun::processDesktopExec(). |
|
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.
References KSycocaEntry::entryPath(). Referenced by locateLocal(), and KRun::run(). |
|
Returns the filename of the service desktop entry without any extension. E.g. "kppp"
Referenced by KRun::run(). |
|
Returns the menu ID of the service desktop entry. The menu ID is used to add or remove the entry to a menu.
Referenced by KServiceGroup::entries(). |
|
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()
References KSycocaEntry::entryPath(). |
|
Returns the DCOPServiceType supported by this service.
References DCOPServiceType_t. |
|
Returns the working directory to run the program in.
|
|
Returns the descriptive comment for the service, if there is one.
|
|
Returns the generic name for the service, if there is one (e.g. "Mail Client").
|
|
Returns the untranslated (US English) generic name for the service, if there is one (e.g. "Mail Client").
References property(). |
|
Returns a list of descriptive keywords the service, if there are any.
|
|
Returns a list of VFolder categories.
|
|
Returns the service types that this service supports.
|
|
Checks whether the service supports this service type.
References KMimeType::defaultMimeTypePtr(), KMimeType::mimeType(), and KServiceType::serviceType(). |
|
Checks whether a service is used as a default setting, for example as plugin in a file manager. Usually that is the case, but some services may only be started when the user selected them. This kind of services returns false here.
|
|
Checks whether this service can handle several files as startup arguments.
|
|
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.
|
|
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.
References KMimeType::defaultMimeTypePtr(), KMimeType::mimeType(), and KServiceType::serviceType(). |
|
Whether the entry should be suppressed in menus.
Referenced by KServiceGroup::childCount(), and KServiceGroup::entries(). |
|
Name of the application this service belongs to. (Useful for e.g. plugins)
|
|
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.
Referenced by substituteUid(), untranslatedGenericName(), and username(). |
|
Returns the requested property.
References KSycocaEntry::entryPath(), and kdDebug(). |
|
Returns the list of all properties that this service can have. That means, that some of these properties may be empty.
|
|
Checks whether the service is valid.
Implements KSycocaEntry. Definition at line 371 of file kservice.h. |
|
Returns a path that can be used for saving changes to this service.
References desktopEntryPath(), locateLocal(), and KDesktopFile::locateLocal(). |
|
Find a service by name, i.e. the translated Name field. You should really not use this method, since the name is translated.
References KSycocaEntry::Ptr. Referenced by KServiceTypeProfile::allowAsDefault(). |
|
Find a service based on its path as returned by desktopEntryPath(). It's usually better to use serviceByStorageId() instead.
References KSycocaEntry::Ptr. Referenced by serviceByStorageId(). |
|
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.
References KSycocaEntry::Ptr. Referenced by KRun::foundMimeType(), KURIFilterData::iconName(), KRun::runCommand(), and serviceByStorageId(). |
|
Find a service by its menu-id.
References KSycocaEntry::Ptr. Referenced by newServicePath(), and serviceByStorageId(). |
|
Find a service by its storage-id or desktop-file path. This function will try very hard to find a matching service.
References KService(), serviceByDesktopName(), serviceByDesktopPath(), and serviceByMenuId(). |
|
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.
|
|
Returns all services that require initialisation. Only needed by "kcminit"
|
|
Returns a path that can be used to create a new KService based on
References locate(), locateLocal(), and serviceByMenuId(). |
|
Rebuild KSycoca and show a progress dialog while doing so.
References DCOPClient::callAsync(). Referenced by KDesktopPropsPlugin::applyChanges(). |
The documentation for this class was generated from the following files: