Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include <qquickdrag_p.h>
Public Slots | |
void | start (QQmlV4FunctionPtr) |
\qmlattachedmethod void QtQuick::Drag::start(flags supportedActions) | |
void | startDrag (QQmlV4FunctionPtr) |
\qmlattachedmethod void QtQuick::Drag::startDrag(flags supportedActions) | |
void | cancel () |
\qmlattachedmethod void QtQuick::Drag::cancel() | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Signals | |
void | dragStarted () |
void | dragFinished (Qt::DropAction dropAction) |
void | activeChanged () |
void | sourceChanged () |
void | targetChanged () |
void | hotSpotChanged () |
void | imageSourceChanged () |
void | imageSourceSizeChanged () |
void | keysChanged () |
void | mimeDataChanged () |
void | supportedActionsChanged () |
void | proposedActionChanged () |
void | dragTypeChanged () |
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. | |
Public Member Functions | |
QQuickDragAttached (QObject *parent) | |
~QQuickDragAttached () | |
bool | isActive () const |
\qmlattachedproperty bool QtQuick::Drag::active | |
void | setActive (bool active) |
QObject * | source () const |
\qmlattachedproperty Object QtQuick::Drag::source | |
void | setSource (QObject *item) |
void | resetSource () |
QObject * | target () const |
\qmlattachedproperty Object QtQuick::Drag::target | |
QPointF | hotSpot () const |
\qmlattachedproperty QPointF QtQuick::Drag::hotSpot | |
void | setHotSpot (const QPointF &hotSpot) |
QUrl | imageSource () const |
\qmlattachedproperty QUrl QtQuick::Drag::imageSource | |
void | setImageSource (const QUrl &url) |
QSize | imageSourceSize () const |
\qmlattachedproperty size QtQuick::Drag::imageSourceSize | |
void | setImageSourceSize (const QSize &size) |
QStringList | keys () const |
\qmlattachedproperty stringlist QtQuick::Drag::keys | |
void | setKeys (const QStringList &keys) |
QVariantMap | mimeData () const |
\qmlattachedproperty var QtQuick::Drag::mimeData | |
void | setMimeData (const QVariantMap &mimeData) |
Qt::DropActions | supportedActions () const |
\qmlattachedproperty flags QtQuick::Drag::supportedActions | |
void | setSupportedActions (Qt::DropActions actions) |
Qt::DropAction | proposedAction () const |
\qmlattachedproperty enumeration QtQuick::Drag::proposedAction | |
void | setProposedAction (Qt::DropAction action) |
QQuickDrag::DragType | dragType () const |
\qmlattachedproperty enumeration QtQuick::Drag::dragType | |
void | setDragType (QQuickDrag::DragType dragType) |
Q_INVOKABLE int | drop () |
\qmlattachedmethod enumeration QtQuick::Drag::drop() | |
bool | event (QEvent *event) override |
This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
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 | 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 | |
bool | active |
QObject * | source |
QObject * | target |
QPointF | hotSpot |
QUrl | imageSource |
QSize | imageSourceSize |
QStringList | keys |
QVariantMap | mimeData |
Qt::DropActions | supportedActions |
Qt::DropAction | proposedAction |
QQuickDrag::DragType | dragType |
Properties inherited from QObject | |
QString | objectName |
the name of this object | |
Additional Inherited Members | |
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) | |
Definition at line 214 of file qquickdrag_p.h.
QQuickDragAttached::QQuickDragAttached | ( | QObject * | parent | ) |
Definition at line 181 of file qquickdrag.cpp.
QQuickDragAttached::~QQuickDragAttached | ( | ) |
Definition at line 189 of file qquickdrag.cpp.
|
signal |
|
slot |
\qmlattachedmethod void QtQuick::Drag::cancel()
Ends a drag sequence.
Definition at line 684 of file qquickdrag.cpp.
|
signal |
|
signal |
QQuickDrag::DragType QQuickDragAttached::dragType | ( | ) | const |
\qmlattachedproperty enumeration QtQuick::Drag::dragType
This property indicates whether to automatically start drags, do nothing, or to use backwards compatible internal drags. The default is to use backwards compatible internal drags.
A drag can also be started manually using \l startDrag.
\value Drag.None do not start drags automatically \value Drag.Automatic start drags automatically \value Drag.Internal (default) start backwards compatible drags automatically
When using Drag.Automatic
you should also define \l mimeData and bind the \l active property to the active property of MouseArea : \l {MouseArea::drag.active}
Definition at line 541 of file qquickdrag.cpp.
|
signal |
int QQuickDragAttached::drop | ( | ) |
\qmlattachedmethod enumeration QtQuick::Drag::drop()
Ends a drag sequence by sending a drop event to the target item.
Returns the action accepted by the target item. If the target item or a parent doesn't accept the drop event then Qt.IgnoreAction will be returned.
The returned 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).
Definition at line 636 of file qquickdrag.cpp.
|
overridevirtual |
This virtual function receives events to an object and should return true if the event e was recognized and processed.
The event() function can be reimplemented to customize the behavior of an object.
Make sure you call the parent event class implementation for all the events you did not handle.
Example:
Reimplemented from QObject.
Definition at line 156 of file qquickdrag.cpp.
QPointF QQuickDragAttached::hotSpot | ( | ) | const |
\qmlattachedproperty QPointF QtQuick::Drag::hotSpot
This property holds the drag position relative to the top left of the item.
By default this is (0, 0).
Changes to hotSpot trigger a new drag move with the updated position.
Definition at line 308 of file qquickdrag.cpp.
|
signal |
QUrl QQuickDragAttached::imageSource | ( | ) | const |
\qmlattachedproperty QUrl QtQuick::Drag::imageSource
This property holds the URL of the image which will be used to represent the data during the drag and drop operation. Changing this property after the drag operation has started will have no effect.
The example below uses an item's contents as a drag image:
Definition at line 342 of file qquickdrag.cpp.
|
signal |
QSize QQuickDragAttached::imageSourceSize | ( | ) | const |
\qmlattachedproperty size QtQuick::Drag::imageSourceSize
This property holds the size of the image that will be used to represent the data during the drag and drop operation. Changing this property after the drag operation has started will have no effect.
This property sets the maximum number of pixels stored for the loaded image so that large images do not use more memory than necessary. See \l {QtQuick::Image::sourceSize}{Image.sourceSize} for more details.
The example below shows an SVG image rendered at one size, and re-renders it at a different size for the drag image:
Definition at line 384 of file qquickdrag.cpp.
|
signal |
bool QQuickDragAttached::isActive | ( | ) | const |
\qmlattachedproperty bool QtQuick::Drag::active
This property holds whether a drag event sequence is currently active.
Binding this property to the active property of \l MouseArea::drag will cause \l startDrag to be called when the user starts dragging.
Setting this property to true will also send a QDragEnter event to the scene with the item's current position. Setting it to false will send a QDragLeave event.
While a drag is active any change in an item's position will send a QDragMove event with item's new position to the scene.
Definition at line 211 of file qquickdrag.cpp.
QStringList QQuickDragAttached::keys | ( | ) | const |
\qmlattachedproperty stringlist QtQuick::Drag::keys
This property holds a list of keys that can be used by a DropArea to filter drag events.
Changing the keys while a drag is active will reset the sequence of drag events by sending a drag leave event followed by a drag enter event with the new source.
Definition at line 426 of file qquickdrag.cpp.
|
signal |
QVariantMap QQuickDragAttached::mimeData | ( | ) | const |
\qmlattachedproperty var QtQuick::Drag::mimeData
This property holds a map from mime type to data that is used during startDrag. The mime data needs to be of a type that matches the mime type (e.g. a string if the mime type is "text/plain", or an image if the mime type is "image/png"), or an ArrayBuffer
with the data encoded according to the mime type.
Definition at line 453 of file qquickdrag.cpp.
|
signal |
Qt::DropAction QQuickDragAttached::proposedAction | ( | ) | const |
\qmlattachedproperty enumeration QtQuick::Drag::proposedAction
This property holds an action that is recommended by the drag source as a return value from Drag.drop().
Changes to proposedAction will trigger a move event with the updated proposal.
Definition at line 503 of file qquickdrag.cpp.
|
signal |
void QQuickDragAttached::resetSource | ( | ) |
Definition at line 269 of file qquickdrag.cpp.
void QQuickDragAttached::setActive | ( | bool | active | ) |
Definition at line 217 of file qquickdrag.cpp.
void QQuickDragAttached::setDragType | ( | QQuickDrag::DragType | dragType | ) |
Definition at line 547 of file qquickdrag.cpp.
Definition at line 314 of file qquickdrag.cpp.
Definition at line 348 of file qquickdrag.cpp.
Definition at line 404 of file qquickdrag.cpp.
void QQuickDragAttached::setKeys | ( | const QStringList & | keys | ) |
Definition at line 432 of file qquickdrag.cpp.
void QQuickDragAttached::setMimeData | ( | const QVariantMap & | mimeData | ) |
Definition at line 459 of file qquickdrag.cpp.
void QQuickDragAttached::setProposedAction | ( | Qt::DropAction | action | ) |
Definition at line 509 of file qquickdrag.cpp.
Definition at line 258 of file qquickdrag.cpp.
void QQuickDragAttached::setSupportedActions | ( | Qt::DropActions | actions | ) |
Definition at line 483 of file qquickdrag.cpp.
QObject * QQuickDragAttached::source | ( | ) | const |
\qmlattachedproperty Object QtQuick::Drag::source
This property holds an object that is identified to recipients of drag events as the source of the events. By default this is the item that the Drag property is attached to.
Changing the source while a drag is active will reset the sequence of drag events by sending a drag leave event followed by a drag enter event with the new source.
Definition at line 252 of file qquickdrag.cpp.
|
signal |
|
slot |
\qmlattachedmethod void QtQuick::Drag::start(flags supportedActions)
Starts sending drag events. Used for starting old-style internal drags. \l startDrag is the new-style, preferred method of starting drags.
The optional supportedActions argument can be used to override the \l supportedActions property for the started sequence.
Definition at line 594 of file qquickdrag.cpp.
|
slot |
\qmlattachedmethod void QtQuick::Drag::startDrag(flags supportedActions)
Starts sending drag events.
The optional supportedActions argument can be used to override the \l supportedActions property for the started sequence.
Definition at line 877 of file qquickdrag.cpp.
Qt::DropActions QQuickDragAttached::supportedActions | ( | ) | const |
\qmlattachedproperty flags QtQuick::Drag::supportedActions
This property holds return values of Drag.drop() supported by the drag source.
Changing the supportedActions while a drag is active will reset the sequence of drag events by sending a drag leave event followed by a drag enter event with the new source.
Definition at line 477 of file qquickdrag.cpp.
|
signal |
QObject * QQuickDragAttached::target | ( | ) | const |
\qmlattachedproperty Object QtQuick::Drag::target
While a drag is active this property holds the last object to accept an enter event from the dragged item, if the current drag position doesn't intersect any accepting targets it is null.
When a drag is not active this property holds the object that accepted the drop event that ended the drag, if no object accepted the drop or the drag was canceled the target will then be null.
Definition at line 292 of file qquickdrag.cpp.
|
signal |
|
readwrite |
Definition at line 219 of file qquickdrag_p.h.
|
readwrite |
Definition at line 230 of file qquickdrag_p.h.
|
readwrite |
Definition at line 222 of file qquickdrag_p.h.
|
readwrite |
Definition at line 223 of file qquickdrag_p.h.
|
readwrite |
Definition at line 225 of file qquickdrag_p.h.
|
readwrite |
Definition at line 226 of file qquickdrag_p.h.
|
readwrite |
Definition at line 227 of file qquickdrag_p.h.
|
readwrite |
Definition at line 229 of file qquickdrag_p.h.
|
readwrite |
Definition at line 220 of file qquickdrag_p.h.
|
readwrite |
Definition at line 228 of file qquickdrag_p.h.
|
read |
Definition at line 221 of file qquickdrag_p.h.