QPlatformCursor Class Reference

The QPlatformCursor class provides information about pointer device events (movement, buttons), and requests to change the currently displayed cursor. More...

#include <qplatformcursor_qpa.h>

Inheritance diagram for QPlatformCursor:

Public Functions
virtual void	changeCursor (QCursor *widgetCursor, QWidget *widget)=0
	This method is called by Qt whenever the cursor graphic should be changed. More...
virtual void	pointerEvent (const QMouseEvent &event)
	This method is called by Qt whenever a QMouseEvent is generated by the underlying pointer input. More...
virtual QPoint	pos () const
	QPlatformCursor (QPlatformScreen *)
	Constructs a QPlatformCursor for the given screen. More...
virtual void	setPos (const QPoint &pos)
Public Functions inherited from QObject
bool	blockSignals (bool b)
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
const QObjectList &	children () const
	Returns a list of child objects. More...
bool	connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
bool	disconnect (const QObject *receiver, const char *member=0)
void	dumpObjectInfo ()
	Dumps information about signal connections, etc. More...
void	dumpObjectTree ()
	Dumps a tree of children to the debug output. More...
QList< QByteArray >	dynamicPropertyNames () const
	Returns the names of all properties that were dynamically added to the object using setProperty(). More...
virtual bool	event (QEvent *)
	This virtual function receives events to an object and should return true if the event e was recognized and processed. More...
virtual bool	eventFilter (QObject *, QEvent *)
	Filters events if this object has been installed as an event filter for the watched object. More...
template<typename T >
T	findChild (const QString &aName=QString()) const
	Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...
template<typename T >
QList< T >	findChildren (const QRegExp &re) const
bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...
void	installEventFilter (QObject *)
	Installs an event filter filterObj on this object. More...
bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false. More...
void	killTimer (int id)
	Kills the timer with timer identifier, id. More...
virtual const QMetaObject *	metaObject () const
	Returns a pointer to the meta-object of this object. More...
void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children. More...
QString	objectName () const
QObject *	parent () const
	Returns a pointer to the parent object. More...
QVariant	property (const char *name) const
	Returns the value of the object's name property. More...
Q_INVOKABLE	QObject (QObject *parent=0)
	Constructs an object with parent object parent. More...
void	removeEventFilter (QObject *)
	Removes an event filter object obj from this object. More...
void	setObjectName (const QString &name)
void	setParent (QObject *)
	Makes the object a child of parent. More...
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value. More...
void	setUserData (uint id, QObjectUserData *data)
bool	signalsBlocked () const
	Returns true if signals are blocked; otherwise returns false. More...
int	startTimer (int interval)
	Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
QThread *	thread () const
	Returns the thread in which the object lives. More...
QObjectUserData *	userData (uint id) const
virtual	~QObject ()
	Destroys the object, deleting all its child objects. More...

Protected Variables
QPlatformScreen *	screen
Protected Variables inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Private Functions
	Q_DECLARE_PRIVATE (QPlatformCursor)

Friends
class	QApplicationPrivate
void	qt_qpa_set_cursor (QWidget *w, bool force)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	Schedules this object for deletion. More...
Signals inherited from QObject
void	destroyed (QObject *=0)
	This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
Static Public Functions inherited from QObject
static bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
	Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
static bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
static bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
	Disconnects signal in object sender from method in object receiver. More...
static bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static uint	registerUserData ()
static QString	tr (const char *sourceText, const char *comment=0, int n=-1)
static QString	trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
Static Public Variables inherited from QObject
static const QMetaObject	staticMetaObject
	This variable stores the meta-object for the class. More...
Protected Functions inherited from QObject
virtual void	childEvent (QChildEvent *)
	This event handler can be reimplemented in a subclass to receive child events. More...
virtual void	connectNotify (const char *signal)
	This virtual function is called when something has been connected to signal in this object. More...
virtual void	customEvent (QEvent *)
	This event handler can be reimplemented in a subclass to receive custom events. More...
virtual void	disconnectNotify (const char *signal)
	This virtual function is called when something has been disconnected from signal in this object. More...
	QObject (QObjectPrivate &dd, QObject *parent=0)
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal. More...
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *)
	This event handler can be reimplemented in a subclass to receive timer events for the object. More...
Static Protected Variables inherited from QObject
static const QMetaObject	staticQtMetaObject
Related Functions inherited from QObject
T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QRegExp &regExp)()
T *	qobject_cast (QObject *object)
	QObjectList
void *	qt_find_obj_child (QObject *parent, const char *type, const QString &name)
	Returns a pointer to the object named name that inherits type and with a given parent. More...

Detailed Description

The QPlatformCursor class provides information about pointer device events (movement, buttons), and requests to change the currently displayed cursor.

Since

4.8

Note that QPlatformCursor does not include any graphics for display. An application that sets a QCursor may provide its own graphics.

See also

QPlatformCursorImage

Definition at line 82 of file qplatformcursor_qpa.h.

