#include <qquickdroparea_p.h>

Inheritance diagram for QQuickDragEvent:

Collaboration diagram for QQuickDragEvent:

Public Member Functions
	QQuickDragEvent (QQuickDropAreaPrivate d, QDropEvent event)

qreal	x () const

qreal	y () const

QObject *	source () const
	\qmltype DragEvent \instantiates QQuickDragEvent \inqmlmodule QtQuick

Qt::DropActions	supportedActions () const

Qt::DropActions	proposedAction () const

Qt::DropAction	action () const

void	setAction (Qt::DropAction action)

void	resetAction ()

QStringList	keys () const

bool	accepted () const

void	setAccepted (bool accepted)

bool	hasColor () const

bool	hasHtml () const

bool	hasText () const

bool	hasUrls () const

QVariant	colorData () const

QString	html () const

QString	text () const

QList< QUrl >	urls () const

QStringList	formats () const

Q_INVOKABLE QString	getDataAsString (const QString &format) const

Q_INVOKABLE QByteArray	getDataAsArrayBuffer (const QString &format) const

Q_INVOKABLE void	acceptProposedAction ()

Q_INVOKABLE void	accept ()

Q_INVOKABLE void	accept (Qt::DropAction 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.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

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	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`.

Properties
qreal	x

qreal	y

QObject *	source

QStringList	keys

Qt::DropActions	supportedActions

Qt::DropActions	proposedAction

Qt::DropAction	action

bool	accepted

bool	hasColor

bool	hasHtml

bool	hasText

bool	hasUrls

QVariant	colorData

QString	html

QString	text

QList< QUrl >	urls

QStringList	formats

Properties inherited from QObject
QString	objectName
	the name of this object

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 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 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	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

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)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 29 of file qquickdroparea_p.h.

Constructor & Destructor Documentation

◆ QQuickDragEvent()

QQuickDragEvent::QQuickDragEvent	(	QQuickDropAreaPrivate *	d,
		QDropEvent *	event )

inline

Definition at line 53 of file qquickdroparea_p.h.

Member Function Documentation

◆ accept() [1/2]

void QQuickDragEvent::accept ( )

Definition at line 553 of file qquickdroparea.cpp.

References action.

◆ accept() [2/2]

void QQuickDragEvent::accept ( Qt::DropAction action )

Definition at line 560 of file qquickdroparea.cpp.

References action.

◆ accepted()

bool QQuickDragEvent::accepted ( ) const

inline

Definition at line 68 of file qquickdroparea_p.h.

◆ acceptProposedAction()

void QQuickDragEvent::acceptProposedAction ( )

Definition at line 548 of file qquickdroparea.cpp.

◆ action()

Qt::DropAction QQuickDragEvent::action ( ) const

inline

Definition at line 62 of file qquickdroparea_p.h.

◆ colorData()

QVariant QQuickDragEvent::colorData ( ) const

Definition at line 513 of file qquickdroparea.cpp.

◆ formats()

QStringList QQuickDragEvent::formats ( ) const

Definition at line 533 of file qquickdroparea.cpp.

◆ getDataAsArrayBuffer()

QByteArray QQuickDragEvent::getDataAsArrayBuffer ( const QString & format ) const

Definition at line 543 of file qquickdroparea.cpp.

References QByteArray::data().

Here is the call graph for this function:

◆ getDataAsString()

QString QQuickDragEvent::getDataAsString ( const QString & format ) const

Definition at line 538 of file qquickdroparea.cpp.

References QString::fromUtf8().

Here is the call graph for this function:

◆ hasColor()

bool QQuickDragEvent::hasColor ( ) const

Definition at line 493 of file qquickdroparea.cpp.

◆ hasHtml()

bool QQuickDragEvent::hasHtml ( ) const

Definition at line 498 of file qquickdroparea.cpp.

◆ hasText()

bool QQuickDragEvent::hasText ( ) const

Definition at line 503 of file qquickdroparea.cpp.

◆ hasUrls()

bool QQuickDragEvent::hasUrls ( ) const

Definition at line 508 of file qquickdroparea.cpp.

◆ html()

QString QQuickDragEvent::html ( ) const

Definition at line 518 of file qquickdroparea.cpp.

◆ keys()

QStringList QQuickDragEvent::keys ( ) const

Definition at line 488 of file qquickdroparea.cpp.

References QQuickDropAreaPrivate::getKeys().

Here is the call graph for this function:

◆ proposedAction()

Qt::DropActions QQuickDragEvent::proposedAction ( ) const

inline

Definition at line 61 of file qquickdroparea_p.h.

◆ resetAction()

void QQuickDragEvent::resetAction ( )

inline

Definition at line 64 of file qquickdroparea_p.h.

◆ setAccepted()

void QQuickDragEvent::setAccepted ( bool accepted )

inline

Definition at line 69 of file qquickdroparea_p.h.

References accepted.

◆ setAction()

void QQuickDragEvent::setAction ( Qt::DropAction action )

inline

Definition at line 63 of file qquickdroparea_p.h.

References action.

◆ source()

QObject * QQuickDragEvent::source ( ) const

\qmltype DragEvent \instantiates QQuickDragEvent \inqmlmodule QtQuick

Provides information about a drag event.

The position of the drag event can be obtained from the \l x and \l y properties, and the \l keys property identifies the drag keys of the event \l {drag.source}{source}.

The existence of specific drag types can be determined using the \l hasColor, \l hasHtml, \l hasText, and \l hasUrls properties.

The list of all supplied formats can be determined using the \l formats property.

Specific drag types can be obtained using the \l colorData, \l html, \l text, and \l urls properties.

A string version of any available mimeType can be obtained using \l getDataAsString.

\qmlproperty real QtQuick::DragEvent::x

This property holds the x coordinate of a drag event.

\qmlproperty real QtQuick::DragEvent::y

This property holds the y coordinate of a drag event.

\qmlproperty QtObject QtQuick::DragEvent::drag.source

This property holds the source of a drag event.

\qmlproperty stringlist QtQuick::DragEvent::keys

This property holds a list of keys identifying the data type or source of a drag event.

\qmlproperty enumeration QtQuick::DragEvent::action

This property holds the action that the \l {drag.source}{source} is to perform on an accepted drop.

The drop action may be one of:

\value Qt.CopyAction Copy the data to the target. \value Qt.MoveAction Move the data from the source to the target. \value Qt.LinkAction Create a link from the source to the target. \value Qt.IgnoreAction Ignore the action (do nothing with the data).

\qmlproperty flags QtQuick::DragEvent::supportedActions

This property holds the set of \l {action}{actions} supported by the drag source.

\qmlproperty flags QtQuick::DragEvent::proposedAction

Since: 5.2

This property holds the set of \l {action}{actions} proposed by the drag source.

\qmlproperty bool QtQuick::DragEvent::accepted

This property holds whether the drag event was accepted by a handler.

The default value is true.

\qmlmethod QtQuick::DragEvent::accept() \qmlmethod QtQuick::DragEvent::accept(enumeration action)

Accepts the drag event.

If an action is specified it will overwrite the value of the \l action property.

\qmlmethod QtQuick::DragEvent::acceptProposedAction()

Since: 5.2

Accepts the drag event with the \l proposedAction.

\qmlproperty bool QtQuick::DragEvent::hasColor

Since: 5.2

This property holds whether the drag event contains a color item.

\qmlproperty bool QtQuick::DragEvent::hasHtml

Since: 5.2

This property holds whether the drag event contains a html item.

\qmlproperty bool QtQuick::DragEvent::hasText

Since: 5.2

This property holds whether the drag event contains a text item.

\qmlproperty bool QtQuick::DragEvent::hasUrls

Since: 5.2

This property holds whether the drag event contains one or more url items.

\qmlproperty color QtQuick::DragEvent::colorData

Since: 5.2

This property holds color data, if any.

\qmlproperty string QtQuick::DragEvent::html

Since: 5.2

This property holds html data, if any.

\qmlproperty string QtQuick::DragEvent::text

Since: 5.2

This property holds text data, if any.

\qmlproperty urllist QtQuick::DragEvent::urls

Since: 5.2

This property holds a list of urls, if any.

\qmlproperty stringlist QtQuick::DragEvent::formats

Since: 5.2

This property holds a list of mime type formats contained in the drag data.

\qmlmethod string QtQuick::DragEvent::getDataAsString(string format)

Since: 5.2

Returns the data for the given format converted to a string. format should be one contained in the \l formats property.

\qmlmethod string QtQuick::DragEvent::getDataAsArrayBuffer(string format)

Since: 5.5

Returns the data for the given format into an ArrayBuffer, which can easily be translated into a QByteArray. format should be one contained in the \l formats property.

Definition at line 480 of file qquickdroparea.cpp.

◆ supportedActions()

Qt::DropActions QQuickDragEvent::supportedActions ( ) const

inline

Definition at line 60 of file qquickdroparea_p.h.

◆ text()

QString QQuickDragEvent::text ( ) const

Definition at line 523 of file qquickdroparea.cpp.

◆ urls()

QList< QUrl > QQuickDragEvent::urls ( ) const

Definition at line 528 of file qquickdroparea.cpp.

◆ x()

qreal QQuickDragEvent::x ( ) const

inline

Definition at line 55 of file qquickdroparea_p.h.

◆ y()

qreal QQuickDragEvent::y ( ) const

inline

Definition at line 56 of file qquickdroparea_p.h.

Property Documentation

◆ accepted

bool QQuickDragEvent::accepted

readwrite

Definition at line 39 of file qquickdroparea_p.h.

Referenced by setAccepted().

◆ action

Qt::DropAction QQuickDragEvent::action

readwrite

Definition at line 38 of file qquickdroparea_p.h.

Referenced by accept(), accept(), and setAction().

◆ colorData

QVariant QQuickDragEvent::colorData

read

Definition at line 44 of file qquickdroparea_p.h.

◆ formats

QStringList QQuickDragEvent::formats

read

Definition at line 48 of file qquickdroparea_p.h.

◆ hasColor

bool QQuickDragEvent::hasColor

read

Definition at line 40 of file qquickdroparea_p.h.

◆ hasHtml

bool QQuickDragEvent::hasHtml

read

Definition at line 41 of file qquickdroparea_p.h.

◆ hasText

bool QQuickDragEvent::hasText

read

Definition at line 42 of file qquickdroparea_p.h.

◆ hasUrls

bool QQuickDragEvent::hasUrls

read

Definition at line 43 of file qquickdroparea_p.h.

◆ html

QString QQuickDragEvent::html

read

Definition at line 45 of file qquickdroparea_p.h.

◆ keys

QStringList QQuickDragEvent::keys

read

Definition at line 35 of file qquickdroparea_p.h.

◆ proposedAction

Qt::DropActions QQuickDragEvent::proposedAction

read

Definition at line 37 of file qquickdroparea_p.h.

◆ source

QObject * QQuickDragEvent::source

read

Definition at line 34 of file qquickdroparea_p.h.

◆ supportedActions

Qt::DropActions QQuickDragEvent::supportedActions

read

Definition at line 36 of file qquickdroparea_p.h.

◆ text

QString QQuickDragEvent::text

read

Definition at line 46 of file qquickdroparea_p.h.

◆ urls

QList<QUrl> QQuickDragEvent::urls

read

Definition at line 47 of file qquickdroparea_p.h.

◆ x

qreal QQuickDragEvent::x

read

Definition at line 32 of file qquickdroparea_p.h.

◆ y

qreal QQuickDragEvent::y

read

Definition at line 33 of file qquickdroparea_p.h.

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

qtdeclarative/src/quick/items/qquickdroparea_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/items/qquickdroparea.cpp (5a665bc4740106a7c3932506173229ddc8aec8be)

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickDragEvent()

Member Function Documentation

◆ accept() [1/2]

◆ accept() [2/2]

◆ accepted()

◆ acceptProposedAction()

◆ action()

◆ colorData()

◆ formats()

◆ getDataAsArrayBuffer()

◆ getDataAsString()

◆ hasColor()

◆ hasHtml()

◆ hasText()

◆ hasUrls()

◆ html()

◆ keys()

◆ proposedAction()

◆ resetAction()

◆ setAccepted()

◆ setAction()

◆ source()

◆ supportedActions()

◆ text()

◆ urls()

◆ x()

◆ y()

Property Documentation

◆ accepted

◆ action

◆ colorData

◆ formats

◆ hasColor

◆ hasHtml

◆ hasText

◆ hasUrls

◆ html

◆ keys

◆ proposedAction

◆ source

◆ supportedActions

◆ text

◆ urls

◆ x

◆ y