search_text_widget.h

Go to the documentation of this file.

 
/*
 * This file depends on Qt which is licensed under LGPLv3.
 * See ADTF_DIR/3rdparty/qt5 and doc/license for detailed information.
 */
 
#pragma once
 
#include <adtf_utils.h>
 
#include <QActionGroup>
#include <QLabel>
#include <QLineEdit>
#include <QMetaType>
#include <QObject>
#include <QPushButton>
#include <QSortFilterProxyModel>
#include <QSpinBox>
#include <QStandardItemModel>
#include <QString>
#include <QThreadPool>
#include <QSet>
#include <unordered_set>
 
namespace adtf
{
namespace ui 
{
namespace widget
{
namespace osborn
{
 
enum class FilterType
{
    normal,
    wildcard,
    regex,
    fuzzy
};
 
class cSearchTextWidget;
 
// cFilterModel
 
class cFilterModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
    public:
        using QSortFilterProxyModel::QSortFilterProxyModel;
        cFilterModel(QObject* parent = nullptr);
 
    public:
        QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
 
        void SetFilterType(FilterType eFilterType);
        void SetFilterColumn(int64_t nFilterColumn);
        void ClearMatchingData();
        void SetMatchingTexts(const QSet<QString>& oMatchingTexts);
 
    private:
        bool filterAcceptsRow(int source_row, const QModelIndex& source_parent) const override;
 
        void ClearMatchings();
 
    private:
        FilterType m_eFilterType = FilterType::normal;
        int64_t m_nFilterColumn = -1;
 
        bool m_bUseMatchingData = false;
 
        QSet<QString> m_setMatchingTexts;
};
 
// cSearchTextWidget
class cSearchTextWidget : public QFrame
{
    Q_OBJECT
 
    signals:
        void selectedFilterColumnChanged();
        void searchParametersChanged();
        void resultChanged();
 
    public:
        /*
         * Constructor.
         * @param pParent parent widget
         */
        cSearchTextWidget(QWidget* pParent = nullptr);
 
    public:
        /*
         * Show bottom border.
         * @param show Whether to show.
         */
        void ShowBottomBorder(bool show);
 
        /*
         * Set the model which is filtered.
         * @param oFilterModel The filter model.
         */
        void SetFilterModel(cFilterModel& oFilterModel);
 
        /*
         * Returns index of selected filter column.
         * @return index
         */
        uint64_t GetSelectedFilterColumn() const;
        /*
         * Set the names of filter columns which can be single-selected.
         * @param vecFilterColumnNames The column names.
         */
        void SetFilterColumnNames(const std::vector<QString>& vecFilterColumnNames);
        /*
         * Set the names of filter columns which can be single-selected.
         * @param oModel The model from which the column names are obtained.
         */
        void SetFilterColumnNamesFromModel(const QAbstractItemModel& oModel);
 
        /*
         * Set the search text.
         * strSearchText The text.
         */
        void SetSearchText(const QString& strSearchText);
        void Clear();
 
        /*
         * Returns the selected filter type.
         * @return selected filter type
         */
        FilterType GetSelectedFilterType() const;
        /*
         * Select the filter type.
         * @param oFilterType The filter type.
         */
        void SelectFilterType(FilterType oFilterType);
 
        bool IsCaseSensitive() const;
        /*
         * Set whether 'case sensitive' is set or not.
         * @param bCaseSensitive Whether 'case sensitive' should be set.
         */
        void SetCaseSensitive(bool bCaseSensitive);
 
    private:
        bool event(QEvent* event) override;
 
        void UpdateStyle();
        void UpdateUi();
 
        void SetItemTextOutOfDate();
 
        void HandleChangedSearchParameters(bool bTextChanged);
 
        void SearchNormalString();
        void SearchWildcard();
        void SearchRegexString();
        void SearchFuzzy();
 
        QSet<QString> ComputeItemTexts(const QModelIndex& oModelIndex, const uint64_t nFilterColumn);
        void ComputeTreeModelIndexs(const QModelIndex& oModelIndex,
                                    const uint64_t nFilterColumn,
                                    const std::function<void(const QModelIndex& oIndex)>& fnCallback);
 
    private:
        bool m_bShowBottomBorder = true;
 
        cFilterModel* m_pFilterModel = nullptr;
        QAbstractItemModel* m_pSourceModel = nullptr;
 
        QLineEdit* m_pSearchTextLineEdit = nullptr;
        QLabel* m_pErrorLabel = nullptr;
        QToolButton* m_pClearButton = nullptr;
        QMenu* m_pFilterMenu = nullptr;
        QActionGroup* m_pFilterActionGroup = nullptr;
        QAction* m_pFuzzyFilterAction = nullptr;
        QAction* m_pCaseSensitiveAction = nullptr;
        QPushButton* m_pFilterButton = nullptr;
        QMenu* m_pFilterColumnMenu = nullptr;
        QActionGroup* m_pFilterColumnActionGroup = nullptr;
        QWidget* m_pFuzzyParametersWidget = nullptr;
        QSpinBox* m_pFuzzyScaledScoreThresholdSpinBox = nullptr;
 
        bool m_bIsInInitialization = false;
 
        QSet<QString> m_setItemTextCache;
 
        QThreadPool m_oSearchThreadPool;
        std::atomic<bool> m_bSearchCanceled = false;
        bool m_bSearchRequested = false;
        std::chrono::time_point<std::chrono::system_clock> m_oKeyPressedTimestamp;
};
 
};
 
using osborn::cFilterModel;
using osborn::cSearchTextWidget;
 
}
}
} // namespace adtf
Q_DECLARE_METATYPE(adtf::ui::widget::osborn::FilterType);