searchbar.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "gui/searchbar/searchoptions.h"
#include <QFrame>
 
class QLabel;
class QLineEdit;
class QHBoxLayout;
class QPushButton;
class QToolButton;
 
namespace hal
{
    class Searchbar : public QFrame
    {
        Q_OBJECT
        Q_PROPERTY(QString searchIcon READ searchIcon WRITE setSearchIcon)
        Q_PROPERTY(QString searchIconStyle READ searchIconStyle WRITE setSearchIconStyle)
        Q_PROPERTY(QString clearIcon READ clearIcon WRITE setClearIcon)
        Q_PROPERTY(QString clearIconStyle READ clearIconStyle WRITE setClearIconStyle)
        Q_PROPERTY(QString optionDialogIcon READ optionDialogIcon WRITE setOptionDialogIcon)
        Q_PROPERTY(QString optionDialogIconStyle READ optionDialogIconStyle WRITE setOptionDialogIconStyle)
 
    public:
        Searchbar(QWidget* parent = nullptr);
 
        QString searchIcon() const;
        QString searchIconStyle() const;
        QString clearIcon() const;
        QString clearIconStyle() const;
        QString optionDialogIcon() const;
        QString optionDialogIconStyle() const;
 
        void setSearchIcon(const QString& icon);
        void setSearchIconStyle(const QString& style);
        void setClearIcon(const QString& icon);
        void setClearIconStyle(const QString& style);
        void setColumnNames(QList<QString> list);
        void setOptionDialogIcon(const QString& icon);
        void setOptionDialogIconStyle(const QString& style);
 
        void setPlaceholderText(const QString& text);
 
        void clear();
 
        void hideEvent(QHideEvent *) override;
 
        void showEvent(QShowEvent *) override;
 
        QString getCurrentText();
 
        QString getCurrentTextWithFlags();
 
        QString addFlags(const QString& text);
 
        void repolish();
 
        SearchOptions getSearchOptions() const;
        // bool exactMatchChecked();
 
        // bool caseSensitiveChecked();
 
        bool filterApplied();
 
        void setEmitTextWithFlags(bool);
 
        bool getEmitTextWithFlags();
 
        bool eventFilter(QObject *object, QEvent *event) override;
 
 
    Q_SIGNALS:
        void triggerNewSearch(const QString& text, int searchOptions);
 
        void returnPressed();
 
        // testing, might be removed
        void searchIconClicked();
 
    public Q_SLOTS:
        void handleTextEdited();
 
        void handleReturnPressed();
 
        void handleClearClicked();
 
        void handleSearchOptionsDialog();
 
        void updateSearchHistory(QString entry);
 
    private:
        QHBoxLayout* mLayout;
 
        QLabel* mSearchIconLabel;
        QLineEdit* mLineEdit;
        QLabel* mClearIconLabel;
 
        QToolButton* mDownButton;
        QToolButton* mUpButton;
        //QToolButton* mCaseSensitiveButton;
        QToolButton* mSearchOptionsButton;
        QToolButton* mClearButton;
 
        QString mSearchIcon;
        QString mSearchIconStyle;
        QString mClearIcon;
        QString mClearIconStyle;
        QString mOptionDialogIcon;
        QString mOptionDialogIconStyle;
 
        QList<QString> mColumnNames;
 
 
        // One can decide wether to receive the text (emitted by textEdited) with or without regex modifier
        // If set to false, one has to manually implement 'Exact Match'/'Case Sensitive' functionality
        bool mEmitTextWithFlags = true;
 
        SearchOptions* mCurrentOptions;
        bool mIncrementalSearch = true;
        int mMinCharsToStartIncSearch = 3;
 
        QStringList mSearchHistory;
    };
}