Класс QDrag

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

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

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

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

Сигналы

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

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

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

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

• 1 свойство унаследовано от QObject
• 1 открытый слот унаследован от QObject
• 9 защищённых функций унаследованы от 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 может выполнить очистку после завершения операции перетаскивания.

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

[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 передайте null 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().