summaryrefslogtreecommitdiff
path: root/Libraries/LibGUI/AbstractView.h
blob: 7910871952acb714ae9097d1513ba80694bab68e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <AK/Function.h>
#include <LibGUI/ModelSelection.h>
#include <LibGUI/ScrollableWidget.h>

namespace GUI {

class AbstractView : public ScrollableWidget {
    C_OBJECT_ABSTRACT(AbstractView)

public:
    void set_model(RefPtr<Model>);
    Model* model() { return m_model.ptr(); }
    const Model* model() const { return m_model.ptr(); }

    ModelSelection& selection() { return m_selection; }
    const ModelSelection& selection() const { return m_selection; }
    virtual void select_all() = 0;

    bool is_editable() const { return m_editable; }
    void set_editable(bool editable) { m_editable = editable; }

    bool is_multi_select() const { return m_multi_select; }
    void set_multi_select(bool);

    virtual bool accepts_focus() const override { return true; }
    virtual void did_update_model(unsigned flags);
    virtual void did_update_selection();

    virtual Gfx::IntRect content_rect(const ModelIndex&) const { return {}; }
    virtual ModelIndex index_at_event_position(const Gfx::IntPoint&) const = 0;
    void begin_editing(const ModelIndex&);
    void stop_editing();

    void set_activates_on_selection(bool b) { m_activates_on_selection = b; }
    bool activates_on_selection() const { return m_activates_on_selection; }

    Function<void()> on_selection_change;
    Function<void(const ModelIndex&)> on_activation;
    Function<void(const ModelIndex&)> on_selection;
    Function<void(const ModelIndex&, const ContextMenuEvent&)> on_context_menu_request;
    Function<void(const ModelIndex&, const DropEvent&)> on_drop;

    Function<OwnPtr<ModelEditingDelegate>(const ModelIndex&)> aid_create_editing_delegate;

    void notify_selection_changed(Badge<ModelSelection>);

    NonnullRefPtr<Gfx::Font> font_for_index(const ModelIndex&) const;

    void set_last_valid_hovered_index(const ModelIndex&);

protected:
    AbstractView();
    virtual ~AbstractView() override;

    virtual void mousedown_event(MouseEvent&) override;
    virtual void mousemove_event(MouseEvent&) override;
    virtual void mouseup_event(MouseEvent&) override;
    virtual void doubleclick_event(MouseEvent&) override;
    virtual void context_menu_event(ContextMenuEvent&) override;
    virtual void drop_event(DropEvent&) override;
    virtual void leave_event(Core::Event&) override;

    virtual void clear_selection();
    virtual void set_selection(const ModelIndex&);
    virtual void add_selection(const ModelIndex&);
    virtual void remove_selection(const ModelIndex&);
    virtual void toggle_selection(const ModelIndex&);

    virtual void did_scroll() override;
    void set_hovered_index(const ModelIndex&);
    void activate(const ModelIndex&);
    void activate_selected();
    void update_edit_widget_position();

    bool m_editable { false };
    ModelIndex m_edit_index;
    RefPtr<Widget> m_edit_widget;
    Gfx::IntRect m_edit_widget_content_rect;

    Gfx::IntPoint m_left_mousedown_position;
    bool m_might_drag { false };

    ModelIndex m_hovered_index;
    ModelIndex m_last_valid_hovered_index;

private:
    RefPtr<Model> m_model;
    OwnPtr<ModelEditingDelegate> m_editing_delegate;
    ModelSelection m_selection;
    bool m_activates_on_selection { false };
    bool m_multi_select { true };
};

}