Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QXcbDrag Class Reference

#include <qxcbdrag.h>

Inheritance diagram for QXcbDrag:
Collaboration diagram for QXcbDrag:

Public Member Functions

 QXcbDrag (QXcbConnection *c)
 ~QXcbDrag ()
bool eventFilter (QObject *o, QEvent *e) override
 Filters events if this object has been installed as an event filter for the watched object.
void startDrag () override
void cancel () override
void move (const QPoint &globalPos, Qt::MouseButtons b, Qt::KeyboardModifiers mods) override
void drop (const QPoint &globalPos, Qt::MouseButtons b, Qt::KeyboardModifiers mods) override
void endDrag () override
Qt::DropAction defaultAction (Qt::DropActions possibleActions, Qt::KeyboardModifiers modifiers) const override
void handlePropertyNotifyEvent (const xcb_property_notify_event_t *event) override
void handleEnter (QPlatformWindow *window, const xcb_client_message_event_t *event, xcb_window_t proxy=0)
void handlePosition (QPlatformWindow *w, const xcb_client_message_event_t *event)
void handleLeave (QPlatformWindow *w, const xcb_client_message_event_t *event)
void handleDrop (QPlatformWindow *, const xcb_client_message_event_t *event, Qt::MouseButtons b={ }, Qt::KeyboardModifiers mods={ })
void handleStatus (const xcb_client_message_event_t *event)
void handleSelectionRequest (const xcb_selection_request_event_t *event)
void handleFinished (const xcb_client_message_event_t *event)
bool dndEnable (QXcbWindow *win, bool on)
bool ownsDragObject () const override
 Returns bool indicating whether QPlatformDrag takes ownership and therefore responsibility of deleting the QDrag object passed in from QPlatformDrag::drag. This can be useful on platforms where QDrag object has to be kept around.
void updatePixmap ()
xcb_timestamp_t targetTime ()
Public Member Functions inherited from QXcbObject
 QXcbObject (QXcbConnection *connection=nullptr)
void setConnection (QXcbConnection *connection)
QXcbConnection * connection () const
xcb_atom_t atom (QXcbAtom::Atom atom) const
xcb_connection_t * xcb_connection () const
Public Member Functions inherited from QBasicDrag
 ~QBasicDrag ()
virtual Qt::DropAction drag (QDrag *drag) override
void cancelDrag () override
 Cancels the currently active drag (only for drags of the current application initiated by QPlatformDrag::drag()).
Public Member Functions inherited from QPlatformDrag
 QPlatformDrag ()
virtual ~QPlatformDrag ()
QDrag * currentDrag () const
void updateAction (Qt::DropAction action)
 Called to notify QDrag about changes of the current action.
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString > bindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread * thread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) 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.
template<typename T>
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList & children () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArray > dynamicPropertyNames () const
QBindingStorage * bindingStorage ()
const QBindingStorage * bindingStorage () const
QObject * parent () const
 Returns a pointer to the parent object.
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.
Public Member Functions inherited from QXcbWindowEventListener
virtual ~QXcbWindowEventListener ()
virtual bool handleNativeEvent (xcb_generic_event_t *)
virtual void handleExposeEvent (const xcb_expose_event_t *)
virtual void handleClientMessageEvent (const xcb_client_message_event_t *)
virtual void handleConfigureNotifyEvent (const xcb_configure_notify_event_t *)
virtual void handleMapNotifyEvent (const xcb_map_notify_event_t *)
virtual void handleUnmapNotifyEvent (const xcb_unmap_notify_event_t *)
virtual void handleDestroyNotifyEvent (const xcb_destroy_notify_event_t *)
virtual void handleButtonPressEvent (const xcb_button_press_event_t *)
virtual void handleButtonReleaseEvent (const xcb_button_release_event_t *)
virtual void handleMotionNotifyEvent (const xcb_motion_notify_event_t *)
virtual void handleEnterNotifyEvent (const xcb_enter_notify_event_t *)
virtual void handleLeaveNotifyEvent (const xcb_leave_notify_event_t *)
virtual void handleFocusInEvent (const xcb_focus_in_event_t *)
virtual void handleFocusOutEvent (const xcb_focus_out_event_t *)
virtual void handleXIMouseEvent (xcb_ge_event_t *, Qt::MouseEventSource=Qt::MouseEventNotSynthesized)
virtual void handleXIEnterLeave (xcb_ge_event_t *)
virtual QXcbWindow * toWindow ()

Protected Member Functions

void timerEvent (QTimerEvent *e) override
 This event handler can be reimplemented in a subclass to receive timer events for the object.
