mirrors/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-01-24 10:12:25 -05:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Userland/Libraries/LibGUI/SortingProxyModel.h

83 lines
2.9 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>
*
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
*/
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +01:00
#pragma once
LibGUI: Remove leading G from filenames
2020-02-06 20:33:02 +01:00
#include <LibGUI/Model.h>
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +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 {
LibGUI: Virtualize SortingProxyModel comparator This patch adds SortingProxyModel::less_than(ModelIndex, ModelIndex) which is now used to implement the sort order. This allows you to subclass SortingProxyModel if you want to tweak how sorting works. Get rid of the awkward case sensitivity logic in SortingProxyModel since that can now be done outside. Turns out nobody was actually using it anyway, but it seems like something we will want to do in the future someday.
2020-08-15 13:59:47 +02:00
class SortingProxyModel
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 15:58:47 +02:00
: public Model
LibGUI: Add ModelClient abstract class and allow registering clients This solves a problem where the SortingProxyModel doesn't receive the on_update call because other code overwrote the handler later on.
2020-07-11 06:47:26 -06:00
, private ModelClient {
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +01:00
public:
LibGUI+Userland: Make SortingProxyModel::create() return ErrorOr Unfortunately, most of the users are inside constructors, (and two others are inside callback lambdas) so the error can't propagate, but that can be improved later.
2021-12-24 12:12:04 +00:00
static ErrorOr<NonnullRefPtr<SortingProxyModel>> create(NonnullRefPtr<Model> source)
{
return adopt_nonnull_ref_or_enomem(new (nothrow) SortingProxyModel(move(source)));
}
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 ~SortingProxyModel() override;
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +01:00
LibGUI: Delegate the tree column in SortingProxyModel This was never properly delegated to the source model, so the tree column would just always be zero.
2022-04-04 22:42:42 +02:00
virtual int tree_column() const override { return m_source->tree_column(); }
LibGUI: West Const to East Const refactor
2021-09-07 18:14:34 +02:00
virtual int row_count(ModelIndex const& = ModelIndex()) const override;
virtual int column_count(ModelIndex const& = ModelIndex()) const override;
AK+Everywhere: Rename String to DeprecatedString We have a new, improved string type coming up in AK (OOM aware, no null state), and while it's going to use UTF-8, the name UTF8String is a mouthful - so let's free up the String name by renaming the existing class. Making the old one have an annoying name will hopefully also help with quick adoption :^)
2022-12-04 18:02:33 +00:00
virtual DeprecatedString column_name(int) const override;
LibGUI: West Const to East Const refactor
2021-09-07 18:14:34 +02:00
virtual Variant data(ModelIndex const&, ModelRole = ModelRole::Display) const override;
Everywhere: Replace Model::update() with Model::invalidate() Most of the models were just calling did_update anyway, which is pointless since it can be unified to the base Model class. Instead, code calling update() will now call invalidate(), which functions identically and is more obvious in what it does. Additionally, a default implementation is provided, which removes the need to add empty implementations of update() for each model subclass. Co-Authored-By: Ali Mohammad Pur <ali.mpfard@gmail.com>
2021-05-25 14:13:19 +00:00
virtual void invalidate() override;
LibGUI: Let GModel specify the drag data type GModel subclasses can now override drag_data_type() to specify which type GAbstractView should set for drag data. The default implementation returns a null string, which disables dragging from this widget.
2020-01-22 21:15:46 +03:00
virtual StringView drag_data_type() const override;
LibGUI: West Const to East Const refactor
2021-09-07 18:14:34 +02:00
virtual ModelIndex parent_index(ModelIndex const&) const override;
virtual ModelIndex index(int row, int column, ModelIndex const& parent) const override;
virtual bool is_editable(ModelIndex const&) const override;
LibGUI: Implement searching/jumping as you type in views This allows the user to start typing and highlighting and jumping to a match in ColumnsView, IconView, TableView and TreeView if the model supports it.
2020-10-20 15:13:28 -06:00
virtual bool is_searchable() const override;
LibGUI: West Const to East Const refactor
2021-09-07 18:14:34 +02:00
virtual void set_data(ModelIndex const&, Variant const&) override;
Everywhere: Pass AK::StringView by value
2021-11-11 00:55:02 +01:00
virtual Vector<ModelIndex> matches(StringView, unsigned = MatchesFlag::AllMatching, ModelIndex const& = ModelIndex()) override;
AK+Everywhere: Rename String to DeprecatedString We have a new, improved string type coming up in AK (OOM aware, no null state), and while it's going to use UTF-8, the name UTF8String is a mouthful - so let's free up the String name by renaming the existing class. Making the old one have an annoying name will hopefully also help with quick adoption :^)
2022-12-04 18:02:33 +00:00
virtual bool accepts_drag(ModelIndex const&, Vector<DeprecatedString> const& mime_types) const override;
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +01:00
LibGUI: Replace ColumnMetadata::sortable => Model::is_column_sortable() Now there's only one thing left in ColumnMetadata: the initial width.
2020-05-21 19:45:15 +02:00
virtual bool is_column_sortable(int column_index) const override;
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +01:00
LibGUI: West Const to East Const refactor
2021-09-07 18:14:34 +02:00
virtual bool less_than(ModelIndex const&, ModelIndex const&) const;
LibGUI: Virtualize SortingProxyModel comparator This patch adds SortingProxyModel::less_than(ModelIndex, ModelIndex) which is now used to implement the sort order. This allows you to subclass SortingProxyModel if you want to tweak how sorting works. Get rid of the awkward case sensitivity logic in SortingProxyModel since that can now be done outside. Turns out nobody was actually using it anyway, but it seems like something we will want to do in the future someday.
2020-08-15 13:59:47 +02:00
LibGUI: West Const to East Const refactor
2021-09-07 18:14:34 +02:00
ModelIndex map_to_source(ModelIndex const&) const;
ModelIndex map_to_proxy(ModelIndex const&) const;
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +01:00
LibGUI: Move GUI::Model::Role to GUI::ModelRole This is preparation for using ModelRole in the ModelIndex API.
2020-08-16 16:00:07 +02:00
ModelRole sort_role() const { return m_sort_role; }
void set_sort_role(ModelRole role) { m_sort_role = role; }
LibGUI: Add SortingProxyModel::sort_role() This allows you to specify a role to sort by. Defaults to Role::Sort. Also reordered the Role enum so that Role::Custom is last.
2020-07-04 18:40:21 +02:00
LibGUI: Make model sorting imperative and move order to AbstractView Instead of SortingProxyModel having a column+order, we move that state to AbstractView. When you click on a column header, the view tells the model to resort the relevant column with the new order. This is implemented in SortingProxyModel by simply walking all the reified source/proxy mappings and resorting their row indexes.
2020-08-16 10:44:10 +02:00
virtual void sort(int column, SortOrder) override;
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +01:00
private:
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 15:58:47 +02:00
explicit SortingProxyModel(NonnullRefPtr<Model> source);
LibGUI: Make GTableModel a retainable object. It became clear that this class needs to support multiple owners.
2019-03-20 03:27:07 +01:00
Everywhere: "indexes" => "indices" I've wasted a silly amount of time in the past fretting over which of these words to use. Let's just choose one and use it everywhere. :^)
2021-04-29 22:23:52 +02:00
// NOTE: The internal_data() of indices points to the corresponding Mapping object for that index.
LibGUI: Make SortingProxyModel support hierarchical models We now create multiple levels of internal mappings between source and proxy indexes, to support tree models. This breaks selection update after resort, which we'll have to deal with somehow.
2020-08-15 19:22:32 +02:00
struct Mapping {
Vector<int> source_rows;
Vector<int> proxy_rows;
ModelIndex source_parent;
};
using InternalMapIterator = HashMap<ModelIndex, NonnullOwnPtr<Mapping>>::IteratorType;
LibGUI: Make model sorting imperative and move order to AbstractView Instead of SortingProxyModel having a column+order, we move that state to AbstractView. When you click on a column header, the view tells the model to resort the relevant column with the new order. This is implemented in SortingProxyModel by simply walking all the reified source/proxy mappings and resorting their row indexes.
2020-08-16 10:44:10 +02:00
void sort_mapping(Mapping&, int column, SortOrder);
LibGUI: Rename ModelClient::on_model_update() => model_did_update() This follows the typical client callback naming scheme used elsewhere and doesn't collide with the "on_foo" Function hook convention.
2020-08-13 20:06:14 +02:00
// ^ModelClient
virtual void model_did_update(unsigned) override;
LibGUI: Add ModelClient abstract class and allow registering clients This solves a problem where the SortingProxyModel doesn't receive the on_update call because other code overwrote the handler later on.
2020-07-11 06:47:26 -06:00
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 15:58:47 +02:00
Model& source() { return *m_source; }
LibGUI: West Const to East Const refactor
2021-09-07 18:14:34 +02:00
Model const& source() const { return *m_source; }
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +01:00
Everywhere: Replace Model::update() with Model::invalidate() Most of the models were just calling did_update anyway, which is pointless since it can be unified to the base Model class. Instead, code calling update() will now call invalidate(), which functions identically and is more obvious in what it does. Additionally, a default implementation is provided, which removes the need to add empty implementations of update() for each model subclass. Co-Authored-By: Ali Mohammad Pur <ali.mpfard@gmail.com>
2021-05-25 14:13:19 +00:00
void update_sort(unsigned = UpdateFlag::DontInvalidateIndices);
LibGUI: West Const to East Const refactor
2021-09-07 18:14:34 +02:00
InternalMapIterator build_mapping(ModelIndex const& proxy_index);
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +01:00
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 15:58:47 +02:00
NonnullRefPtr<Model> m_source;
LibGUI: Make SortingProxyModel support hierarchical models We now create multiple levels of internal mappings between source and proxy indexes, to support tree models. This breaks selection update after resort, which we'll have to deal with somehow.
2020-08-15 19:22:32 +02:00
HashMap<ModelIndex, NonnullOwnPtr<Mapping>> m_mappings;
LibGUI: Move GUI::Model::Role to GUI::ModelRole This is preparation for using ModelRole in the ModelIndex API.
2020-08-16 16:00:07 +02:00
ModelRole m_sort_role { ModelRole::Sort };
LibGUI: Make model sorting imperative and move order to AbstractView Instead of SortingProxyModel having a column+order, we move that state to AbstractView. When you click on a column header, the view tells the model to resort the relevant column with the new order. This is implemented in SortingProxyModel by simply walking all the reified source/proxy mappings and resorting their row indexes.
2020-08-16 10:44:10 +02:00
int m_last_key_column { -1 };
SortOrder m_last_sort_order { SortOrder::Ascending };
Make it possible to sort a GTableModel by column+order. This is accomplished by putting a GSortingProxyTableModel between the model and the view. It's pretty simplistic but it works for this use case. :^)
2019-03-09 13:33:52 +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