jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <LibGUI/AbstractView.h>
30
31namespace GUI {
32
33class TableCellPaintingDelegate {
34public:
35 virtual ~TableCellPaintingDelegate() {}
36
37 virtual void paint(Painter&, const Gfx::Rect&, const Gfx::Palette&, const Model&, const ModelIndex&) = 0;
38};
39
40class AbstractTableView : public AbstractView {
41public:
42 int item_height() const { return 16; }
43
44 bool alternating_row_colors() const { return m_alternating_row_colors; }
45 void set_alternating_row_colors(bool b) { m_alternating_row_colors = b; }
46
47 int header_height() const { return m_headers_visible ? 16 : 0; }
48
49 bool headers_visible() const { return m_headers_visible; }
50 void set_headers_visible(bool headers_visible) { m_headers_visible = headers_visible; }
51
52 bool is_column_hidden(int) const;
53 void set_column_hidden(int, bool);
54
55 void set_size_columns_to_fit_content(bool b) { m_size_columns_to_fit_content = b; }
56 bool size_columns_to_fit_content() const { return m_size_columns_to_fit_content; }
57
58 void set_cell_painting_delegate(int column, OwnPtr<TableCellPaintingDelegate>&&);
59
60 int horizontal_padding() const { return m_horizontal_padding; }
61
62 Gfx::Point adjusted_position(const Gfx::Point&) const;
63
64 virtual Gfx::Rect content_rect(const ModelIndex&) const override;
65 Gfx::Rect content_rect(int row, int column) const;
66 Gfx::Rect row_rect(int item_index) const;
67
68 void scroll_into_view(const ModelIndex&, Orientation);
69
70 virtual ModelIndex index_at_event_position(const Gfx::Point&, bool& is_toggle) const;
71 virtual ModelIndex index_at_event_position(const Gfx::Point&) const override;
72
73 virtual void select_all() override;
74protected:
75 virtual ~AbstractTableView() override;
76 AbstractTableView();
77
78 virtual void did_update_model() override;
79 virtual void mouseup_event(MouseEvent&) override;
80 virtual void mousedown_event(MouseEvent&) override;
81 virtual void mousemove_event(MouseEvent&) override;
82 virtual void doubleclick_event(MouseEvent&) override;
83 virtual void keydown_event(KeyEvent&) override;
84 virtual void leave_event(Core::Event&) override;
85 virtual void context_menu_event(ContextMenuEvent&) override;
86
87 virtual void toggle_index(const ModelIndex&) {}
88
89 void paint_headers(Painter&);
90 Gfx::Rect header_rect(int column) const;
91
92 static const Gfx::Font& header_font();
93 void update_headers();
94 void set_hovered_header_index(int);
95
96 struct ColumnData {
97 int width { 0 };
98 bool has_initialized_width { false };
99 bool visibility { true };
100 RefPtr<Action> visibility_action;
101 OwnPtr<TableCellPaintingDelegate> cell_painting_delegate;
102 };
103 ColumnData& column_data(int column) const;
104
105 mutable Vector<ColumnData> m_column_data;
106
107 Menu& ensure_header_context_menu();
108 RefPtr<Menu> m_header_context_menu;
109
110 Gfx::Rect column_resize_grabbable_rect(int) const;
111 int column_width(int) const;
112 void update_content_size();
113 virtual void update_column_sizes();
114 virtual int item_count() const;
115
116private:
117 bool m_headers_visible { true };
118 bool m_size_columns_to_fit_content { false };
119 bool m_in_column_resize { false };
120 bool m_alternating_row_colors { true };
121 int m_horizontal_padding { 5 };
122 Gfx::Point m_column_resize_origin;
123 int m_column_resize_original_width { 0 };
124 int m_resizing_column { -1 };
125 int m_pressed_column_header_index { -1 };
126 bool m_pressed_column_header_is_pressed { false };
127 int m_hovered_column_header_index { -1 };
128};
129
130}