Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-11-03 23:00:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Userland/Libraries/LibGUI/TreeView.h

86 lines
2.8 KiB
C
Raw Normal View History

Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
Libraries: Use default constructors/destructors in LibGUI https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#cother-other-default-operation-rules "The compiler is more likely to get the default semantics right and you cannot implement these functions better than the compiler."
2022-02-26 10:50:04 -07:00
* Copyright (c) 2022, the SerenityOS developers.
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 01:24:48 -07:00
* SPDX-License-Identifier: BSD-2-Clause
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
*/
LibGUI: Start working on a GTreeView class.
2019-03-29 04:00:07 +01:00
#pragma once
LibGUI: Add forwarding header This patch adds <LibGUI/Forward.h> and uses it a bunch. It also dragged various header dependency reduction changes into it.
2020-02-16 09:17:49 +01:00
#include <AK/HashMap.h>
LibGUI: Remove leading G from filenames
2020-02-06 20:33:02 +01:00
#include <LibGUI/AbstractTableView.h>
LibGUI: Start working on a GTreeView class.
2019-03-29 04:00:07 +01:00
LibGUI: Put all classes in the GUI namespace and remove the leading G This took me a moment. Welcome to the new world of GUI::Widget! :^)
2020-02-02 15:07:41 +01:00
namespace GUI {
class TreeView : public AbstractTableView {
C_OBJECT(TreeView)
LibGUI: Start working on a GTreeView class.
2019-03-29 04:00:07 +01:00
public:
Libraries: Use default constructors/destructors in LibGUI https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#cother-other-default-operation-rules "The compiler is more likely to get the default semantics right and you cannot implement these functions better than the compiler."
2022-02-26 10:50:04 -07:00
virtual ~TreeView() override = default;
LibGUI: Start working on a GTreeView class.
2019-03-29 04:00:07 +01:00
Everywhere: Run clang-format
2022-04-01 20:58:27 +03:00
virtual void scroll_into_view(ModelIndex const&, bool scroll_horizontally, bool scroll_vertically) override;
LibGUI: Start working on a GTreeView class.
2019-03-29 04:00:07 +01:00
LibGUI: Make GTreeView inherit from GAbstractColumnView This makes GTreeView able to support multi-column models! Only one column can be the "tree column", this is column 0 by default but can be changed by overriding GModel::tree_column().
2019-12-13 23:36:36 +01:00
virtual int item_count() const override;
Everywhere: Run clang-format
2022-04-01 20:58:27 +03:00
virtual void toggle_index(ModelIndex const&) override;
LibGUI: Add is_toggled getter for TreeView This has safer fallbacks than toggle_index, because we want to be able to call it on indices that don't have children.
2022-04-05 00:19:52 +02:00
bool is_toggled(ModelIndex const& index);
LibGUI: Make GTreeView inherit from GAbstractColumnView This makes GTreeView able to support multi-column models! Only one column can be the "tree column", this is column 0 by default but can be changed by overriding GModel::tree_column().
2019-12-13 23:36:36 +01:00
Everywhere: Run clang-format
2022-04-01 20:58:27 +03:00
void expand_tree(ModelIndex const& root = {});
void collapse_tree(ModelIndex const& root = {});
LibGUI: Allow expand/collapse subtrees in TreeView with Alt+Left/Right This makes TreeView a lot more keyboard friendly.
2020-05-21 13:36:08 +02:00
Everywhere: Run clang-format
2022-04-01 20:58:27 +03:00
void expand_all_parents_of(ModelIndex const&);
LibGUI: Add TreeView::expand_all_parents_of(ModelIndex) This does exactly what it sounds like. :^)
2020-09-18 18:38:27 +02:00
Everywhere: Run clang-format
2022-04-01 20:58:27 +03:00
Function<void(ModelIndex const&, bool const)> on_toggle;
LibGUI: Add on_toggle function to TreeView This adds a function to expose the index and open/close state of expandible nodes in TreeView.
2020-07-07 07:12:12 -04:00
LibGUI: Shrink the default selection rect of TreeView items Instead of filling the whole row with selection color, only fill behind the text. This gives a snugger, more focused appearance. For embedders that want the entire row to get filled with the selection color when selected, they can opt in to the old behavior by calling TreeView::set_should_fill_selected_rows(). This is used by Profiler.
2020-10-27 20:33:30 +01:00
void set_should_fill_selected_rows(bool fill) { m_should_fill_selected_rows = fill; }
bool should_fill_selected_rows() const { return m_should_fill_selected_rows; }
LibGUI: Add variable padding and center bitmaps in TableViews This lets us make nicer looking bitmap tables and fixes a content rect issue in TreeView. Also makes key column highlighting optional
2021-03-11 10:35:40 -05:00
virtual int vertical_padding() const override { return m_vertical_padding; }
LibGUI: Tighten paint invalidation rects in item views :^) AbstractView now has a paint_invalidation_rect(index) function that subclasses can override to provide a tighter invalidation rect for an index.
2021-07-10 17:11:04 +02:00
virtual Gfx::IntRect content_rect(ModelIndex const&) const override;
virtual Gfx::IntRect paint_invalidation_rect(ModelIndex const& index) const override { return content_rect(index); }
LibGUI: Do not allow tree column to shrink beyond indent and icon We always display the tree indent and the icon, so we shouldn't allow the tree column to shrink beyond that size.
2021-08-08 09:52:15 +00:00
virtual int minimum_column_width(int column) override;
LibGUI: Start working on a GTreeView class.
2019-03-29 04:00:07 +01:00
protected:
LibGUI: Remove parent parameter to GUI::Widget constructor
2020-02-23 12:07:13 +01:00
TreeView();
LibGUI: Convert GTreeView to ObjectPtr
2019-09-21 16:06:43 +02:00
LibGUI: Put all classes in the GUI namespace and remove the leading G This took me a moment. Welcome to the new world of GUI::Widget! :^)
2020-02-02 15:07:41 +01:00
virtual void paint_event(PaintEvent&) override;
virtual void doubleclick_event(MouseEvent&) override;
virtual void keydown_event(KeyEvent&) override;
LibGUI: Add AbstractView::move_cursor() and share some movement logic A view can now be told to move its cursor in one of multiple directions as specified by the CursorMovement enum. View subclasses can override move_cursor(CursorMovement) to implement their own cursor behavior. By default, AbstractView::move_cursor() is a no-op. This patch improves code sharing between TableView and TreeView. :^)
2020-08-27 17:47:19 +02:00
FileManager: Make the tree view follow the directory view navigations.
2019-03-30 03:27:25 +01:00
virtual void did_update_selection() override;
LibGUI: Remove `AbstractView::did_update_model()' ...and use `ModelClient::model_did_update()' instead. This makes AbstractView a ModelClient (which it always was anyway).
2020-11-26 11:10:14 +03:30
virtual void model_did_update(unsigned flags) override;
LibGUI: Add a cursor to AbstractView, separate from the selection Views now have a cursor index (retrievable via cursor_index()) which is separate from the selection. Until now, we've been using the first entry in the selection as "the cursor", which gets messy whenever you want to select more than one index in the model. When setting the cursor, the selection is implicitly updated as well to maintain the old behavior (for the most part.) Going forward, this will make it much easier to implement things like shift-select (extend selection from cursor) and such. :^)
2020-08-27 18:36:31 +02:00
virtual void move_cursor(CursorMovement, SelectionUpdate) override;
LibGUI: Start working on a GTreeView class.
2019-03-29 04:00:07 +01:00
private:
Everywhere: Run clang-format
2022-04-01 20:58:27 +03:00
virtual ModelIndex index_at_event_position(Gfx::IntPoint const&, bool& is_toggle) const override;
LibGUI: Make GTreeView inherit from GAbstractColumnView This makes GTreeView able to support multi-column models! Only one column can be the "tree column", this is column 0 by default but can be changed by overriding GModel::tree_column().
2019-12-13 23:36:36 +01:00
LibGUI: Make AbstractTableView row height configurable The row height is per-table, not per-row, but this is still nice.
2020-08-26 20:34:07 +02:00
int row_height() const { return 16; }
GTreeView: A bunch of work on the tree view.
2019-03-29 14:46:53 +01:00
int max_item_width() const { return frame_inner_rect().width(); }
GTreeView: More implementation work.
2019-03-29 18:10:36 +01:00
int indent_width_in_pixels() const { return 16; }
GTreeView: A bunch of work on the tree view.
2019-03-29 14:46:53 +01:00
int icon_size() const { return 16; }
GTreeView: Tweak line tree back and forth a bit.
2019-03-30 01:42:16 +01:00
int icon_spacing() const { return 2; }
GTreeView: Add expand/collapse buttons to items with children.
2019-03-29 20:18:15 +01:00
int toggle_size() const { return 9; }
GTreeView: Tweak line tree back and forth a bit.
2019-03-30 01:42:16 +01:00
int text_padding() const { return 2; }
LibGUI: Fix broken TreeView rendering with more than two columns The computation of the tree column x offset was not taking padding into account. This patch fixes that and collects the logic in a helper.
2020-03-02 21:36:01 +01:00
int tree_column_x_offset() const;
LibGUI: Make GTreeView inherit from GAbstractColumnView This makes GTreeView able to support multi-column models! Only one column can be the "tree column", this is column 0 by default but can be changed by overriding GModel::tree_column().
2019-12-13 23:36:36 +01:00
virtual void update_column_sizes() override;
LibGUI: Support double-click resizing multi-column TreeViews
2021-03-18 22:37:52 -04:00
virtual void auto_resize_column(int column) override;
GTreeView: A bunch of work on the tree view.
2019-03-29 14:46:53 +01:00
GTreeView: Factor paint traversal into a shared function. This way it can be used by hit testing as well, guaranteeing that everything stays consistent.
2019-03-29 17:30:27 +01:00
template<typename Callback>
void traverse_in_paint_order(Callback) const;
GTreeView: A bunch of work on the tree view.
2019-03-29 14:46:53 +01:00
struct MetadataForIndex;
Everywhere: Run clang-format
2022-04-01 20:58:27 +03:00
MetadataForIndex& ensure_metadata_for_index(ModelIndex const&) const;
void set_open_state_of_all_in_subtree(ModelIndex const& root, bool open);
GTreeView: A bunch of work on the tree view.
2019-03-29 14:46:53 +01:00
LibGUI: Associate model index metadata directly with the model index This was using internal_data beforehand, which relies on the internal data to be distinct for different model indices. That's not the case for example for SortingProxyModel. Using the model index directly makes tree expansion work properly when using a tree table widget with a SortingProxyModel.
2022-04-05 00:16:49 +02:00
mutable HashMap<ModelIndex, NonnullOwnPtr<MetadataForIndex>> m_view_metadata;
GTreeView: More implementation work.
2019-03-29 18:10:36 +01:00
LibDraw: Put all classes in the Gfx namespace I started adding things to a Draw namespace, but it somehow felt really wrong seeing Draw::Rect and Draw::Bitmap, etc. So instead, let's rename the library to LibGfx. :^)
2020-02-06 11:56:38 +01:00
RefPtr<Gfx::Bitmap> m_expand_bitmap;
RefPtr<Gfx::Bitmap> m_collapse_bitmap;
LibGUI: Shrink the default selection rect of TreeView items Instead of filling the whole row with selection color, only fill behind the text. This gives a snugger, more focused appearance. For embedders that want the entire row to get filled with the selection color when selected, they can opt in to the old behavior by calling TreeView::set_should_fill_selected_rows(). This is used by Profiler.
2020-10-27 20:33:30 +01:00
bool m_should_fill_selected_rows { false };
LibGUI: Add variable padding and center bitmaps in TableViews This lets us make nicer looking bitmap tables and fixes a content rect issue in TreeView. Also makes key column highlighting optional
2021-03-11 10:35:40 -05:00
int m_vertical_padding { 6 };
LibGUI: Start working on a GTreeView class.
2019-03-29 04:00:07 +01:00
};
LibGUI: Put all classes in the GUI namespace and remove the leading G This took me a moment. Welcome to the new world of GUI::Widget! :^)
2020-02-02 15:07:41 +01:00
}
Reference in a new issue Copy permalink