okular/interfaces/configinterface.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Pino Toscano <pino@kde.org>                     *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  ***************************************************************************/
   9
  10 #ifndef _OKULAR_CONFIGINTERFACE_H_
  11 #define _OKULAR_CONFIGINTERFACE_H_
  12
  13 #include <okular/core/okular_export.h>
  14
  15 #include <QtCore/QObject>
  16
  17 class KConfigDialog;
  18
  19 namespace Okular {
  20
  21 /**
  22  * @short Abstract interface for configuration control
  23  *
  24  * This interface defines a way to configure the Generator itself.
  25  *
  26  * How to use it in a custom Generator:
  27  * @code
  28     class MyGenerator : public Okular::Generator, public Okular::ConfigInterface
  29     {
  30         Q_OBJECT
  31         Q_INTERFACES( Okular::ConfigInterface )
  32
  33         ...
  34     };
  35  * @endcode
  36  * and - of course - implementing its methods.
  37  */
  38 class OKULAR_EXPORT ConfigInterface
  39 {
  40     public:
  41         /**
  42          * Destroys the config interface.
  43          */
  44         virtual ~ConfigInterface() {}
  45
  46         /**
  47          * This method is called to tell the generator to re-parse its configuration.
  48          *
  49          * Returns true if something has changed.
  50          *
  51          * @note this method can be called also when the generator is not the
  52          * active generator, or when there was not changed in the config added
  53          * by the generator itself. So the suggestion is to @b check whether
  54          * something changed, and only in that case return @p true
  55          */
  56         virtual bool reparseConfig() = 0;
  57
  58         /**
  59          * This method allows the generator to add custom configuration pages to the
  60          * config @p dialog of okular.
  61          */
  62         virtual void addPages( KConfigDialog *dialog ) = 0;
  63 };
  64
  65 }
  66
  67 Q_DECLARE_INTERFACE( Okular::ConfigInterface, "org.kde.okular.ConfigInterface/0.1" )
  68
  69 #endif