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 <AK/HashMap.h>
30#include <LibGUI/AbstractTableView.h>
31
32namespace GUI {
33
34class TreeView : public AbstractTableView {
35 C_OBJECT(TreeView)
36public:
37 virtual ~TreeView() override;
38
39 virtual void scroll_into_view(const ModelIndex&, Gfx::Orientation);
40
41 virtual int item_count() const override;
42 virtual void toggle_index(const ModelIndex&) override;
43
44protected:
45 TreeView();
46
47 virtual void paint_event(PaintEvent&) override;
48 virtual void doubleclick_event(MouseEvent&) override;
49 virtual void keydown_event(KeyEvent&) override;
50 virtual void did_update_selection() override;
51 virtual void did_update_model() override;
52
53private:
54 virtual ModelIndex index_at_event_position(const Gfx::Point&, bool& is_toggle) const override;
55
56 int item_height() const { return 16; }
57 int max_item_width() const { return frame_inner_rect().width(); }
58 int indent_width_in_pixels() const { return 16; }
59 int icon_size() const { return 16; }
60 int icon_spacing() const { return 2; }
61 int toggle_size() const { return 9; }
62 int text_padding() const { return 2; }
63 int tree_column_x_offset() const;
64 virtual void update_column_sizes() override;
65
66 template<typename Callback>
67 void traverse_in_paint_order(Callback) const;
68
69 struct MetadataForIndex;
70
71 MetadataForIndex& ensure_metadata_for_index(const ModelIndex&) const;
72
73 mutable HashMap<void*, NonnullOwnPtr<MetadataForIndex>> m_view_metadata;
74
75 RefPtr<Gfx::Bitmap> m_expand_bitmap;
76 RefPtr<Gfx::Bitmap> m_collapse_bitmap;
77};
78
79}