Constructors and Destructors

QPlatformCursor()

QPlatformCursor::QPlatformCursor

(

QPlatformScreen *

screen

)

Constructs a QPlatformCursor for the given screen.

Definition at line 106 of file qplatformcursor_qpa.cpp.

        : screen(scr)
{
    QPlatformCursorPrivate::instances.append(this);
}

Functions

changeCursor()

void QPlatformCursor::changeCursor ( QCursor *  widgetCursor, QWidget *  widget  )

pure virtual

This method is called by Qt whenever the cursor graphic should be changed.

Implementation of this method is mandatory for a subclass of QPlatformCursor.

widgetCursor is a pointer to the QCursor that should be displayed.

widget is a pointer to the widget currently displayed at QCursor::pos(). Note that this may be 0 if the current position is not occupied by a displayed widget.

See also

QCursor::pos()

Implemented in QPlatformSoftwareCursor, QVNCCursor, QDirectFBCursor, QXlibCursor, QWaylandCursor, and QBBCursor.

Referenced by qt_qpa_set_cursor().

pointerEvent()

void QPlatformCursor::pointerEvent ( const QMouseEvent &  event )

inlinevirtual

This method is called by Qt whenever a QMouseEvent is generated by the underlying pointer input.

event is a reference to the QMouseEvent in question. A default do-nothing implementation is provided.

Reimplemented in QPlatformSoftwareCursor.

Definition at line 87 of file qplatformcursor_qpa.h.

Referenced by qt_cleanup().

{ Q_UNUSED(event); }

pos()

QPoint QPlatformCursor::pos ( ) const

virtual

Reimplemented in QBBCursor.

Definition at line 115 of file qplatformcursor_qpa.cpp.

{
    // As a fallback return the last mouse position seen by QApplication.
    return QPoint(qt_last_x, qt_last_y);
}

Q_DECLARE_PRIVATE()

QPlatformCursor::Q_DECLARE_PRIVATE ( QPlatformCursor  )

private

setPos()

void QPlatformCursor::setPos ( const QPoint &  pos )

virtual

Reimplemented in QBBCursor.

Definition at line 121 of file qplatformcursor_qpa.cpp.

{
    Q_UNUSED(pos);
    qWarning("This plugin does not support QCursor::setPos()");
}

Friends and Related Functions

QApplicationPrivate

friend class QApplicationPrivate

friend

Definition at line 98 of file qplatformcursor_qpa.h.

qt_qpa_set_cursor

void qt_qpa_set_cursor ( QWidget *  w, bool  force  )

friend

Definition at line 872 of file qwidget_qpa.cpp.

{
    static QCursor arrowCursor(Qt::ArrowCursor);
    static QPointer<QWidget> lastUnderMouse = 0;

    QCursor * override = QApplication::overrideCursor();

    if (override && w != 0)
        return;

    QWidget *cursorWidget;
    QCursor cursorCursor;

    do {
        if (w == 0) {
            if (override) {
                cursorCursor = *override;
                cursorWidget = QApplication::topLevelAt(QCursor::pos());
                break;
            }
            w = QApplication::widgetAt(QCursor::pos());
            if (w == 0) // clear the override cursor while over empty space
                w = QApplication::desktop();
        } else if (force) {
            lastUnderMouse = w;
        } else if (w->testAttribute(Qt::WA_WState_Created) && lastUnderMouse
                   && lastUnderMouse->effectiveWinId() == w->effectiveWinId()) {
            w = lastUnderMouse;
        }
        if (w == QApplication::desktop() && !override) {
            cursorCursor = arrowCursor;
            cursorWidget = w;
            break;
        }

        QWidget * curWin = QApplication::activeWindow();
        if (!curWin && w && w->internalWinId())
            return;
        QWidget* cW = w && !w->internalWinId() ? w : curWin;

        if (!cW || cW->window() != w->window() ||
            !cW->isVisible() || !cW->underMouse() || override)
            return;

        cursorCursor = w->cursor();
        cursorWidget = w;
    } while (0);
    foreach (QWeakPointer<QPlatformCursor> cursor, QPlatformCursorPrivate::getInstances())
        if (cursor)
            cursor.data()->changeCursor(&cursorCursor, cursorWidget);
}

Properties

screen

QPlatformScreen* QPlatformCursor::screen

protected

Definition at line 93 of file qplatformcursor_qpa.h.

Referenced by QDirectFBCursor::changeCursor(), QPlatformSoftwareCursor::changeCursor(), QPlatformSoftwareCursor::drawCursor(), QPlatformSoftwareCursor::getCurrentRect(), QPlatformSoftwareCursor::pointerEvent(), QPlatformSoftwareCursor::setDirty(), and QXlibCursor::testLiteScreen().

---

The documentation for this class was generated from the following files:

• /src/gui/kernel/qplatformcursor_qpa.h
• /src/gui/kernel/qplatformcursor_qpa.cpp