project/projectconfigskeleton.h

   1 /* This file is part of KDevelop
   2 Copyright 2006 Adam Treat <treat@kde.org>
   3 Copyright 2007 Andreas Pakulat <apaku@gmx.de>
   4
   5 This library is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU Library General Public
   7 License as published by the Free Software Foundation; either
   8 version 2 of the License, or (at your option) any later version.
   9
  10 This library is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 Library General Public License for more details.
  14
  15 You should have received a copy of the GNU Library General Public License
  16 along with this library; see the file COPYING.LIB.  If not, write to
  17 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18 Boston, MA 02110-1301, USA.
  19 */
  20
  21 #ifndef KDEVPROJECTCONFIGSKELETON_H
  22 #define KDEVPROJECTCONFIGSKELETON_H
  23
  24 #include "projectexport.h"
  25 #include <kconfigskeleton.h>
  26
  27 namespace KDevelop
  28 {
  29
  30 class KDEVPLATFORMPROJECT_EXPORT ProjectConfigSkeleton: public KConfigSkeleton
  31 {
  32     Q_OBJECT
  33 public:
  34
  35     /**
  36      * Constructs a new skeleton, the skeleton will write to the developer
  37      * configuration file, which is by default located in projectdir/.kdev4
  38      * The defaults will be set from the project file, which is in the projectdir
  39      *
  40      * @param configname The absolute filename of the developer configuration file
  41      */
  42     ProjectConfigSkeleton( const QString & configname );
  43
  44     virtual ~ProjectConfigSkeleton();
  45
  46     void setDeveloperTempFile( const QString& );
  47     void setProjectTempFile( const QString& );
  48     void setProjectFileUrl( const QString& );
  49     void setDeveloperFileUrl( const QString& );
  50     void setDefaults();
  51     bool useDefaults( bool b );
  52     void writeConfig();
  53
  54     KUrl projectFileUrl() const;
  55     KUrl developerFileUrl() const;
  56 private:
  57     /**
  58      * There's no way in KDE4 API to find out the file that the config object
  59      * was created from, so we can't apply defaults when using this
  60      * constructors. Thus I'm making this private, so we can find out when
  61      * this constructor is used and see if we need to add appropriate API to
  62      * kdelibs
  63      */
  64      ProjectConfigSkeleton( KSharedConfig::Ptr config );
  65      struct ProjectConfigSkeletonPrivate * const d;
  66 };
  67
  68 }
  69 #endif
  70