libkdepim/kresourceprefs.h

   1 /*
   2   This file is part of libkdepim.
   3
   4   Copyright (c) 2004 Tobias Koenig <tokoe@kde.org>
   5
   6   This library is free software; you can redistribute it and/or
   7   modify it under the terms of the GNU Library General Public
   8   License as published by the Free Software Foundation; either
   9   version 2 of the License, or (at your option) any later version.
  10
  11   This library is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14   Library General Public License for more details.
  15
  16   You should have received a copy of the GNU Library General Public License
  17   along with this library; see the file COPYING.LIB.  If not, write to
  18   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19   Boston, MA 02110-1301, USA.
  20 */
  21
  22 #ifndef KDEPIM_KRESOURCEPREFS_H
  23 #define KDEPIM_KRESOURCEPREFS_H
  24
  25 #include "kdepim_export.h"
  26 #include <KConfigSkeleton>
  27
  28 class QString;
  29
  30 namespace KPIM {
  31
  32 /**
  33   This is a base class for all KPrefs objects, where multiple instances want
  34   to work on the same config file.
  35   By calling addGroupPrefix( "foobar" ), 'foobar' as a prefix is added to the
  36   group names in the configuration file.
  37   The prefix should be an unique identifier to avoid name clashes and the method
  38   has to be called before readConfig(), otherwise the wrong entries are read.
  39  */
  40 class KDEPIM_EXPORT KResourcePrefs : public KConfigSkeleton
  41 {
  42   public:
  43     KResourcePrefs( const QString &name = QString() );
  44
  45     /**
  46       Adds a prefix to all groups of this prefs object.
  47      */
  48     void addGroupPrefix( const QString &prefix );
  49 };
  50
  51 }
  52
  53 #endif