texteditfindbarbase.h

/*
   SPDX-FileCopyrightText: 2013-2025 Laurent Montel <montel@kde.org>
 
   SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#pragma once
 
#include "textcustomeditor_export.h"
#include <QRegularExpression>
#include <QWidget>
namespace TextCustomEditor
{
class TextFindWidget;
class TextReplaceWidget;
/**
 * @brief The TextEditFindBarBase class
 * @author Laurent Montel <montel@kde.org>
 */
class TEXTCUSTOMEDITOR_EXPORT TextEditFindBarBase : public QWidget
{
    Q_OBJECT
 
public:
    enum FindFlag {
        FindBackward = 0x00001,
        FindCaseSensitively = 0x00002,
        FindWholeWords = 0x00004,
        FindRespectDiacritics = 0x00008,
    };
    Q_DECLARE_FLAGS(FindFlags, FindFlag)
 
    explicit TextEditFindBarBase(QWidget *parent = nullptr);
    ~TextEditFindBarBase() override;
 
    [[nodiscard]] QString text() const;
    void setText(const QString &text);
 
    void focusAndSetCursor();
 
    void showReplace();
    void showFind();
    void setHideWhenClose(bool hide);
 
Q_SIGNALS:
    void displayMessageIndicator(const QString &message);
    void hideFindBar();
 
protected:
    [[nodiscard]] virtual bool viewIsReadOnly() const = 0;
    [[nodiscard]] virtual bool documentIsEmpty() const = 0;
    virtual bool searchInDocument(const QString &text, TextEditFindBarBase::FindFlags searchOptions) = 0;
    virtual bool searchInDocument(const QRegularExpression &regExp, TextEditFindBarBase::FindFlags searchOptions) = 0;
    virtual void autoSearchMoveCursor() = 0;
 
    [[nodiscard]] bool event(QEvent *e) override;
    void clearSelections();
    bool searchText(bool backward, bool isAutoSearch);
 
    void setFoundMatch(bool match);
    void messageInfo(bool backward, bool isAutoSearch, bool found);
 
public Q_SLOTS:
    void findNext();
    void findPrev();
    void autoSearch(const QString &str);
    virtual void slotSearchText(bool backward = false, bool isAutoSearch = true) = 0;
    void closeBar();
 
private Q_SLOTS:
    TEXTCUSTOMEDITOR_NO_EXPORT void slotClearSearch();
    TEXTCUSTOMEDITOR_NO_EXPORT void slotUpdateSearchOptions();
    virtual void slotReplaceText() = 0;
    virtual void slotReplaceAllText() = 0;
 
protected:
    QString mLastSearchStr;
    QRegularExpression mLastSearchRegExp;
    TextFindWidget *const mFindWidget;
    TextReplaceWidget *const mReplaceWidget;
    bool mHideWhenClose = true;
};
}