kservice.h

/* This file is part of the KDE project
   Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
 
   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., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
 
#ifndef __kservices_h__
#define __kservices_h__
 
#include <tqstringlist.h>
#include <tqmap.h>
#include <tqvariant.h>
#include <kicontheme.h>
 
#include "tdesycocaentry.h"
 
class TQDataStream;
class KDesktopFile;
class KService;
class KBuildSycoca;
class TQWidget;
 
class TDEIO_EXPORT KService : public KSycocaEntry
{
  K_SYCOCATYPE( KST_KService, KSycocaEntry )
 
  friend class KBuildSycoca;
 
public:
  typedef TDESharedPtr<KService> Ptr;
  typedef TQValueList<Ptr> List;
public:
  KService( const TQString & _name, const TQString &_exec, const TQString &_icon);
 
  explicit KService( const TQString & _fullpath );
 
  KService( KDesktopFile *config ); // KDE-4.0: make explicit
 
  KService( TQDataStream& _str, int offset );
 
  virtual ~KService();
 
  virtual TQString type() const { return m_strType; }
  virtual TQString name() const { return m_strName; }
  TQString exec() const { return m_strExec; }
  TQString library() const { return m_strLibrary; }
  TQString init() const { return m_strInit; }
 
  TQString icon() const { return m_strIcon; }
  TQPixmap pixmap( TDEIcon::Group _group, int _force_size = 0, int _state = 0,
                  TQString * _path = 0L ) const;
  bool terminal() const { return m_bTerminal; }
  TQString terminalOptions() const { return m_strTerminalOptions; }
  bool substituteUid() const;
  TQString username() const;
 
  TQString desktopEntryPath() const { return entryPath(); }
 
  TQString desktopEntryName() const { return m_strDesktopEntryName; }
 
  TQString menuId() const;
 
  TQString storageId() const;
 
  enum DCOPServiceType_t { DCOP_None = 0, DCOP_Unique, DCOP_Multi, DCOP_Wait };
 
  DCOPServiceType_t DCOPServiceType() const { return m_DCOPServiceType; }
 
  TQString path() const { return m_strPath; }
 
  TQString comment() const { return m_strComment; }
 
  TQString genericName() const { return m_strGenName; }
 
  TQString untranslatedGenericName() const;
 
  TQStringList keywords() const { return m_lstKeywords; }
 
  TQStringList categories() const;
 
  TQStringList serviceTypes() const { return m_lstServiceTypes; }
 
  bool hasServiceType( const TQString& _service ) const;
 
  bool allowAsDefault() const { return m_bAllowAsDefault; }
 
  bool allowMultipleFiles() const;
 
  int initialPreference() const { return m_initialPreference; }
 
  int initialPreferenceForMimeType( const TQString& mimeType ) const;
 
  void setInitialPreference( int i ) { m_initialPreference = i; }
 
  bool noDisplay() const;
  bool SuSEunimportant() const;
 
  TQString parentApp() const;
 
  virtual TQVariant property( const TQString& _name ) const;
 
  TQVariant property( const TQString& _name, TQVariant::Type t ) const;
 
  virtual TQStringList propertyNames() const;
 
  bool isValid() const { return m_bValid; }
 
  TQString locateLocal();
 
  virtual void load( TQDataStream& );
  virtual void save( TQDataStream& );
  void setMenuId(const TQString &menuId);
  void setTerminal(bool b) { m_bTerminal = b; }
  void setTerminalOptions(const TQString &options) { m_strTerminalOptions = options; }
 
  static Ptr serviceByName( const TQString& _name );
 
  static Ptr serviceByDesktopPath( const TQString& _path );
 
  static Ptr serviceByDesktopName( const TQString& _name );
 
  static Ptr serviceByMenuId( const TQString& _menuId );
 
  static Ptr serviceByStorageId( const TQString& _storageId );
 
  static List allServices();
 
  static List allInitServices();
 
  static TQString newServicePath(bool showInMenu, const TQString &suggestedName,
                                TQString *menuId = 0,
                                const TQStringList *reservedMenuIds = 0);
 
 
  static void rebuildKSycoca(TQWidget *parent);
 
protected:
 
  void init(KDesktopFile *config);
 
  TQStringList &accessServiceTypes() { return m_lstServiceTypes; }
 
 
private:
  KService( const KService& ); // forbidden
  KService& operator=(const KService&);
 
  TQString m_strType;
  TQString m_strName;
  TQString m_strExec;
  TQString m_strIcon;
  TQString m_strTerminalOptions;
  TQString m_strPath;
  TQString m_strComment;
  TQString m_strLibrary;
  TQStringList m_lstServiceTypes;
  bool m_bAllowAsDefault;
  int m_initialPreference;
  bool m_bTerminal;
  //bool m_bSuid;
  //TQString m_strUsername;
  TQString m_strDesktopEntryName;
  //TQString m_docPath;
  //bool m_bHideFromPanel;
  DCOPServiceType_t m_DCOPServiceType;
  TQStringVariantMap m_mapProps;
  bool m_bValid;
  TQStringList m_lstKeywords;
  TQString m_strInit;
  TQString m_strGenName;
protected:
  virtual void virtual_hook( int id, void* data );
private:
  class KServicePrivate;
  KServicePrivate* d;
};
#endif