searchtextbar.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-11-25
 * Description : a bar used to search a string - version not based on database models
 *
 * Copyright (C) 2007-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_SEARCH_TEXT_BAR_H
#define DIGIKAM_SEARCH_TEXT_BAR_H
 
// Qt includes
 
#include <QAbstractItemModel>
#include <QStringList>
#include <QLineEdit>
 
// Local includes
 
#include "digikam_export.h"
#include "modelcompleter.h"
#include "statesavingobject.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT SearchTextSettings
{
 
public:
 
    SearchTextSettings()
      : caseSensitive(Qt::CaseInsensitive)
    {
    }
 
    Qt::CaseSensitivity caseSensitive;
 
    QString             text;
};
 
bool DIGIKAM_EXPORT operator==(const SearchTextSettings& a, const SearchTextSettings& b);
 
class DIGIKAM_EXPORT SearchTextBar : public QLineEdit,
                                     public StateSavingObject
{
    Q_OBJECT
 
public:
 
    enum HighlightState
    {
        NEUTRAL,
 
        HAS_RESULT,
 
        NO_RESULT
    };
 
public:
 
    explicit SearchTextBar(QWidget* const parent,
                           const QString& name,
                           const QString& msg = QString());
    ~SearchTextBar()                                  override;
 
    void setTextQueryCompletion(bool b);
    bool hasTextQueryCompletion()               const;
 
    void setHighlightOnResult(bool highlight);
 
    HighlightState getCurrentHighlightState()   const;
 
    void setCaseSensitive(bool b);
    bool hasCaseSensitive()                     const;
 
    void setSearchTextSettings(const SearchTextSettings& settings);
    SearchTextSettings searchTextSettings()     const;
    ModelCompleter*  completerModel()           const;
 
Q_SIGNALS:
 
    void signalSearchTextSettings(const SearchTextSettings& settings);
    void completerHighlighted(int albumId);
    void completerActivated();
 
public Q_SLOTS:
 
    void slotSearchResult(bool match);
 
private Q_SLOTS:
 
    void slotTextChanged();
 
protected:
 
    void doLoadState()                                override;
    void doSaveState()                                override;
 
private:
 
    void contextMenuEvent(QContextMenuEvent* e)       override;
 
    void setIgnoreCase(bool ignore);
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_SEARCH_TEXT_BAR_H