Класс QDrag

Класс QDrag предоставляет поддержку передачи данных перетаскиванием и сбрасыванием на основе MIME. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Открытые функции

• 34 открытые функции, унаследованные от QObject

Сигналы

• 2 сигнала, унаследованные от QObject

Статические открытые члены

• 10 статических открытых членов, унаследованных от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 открытый слот, унаследованный от QObject
• 1 открытая переменная, унаследованная от QObject
• 9 защищенных функций, унаследованных от QObject
• 2 защищенных переменных, унаследованных от QObject

Подробное описание

Класс QDrag предоставляет поддержку передачи данных перетаскиванием и сбрасыванием на основе MIME.

Перетаскивание и сбрасывание — интуитивный способ для пользователей копировать или перемещать данные в приложении, и используется во многих средах рабочего стола в качестве механизма для копирования данных между приложениями. Поддержка перетаскивания и сбрасывания в Qt основана на классе QDrag, который обрабатывает большинство деталей операции перетаскивания и сбрасывания.

Данные, которые должны быть переданы при операции перетаскивания и сбрасывания, содержатся в объекте QMimeData. Это задаётся с помощью функции setMimeData() следующим образом:

        QDrag *drag = new QDrag(this);
        QMimeData *mimeData = new QMimeData;

        mimeData->setText(commentEdit->toPlainText());
        drag->setMimeData(mimeData);

Обратите внимание, что setMimeData() назначает владение объектом QMimeData объекту QDrag. Объект QDrag должен быть создан на куче с родительским объектом QObject, чтобы гарантировать, что Qt может очистить его после завершения операции перетаскивания и сбрасывания.

QPixmap может использоваться для представления данных во время перетаскивания и будет перемещаться вместе с курсором к цели сбрасывания. Эта pixmap обычно отображает значок, представляющий тип MIME передаваемых данных, но любая pixmap может быть задана с помощью setPixmap(). Положение курсора может быть задано относительно верхнего левого угла pixmap с помощью функции setHotSpot(). Следующий код позиционирует pixmap так, чтобы курсор указывал на центр нижнего края:

    drag->setHotSpot(QPoint(drag->pixmap().width()/2,
                            drag->pixmap().height()));

Примечание: На X11 pixmap может не успевать за перемещениями мыши, если точка фокусировки приводит к отображению pixmap непосредственно под курсором.

Источник и целевые виджеты могут быть найдены с помощью source() и target(). Эти функции часто используются для определения, началась ли операция перетаскивания и сбрасывания в одном виджете, так что можно реализовать специальное поведение.

QDrag обрабатывает только саму операцию перетаскивания и сбрасывания. Разработчику необходимо определить, когда начинается операция перетаскивания и как объект QDrag должен быть создан и использован. Для данного виджета часто необходимо переопределить mousePressEvent(), чтобы определить, нажал ли пользователь кнопку мыши, и переопределить mouseMoveEvent(), чтобы проверить, нужен ли объект QDrag.

См. также Перетаскивание и сбрасывание, QClipboard, QMimeData, QMacPasteboardMime, Пример значков, которые можно перетаскивать, Пример перетаскиваемого текста, Пример целевой области сброса и Пример магнитов для холодильника.

Документация по функциям-членам

QDrag::QDrag(QObject *dragSource)

Создаёт новый объект перетаскивания для виджета, заданного dragSource.

[virtual] QDrag::~QDrag()

Уничтожает объект перетаскивания.

[signal] void QDrag::actionChanged(Qt::DropAction action)

Этот сигнал испускается, когда изменяется action, связанный с перетаскиванием.

См. также targetChanged().

[static] void QDrag::cancel()

Отменяет операцию перетаскивания, инициированную Qt.

Примечание: В настоящее время реализовано в Windows и X11.

Эта функция была добавлена в Qt 5.7.

См. также exec().

Qt::DropAction QDrag::defaultAction() const

Возвращает предлагаемое по умолчанию действие сброса для этой операции перетаскивания.

См. также exec() и supportedActions().

QPixmap QDrag::dragCursor(Qt::DropAction action) const

Возвращает курсор перетаскивания для action.

