123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769 |
- /*
- * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
- *
- * SPDX-License-Identifier: BSD-2-Clause
- */
- #include <AK/StringBuilder.h>
- #include <AK/Utf8View.h>
- #include <AK/Vector.h>
- #include <LibCore/Timer.h>
- #include <LibGUI/AbstractView.h>
- #include <LibGUI/DragOperation.h>
- #include <LibGUI/Model.h>
- #include <LibGUI/ModelEditingDelegate.h>
- #include <LibGUI/Painter.h>
- #include <LibGUI/Scrollbar.h>
- #include <LibGUI/TextBox.h>
- #include <LibGfx/Palette.h>
- namespace GUI {
- AbstractView::AbstractView()
- : m_sort_order(SortOrder::Ascending)
- , m_selection(*this)
- {
- REGISTER_BOOL_PROPERTY("activates_on_selection", activates_on_selection, set_activates_on_selection);
- set_focus_policy(GUI::FocusPolicy::StrongFocus);
- }
- AbstractView::~AbstractView()
- {
- if (m_searching_timer)
- m_searching_timer->stop();
- if (m_model)
- m_model->unregister_view({}, *this);
- }
- void AbstractView::set_model(RefPtr<Model> model)
- {
- if (model == m_model)
- return;
- if (m_model)
- m_model->unregister_view({}, *this);
- m_model = move(model);
- if (m_model)
- m_model->register_view({}, *this);
- model_did_update(GUI::Model::InvalidateAllIndices);
- scroll_to_top();
- }
- void AbstractView::model_did_update(unsigned int flags)
- {
- if (!model() || (flags & GUI::Model::InvalidateAllIndices)) {
- stop_editing();
- m_edit_index = {};
- m_hovered_index = {};
- m_cursor_index = {};
- m_drop_candidate_index = {};
- clear_selection();
- } else {
- // FIXME: These may no longer point to whatever they did before,
- // but let's be optimistic until we can be sure about it.
- if (!model()->is_within_range(m_edit_index)) {
- stop_editing();
- m_edit_index = {};
- }
- if (!model()->is_within_range(m_hovered_index))
- m_hovered_index = {};
- if (!model()->is_within_range(m_cursor_index))
- m_cursor_index = {};
- if (!model()->is_within_range(m_drop_candidate_index))
- m_drop_candidate_index = {};
- selection().remove_matching([this](auto& index) { return !model()->is_within_range(index); });
- }
- m_selection_start_index = {};
- }
- void AbstractView::clear_selection()
- {
- m_selection.clear();
- }
- void AbstractView::set_selection(const ModelIndex& new_index)
- {
- m_selection.set(new_index);
- }
- void AbstractView::set_selection_start_index(const ModelIndex& new_index)
- {
- m_selection_start_index = new_index;
- }
- void AbstractView::add_selection(const ModelIndex& new_index)
- {
- m_selection.add(new_index);
- }
- void AbstractView::remove_selection(const ModelIndex& new_index)
- {
- m_selection.remove(new_index);
- }
- void AbstractView::toggle_selection(const ModelIndex& new_index)
- {
- m_selection.toggle(new_index);
- }
- void AbstractView::did_update_selection()
- {
- if (!model() || selection().first() != m_edit_index)
- stop_editing();
- if (model() && on_selection_change)
- on_selection_change();
- }
- void AbstractView::did_scroll()
- {
- update_edit_widget_position();
- }
- void AbstractView::update_edit_widget_position()
- {
- if (!m_edit_widget)
- return;
- m_edit_widget->set_relative_rect(m_edit_widget_content_rect.translated(-horizontal_scrollbar().value(), -vertical_scrollbar().value()));
- }
- void AbstractView::begin_editing(const ModelIndex& index)
- {
- VERIFY(is_editable());
- VERIFY(model());
- if (m_edit_index == index)
- return;
- if (!model()->is_editable(index))
- return;
- if (m_edit_widget) {
- remove_child(*m_edit_widget);
- m_edit_widget = nullptr;
- }
- m_edit_index = index;
- VERIFY(aid_create_editing_delegate);
- m_editing_delegate = aid_create_editing_delegate(index);
- m_editing_delegate->bind(*model(), index);
- m_editing_delegate->set_value(index.data());
- m_edit_widget = m_editing_delegate->widget();
- add_child(*m_edit_widget);
- m_edit_widget->move_to_back();
- m_edit_widget_content_rect = editing_rect(index).translated(frame_thickness(), frame_thickness());
- update_edit_widget_position();
- m_edit_widget->set_focus(true);
- m_editing_delegate->will_begin_editing();
- m_editing_delegate->on_commit = [this] {
- VERIFY(model());
- model()->set_data(m_edit_index, m_editing_delegate->value());
- stop_editing();
- };
- m_editing_delegate->on_rollback = [this] {
- VERIFY(model());
- stop_editing();
- };
- m_editing_delegate->on_change = [this, index] {
- editing_widget_did_change(index);
- };
- }
- void AbstractView::stop_editing()
- {
- bool take_back_focus = false;
- m_edit_index = {};
- if (m_edit_widget) {
- take_back_focus = m_edit_widget->is_focused();
- remove_child(*m_edit_widget);
- m_edit_widget = nullptr;
- }
- if (take_back_focus)
- set_focus(true);
- }
- void AbstractView::activate(const ModelIndex& index)
- {
- if (on_activation)
- on_activation(index);
- }
- void AbstractView::activate_selected()
- {
- if (!on_activation)
- return;
- selection().for_each_index([this](auto& index) {
- on_activation(index);
- });
- }
- void AbstractView::notify_selection_changed(Badge<ModelSelection>)
- {
- did_update_selection();
- if (!m_suppress_update_on_selection_change)
- update();
- }
- NonnullRefPtr<Gfx::Font> AbstractView::font_for_index(const ModelIndex& index) const
- {
- if (!model())
- return font();
- auto font_data = index.data(ModelRole::Font);
- if (font_data.is_font())
- return font_data.as_font();
- return font();
- }
- void AbstractView::mousedown_event(MouseEvent& event)
- {
- AbstractScrollableWidget::mousedown_event(event);
- if (!model())
- return;
- if (event.button() == MouseButton::Left)
- m_left_mousedown_position = event.position();
- auto index = index_at_event_position(event.position());
- m_might_drag = false;
- if (!index.is_valid()) {
- clear_selection();
- } else if (event.modifiers() & Mod_Ctrl) {
- set_cursor(index, SelectionUpdate::Ctrl);
- } else if (event.modifiers() & Mod_Shift) {
- set_cursor(index, SelectionUpdate::Shift);
- } else if (event.button() == MouseButton::Left && m_selection.contains(index) && !m_model->drag_data_type().is_null()) {
- // We might be starting a drag, so don't throw away other selected items yet.
- m_might_drag = true;
- } else if (event.button() == MouseButton::Right) {
- set_cursor(index, SelectionUpdate::ClearIfNotSelected);
- } else {
- set_cursor(index, SelectionUpdate::Set);
- m_might_drag = true;
- }
- update();
- }
- void AbstractView::set_hovered_index(const ModelIndex& index)
- {
- if (m_hovered_index == index)
- return;
- auto old_index = m_hovered_index;
- m_hovered_index = index;
- did_change_hovered_index(old_index, index);
- if (old_index.is_valid())
- update(to_widget_rect(paint_invalidation_rect(old_index)));
- if (index.is_valid())
- update(to_widget_rect(paint_invalidation_rect(index)));
- }
- void AbstractView::leave_event(Core::Event& event)
- {
- AbstractScrollableWidget::leave_event(event);
- set_hovered_index({});
- }
- void AbstractView::mousemove_event(MouseEvent& event)
- {
- if (!model())
- return AbstractScrollableWidget::mousemove_event(event);
- auto hovered_index = index_at_event_position(event.position());
- set_hovered_index(hovered_index);
- auto data_type = m_model->drag_data_type();
- if (data_type.is_null())
- return AbstractScrollableWidget::mousemove_event(event);
- if (!m_might_drag)
- return AbstractScrollableWidget::mousemove_event(event);
- if (!(event.buttons() & MouseButton::Left) || m_selection.is_empty()) {
- m_might_drag = false;
- return AbstractScrollableWidget::mousemove_event(event);
- }
- auto diff = event.position() - m_left_mousedown_position;
- auto distance_travelled_squared = diff.x() * diff.x() + diff.y() * diff.y();
- constexpr int drag_distance_threshold = 5;
- if (distance_travelled_squared <= drag_distance_threshold)
- return AbstractScrollableWidget::mousemove_event(event);
- VERIFY(!data_type.is_null());
- if (m_is_dragging)
- return;
- // An event might sneak in between us constructing the drag operation and the
- // event loop exec at the end of `drag_operation->exec()' if the user is fast enough.
- // Prevent this by just ignoring later drag initiations (until the current drag operation ends).
- TemporaryChange dragging { m_is_dragging, true };
- dbgln("Initiate drag!");
- auto drag_operation = DragOperation::construct();
- drag_operation->set_mime_data(m_model->mime_data(m_selection));
- auto outcome = drag_operation->exec();
- switch (outcome) {
- case DragOperation::Outcome::Accepted:
- dbgln("Drag was accepted!");
- break;
- case DragOperation::Outcome::Cancelled:
- dbgln("Drag was cancelled!");
- m_might_drag = false;
- break;
- default:
- VERIFY_NOT_REACHED();
- break;
- }
- }
- void AbstractView::mouseup_event(MouseEvent& event)
- {
- AbstractScrollableWidget::mouseup_event(event);
- if (!model())
- return;
- if (m_might_drag) {
- // We were unsure about unselecting items other than the current one
- // in mousedown_event(), because we could be seeing a start of a drag.
- // Since we're here, it was not that; so fix up the selection now.
- auto index = index_at_event_position(event.position());
- if (index.is_valid()) {
- set_selection(index);
- set_selection_start_index(index);
- } else
- clear_selection();
- m_might_drag = false;
- update();
- }
- if (activates_on_selection())
- activate_selected();
- }
- void AbstractView::doubleclick_event(MouseEvent& event)
- {
- if (!model())
- return;
- if (event.button() != MouseButton::Left)
- return;
- m_might_drag = false;
- auto index = index_at_event_position(event.position());
- if (!index.is_valid()) {
- clear_selection();
- return;
- }
- if (!m_selection.contains(index))
- set_selection(index);
- if (is_editable() && edit_triggers() & EditTrigger::DoubleClicked)
- begin_editing(cursor_index());
- else
- activate(cursor_index());
- }
- void AbstractView::context_menu_event(ContextMenuEvent& event)
- {
- if (!model())
- return;
- auto index = index_at_event_position(event.position());
- if (index.is_valid())
- add_selection(index);
- else
- clear_selection();
- if (on_context_menu_request)
- on_context_menu_request(index, event);
- }
- void AbstractView::drop_event(DropEvent& event)
- {
- event.accept();
- if (!model())
- return;
- auto index = index_at_event_position(event.position());
- if (on_drop)
- on_drop(index, event);
- }
- void AbstractView::set_selection_mode(SelectionMode selection_mode)
- {
- if (m_selection_mode == selection_mode)
- return;
- m_selection_mode = selection_mode;
- if (m_selection_mode == SelectionMode::NoSelection)
- m_selection.clear();
- else if (m_selection_mode != SelectionMode::SingleSelection && m_selection.size() > 1) {
- auto first_selected = m_selection.first();
- m_selection.clear();
- m_selection.set(first_selected);
- }
- update();
- }
- void AbstractView::set_key_column_and_sort_order(int column, SortOrder sort_order)
- {
- m_key_column = column;
- m_sort_order = sort_order;
- if (model())
- model()->sort(column, sort_order);
- update();
- }
- void AbstractView::set_cursor(ModelIndex index, SelectionUpdate selection_update, bool scroll_cursor_into_view)
- {
- if (!model() || !index.is_valid() || selection_mode() == SelectionMode::NoSelection) {
- m_cursor_index = {};
- cancel_searching();
- return;
- }
- if (!m_cursor_index.is_valid() || model()->parent_index(m_cursor_index) != model()->parent_index(index))
- cancel_searching();
- if (selection_mode() == SelectionMode::SingleSelection && (selection_update == SelectionUpdate::Ctrl || selection_update == SelectionUpdate::Shift))
- selection_update = SelectionUpdate::Set;
- if (model()->is_within_range(index)) {
- if (selection_update == SelectionUpdate::Set) {
- set_selection(index);
- set_selection_start_index(index);
- } else if (selection_update == SelectionUpdate::Ctrl) {
- toggle_selection(index);
- } else if (selection_update == SelectionUpdate::ClearIfNotSelected) {
- if (!m_selection.contains(index))
- clear_selection();
- } else if (selection_update == SelectionUpdate::Shift) {
- auto min_row = min(selection_start_index().row(), index.row());
- auto max_row = max(selection_start_index().row(), index.row());
- auto min_column = min(selection_start_index().column(), index.column());
- auto max_column = max(selection_start_index().column(), index.column());
- clear_selection();
- for (auto row = min_row; row <= max_row; ++row) {
- for (auto column = min_column; column <= max_column; ++column) {
- auto new_index = model()->index(row, column);
- if (new_index.is_valid())
- toggle_selection(new_index);
- }
- }
- }
- // FIXME: Support the other SelectionUpdate types
- auto old_cursor_index = m_cursor_index;
- m_cursor_index = index;
- did_change_cursor_index(old_cursor_index, m_cursor_index);
- if (scroll_cursor_into_view)
- scroll_into_view(index, true, true);
- update();
- }
- }
- void AbstractView::set_edit_triggers(unsigned triggers)
- {
- m_edit_triggers = triggers;
- }
- void AbstractView::hide_event(HideEvent& event)
- {
- stop_editing();
- AbstractScrollableWidget::hide_event(event);
- }
- void AbstractView::keydown_event(KeyEvent& event)
- {
- if (event.alt()) {
- event.ignore();
- return;
- }
- if (event.key() == KeyCode::Key_F2) {
- if (is_editable() && edit_triggers() & EditTrigger::EditKeyPressed) {
- begin_editing(cursor_index());
- event.accept();
- return;
- }
- }
- if (event.key() == KeyCode::Key_Return) {
- activate_selected();
- event.accept();
- return;
- }
- SelectionUpdate selection_update = SelectionUpdate::Set;
- if (event.modifiers() == KeyModifier::Mod_Shift) {
- selection_update = SelectionUpdate::Shift;
- }
- if (event.key() == KeyCode::Key_Left) {
- move_cursor(CursorMovement::Left, selection_update);
- event.accept();
- return;
- }
- if (event.key() == KeyCode::Key_Right) {
- move_cursor(CursorMovement::Right, selection_update);
- event.accept();
- return;
- }
- if (event.key() == KeyCode::Key_Up) {
- move_cursor(CursorMovement::Up, selection_update);
- event.accept();
- return;
- }
- if (event.key() == KeyCode::Key_Down) {
- move_cursor(CursorMovement::Down, selection_update);
- event.accept();
- return;
- }
- if (event.key() == KeyCode::Key_Home) {
- move_cursor(CursorMovement::Home, selection_update);
- event.accept();
- return;
- }
- if (event.key() == KeyCode::Key_End) {
- move_cursor(CursorMovement::End, selection_update);
- event.accept();
- return;
- }
- if (event.key() == KeyCode::Key_PageUp) {
- move_cursor(CursorMovement::PageUp, selection_update);
- event.accept();
- return;
- }
- if (event.key() == KeyCode::Key_PageDown) {
- move_cursor(CursorMovement::PageDown, selection_update);
- event.accept();
- return;
- }
- if (is_searchable()) {
- if (event.key() == KeyCode::Key_Backspace) {
- if (is_searching()) {
- //if (event.modifiers() == Mod_Ctrl) {
- // TODO: delete last word
- //}
- Utf8View view(m_searching);
- size_t n_code_points = view.length();
- if (n_code_points > 1) {
- n_code_points--;
- StringBuilder sb;
- for (auto it = view.begin(); it != view.end(); ++it) {
- if (n_code_points == 0)
- break;
- n_code_points--;
- sb.append_code_point(*it);
- }
- do_search(sb.to_string());
- start_searching_timer();
- } else {
- cancel_searching();
- }
- event.accept();
- return;
- }
- } else if (event.key() == KeyCode::Key_Escape) {
- if (is_searching()) {
- cancel_searching();
- event.accept();
- return;
- }
- } else if (event.key() != KeyCode::Key_Tab && !event.ctrl() && !event.alt() && event.code_point() != 0) {
- StringBuilder sb;
- sb.append(m_searching);
- sb.append_code_point(event.code_point());
- do_search(sb.to_string());
- start_searching_timer();
- event.accept();
- return;
- }
- }
- AbstractScrollableWidget::keydown_event(event);
- }
- void AbstractView::cancel_searching()
- {
- m_searching = nullptr;
- if (m_searching_timer)
- m_searching_timer->stop();
- if (m_highlighted_search_index.is_valid()) {
- m_highlighted_search_index = {};
- update();
- }
- }
- void AbstractView::start_searching_timer()
- {
- if (!m_searching_timer) {
- m_searching_timer = add<Core::Timer>();
- m_searching_timer->set_single_shot(true);
- m_searching_timer->on_timeout = [this] {
- cancel_searching();
- };
- }
- m_searching_timer->set_interval(5 * 1000);
- m_searching_timer->restart();
- }
- void AbstractView::do_search(String&& searching)
- {
- if (searching.is_empty() || !model()) {
- cancel_searching();
- return;
- }
- auto found_indices = model()->matches(searching, Model::MatchesFlag::FirstMatchOnly | Model::MatchesFlag::MatchAtStart | Model::MatchesFlag::CaseInsensitive, model()->parent_index(cursor_index()));
- if (!found_indices.is_empty() && found_indices[0].is_valid()) {
- auto& index = found_indices[0];
- m_highlighted_search_index = index;
- m_searching = move(searching);
- set_selection(index);
- scroll_into_view(index);
- update();
- }
- }
- bool AbstractView::is_searchable() const
- {
- if (!m_searchable || !model())
- return false;
- return model()->is_searchable();
- }
- void AbstractView::set_searchable(bool searchable)
- {
- if (m_searchable == searchable)
- return;
- m_searchable = searchable;
- if (!m_searchable)
- cancel_searching();
- }
- void AbstractView::draw_item_text(Gfx::Painter& painter, const ModelIndex& index, bool is_selected, const Gfx::IntRect& text_rect, const StringView& item_text, const Gfx::Font& font, Gfx::TextAlignment alignment, Gfx::TextElision elision, size_t search_highlighting_offset)
- {
- if (m_edit_index == index)
- return;
- Color text_color;
- if (is_selected)
- text_color = is_focused() ? palette().selection_text() : palette().inactive_selection_text();
- else
- text_color = index.data(ModelRole::ForegroundColor).to_color(palette().color(foreground_role()));
- if (index == m_highlighted_search_index) {
- Utf8View searching_text(m_searching);
- auto searching_length = searching_text.length();
- if (searching_length > search_highlighting_offset)
- searching_length -= search_highlighting_offset;
- else if (search_highlighting_offset > 0)
- searching_length = 0;
- // Highlight the text background first
- auto background_searching_length = searching_length;
- painter.draw_text([&](const Gfx::IntRect& rect, u32) {
- if (background_searching_length > 0) {
- background_searching_length--;
- painter.fill_rect(rect.inflated(0, 2), palette().highlight_searching());
- }
- },
- text_rect, item_text, font, alignment, elision);
- // Then draw the text
- auto text_searching_length = searching_length;
- auto highlight_text_color = palette().highlight_searching_text();
- searching_length = searching_text.length();
- painter.draw_text([&](const Gfx::IntRect& rect, u32 code_point) {
- if (text_searching_length > 0) {
- text_searching_length--;
- painter.draw_glyph_or_emoji(rect.location(), code_point, font, highlight_text_color);
- } else {
- painter.draw_glyph_or_emoji(rect.location(), code_point, font, text_color);
- }
- },
- text_rect, item_text, font, alignment, elision);
- } else {
- if (m_draw_item_text_with_shadow) {
- painter.draw_text(text_rect.translated(1, 1), item_text, font, alignment, Color::Black, elision);
- painter.draw_text(text_rect, item_text, font, alignment, Color::White, elision);
- } else {
- painter.draw_text(text_rect, item_text, font, alignment, text_color, elision);
- }
- }
- }
- void AbstractView::focusin_event(FocusEvent& event)
- {
- AbstractScrollableWidget::focusin_event(event);
- if (model() && !cursor_index().is_valid()) {
- move_cursor(CursorMovement::Home, SelectionUpdate::None);
- clear_selection();
- }
- }
- void AbstractView::drag_enter_event(DragEvent& event)
- {
- if (!model())
- return;
- // NOTE: Right now, AbstractView always accepts drags since we won't get "drag move" events
- // unless we accept the "drag enter" event.
- // We might be able to reduce event traffic by communicating the set of drag-accepting
- // rects in this widget to the windowing system somehow.
- event.accept();
- dbgln("accepting drag of {}", event.mime_types().first());
- }
- void AbstractView::drag_move_event(DragEvent& event)
- {
- if (!model())
- return;
- auto index = index_at_event_position(event.position());
- ModelIndex new_drop_candidate_index;
- if (index.is_valid()) {
- bool acceptable = model()->accepts_drag(index, event.mime_types());
- if (acceptable)
- new_drop_candidate_index = index;
- }
- if (m_drop_candidate_index != new_drop_candidate_index) {
- m_drop_candidate_index = new_drop_candidate_index;
- update();
- }
- if (m_drop_candidate_index.is_valid())
- event.accept();
- }
- void AbstractView::drag_leave_event(Event&)
- {
- if (m_drop_candidate_index.is_valid()) {
- m_drop_candidate_index = {};
- update();
- }
- }
- }
|