/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qcursor.h"

#ifndef QT_NO_CURSOR

#include <qapplication.h>

#include <qbitmap.h>

#include <qimage.h>

#include <qdatastream.h>

#include <qvariant.h>

#include <private/qcursor_p.h>

QT_BEGIN_NAMESPACE

/*!

    \class QCursor

    \brief The QCursor class provides a mouse cursor with an arbitrary

    shape.

    \ingroup appearance

    \ingroup shared

    This class is mainly used to create mouse cursors that are

    associated with particular widgets and to get and set the position

    of the mouse cursor.

    Qt has a number of standard cursor shapes, but you can also make

    custom cursor shapes based on a QBitmap, a mask and a hotspot.

    To associate a cursor with a widget, use QWidget::setCursor(). To

    associate a cursor with all widgets (normally for a short period

    of time), use QApplication::setOverrideCursor().

    To set a cursor shape use QCursor::setShape() or use the QCursor

    constructor which takes the shape as argument, or you can use one

    of the predefined cursors defined in the \l Qt::CursorShape enum.

    If you want to create a cursor with your own bitmap, either use

    the QCursor constructor which takes a bitmap and a mask or the

    constructor which takes a pixmap as arguments.

    To set or get the position of the mouse cursor use the static

    methods QCursor::pos() and QCursor::setPos().

    \bold{Note:} It is possible to create a QCursor before

    QApplication, but it is not useful except as a place-holder for a

    real QCursor created after QApplication. Attempting to use a

    QCursor that was created before QApplication will result in a

    crash.

    \section1 A Note for X11 Users

    On X11, Qt supports the \link

    http://www.xfree86.org/4.3.0/Xcursor.3.html Xcursor\endlink

    library, which allows for full color icon themes. The table below

    shows the cursor name used for each Qt::CursorShape value. If a

    cursor cannot be found using the name shown below, a standard X11

    cursor will be used instead. Note: X11 does not provide

    appropriate cursors for all possible Qt::CursorShape values. It

    is possible that some cursors will be taken from the Xcursor

    theme, while others will use an internal bitmap cursor.

    \table

    \header \o Shape \o Qt::CursorShape Value \o Cursor Name

            \o Shape \o Qt::CursorShape Value \o Cursor Name

    \row \o \inlineimage cursor-arrow.png

         \o Qt::ArrowCursor   \o \c left_ptr

         \o \inlineimage      cursor-sizev.png

         \o Qt::SizeVerCursor \o \c size_ver

    \row \o \inlineimage      cursor-uparrow.png

         \o Qt::UpArrowCursor \o \c up_arrow

         \o \inlineimage      cursor-sizeh.png

         \o Qt::SizeHorCursor \o \c size_hor

    \row \o \inlineimage      cursor-cross.png

         \o Qt::CrossCursor   \o \c cross

         \o \inlineimage      cursor-sizeb.png

         \o Qt::SizeBDiagCursor \o \c size_bdiag

    \row \o \inlineimage      cursor-ibeam.png

         \o Qt::IBeamCursor   \o \c ibeam

         \o \inlineimage      cursor-sizef.png

         \o Qt::SizeFDiagCursor \o \c size_fdiag

    \row \o \inlineimage      cursor-wait.png

         \o Qt::WaitCursor    \o \c wait

         \o \inlineimage      cursor-sizeall.png

         \o Qt::SizeAllCursor \o \c size_all

    \row \o \inlineimage      cursor-busy.png

         \o Qt::BusyCursor    \o \c left_ptr_watch

         \o \inlineimage      cursor-vsplit.png

         \o Qt::SplitVCursor  \o \c split_v

    \row \o \inlineimage      cursor-forbidden.png

         \o Qt::ForbiddenCursor \o \c forbidden

         \o \inlineimage      cursor-hsplit.png

         \o Qt::SplitHCursor  \o \c split_h

    \row \o \inlineimage      cursor-hand.png

         \o Qt::PointingHandCursor \o \c pointing_hand

         \o \inlineimage      cursor-openhand.png

         \o Qt::OpenHandCursor  \o \c openhand

    \row \o \inlineimage      cursor-whatsthis.png

         \o Qt::WhatsThisCursor \o \c whats_this

         \o \inlineimage      cursor-closedhand.png

         \o Qt::ClosedHandCursor \o \c closedhand

    \endtable

    \sa QWidget, {fowler}{GUI Design Handbook: Cursors}

*/

/*!

    \fn HCURSOR_or_HANDLE QCursor::handle() const

    Returns a platform-specific cursor handle. The \c

    HCURSOR_or_HANDLE type is \c HCURSOR on Windows and Qt::HANDLE on X11

    and Mac OS X. On \l{Qt for Embedded Linux} it is an integer.

    \warning Using the value returned by this function is not

    portable.

*/

/*!

    \fn QCursor::QCursor(HCURSOR cursor)

    Constructs a Qt cursor from the given Windows \a cursor.

    \warning This function is only available on Windows.

    \sa handle()

*/