Эта функция была добавлена в Qt 5.0.

См. также setDragCursor().

Qt::DropAction QDrag::exec(Qt::DropActions supportedActions = Qt::MoveAction)

Инициирует операцию перетаскивания и сбрасывания и возвращает значение, указывающее затребованное действие сброса при завершении. Действия сброса, которые может выбрать пользователь, задаются в supportedActions. Предлагаемое по умолчанию действие будет выбрано среди разрешенных действий в следующем порядке: Переместить, Скопировать и Связать.

Примечание: В Linux и macOS операция перетаскивания и сбрасывания может занять некоторое время, но эта функция не блокирует цикл событий. Другие события всё ещё доставляются приложению, пока выполняется операция. В Windows цикл событий Qt блокируется во время операции.

Эта функция была добавлена в Qt 4.3.

См. также cancel().

Qt::DropAction QDrag::exec(Qt::DropActions supportedActions, Qt::DropAction defaultDropAction)

Инициализирует операцию перетаскивания и возвращает значение, указывающее на запрошенное действие опускания по завершении. Действия опускания, которые может выбрать пользователь, задаются в supportedActions.

defaultDropAction определяет, какое действие будет предложено, когда пользователь выполняет перетаскивание без использования модификаторов.

Примечание: В Linux и macOS операция перетаскивания может занять некоторое время, но эта функция не блокирует цикл событий. Другие события по-прежнему доставляются приложению во время выполнения операции. В Windows цикл событий Qt блокируется во время операции. Однако, QDrag::exec() в Windows вызывает processEvents() часто, чтобы сохранить отзывчивость графического интерфейса. Если какие-либо циклы или операции вызываются во время активной операции перетаскивания, это заблокирует операцию перетаскивания.

Эта функция была добавлена в Qt 4.3.

QPoint QDrag::hotSpot() const

Возвращает положение горячей точки относительно левого верхнего угла курсора.

См. также setHotSpot().

QMimeData *QDrag::mimeData() const

Возвращает данные MIME, инкапсулированные объектом перетаскивания.

См. также setMimeData().

QPixmap QDrag::pixmap() const

Возвращает пиксель, используемый для представления данных в операции перетаскивания и опускания.

См. также setPixmap().

void QDrag::setDragCursor(const QPixmap &cursor, Qt::DropAction action)

Устанавливает курсор перетаскивания cursor для действия action. Это позволяет переопределить стандартные системные курсоры. Для возврата к использованию системного курсора для action передайте нулевой QPixmap как cursor.

Примечание: установка курсора перетаскивания для IgnoreAction может не работать на всех платформах. Тестировалось на X11 и macOS. Windows не поддерживает это.

См. также dragCursor().

void QDrag::setHotSpot(const QPoint &hotspot)

Устанавливает положение горячей точки относительно левого верхнего угла пиксельного изображения, заданного в hotspot.

Примечание: в X11 пиксельное изображение может не успевать за перемещением мыши, если горячая точка приводит к отображению пиксельного изображения непосредственно под курсором.

См. также hotSpot().

void QDrag::setMimeData(QMimeData *data)

Устанавливает данные, которые должны быть отправлены в заданные данные MIME data. Владение данными передаётся объекту QDrag.

См. также mimeData().

void QDrag::setPixmap(const QPixmap &pixmap)

Устанавливает pixmap в качестве пиксельного изображения, используемого для представления данных в операции перетаскивания и опускания. Вы можете установить пиксельное изображение только до начала перетаскивания.

См. также pixmap().

QObject *QDrag::source() const

Возвращает источник объекта перетаскивания. Это виджет, откуда началась операция перетаскивания и опускания.

Qt::DropActions QDrag::supportedActions() const

Возвращает набор возможных действий опускания для этой операции перетаскивания.

См. также exec() и defaultAction().

QObject *QDrag::target() const

Возвращает целевой объект операции перетаскивания и опускания. Это виджет, в который был опущен объект перетаскивания.

[signal] void QDrag::targetChanged(QObject *newTarget)

Этот сигнал излучается, когда целевой объект операции перетаскивания и опускания изменяется, где newTarget – новая цель.

См. также target() и actionChanged().