kdeui/xmlgui/kxmlguiversionhandler_p.h

   1 /* This file is part of the KDE libraries
   2    Copyright (C) 2000 Simon Hausmann <hausmann@kde.org>
   3    Copyright (C) 2000 Kurt Granroth <granroth@kde.org>
   4    Copyright     2007 David Faure <faure@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 KXMLGUIVERSIONHANDLER_P_H
  23 #define KXMLGUIVERSIONHANDLER_P_H
  24
  25 #include <QStringList>
  26
  27 /**
  28  * @internal
  29  * Helper class for KXMLGUIClient::setXMLFile
  30  * Finds the xml file with the largest version number and takes
  31  * care of keeping user settings (from the most local file)
  32  * like action shortcuts or toolbar customizations.
  33  *
  34  * This is about handling upgrades (a new version of the application
  35  * has been installed, with a new xmlgui file, and the user might have
  36  * a local modified version of an older xmlgui file).
  37  */
  38 class KXmlGuiVersionHandler
  39 {
  40 public:
  41     KXmlGuiVersionHandler(const QStringList& files);
  42
  43     QString finalFile() const { return m_file; }
  44     QString finalDocument() const { return m_doc; }
  45
  46     static QString findVersionNumber( const QString &xml ); // used by the unit test
  47
  48 private:
  49     QString m_file;
  50     QString m_doc;
  51 };
  52
  53 #endif /* KXMLGUIVERSIONHANDLER_P_H */