/*!

    \fn QCursor::QCursor(Qt::HANDLE handle)

    Constructs a Qt cursor from the given \a handle.

    \warning This function is only available on X11.

    \sa handle()

*/

/*!

    \fn QPoint QCursor::pos()

    Returns the position of the cursor (hot spot) in global screen

    coordinates.

    You can call QWidget::mapFromGlobal() to translate it to widget

    coordinates.

    \sa setPos(), QWidget::mapFromGlobal(), QWidget::mapToGlobal()

*/

/*!

    \fn void QCursor::setPos(int x, int y)

    Moves the cursor (hot spot) to the global screen position (\a x,

    \a y).

    You can call QWidget::mapToGlobal() to translate widget

    coordinates to global screen coordinates.

    \sa pos(), QWidget::mapFromGlobal(), QWidget::mapToGlobal()

*/

/*!

    \fn void QCursor::setPos (const QPoint &p)

    \overload

    Moves the cursor (hot spot) to the global screen position at point

    \a p.

*/

/*****************************************************************************

  QCursor stream functions

 *****************************************************************************/

#ifndef QT_NO_DATASTREAM

/*!

    \fn QDataStream &operator<<(QDataStream &stream, const QCursor &cursor)

    \relates QCursor

    Writes the \a cursor to the \a stream.

    \sa {Format of the QDataStream operators}

*/

QDataStream &operator<<(QDataStream &s, const QCursor &c)

{

    s << (qint16)c.shape();                        // write shape id to stream

    if (c.shape() == Qt::BitmapCursor) {                // bitmap cursor

        bool isPixmap = false;

        if (s.version() >= 7) {

            isPixmap = !c.pixmap().isNull();

            s << isPixmap;

        }

        if (isPixmap)

            s << c.pixmap();

        else

            s << *c.bitmap() << *c.mask();

        s << c.hotSpot();

    }

    return s;

}

/*!

    \fn QDataStream &operator>>(QDataStream &stream, QCursor &cursor)

    \relates QCursor

    Reads the \a cursor from the \a stream.

    \sa {Format of the QDataStream operators}

*/

QDataStream &operator>>(QDataStream &s, QCursor &c)

{

    qint16 shape;

    s >> shape;                                        // read shape id from stream

    if (shape == Qt::BitmapCursor) {                // read bitmap cursor

        bool isPixmap = false;

        if (s.version() >= 7)

            s >> isPixmap;

        if (isPixmap) {

            QPixmap pm;

            QPoint hot;

            s >> pm >> hot;

            c = QCursor(pm, hot.x(), hot.y());

        } else {

            QBitmap bm, bmm;

            QPoint hot;

            s >> bm >> bmm >> hot;

            c = QCursor(bm, bmm, hot.x(), hot.y());

        }

    } else {

        c.setShape((Qt::CursorShape)shape);                // create cursor with shape

    }

    return s;

}

#endif // QT_NO_DATASTREAM

/*!

    Constructs a custom pixmap cursor.

    \a pixmap is the image. It is usual to give it a mask (set using

    QPixmap::setMask()). \a hotX and \a hotY define the cursor's hot

    spot.

    If \a hotX is negative, it is set to the \c{pixmap().width()/2}.

    If \a hotY is negative, it is set to the \c{pixmap().height()/2}.

    Valid cursor sizes depend on the display hardware (or the

    underlying window system). We recommend using 32 x 32 cursors,

    because this size is supported on all platforms. Some platforms

    also support 16 x 16, 48 x 48, and 64 x 64 cursors.

    \note On Windows CE, the cursor size is fixed. If the pixmap

    is bigger than the system size, it will be scaled.

    \sa QPixmap::QPixmap(), QPixmap::setMask()

*/

QCursor::QCursor(const QPixmap &pixmap, int hotX, int hotY)

    : d(0)

{

    QImage img = pixmap.toImage().convertToFormat(QImage::Format_Indexed8, Qt::ThresholdDither|Qt::AvoidDither);

    QBitmap bm = QBitmap::fromImage(img, Qt::ThresholdDither|Qt::AvoidDither);

    QBitmap bmm = pixmap.mask();

    if (!bmm.isNull()) {

        QBitmap nullBm;

        bm.setMask(nullBm);

    }

    else if (!pixmap.mask().isNull()) {

        QImage mimg = pixmap.mask().toImage().convertToFormat(QImage::Format_Indexed8, Qt::ThresholdDither|Qt::AvoidDither);

        bmm = QBitmap::fromImage(mimg, Qt::ThresholdDither|Qt::AvoidDither);

    }

    else {

        bmm = QBitmap(bm.size());

        bmm.fill(Qt::color1);

    }

    d = QCursorData::setBitmap(bm, bmm, hotX, hotY);

    d->pixmap = pixmap;

}

