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 <AK/Traits.h>
30#include <LibGUI/Forward.h>
31
32namespace GUI {
33
34class ModelIndex {
35 friend class Model;
36
37public:
38 ModelIndex() {}
39
40 bool is_valid() const { return m_row != -1 && m_column != -1; }
41 int row() const { return m_row; }
42 int column() const { return m_column; }
43
44 void* internal_data() const { return m_internal_data; }
45
46 ModelIndex parent() const;
47
48 bool operator==(const ModelIndex& other) const
49 {
50 return m_model == other.m_model && m_row == other.m_row && m_column == other.m_column && m_internal_data == other.m_internal_data;
51 }
52
53 bool operator!=(const ModelIndex& other) const
54 {
55 return !(*this == other);
56 }
57
58private:
59 ModelIndex(const Model& model, int row, int column, void* internal_data)
60 : m_model(&model)
61 , m_row(row)
62 , m_column(column)
63 , m_internal_data(internal_data)
64 {
65 }
66
67 const Model* m_model { nullptr };
68 int m_row { -1 };
69 int m_column { -1 };
70 void* m_internal_data { nullptr };
71};
72
73const LogStream& operator<<(const LogStream&, const ModelIndex&);
74
75}
76
77namespace AK {
78template<>
79struct Traits<GUI::ModelIndex> : public GenericTraits<GUI::ModelIndex> {
80 static unsigned hash(const GUI::ModelIndex& index) { return pair_int_hash(index.row(), index.column()); }
81};
82}