src/gui/kernel/qcursor.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QCURSOR_H
  43 #define QCURSOR_H
  44
  45 #include <QtCore/qpoint.h>
  46 #include <QtGui/qwindowdefs.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52
  53 class QVariant;
  54 class QScreen;
  55
  56 /*
  57   ### The fake cursor has to go first with old qdoc.
  58 */
  59 #ifdef QT_NO_CURSOR
  60
  61 class Q_GUI_EXPORT QCursor
  62 {
  63 public:
  64     static QPoint pos();
  65     static QPoint pos(const QScreen *screen);
  66     static void setPos(int x, int y);
  67     static void setPos(QScreen *screen, int x, int y);
  68     inline static void setPos(const QPoint &p) { setPos(p.x(), p.y()); }
  69 private:
  70     QCursor();
  71 };
  72
  73 #endif // QT_NO_CURSOR
  74
  75 #ifndef QT_NO_CURSOR
  76
  77 class QCursorData;
  78 class QBitmap;
  79 class QPixmap;
  80
  81
  82 class Q_GUI_EXPORT QCursor
  83 {
  84 public:
  85     QCursor();
  86     QCursor(Qt::CursorShape shape);
  87     QCursor(const QBitmap &bitmap, const QBitmap &mask, int hotX=-1, int hotY=-1);
  88     QCursor(const QPixmap &pixmap, int hotX=-1, int hotY=-1);
  89     QCursor(const QCursor &cursor);
  90     ~QCursor();
  91     QCursor &operator=(const QCursor &cursor);
  92 #ifdef Q_COMPILER_RVALUE_REFS
  93     inline QCursor &operator=(QCursor &&other)
  94     { qSwap(d, other.d); return *this; }
  95 #endif
  96     operator QVariant() const;
  97
  98     Qt::CursorShape shape() const;
  99     void setShape(Qt::CursorShape newShape);
 100
 101     const QBitmap *bitmap() const;
 102     const QBitmap *mask() const;
 103     QPixmap pixmap() const;
 104     QPoint hotSpot() const;
 105
 106     static QPoint pos();
 107     static QPoint pos(const QScreen *screen);
 108     static void setPos(int x, int y);
 109     static void setPos(QScreen *screen, int x, int y);
 110     inline static void setPos(const QPoint &p) { setPos(p.x(), p.y()); }
 111     inline static void setPos(QScreen *screen, const QPoint &p) { setPos(screen, p.x(), p.y()); }
 112
 113 private:
 114     QCursorData *d;
 115 };
 116
 117 /*****************************************************************************
 118   QCursor stream functions
 119  *****************************************************************************/
 120 #ifndef QT_NO_DATASTREAM
 121 Q_GUI_EXPORT QDataStream &operator<<(QDataStream &outS, const QCursor &cursor);
 122 Q_GUI_EXPORT QDataStream &operator>>(QDataStream &inS, QCursor &cursor);
 123 #endif
 124
 125 #ifndef QT_NO_DEBUG_STREAM
 126 Q_GUI_EXPORT QDebug operator<<(QDebug, const QCursor &);
 127 #endif
 128
 129 #endif // QT_NO_CURSOR
 130
 131 QT_END_NAMESPACE
 132
 133 QT_END_HEADER
 134
 135 #endif // QCURSOR_H