RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 19:47:46 +00:00
Code Issues Activity Actions

LibGUI: Add search API to TextEditor with highlighted results

Browse source 
This adds a search API to TextEditor.

The API that is similar to "find_text" of TextDocument (which is used
internally to do the search).

All search results (as well as the current one) are highlighted with
a "span collection", which is pretty neat :^)
This commit is contained in:
Itamar 2022-03-29 16:33:46 +03:00 • committed by Andreas Kling
parent a12385dc4b
commit 5f2a0f03a6
2 changed files with 75 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Userland/Libraries/LibGUI/TextEditor.h
View file

@ -1,5 +1,6 @@
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
* Copyright (c) 2022, the SerenityOS developers.
*
* SPDX-License-Identifier: BSD-2-Clause
*/
@ -213,6 +214,15 @@ public:
void set_text_is_secret(bool text_is_secret);
void force_rehighlight();
enum class SearchDirection {
Forward,
Backward,
};
TextRange find_text(StringView needle, SearchDirection, GUI::TextDocument::SearchShouldWrap, bool use_regex, bool match_case);
void reset_search_results();
Optional<size_t> search_result_index() const { return m_search_result_index; }
Vector<TextRange> const& search_results() const { return m_search_results; }
protected:
explicit TextEditor(Type = Type::MultiLine);
@ -260,7 +270,6 @@ private:
// ^Syntax::HighlighterClient
virtual Vector<TextDocumentSpan>& spans() final { return document().spans(); }
virtual Vector<TextDocumentSpan> const& spans() const final { return document().spans(); }
virtual void highlighter_did_set_spans(Vector<TextDocumentSpan> spans) final { document().set_spans(move(spans)); }
virtual void set_span_at_index(size_t index, TextDocumentSpan span) final { document().set_span_at_index(index, move(span)); }
virtual void highlighter_did_request_update() final { update(); }
virtual String highlighter_did_request_text() const final { return text(); }
@ -337,6 +346,9 @@ private:
}
virtual void will_execute(TextDocumentUndoCommand const&) { }
void on_search_results(GUI::TextRange current, Vector<GUI::TextRange> all_results);
static constexpr auto search_results_span_collection_index = 1;
Type m_type { MultiLine };
Mode m_mode { Editable };
@ -408,6 +420,9 @@ private:
RefPtr<Gfx::Bitmap> m_icon;
bool m_text_is_secret { false };
Optional<size_t> m_search_result_index;
Vector<GUI::TextRange> m_search_results;
};
}