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 QtGui 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#ifndef QCURSOR_H
41#define QCURSOR_H
42
43#include <QtGui/qtguiglobal.h>
44#include <QtCore/qpoint.h>
45#include <QtGui/qwindowdefs.h>
46#include <QtGui/qbitmap.h>
47
48QT_BEGIN_NAMESPACE
49
50
51class QVariant;
52class QScreen;
53
54/*
55 ### The fake cursor has to go first with old qdoc.
56*/
57#ifdef QT_NO_CURSOR
58
59class Q_GUI_EXPORT QCursor
60{
61public:
62 static QPoint pos();
63 static QPoint pos(const QScreen *screen);
64 static void setPos(int x, int y);
65 static void setPos(QScreen *screen, int x, int y);
66 inline static void setPos(const QPoint &p) { setPos(p.x(), p.y()); }
67private:
68 QCursor();
69};
70
71#endif // QT_NO_CURSOR
72
73#ifndef QT_NO_CURSOR
74
75class QCursorData;
76class QBitmap;
77class QPixmap;
78
79
80class Q_GUI_EXPORT QCursor
81{
82public:
83 QCursor();
84 QCursor(Qt::CursorShape shape);
85 QCursor(const QBitmap &bitmap, const QBitmap &mask, int hotX=-1, int hotY=-1);
86 explicit QCursor(const QPixmap &pixmap, int hotX=-1, int hotY=-1);
87 QCursor(const QCursor &cursor);
88 ~QCursor();
89 QCursor &operator=(const QCursor &cursor);
90 QCursor(QCursor &&other) noexcept : d(qExchange(other.d, nullptr)) {}
91 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_MOVE_AND_SWAP(QCursor)
92
93 void swap(QCursor &other) noexcept { qSwap(d, other.d); }
94
95 operator QVariant() const;
96
97 Qt::CursorShape shape() const;
98 void setShape(Qt::CursorShape newShape);
99
100#if QT_DEPRECATED_SINCE(6, 0)
101 QBitmap bitmap(Qt::ReturnByValueConstant) const { return bitmap(); }
102 QBitmap mask(Qt::ReturnByValueConstant) const { return mask(); }
103#endif // QT_DEPRECATED_SINCE(6, 0)
104 QBitmap bitmap() const;
105 QBitmap mask() const;
106
107 QPixmap pixmap() const;
108 QPoint hotSpot() const;
109
110 static QPoint pos();
111 static QPoint pos(const QScreen *screen);
112 static void setPos(int x, int y);
113 static void setPos(QScreen *screen, int x, int y);
114 inline static void setPos(const QPoint &p) { setPos(p.x(), p.y()); }
115 inline static void setPos(QScreen *screen, const QPoint &p) { setPos(screen, p.x(), p.y()); }
116
117private:
118 friend Q_GUI_EXPORT bool operator==(const QCursor &lhs, const QCursor &rhs) noexcept;
119 friend inline bool operator!=(const QCursor &lhs, const QCursor &rhs) noexcept { return !(lhs == rhs); }
120 QCursorData *d;
121};
122Q_DECLARE_SHARED(QCursor)
123
124/*****************************************************************************
125 QCursor stream functions
126 *****************************************************************************/
127#ifndef QT_NO_DATASTREAM
128Q_GUI_EXPORT QDataStream &operator<<(QDataStream &outS, const QCursor &cursor);
129Q_GUI_EXPORT QDataStream &operator>>(QDataStream &inS, QCursor &cursor);
130#endif
131
132#ifndef QT_NO_DEBUG_STREAM
133Q_GUI_EXPORT QDebug operator<<(QDebug, const QCursor &);
134#endif
135
136#endif // QT_NO_CURSOR
137
138QT_END_NAMESPACE
139
140#endif // QCURSOR_H
141