/*!

    Constructs a custom bitmap cursor.

    \a bitmap and

    \a mask make up the bitmap.

    \a hotX and

    \a hotY define the cursor's hot spot.

    If \a hotX is negative, it is set to the \c{bitmap().width()/2}.

    If \a hotY is negative, it is set to the \c{bitmap().height()/2}.

    The cursor \a bitmap (B) and \a mask (M) bits are combined like this:

    \list

    \o B=1 and M=1 gives black.

    \o B=0 and M=1 gives white.

    \o B=0 and M=0 gives transparent.

    \o B=1 and M=0 gives an XOR'd result.

    \endlist

    Use the global Qt color Qt::color0 to draw 0-pixels and Qt::color1 to

    draw 1-pixels in the bitmaps.

    Valid cursor sizes depend on the display hardware (or the

    underlying window system). We recommend using 32 x 32 cursors,

    because this size is supported on all platforms. Some platforms

    also support 16 x 16, 48 x 48, and 64 x 64 cursors.

    \note On Windows CE, the cursor size is fixed. If the pixmap

    is bigger than the system size, it will be scaled.

    \sa QBitmap::QBitmap(), QBitmap::setMask()

*/

QCursor::QCursor(const QBitmap &bitmap, const QBitmap &mask, int hotX, int hotY)

    : d(0)

{

    d = QCursorData::setBitmap(bitmap, mask, hotX, hotY);

}

QCursorData *qt_cursorTable[Qt::LastCursor + 1];

bool QCursorData::initialized = false;

/*! \internal */

void QCursorData::cleanup()

{

    if(!QCursorData::initialized)

        return;

    for (int shape = 0; shape <= Qt::LastCursor; ++shape) {

        // In case someone has a static QCursor defined with this shape

        if (!qt_cursorTable[shape]->ref.deref())

            delete qt_cursorTable[shape];

        qt_cursorTable[shape] = 0;

    }

    QCursorData::initialized = false;

}

/*! \internal */

void QCursorData::initialize()

{

    if (QCursorData::initialized)

        return;

#ifdef Q_WS_MAC

    // DRSWAT - Not Needed Cocoa or Carbon

	//InitCursor();

#endif

    for (int shape = 0; shape <= Qt::LastCursor; ++shape)

        qt_cursorTable[shape] = new QCursorData((Qt::CursorShape)shape);

    QCursorData::initialized = true;

}

/*!

    Constructs a cursor with the default arrow shape.

*/

QCursor::QCursor()

{

    if (!QCursorData::initialized) {

        if (QApplication::startingUp()) {

            d = 0;

            return;

        }

        QCursorData::initialize();

    }

    QCursorData *c = qt_cursorTable[0];

    c->ref.ref();

    d = c;

}

/*!

    Constructs a cursor with the specified \a shape.

    See \l Qt::CursorShape for a list of shapes.

    \sa setShape()

*/

QCursor::QCursor(Qt::CursorShape shape)

    : d(0)

{

    if (!QCursorData::initialized)

        QCursorData::initialize();

    setShape(shape);

}

/*!

    Returns the cursor shape identifier. The return value is one of

    the \l Qt::CursorShape enum values (cast to an int).

    \sa setShape()

*/

Qt::CursorShape QCursor::shape() const

{

    if (!QCursorData::initialized)

        QCursorData::initialize();

    return d->cshape;

}

/*!

    Sets the cursor to the shape identified by \a shape.

    See \l Qt::CursorShape for the list of cursor shapes.

    \sa shape()

*/

void QCursor::setShape(Qt::CursorShape shape)

{

    if (!QCursorData::initialized)

        QCursorData::initialize();

    QCursorData *c = uint(shape) <= Qt::LastCursor ? qt_cursorTable[shape] : 0;

    if (!c)

        c = qt_cursorTable[0];

    c->ref.ref();

    if (!d) {

        d = c;

    } else {

        if (!d->ref.deref())

            delete d;

        d = c;

    }

}

/*!

    Returns the cursor bitmap, or 0 if it is one of the standard

    cursors.

*/

const QBitmap *QCursor::bitmap() const

{

    if (!QCursorData::initialized)

        QCursorData::initialize();

    return d->bm;

}

/*!

    Returns the cursor bitmap mask, or 0 if it is one of the standard

    cursors.

*/

const QBitmap *QCursor::mask() const

{

    if (!QCursorData::initialized)

        QCursorData::initialize();

    return d->bmm;

}

/*!

    Returns the cursor pixmap. This is only valid if the cursor is a

    pixmap cursor.

*/

QPixmap QCursor::pixmap() const

{

    if (!QCursorData::initialized)

        QCursorData::initialize();

    return d->pixmap;

}

/*!

    Returns the cursor hot spot, or (0, 0) if it is one of the

    standard cursors.

*/

QPoint QCursor::hotSpot() const

{

    if (!QCursorData::initialized)

        QCursorData::initialize();

    return QPoint(d->hx, d->hy);

}

/*!

    Constructs a copy of the cursor \a c.

*/

QCursor::QCursor(const QCursor &c)

{

    if (!QCursorData::initialized)

        QCursorData::initialize();

    d = c.d;

    d->ref.ref();

}