/*********
*
* This file is part of BibleTime's source code, http://www.bibletime.info/.
*
* Copyright 1999-2008 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License version 2.0.
*
**********/



#ifndef CKEYCHOOSER_H
#define CKEYCHOOSER_H


class CSwordModuleInfo;

#include <QWidget>


class CSwordKey;
class QAction;

class BTHistory;


/**
 * The base class for the KeyChooser.
 * Do not use directly, create a KeyChooser with
 * @ref #createInstance , this will create the proper one
 * of the classes that inherit from @ref CKeyChooser
 *
  * @author The BibleTime team
  */

class CKeyChooser : public QWidget {
        Q_OBJECT

    public:

        /**
        * Creates a proper Instance, either
        *
        @ref CLexiconKeyChooser or
        * @ref CBibleKeyChooser
        * @param info the @ref CModuleInfo to be represented by the KeyChooser
        * @param key if not NULL, the @ref CKey the KeyChooser should be set to
        * @param parent the parent of the widget to create
        */
        static CKeyChooser* createInstance(QList<CSwordModuleInfo*> modules, CSwordKey *key, QWidget *parent);


    public slots:
        /**
        * sets the @ref CKey
        * @param key the key which the widget should be set to
        */
        virtual void setKey(CSwordKey* key) = 0;
        /**
        * sets the @ref CKey
        * @param key the key which the widget should be set to
        */
        virtual void updateKey(CSwordKey* key) = 0;
        /**
        * gets the current @ref CKey
        *
        * @return the current @ref CKey
        */
        virtual CSwordKey* key() = 0;
        /**
        * Sets the module of this keychooser and refreshes the comboboxes
        */
        virtual void setModules( const QList<CSwordModuleInfo*>& modules, const bool refresh = true ) = 0;
        /**
        * Freshes the content of the different key chooser parts.
        */
        virtual void refreshContent() = 0;

        /**
        * Returns the history object of this keychooser.
        */
        BTHistory* history();

    signals:

        /**
        * is emitted if the @ref CKey was changed by the user
        */
        void keyChanged(CSwordKey* newKey);
        /**
        * Is emitted before the key is changed!
        */
        void beforeKeyChange(const QString& key);

    protected:

        /**
        * the constructor - DO NOT USE! -- use @ref #createInstance instead!
        */
        CKeyChooser(QList<CSwordModuleInfo*> info, CSwordKey *key = 0, QWidget *parent = 0);
        virtual ~CKeyChooser();
        /**
        * Set the appropriate font do display the modules
        */
        virtual void adjustFont() = 0;

    protected slots:
        virtual void setKey(QString& newKey) = 0;

    private:
        BTHistory* m_history;

};

#endif