TextCustomEditor::TextEditFindBarBase Class
The TextEditFindBarBase class Author: Laurent Montel <montel@kde.org>. More...
| Header: | #include <TextCustomEditor/TextEditFindBarBase> |
| CMake: | find_package(KF6TextCustomEditor REQUIRED)target_link_libraries(mytarget PRIVATE KF6::TextCustomEditor) |
| Inherited By: | TextCustomEditor::PlainTextEditFindBar, TextCustomEditor::RichTextBrowserFindBar, and TextCustomEditor::RichTextEditFindBar |
Public Functions
| TextEditFindBarBase(QWidget *parent = nullptr) | |
| virtual | ~TextEditFindBarBase() override |
| void | focusAndSetCursor() |
| void | setHideWhenClose(bool hide) |
| void | setText(const QString &text) |
| void | showFind() |
| void | showReplace() |
| QString | text() const |
Public Slots
| void | autoSearch(const QString &str) |
| void | closeBar() |
| void | findNext() |
| void | findPrev() |
| virtual void | slotSearchText(bool backward = false, bool isAutoSearch = true) = 0 |
Signals
| void | displayMessageIndicator(const QString &message) |
| void | hideFindBar() |
Protected Functions
| virtual void | autoSearchMoveCursor() = 0 |
| void | clearSelections() |
| virtual bool | documentIsEmpty() const = 0 |
| void | messageInfo(bool backward, bool isAutoSearch, bool found) |
| virtual bool | searchInDocument(const QRegularExpression ®Exp, TextEditFindBarBase::FindFlags searchOptions) = 0 |
| virtual bool | searchInDocument(const QString &text, TextEditFindBarBase::FindFlags searchOptions) = 0 |
| bool | searchText(bool backward, bool isAutoSearch) |
| virtual bool | viewIsReadOnly() const = 0 |
Reimplemented Protected Functions
| virtual bool | event(QEvent *e) override |
Private Slots
| void | slotClearSearch() |
| virtual void | slotReplaceAllText() = 0 |
| virtual void | slotReplaceText() = 0 |
| void | slotUpdateSearchOptions() |
Detailed Description
Member Function Documentation
[explicit] TextEditFindBarBase::TextEditFindBarBase(QWidget *parent = nullptr)
[override virtual noexcept] TextEditFindBarBase::~TextEditFindBarBase()
[slot] void TextEditFindBarBase::autoSearch(const QString &str)
Automatically searches for the given text.
[pure virtual protected] void TextEditFindBarBase::autoSearchMoveCursor()
Moves the cursor after an automatic search. Implemented by subclasses.
[protected] void TextEditFindBarBase::clearSelections()
Clears the current search selections.
[slot] void TextEditFindBarBase::closeBar()
Closes the find bar.
[signal] void TextEditFindBarBase::displayMessageIndicator(const QString &message)
Emitted to display a message to the user.
[pure virtual protected] bool TextEditFindBarBase::documentIsEmpty() const
Returns whether the document is empty. Implemented by subclasses.
[override virtual protected] bool TextEditFindBarBase::event(QEvent *e)
Handles events.
[slot] void TextEditFindBarBase::findNext()
Finds the next occurrence of the search text.
[slot] void TextEditFindBarBase::findPrev()
Finds the previous occurrence of the search text.
void TextEditFindBarBase::focusAndSetCursor()
[signal] void TextEditFindBarBase::hideFindBar()
Emitted when the find bar should be hidden.
[protected] void TextEditFindBarBase::messageInfo(bool backward, bool isAutoSearch, bool found)
Displays a message about the search result.
[pure virtual protected] bool TextEditFindBarBase::searchInDocument(const QRegularExpression ®Exp, TextEditFindBarBase::FindFlags searchOptions)
Searches for text using regex in the document. Implemented by subclasses.
[pure virtual protected] bool TextEditFindBarBase::searchInDocument(const QString &text, TextEditFindBarBase::FindFlags searchOptions)
Searches for text in the document. Implemented by subclasses.
[protected] bool TextEditFindBarBase::searchText(bool backward, bool isAutoSearch)
Searches for text with the given options.
void TextEditFindBarBase::setHideWhenClose(bool hide)
void TextEditFindBarBase::setText(const QString &text)
See also text().
void TextEditFindBarBase::showFind()
void TextEditFindBarBase::showReplace()
[private slot] void TextEditFindBarBase::slotClearSearch()
[pure virtual private slot] void TextEditFindBarBase::slotReplaceAllText()
[pure virtual private slot] void TextEditFindBarBase::slotReplaceText()
[pure virtual slot] void TextEditFindBarBase::slotSearchText(bool backward = false, bool isAutoSearch = true)
Searches for text with the given options. Implemented by subclasses.
[private slot] void TextEditFindBarBase::slotUpdateSearchOptions()
QString TextEditFindBarBase::text() const
See also setText().
[pure virtual protected] bool TextEditFindBarBase::viewIsReadOnly() const
Returns whether the view is read-only. Implemented by subclasses.