File: ModelSupport.h

package info (click to toggle)
calligra 1%3A3.2.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 260,432 kB
  • sloc: cpp: 650,911; xml: 27,662; python: 6,044; perl: 2,724; yacc: 1,817; ansic: 1,325; sh: 1,277; lex: 1,107; ruby: 1,010; javascript: 495; makefile: 24
file content (159 lines) | stat: -rw-r--r-- 5,251 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/* This file is part of the KDE project
   Copyright 2010 Stefan Nikolaus <stefan.nikolaus@kdemail.net>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KSPREAD_MODEL_SUPPORT
#define KSPREAD_MODEL_SUPPORT

#include <QAbstractItemModel>
#include <QItemSelection>

#include "Cell.h"
#include "Region.h"
#include "Sheet.h"

namespace Calligra
{
namespace Sheets
{

/**
 * Item roles representing sheet data.
 * \ingroup Model
 */
enum SheetDataRole {
    // Qt::UserRole = 32
    // Sheet properties; MapModel, MapViewModel
    VisibilityRole      = Qt::UserRole, ///< sheet visibility; bool
    ProtectionRole,                     ///< sheet protection; bool
    ActivityRole                        ///< active sheet; bool
};


/**
 * Item roles representing cell data.
 * \ingroup Model
 */
enum CellDataRole {
    // Qt::UserRole     = 0x00000020 = 32
    NoCellDataRole      = Qt::UserRole, ///< used for iterating over all data, default and non-default
    // Cell contents; SheetModel, RegionModel
    UserInputRole       = 0x00000100,   ///< cell's user input; QString
    FormulaRole         = 0x00000200,   ///< cell's formula; Formula
    ValueRole           = 0x00000400,   ///< cell's value; Value
    LinkRole            = 0x00000800,   ///< cell's hyperlink; QString
    RichTextRole        = 0x00001000,   ///< cell's rich text; QSharedPointer<QTextDocument>
    // Cell range associations; SheetModel, RegionModel
    CommentRole         = 0x00002000,   ///< a comment; QString
    ConditionRole       = 0x00004000,   ///< a conditional style; Conditions
    StyleRole           = 0x00008000,   ///< a style; Style
    ValidityRole        = 0x00010000,   ///< a cell validition; Validity
    FusionedRangeRole   = 0x00020000,   ///< a fusioned cell range; bool
    LockedRangeRole     = 0x00040000,   ///< a locked cell range; bool
    NamedAreaRole       = 0x00080000,   ///< a named area; QString
    SourceRangeRole     = 0x00100000,   ///< a source cell range; Binding
    TargetRangeRole     = 0x00200000,   ///< a target cell range; Database
    AllCellDataRoles    = 0x00FFFF00    ///< used for iterating over the non-default data only
};
Q_DECLARE_FLAGS(CellDataRoles, CellDataRole)


/**
 * Converts a model index into a Cell.
 * \ingroup Model
 */
static inline Cell toCell(const QModelIndex &index)
{
    const int column = index.column() + 1;
    const int row = index.row() + 1;
    Sheet *const sheet = static_cast<Sheet*>(index.internalPointer());
    return Cell(sheet, column, row);
}

/**
 * Converts a model index into cell coordinates.
 * \ingroup Model
 */
static inline QPoint toPoint(const QModelIndex &index)
{
    const int column = index.column() + 1;
    const int row = index.row() + 1;
    return QPoint(column, row);
}

/**
 * Converts an item range into a range in cell coordinates.
 * \ingroup Model
 */
static inline QRect toRange(const QItemSelectionRange &range)
{
    return QRect(range.left() + 1, range.top() + 1, range.width(), range.height());
}

/**
 * Converts an item selection into a cell region.
 * \ingroup Model
 */
static inline Region toRegion(const QItemSelection &selection)
{
    Region region;
    for (int i = 0; i < selection.count(); ++i) {
        const QItemSelectionRange range = selection[i];
        Sheet *const sheet = static_cast<Sheet*>(range.topLeft().internalPointer());
        region.add(toRange(range), sheet);
    }
    return region;
}

/**
 * Converts a range in cell coordinates into a model item range.
 * \ingroup Model
 */
static inline QItemSelectionRange fromRange(const QRect &range, const QAbstractItemModel *const model)
{
    const QModelIndex topLeft = model->index(range.top() - 1, range.left() - 1);
    const QModelIndex bottomRight = model->index(range.bottom() - 1, range.right() - 1);
    return QItemSelectionRange(topLeft, bottomRight);
}

/**
 * Converts a range in cell coordinates into a model item range.
 * \ingroup Model
 */
static inline QItemSelectionRange fromRange(const QRect &range, Sheet *const sheet)
{
    return fromRange(range, sheet->model());
}

/**
 * Converts a cell region into an item selection.
 * \ingroup Model
 */
static inline QItemSelection fromRegion(const Region &region)
{
    QItemSelection selection;
    for (Region::ConstIterator it = region.constBegin(), end = region.constEnd(); it != end; ++it) {
        selection.append(fromRange((*it)->rect(), (*it)->sheet()));
    }
    return selection;
}

} // namespace Sheets
} // namespace Calligra

#endif // KSPREAD_MODEL_SUPPORT