/* This file is part of the KDE project
Copyright (C) 1998, 1999 Torben Weis
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef __kservices_h__
#define __kservices_h__
#include
#include
#include
#include
#include "ksycocaentry.h"
class QDataStream;
class KDesktopFile;
class KService;
class KBuildSycoca;
/**
* 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.
*
* @author Torben Weis
*/
class KService : public KSycocaEntry
{
K_SYCOCATYPE( KST_KService, KSycocaEntry )
friend class KBuildSycoca;
public:
typedef KSharedPtr Ptr;
typedef QValueList List;
public:
/**
* Construct a temporary service with a given name, exec-line and icon.
*/
KService( const QString & _name, const QString &_exec, const QString &_icon);
/**
* Construct a service and take all information from a config file.
*
* @param _fullpath Full path to the config file.
*/
KService( const QString & _fullpath );
/**
* Construct a service and take all information from a desktop file.
*/
KService( KDesktopFile *config );
/**
* @internal
* Construct a service from a stream.
* The stream must already be positionned at the correct offset.
*/
KService( QDataStream& _str, int offset );
virtual ~KService();
/**
* @return the type of the service ("Application" or "Service").
*/
virtual QString type() const { return m_strType; }
/**
* @return the name of the service.
*/
virtual QString name() const { return m_strName; }
/**
* @return the command that the service executes.
*/
QString exec() const { return m_strExec; }
/**
* @return the name of the library that contains the services
* implementation.
*/
QString library() const { return m_strLibrary; }
/**
* @return the name of the init function to call in this service
* during startup of KDE. (KControl modules only)
*/
QString init() const { return m_strInit; }
/**
* @return the icon associated with the service.
*/
QString icon() const { return m_strIcon; }
/**
* @return a pixmap for this service (finds and loads icon())
*/
QPixmap pixmap( KIcon::Group _group, int _force_size = 0, int _state = 0,
QString * _path = 0L ) const;
/**
* @return true if the service is to be run in a terminal.
*/
bool terminal() const { return m_bTerminal; }
/**
* @return any options associated with the terminal the service
* runs in, if it requires a terminal.
*
* The service must be a tty-oriented program.
*/
QString terminalOptions() const { return m_strTerminalOptions; }
/**
* @return true if the service has to be run under a different uid.
*/
bool substituteUid() const;
/**
* @return the username under which the service has to be run.
*/
QString username() const;
/**
* @return 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.
*/
QString desktopEntryPath() const { return entryPath(); }
/**
* @return the filename of the service desktop entry without any
* extension. E.g. "kppp"
*/
QString desktopEntryName() const { return m_strDesktopEntryName; }
/**
* @li None - This service has no DCOP support
* @li Unique - This service provides a unique DCOP service.
* The service name is equal to the desktopEntryName.
* @li Multi - This service provides a DCOP service which can be run
* with multiple instances in parallel. The service name of
* an instance is equal to the desktopEntryName + "-" +
* the PID of the process.
* @li Wait - This service has no DCOP support, the launcher will wait
* till it is finished.
*/
enum DCOPServiceType_t { DCOP_None = 0, DCOP_Unique, DCOP_Multi, DCOP_Wait };
/**
* @return The @ref DCOPServiceType supported by this service.
*/
DCOPServiceType_t DCOPServiceType() const { return m_DCOPServiceType; }
/**
* @return the working directory to run the program in.
*/
QString path() const { return m_strPath; }
/**
* @return the descriptive comment for the service, if there is one.
*/
QString comment() const { return m_strComment; }
/**
* @return the generic name for the service, if there is one.
* (e.g. "Mail Client")
*/
QString genericName() const { return m_strGenName; }
/**
* @return a list of descriptive keywords the service, if there are any.
*/
QStringList keywords() const { return m_lstKeywords; }
/**
* @return the service types that this service supports.
*/
QStringList serviceTypes() const { return m_lstServiceTypes; }
/**
* @param _service The name of the service type you are
* interested in determining whether this services supports.
*
* @return true if the service you specified is supported,
* otherwise @p false.
*/
bool hasServiceType( const QString& _service ) const;
/**
* @return true if the service may be used as a default setting, for
* example 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 @p false here.
*/
bool allowAsDefault() const { return m_bAllowAsDefault; }
/**
* @return true if multiple files may be passed to this service at
* startup. False if only one file at a time may be passed.
*/
bool allowMultipleFiles() const;
/**
* 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.
*/
int initialPreference() const { return m_initialPreference; }
/**
* @internal. Allows KServiceType::offers to tweak the initial preference.
*/
void setInitialPreference( int i ) { m_initialPreference = i; }
/**
* Whether the entry should be suppressed in menus.
*/
bool noDisplay() const;
/**
* @return the requested properties. Some often used properties
* have convenience access functions like @ref exec(),
* @ref serviceTypes etc.
*
* It depends upon the @ref serviceTypes() of this service which
* properties a service can have.
*
* @see KServiceType
*/
virtual QVariant property( const QString& _name ) const;
/**
* @return the list of all properties that this service can have.
* That means, that some properties may be empty.
*/
virtual QStringList propertyNames() const;
/**
* @return true if the service is valid (e.g. name is not empty)
*/
bool isValid() const { return m_bValid; }
/**
* @internal
* Load the service from a stream.
*/
virtual void load( QDataStream& );
/**
* @internal
* Save the service to a stream.
*/
virtual void save( QDataStream& );
/**
* Find a service by name, i.e. the translated Name field. You should
* really not use this method, since the name is translated.
*
* @return a pointer to the requested service or 0 if the service is
* unknown.
* @em Very @em important: Don't store the result in a KService* !
*/
static Ptr serviceByName( const QString& _name );
/**
* Find a service by its relative path to the applnk or services
* directory, for instance "Internet/konqbrowser.desktop". Better not use
* it for menu entries though, since the user can move them.
* It's ok to use it for services though (e.g. "http_cache_cleaner.desktop")
*
* @return a pointer to the requested service or 0 if the service is
* unknown.
* @em Very @em important: Don't store the result in a KService* !
*/
static Ptr serviceByDesktopPath( const QString& _name );
/**
* 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.
*
* @return a pointer to the requested service or 0 if the service is
* unknown.
* @em Very @em important: Don't store the result in a KService* !
*/
static Ptr serviceByDesktopName( const QString& _name );
/**
* @return 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.
*/
static List allServices();
/**
* @return all services that require initialisation.
*
* Only needed by "kcminit"
*/
static List allInitServices();
protected:
void init(KDesktopFile *config);
QStringList &accessServiceTypes() { return m_lstServiceTypes; }
private:
QString m_strType;
QString m_strName;
QString m_strExec;
QString m_strIcon;
QString m_strTerminalOptions;
QString m_strPath;
QString m_strComment;
QString m_strLibrary;
QStringList m_lstServiceTypes;
bool m_bAllowAsDefault;
int m_initialPreference;
bool m_bTerminal;
//bool m_bSuid;
//QString m_strUsername;
QString m_strDesktopEntryName;
//QString m_docPath;
//bool m_bHideFromPanel;
DCOPServiceType_t m_DCOPServiceType;
QMap m_mapProps;
bool m_bValid;
QStringList m_lstKeywords;
QString m_strInit;
QString m_strGenName;
protected:
virtual void virtual_hook( int id, void* data );
private:
class KServicePrivate* d;
};
#endif
| Generated by: dfaure on faure on Tue Apr 16 08:49:48 2002, using kdoc 2.0a53. |