kservicegroup.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2000 Waldo Bastian <bastian@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 version 2 as published by the Free Software Foundation.

   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 KSERVICEGROUP_H
#define KSERVICEGROUP_H

#include <kdecore_export.h>
#include <ksycocaentry.h>
#include <kservice.h>

class KBuildServiceGroupFactory;

class KServiceGroupPrivate;

class KDECORE_EXPORT KServiceGroup : public KSycocaEntry
{
  friend class KBuildServiceGroupFactory;
public:
  typedef KSharedPtr<KServiceGroup> Ptr;
  typedef KSharedPtr<KSycocaEntry> SPtr;
  typedef QList<SPtr> List;
public:
  KServiceGroup( const QString & name );

  KServiceGroup( const QString & _fullpath, const QString & _relpath );

  KServiceGroup( QDataStream& _str, int offset, bool deep );

  virtual ~KServiceGroup();

  QString relPath() const;

  QString caption() const;

  QString icon() const;

  QString comment() const;

  int childCount() const;

  bool noDisplay() const;

  bool showEmptyMenu() const;
  void setShowEmptyMenu( bool b);

  bool showInlineHeader() const;
  void setShowInlineHeader(bool _b);

  bool inlineAlias() const;
  void setInlineAlias(bool _b);
  bool allowInline() const;
  void setAllowInline(bool _b);

  int inlineValue() const;
  void setInlineValue(int _val);


  QStringList suppressGenericNames() const;

  void setLayoutInfo(const QStringList &layout);

  QStringList layoutInfo() const;

  List entries(bool sorted, bool excludeNoDisplay, bool allowSeparators, bool sortByGenericName=false);
  List entries(bool sorted, bool excludeNoDisplay);

  List entries(bool sorted = false);

    enum EntriesOption
    {
      NoOptions = 0x0,
      SortEntries = 0x1,    /*< sort items */
      ExcludeNoDisplay = 0x2, /*< exclude items marked "NoDisplay" */
      AllowSeparators = 0x4, /*< allow separator items to be included */
      SortByGenericName = 0x8 /*< sort by GenericName+Name instead of Name+GenericName */
    };
    Q_DECLARE_FLAGS(EntriesOptions, EntriesOption)

    
    QList<Ptr> groupEntries(EntriesOptions options = ExcludeNoDisplay);

    KService::List serviceEntries(EntriesOptions options = ExcludeNoDisplay);

  QString baseGroupName() const;

  QString directoryEntryPath() const;

#ifndef KDE_NO_DEPRECATED
  static KDE_DEPRECATED Ptr baseGroup( const QString &baseGroupName );
#endif

  static Ptr root();

  static Ptr group(const QString &relPath);

  static Ptr childGroup(const QString &parent);

protected:
  void addEntry( const KSycocaEntry::Ptr& entry);
private:
    Q_DECLARE_PRIVATE(KServiceGroup)
};

#endif