1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWidgets module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40/*!
41 \class QGraphicsSceneLinearIndex
42 \brief The QGraphicsSceneLinearIndex class provides an implementation of
43 a linear indexing algorithm for discovering items in QGraphicsScene.
44 \since 4.6
45 \ingroup graphicsview-api
46 \internal
47
48 QGraphicsSceneLinearIndex index is default linear implementation to discover items.
49 It basically store all items in a list and return them to the scene.
50
51 \sa QGraphicsScene, QGraphicsView, QGraphicsSceneIndex, QGraphicsSceneBspTreeIndex
52*/
53
54#include <private/qgraphicsscenelinearindex_p.h>
55
56/*!
57 \fn QGraphicsSceneLinearIndex::QGraphicsSceneLinearIndex(QGraphicsScene *scene = nullptr):
58
59 Construct a linear index for the given \a scene.
60*/
61
62/*!
63 \fn QList<QGraphicsItem *> QGraphicsSceneLinearIndex::items(Qt::SortOrder order = Qt::DescendingOrder) const;
64
65 Return all items in the index and sort them using \a order.
66*/
67
68
69/*!
70 \fn virtual QList<QGraphicsItem *> QGraphicsSceneLinearIndex::estimateItems(const QRectF &rect, Qt::SortOrder order) const
71
72 Returns an estimation visible items that are either inside or
73 intersect with the specified \a rect and return a list sorted using \a order.
74*/
75
76/*!
77 \fn void QGraphicsSceneLinearIndex::clear()
78 \internal
79 Clear the all the BSP index.
80*/
81
82/*!
83 \fn virtual void QGraphicsSceneLinearIndex::addItem(QGraphicsItem *item)
84
85 Add the \a item into the index.
86*/
87
88/*!
89 \fn virtual void QGraphicsSceneLinearIndex::removeItem(QGraphicsItem *item)
90
91 Add the \a item from the index.
92*/
93
94#include "moc_qgraphicsscenelinearindex_p.cpp"
95