Класс QDrag

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

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

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

Сигналы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

QDrag::QDrag(QObject *dragSource)

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

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

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

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

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

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

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

[virtual] QDrag::~QDrag()

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

[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)

Устанавливает курсор перетаскивания для действия. Это позволяет переопределить стандартные системные курсоры. Чтобы вернуться к использованию системного курсора для действия, передайте нулевой 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

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