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/Model.h>
30
31namespace GUI {
32
33class SortingProxyModel final : public Model {
34public:
35 static NonnullRefPtr<SortingProxyModel> create(NonnullRefPtr<Model>&& model) { return adopt(*new SortingProxyModel(move(model))); }
36 virtual ~SortingProxyModel() override;
37
38 virtual int row_count(const ModelIndex& = ModelIndex()) const override;
39 virtual int column_count(const ModelIndex& = ModelIndex()) const override;
40 virtual String row_name(int) const override;
41 virtual String column_name(int) const override;
42 virtual ColumnMetadata column_metadata(int) const override;
43 virtual Variant data(const ModelIndex&, Role = Role::Display) const override;
44 virtual void update() override;
45 virtual StringView drag_data_type() const override;
46
47 virtual int key_column() const override { return m_key_column; }
48 virtual SortOrder sort_order() const override { return m_sort_order; }
49 virtual void set_key_column_and_sort_order(int, SortOrder) override;
50
51 ModelIndex map_to_target(const ModelIndex&) const;
52
53private:
54 explicit SortingProxyModel(NonnullRefPtr<Model>&&);
55
56 Model& target() { return *m_target; }
57 const Model& target() const { return *m_target; }
58
59 void resort();
60
61 void set_sorting_case_sensitive(bool b) { m_sorting_case_sensitive = b; }
62 bool is_sorting_case_sensitive() { return m_sorting_case_sensitive; }
63
64 NonnullRefPtr<Model> m_target;
65 Vector<int> m_row_mappings;
66 int m_key_column { -1 };
67 SortOrder m_sort_order { SortOrder::Ascending };
68 bool m_sorting_case_sensitive { false };
69};
70
71}