bool findXdndAwareTarget (const QPoint &globalPos, xcb_window_t *target_out)
Protected Member Functions inherited from QBasicDrag
 QBasicDrag ()
void moveShapedPixmapWindow (const QPoint &deviceIndependentPosition)
 Move the drag label to globalPos, which is interpreted in device independent coordinates.
QShapedPixmapWindow * shapedPixmapWindow () const
void recreateShapedPixmapWindow (QScreen *screen, const QPoint &pos)
void updateCursor (Qt::DropAction action)
bool canDrop () const
void setCanDrop (bool c)
bool useCompositing () const
void setUseCompositing (bool on)
void setScreen (QScreen *screen)
Qt::DropAction executedDropAction () const
void setExecutedDropAction (Qt::DropAction da)
QDrag * drag () const
Protected Member Functions inherited from QObject
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 \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Friends

class QXcbDropData
class QTypeInfo< Transaction >

Additional Inherited Members

Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
Static Public Member Functions inherited from QPlatformDrag
static QPixmap defaultPixmap ()
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Attributes inherited from QBasicDrag
QWindow * m_sourceWindow = nullptr
QPointer< QWindow > m_windowUnderCursor = nullptr
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
Properties inherited from QObject
QString objectName
 the name of this object
Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 32 of file qxcbdrag.h.

Constructor & Destructor Documentation

◆ QXcbDrag()

QXcbDrag::QXcbDrag ( QXcbConnection * c)

Definition at line 90 of file qxcbdrag.cpp.

References QXcbDropData::QXcbDropData(), and QXcbObject::QXcbObject().

Here is the call graph for this function:

◆ ~QXcbDrag()

QXcbDrag::~QXcbDrag ( )

Definition at line 97 of file qxcbdrag.cpp.

Member Function Documentation

◆ cancel()

void QXcbDrag::cancel ( )
overridevirtual

Reimplemented from QBasicDrag.

Definition at line 1118 of file qxcbdrag.cpp.

Referenced by move().

Here is the caller graph for this function:

◆ defaultAction()

Qt::DropAction QXcbDrag::defaultAction ( Qt::DropActions possibleActions,
Qt::KeyboardModifiers modifiers ) const
overridevirtual

Reimplemented from QPlatformDrag.

Definition at line 182 of file qxcbdrag.cpp.

◆ dndEnable()

bool QXcbDrag::dndEnable ( QXcbWindow * win,
bool on )

Definition at line 1227 of file qxcbdrag.cpp.

References QXcbObject::atom(), QXcbAtom::AtomXdndAware, QXcbObject::xcb_connection(), and xdnd_version.

Here is the call graph for this function:

◆ drop()

void QXcbDrag::drop ( const QPoint & globalPos,
Qt::MouseButtons b,
Qt::KeyboardModifiers mods )
overridevirtual

Implements QBasicDrag.

Definition at line 471 of file qxcbdrag.cpp.

References QXcbObject::atom(), QXcbAtom::AtomXdndDrop, QXcbObject::connection(), and QXcbObject::xcb_connection().

Here is the call graph for this function:

◆ endDrag()

void QXcbDrag::endDrag ( )
overridevirtual

Reimplemented from QBasicDrag.

Definition at line 172 of file qxcbdrag.cpp.

◆ eventFilter()

