Search for usage in LXR

DeclarativeMimeData Class Reference
Inheritance diagram for DeclarativeMimeData:


QColor color
QStringList formats
bool hasUrls
QString html
QString text
QUrl url
QJsonArray urls
- Properties inherited from QObject


void colorChanged ()
void htmlChanged ()
void sourceChanged ()
void textChanged ()
void urlChanged ()
void urlsChanged ()

Public Member Functions

 DeclarativeMimeData ()
 DeclarativeMimeData (const QMimeData *copy)
QColor color () const
Q_INVOKABLE QByteArray getDataAsByteArray (const QString &format)
Q_INVOKABLE bool hasColor () const
void setColor (const QColor &color)
Q_INVOKABLE void setData (const QString &mimeType, const QVariant &data)
void setSource (QQuickItem *source)
void setUrl (const QUrl &url)
void setUrls (const QJsonArray &urls)
QQuickItemsource () const
QUrl url () const
QJsonArray urls () const
- Public Member Functions inherited from QMimeData
void clear ()
QVariant colorData () const const
QByteArray data (const QString &mimeType) const const
virtual QStringList formats () const const
bool hasColor () const const
virtual bool hasFormat (const QString &mimeType) const const
bool hasHtml () const const
bool hasImage () const const
bool hasText () const const
bool hasUrls () const const
QString html () const const
QVariant imageData () const const
void removeFormat (const QString &mimeType)
void setColorData (const QVariant &color)
void setData (const QString &mimeType, const QByteArray &data)
void setHtml (const QString &html)
void setImageData (const QVariant &image)
void setText (const QString &text)
void setUrls (const QList< QUrl > &urls)
QString text () const const
QList< QUrlurls () const const
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
QBindable< QStringbindableObjectName ()
bool blockSignals (bool block)
const QObjectListchildren () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo () const const
void dumpObjectTree () const const
QList< QByteArraydynamicPropertyNames () const const
virtual bool event (QEvent *e)
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isQuickItemType () const const
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setObjectName (QAnyStringView name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool setProperty (const char *name, QVariant &&value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThreadthread () const const

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool disconnect (const QMetaObject::Connection &connection)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
- Public Attributes inherited from QObject
typedef QObjectList
- Protected Member Functions inherited from QMimeData
virtual QVariant retrieveData (const QString &mimeType, QMetaType type) const const
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signal)
bool isSignalConnected (const QMetaMethod &signal) const const
int receivers (const char *signal) const const
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)

Detailed Description

Creates a new DeclarativeMimeData by cloning the QMimeData passed as parameter. This is useful for two reasons :

  • In DragArea, we want to clone our "working copy" of the DeclarativeMimeData instance, as Qt will automatically delete it after the drag and drop operation.
  • In the drop events, the QMimeData is const, and we have troubles passing const to QML. So we clone it to remove the "constness"

This method will try to cast the QMimeData to DeclarativeMimeData, and will clone our extensions to QMimeData as well

Definition at line 17 of file DeclarativeMimeData.h.

Property Documentation

◆ color

QColor DeclarativeMimeData::color

A color if the data stored in the object represents a color (MIME type application/x-color); otherwise QColor().

Definition at line 45 of file DeclarativeMimeData.h.

◆ formats

QStringList DeclarativeMimeData::formats
See also

Definition at line 59 of file DeclarativeMimeData.h.

◆ hasUrls

bool DeclarativeMimeData::hasUrls
See also

Definition at line 53 of file DeclarativeMimeData.h.

◆ html

QString DeclarativeMimeData::html

A string if the data stored in the object is HTML (MIME type text/html); otherwise returns an empty string.

Definition at line 29 of file DeclarativeMimeData.h.

◆ source

QQuickItem * DeclarativeMimeData::source

The graphical item on the scene that started the drag event.

It may be null.

Definition at line 50 of file DeclarativeMimeData.h.

◆ text

QString DeclarativeMimeData::text

A plain text (MIME type text/plain) representation of the data.

Definition at line 24 of file DeclarativeMimeData.h.

◆ url

QUrl DeclarativeMimeData::url

Url contained in the mimedata.

Definition at line 34 of file DeclarativeMimeData.h.

◆ urls

QJsonArray DeclarativeMimeData::urls

A list of URLs contained within the MIME data object.

URLs correspond to the MIME type text/uri-list.

Definition at line 40 of file DeclarativeMimeData.h.

Constructor & Destructor Documentation

◆ DeclarativeMimeData() [1/2]

DeclarativeMimeData::DeclarativeMimeData ( )

\qmlclass MimeData DeclarativeMimeData

This is a wrapper class around QMimeData, with a few extensions to provide better support for in-qml drag & drops.

Definition at line 16 of file DeclarativeMimeData.cpp.

◆ DeclarativeMimeData() [2/2]

DeclarativeMimeData::DeclarativeMimeData ( const QMimeData * copy)

Definition at line 35 of file DeclarativeMimeData.cpp.

Member Function Documentation

◆ color()

QColor DeclarativeMimeData::color ( ) const

Definition at line 99 of file DeclarativeMimeData.cpp.

◆ getDataAsByteArray()

QByteArray DeclarativeMimeData::getDataAsByteArray ( const QString & format)

Definition at line 151 of file DeclarativeMimeData.cpp.

◆ hasColor()

bool DeclarativeMimeData::hasColor ( ) const

Definition at line 107 of file DeclarativeMimeData.cpp.

◆ setColor()

void DeclarativeMimeData::setColor ( const QColor & color)

Definition at line 113 of file DeclarativeMimeData.cpp.

◆ setData()

void DeclarativeMimeData::setData ( const QString & mimeType,
const QVariant & data )

Definition at line 121 of file DeclarativeMimeData.cpp.

◆ setSource()

void DeclarativeMimeData::setSource ( QQuickItem * source)

Definition at line 143 of file DeclarativeMimeData.cpp.

◆ setUrl()

void DeclarativeMimeData::setUrl ( const QUrl & url)

Definition at line 65 of file DeclarativeMimeData.cpp.

◆ setUrls()

void DeclarativeMimeData::setUrls ( const QJsonArray & urls)

Definition at line 87 of file DeclarativeMimeData.cpp.

◆ source()

QQuickItem * DeclarativeMimeData::source ( ) const

\qmlproperty item MimeData::source

Setting source to any existing qml item will enable the receiver of the drag and drop operation to know in which item the operation originated.

In the case of inter-application drag and drop operations, the source will not be available, and will be 0. Be sure to test it in your QML code, before using it, or it will generate errors in the console.

Definition at line 139 of file DeclarativeMimeData.cpp.

◆ url()

QUrl DeclarativeMimeData::url ( ) const

\qmlproperty url MimeData::url

Returns the first URL from the urls property of QMimeData TODO: We should use QDeclarativeListProperty<QUrls> to return the whole list instead of only the first element.

Definition at line 58 of file DeclarativeMimeData.cpp.

◆ urls()

QJsonArray DeclarativeMimeData::urls ( ) const

Definition at line 77 of file DeclarativeMimeData.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 21 2024 12:00:24 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.