beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-26 17:40:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
ladybird/Libraries/LibGUI/SortingProxyModel.h

92 lines
3.7 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 08:38:21 +00:00
/*
* 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.
*/
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 12:33:52 +00:00
#pragma once
LibGUI: Remove leading G from filenames
2020-02-06 19:33:02 +00: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 12:33:52 +00: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 14:07:41 +00: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 11:59:47 +00:00
class SortingProxyModel
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 13:58:47 +00: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 12:47:26 +00: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 12:33:52 +00:00
public:
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 13:58:47 +00:00
static NonnullRefPtr<SortingProxyModel> create(NonnullRefPtr<Model> source) { return adopt(*new 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 14:07:41 +00: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 12:33:52 +00: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 14:07:41 +00:00
virtual int row_count(const ModelIndex& = ModelIndex()) const override;
virtual int column_count(const ModelIndex& = ModelIndex()) 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 12:33:52 +00:00
virtual String column_name(int) const override;
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 14:07:41 +00:00
virtual Variant data(const ModelIndex&, Role = Role::Display) 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 12:33:52 +00:00
virtual void update() 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 18:15:46 +00:00
virtual StringView drag_data_type() const override;
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 17:22:32 +00:00
virtual ModelIndex parent_index(const ModelIndex&) const override;
virtual ModelIndex index(int row, int column, const ModelIndex& parent) 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 12:33:52 +00:00
virtual int key_column() const override { return m_key_column; }
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 14:07:41 +00:00
virtual SortOrder sort_order() const override { return m_sort_order; }
virtual void set_key_column_and_sort_order(int, SortOrder) override;
LibGUI: Replace ColumnMetadata::sortable => Model::is_column_sortable() Now there's only one thing left in ColumnMetadata: the initial width.
2020-05-21 17:45:15 +00: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 12:33:52 +00:00
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 11:59:47 +00:00
virtual bool less_than(const ModelIndex&, const ModelIndex&) const;
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 13:58:47 +00:00
ModelIndex map_to_source(const ModelIndex&) const;
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 17:22:32 +00:00
ModelIndex map_to_proxy(const ModelIndex&) 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 12:33:52 +00:00
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 16:40:21 +00:00
Role sort_role() const { return m_sort_role; }
void set_sort_role(Role role) { m_sort_role = role; }
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 12:33:52 +00:00
private:
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 13:58:47 +00: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 02:27:07 +00:00
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 17:22:32 +00:00
// NOTE: The internal_data() of indexes points to the corresponding Mapping object for that index.
struct Mapping {
Vector<int> source_rows;
Vector<int> proxy_rows;
ModelIndex source_parent;
};
using InternalMapIterator = HashMap<ModelIndex, NonnullOwnPtr<Mapping>>::IteratorType;
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 18:06:14 +00: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 12:47:26 +00:00
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 13:58:47 +00:00
Model& source() { return *m_source; }
const Model& 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 12:33:52 +00:00
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 17:22:32 +00:00
void invalidate(unsigned flags = Model::UpdateFlag::DontInvalidateIndexes);
InternalMapIterator build_mapping(const ModelIndex& 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 12:33:52 +00:00
LibGUI: Rename SortingProxyModel "target" to "source" instead
2020-08-13 13:58:47 +00: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 17:22:32 +00:00
HashMap<ModelIndex, NonnullOwnPtr<Mapping>> m_mappings;
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 12:33:52 +00:00
int m_key_column { -1 };
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 14:07:41 +00:00
SortOrder m_sort_order { SortOrder::Ascending };
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 16:40:21 +00:00
Role m_sort_role { Role::Sort };
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 12:33:52 +00: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 14:07:41 +00:00
}
Reference in a new issue Copy permalink