bool QXcbDrag::eventFilter ( QObject * watched,
QEvent * event )
overridevirtual

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
MainWindow();
protected:
bool eventFilter(QObject *obj, QEvent *ev) override;
private:
QTextEdit *textEdit;
};
MainWindow::MainWindow()
{
textEdit = new QTextEdit;
setCentralWidget(textEdit);
textEdit->installEventFilter(this);
}
bool MainWindow::eventFilter(QObject *obj, QEvent *event)
{
if (obj == textEdit) {
if (event->type() == QEvent::KeyPress) {
QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
qDebug() << "Ate key press" << keyEvent->key();
return true;
} else {
return false;
}
} else {
// pass the event on to the parent class
return QMainWindow::eventFilter(obj, event);
}
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.

Warning
If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.
See also
installEventFilter()

Reimplemented from QBasicDrag.

Definition at line 128 of file qxcbdrag.cpp.

◆ findXdndAwareTarget()

bool QXcbDrag::findXdndAwareTarget ( const QPoint & globalPos,
xcb_window_t * target_out )
protected

Definition at line 282 of file qxcbdrag.cpp.

References QXcbAtom::AtomXdndAware, and QXcbObject::xcb_connection().

Referenced by move().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleDrop()

void QXcbDrag::handleDrop ( QPlatformWindow * ,
const xcb_client_message_event_t * event,
Qt::MouseButtons b = { },
Qt::KeyboardModifiers mods = { } )

Definition at line 954 of file qxcbdrag.cpp.

References QXcbObject::atom(), QXcbAtom::AtomXdndFinished, QXcbObject::connection(), and QXcbObject::xcb_connection().

Here is the call graph for this function:

◆ handleEnter()

void QXcbDrag::handleEnter ( QPlatformWindow * window,
const xcb_client_message_event_t * event,
xcb_window_t proxy = 0 )

Definition at line 681 of file qxcbdrag.cpp.

References QXcbAtom::AtomXdndTypelist, QXcbObject::connection(), QXcbObject::xcb_connection(), and xdnd_version.

Referenced by move().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleFinished()

void QXcbDrag::handleFinished ( const xcb_client_message_event_t * event)

Definition at line 1040 of file qxcbdrag.cpp.

References QXcbObject::connection().

Here is the call graph for this function:

◆ handleLeave()

void QXcbDrag::handleLeave ( QPlatformWindow * w,
const xcb_client_message_event_t * event )

Definition at line 897 of file qxcbdrag.cpp.

◆ handlePosition()

void QXcbDrag::handlePosition ( QPlatformWindow * w,
const xcb_client_message_event_t * event )

Definition at line 834 of file qxcbdrag.cpp.

References QXcbObject::atom(), and QXcbAtom::AtomXdndPosition.

Here is the call graph for this function:

◆ handlePropertyNotifyEvent()

void QXcbDrag::handlePropertyNotifyEvent ( const xcb_property_notify_event_t * event)
overridevirtual

Reimplemented from QXcbWindowEventListener.

Definition at line 190 of file qxcbdrag.cpp.

References QXcbObject::atom(), and QXcbAtom::AtomXdndActionList.

Here is the call graph for this function:

◆ handleSelectionRequest()

void QXcbDrag::handleSelectionRequest ( const xcb_selection_request_event_t * event)

Definition at line 1159 of file qxcbdrag.cpp.

References QXcbObject::connection(), and QXcbObject::xcb_connection().

Here is the call graph for this function:

◆ handleStatus()

void QXcbDrag::handleStatus ( const xcb_client_message_event_t * event)

Definition at line 878 of file qxcbdrag.cpp.

References QXcbObject::atom(), QXcbAtom::AtomXdndStatus, and QXcbObject::connection().

Here is the call graph for this function:

◆ move()

void QXcbDrag::move ( const QPoint & globalPos,
Qt::MouseButtons b,
Qt::KeyboardModifiers mods )
overridevirtual

Implements QBasicDrag.

Definition at line 334 of file qxcbdrag.cpp.

References QXcbObject::atom(), QXcbAtom::AtomXdndAware, QXcbAtom::AtomXdndEnter, QXcbAtom::AtomXdndPosition, cancel(), QXcbVirtualDesktop::compositingActive(), QXcbObject::connection(), findXdndAwareTarget(), handleEnter(), QXcbObject::xcb_connection(), and xdnd_version.

Here is the call graph for this function:

◆ ownsDragObject()

bool QXcbDrag::ownsDragObject ( ) const
overridevirtual

Returns bool indicating whether QPlatformDrag takes ownership and therefore responsibility of deleting the QDrag object passed in from QPlatformDrag::drag. This can be useful on platforms where QDrag object has to be kept around.

Since
5.4

Reimplemented from QPlatformDrag.

Definition at line 1247 of file qxcbdrag.cpp.

◆ startDrag()

void QXcbDrag::startDrag ( )
overridevirtual

Reimplemented from QBasicDrag.

Definition at line 139 of file qxcbdrag.cpp.

References QXcbObject::atom(), QXcbAtom::AtomXdndSelection, QXcbObject::connection(), and QXcbObject::xcb_connection().

Here is the call graph for this function:

◆ targetTime()

xcb_timestamp_t QXcbDrag::targetTime ( )
inline

Definition at line 64 of file qxcbdrag.h.

Referenced by QXcbDropData::xdndObtainData().

Here is the caller graph for this function:

◆ timerEvent()

void QXcbDrag::timerEvent ( QTimerEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also
startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 1085 of file qxcbdrag.cpp.

◆ updatePixmap()

void QXcbDrag::updatePixmap ( )

◆ QTypeInfo< Transaction >

friend class QTypeInfo< Transaction >
friend

Definition at line 134 of file qxcbdrag.h.

◆ QXcbDropData

friend class QXcbDropData
friend

Definition at line 72 of file qxcbdrag.h.

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