ckeychooserwidget.h

Go to the documentation of this file.

/*********
*
* In the name of the Father, and of the Son, and of the Holy Spirit.
*
* This file is part of BibleTime's source code, https://bibletime.info/
*
* Copyright 1999-2021 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License
* version 2.0.
*
**********/
 
#pragma once
 
#include <QComboBox>
 
#include <QObject>
#include <QString>
#include <QStringList>
#include <QWidget>
#include "../../util/btassert.h"
 
 
class CScrollerWidgetSet;
class QEvent;
class QHBoxLayout;
 
/**
* We use this class to control the focus move in the combobox
* This class is used in the key chooser widgets
*/
class CKCComboBox: public QComboBox {
 
    Q_OBJECT
 
public: // methods:
 
    CKCComboBox(QWidget * parent = nullptr);
 
protected: // methods:
 
    bool eventFilter(QObject * o, QEvent * e) override;
 
Q_SIGNALS:
 
    /**
    * Emitted when the user moves the focus away from the combo by pressing tab
    */
    void focusOut(int itemIndex);
 
};
 
/**
 * This class implements the KeyCooser Widget, which
 * consists of a @ref QComboBox, two normal ref @QToolButton
 * and a enhanced @ref CScrollButton
 *
  * @author The BibleTime team
  */
class CKeyChooserWidget: public QWidget  {
 
    Q_OBJECT
 
public: // methods:
 
    CKeyChooserWidget(QStringList * list = nullptr,
                      QWidget * parent = nullptr);
 
    CKeyChooserWidget(int count = 0,
                      QWidget * parent = nullptr);
 
    /**
    * This function does clear the combobox, then fill in
    * the StringList, set the ComboBox' current item to index
    * and if do_emit is true, it will emit @ref #changed
    *
    * @param list the stringlist to be inserted
    * @param index the index that the combobox is to jump to
    * @param do_emit should we emit @ref #changed(int)
    */
    void reset(const int count, int index, bool do_emit);
 
    void reset(const QStringList & list, int index, bool do_emit);
 
    void reset(const QStringList * list, int index, bool do_emit);
 
    /**
    * Initializes this widget. We need this function because
    * we have more than one constructor.
    */
    void init();
 
    /**
    * Sets the tooltips for the given entries using the parameters as text.
    */
    void setToolTips(const QString & comboTip,
                     const QString & nextEntry,
                     const QString & scrollButton,
                     const QString & previousEntry);
 
    /**
    * Sets the current item to the one with the given text
    */
    bool setItem(const QString & item);
 
    /**
    * Return the combobox of this key chooser widget.
    */
    QComboBox & comboBox() const {
        BT_ASSERT(m_comboBox);
        return *m_comboBox;
    }
 
Q_SIGNALS:
 
    /**
    * Is emitted if the widget changed, but
    * only if it is not locked or being reset
    *
    * @param the current ComboBox index
    */
    void changed(int index);
 
    /**
    * Is emitted if the widget was left with a focus out event.
    * @param index The new index of the ComboBox
    */
    void focusOut(int index);
 
private: // fields:
 
    QStringList m_list;
    bool updatelock;
 
    /**
    * Members should never be public!!
    */
    CKCComboBox * m_comboBox;
    QHBoxLayout * m_mainLayout;
    CScrollerWidgetSet * m_scroller;
 
    /**
    * indicates wheter we are resetting at the moment
    */
    bool m_isResetting;
 
    QString m_oldKey;
 
};