Класс QDrag

Класс 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 может выполнить очистку после завершения операции перетаскивания.

Пиктограмма может использоваться для представления данных во время перетаскивания и будет перемещаться вместе с курсором к цели. Эта пиктограмма обычно отображает значок, представляющий тип 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 вызывает процессEvents() часто, чтобы поддерживать отзывчивость графического интерфейса. Если какие-либо циклы или операции вызываются во время активной операции перетаскивания, это заблокирует операцию перетаскивания.

Эта функция была представлена в 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

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