Класс QClipboard

Класс QClipboard предоставляет доступ к буферу обмена системы. Подробнее...

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

Типы

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

Сигналы

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

Буфер обмена предоставляет простой механизм копирования и вставки данных между приложениями.

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

В приложении существует один объект QClipboard, доступный как QGuiApplication::clipboard().

Пример:

QClipboard *clipboard = QGuiApplication::clipboard();
QString originalText = clipboard->text();
...
clipboard->setText(newText);

QClipboard предоставляет некоторые удобные функции для доступа к общим типам данных: setText() позволяет обмениваться текстом Unicode, а setPixmap() и setImage() позволяют обмениваться QPixmap и QImage между приложениями. Функция setMimeData() обеспечивает максимальную гибкость: она позволяет добавить любой QMimeData в буфер обмена. Для каждого из них есть соответствующие функции-получатели, например, text(), image() и pixmap(). Вы можете очистить буфер обмена, вызвав clear().

Типичный пример использования этих функций:

void DropArea::paste()
{
    const QClipboard *clipboard = QApplication::clipboard();
    const QMimeData *mimeData = clipboard->mimeData();

    if (mimeData->hasImage()) {
        setPixmap(qvariant_cast<QPixmap>(mimeData->imageData()));
    } else if (mimeData->hasHtml()) {
        setText(mimeData->html());
        setTextFormat(Qt::RichText);
    } else if (mimeData->hasText()) {
        setText(mimeData->text());
        setTextFormat(Qt::PlainText);
    } else {
        setText(tr("Cannot display data"));
    }

Примечания для пользователей X11

• Система окон X11 имеет понятие отдельного выделения и буфера обмена. При выделении текста он сразу же становится доступным как глобальное выделение мыши. Глобальное выделение мыши может быть скопировано в буфер обмена. По соглашению, для вставки глобального выделения мыши используется средняя кнопка мыши.
• X11 также имеет понятие владения; если вы измените выделение в окне, X11 будет уведомлять только владельца и предыдущего владельца об изменении, т. е. он не будет уведомлять все приложения об изменении выделения или данных буфера обмена.
• Наконец, буфер обмена X11 управляется событиями, т. е. буфер обмена не будет работать должным образом, если цикл событий не запущен. Аналогично, рекомендуется хранить или извлекать содержимое буфера обмена непосредственно в ответ на события ввода пользователя, например, нажатия и отпускания кнопок мыши или клавиш. Не следует хранить или извлекать содержимое буфера обмена в ответ на события таймера или события, не связанные с вводом пользователя.
• Поскольку нет стандартного способа копирования и вставки файлов между приложениями в X11, в настоящее время используются различные типы MIME и соглашения. Например, Nautilus ожидает, что файлы будут предоставлены с типом MIME x-special/gnome-copied-files с данными, начинающимися с действия вырезания/копирования, символа новой строки и URL-адреса файла.

Примечания для пользователей macOS

macOS поддерживает отдельный буфер поиска, который содержит текущую строку поиска в операциях поиска. Этот буфер поиска можно получить, указав режим FindBuffer.

Примечания для пользователей Windows и macOS

• Windows и macOS не поддерживают глобальное выделение мыши; они поддерживают только глобальный буфер обмена, т. е. они добавляют текст в буфер обмена только при выполнении явного копирования или вырезания.
• Windows и macOS не имеют понятия владения; буфер обмена является полностью глобальным ресурсом, поэтому все приложения уведомляются об изменениях.

Примечания для пользователей Universal Windows Platform

• Universal Windows Platform позволяет запрашивать буфер обмена только в том случае, если приложение активно и окно приложения имеет фокус. Доступ к данным буфера обмена в фоновом режиме завершится из-за отказа в доступе.

См. также QGuiApplication.

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

перечисление QClipboard::Mode

Этот тип перечисления используется для управления частью буфера обмена системы, используемой QClipboard::mimeData(), QClipboard::setMimeData() и связанными функциями.

См. также QClipboard::supportsSelection().

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

[signal] void QClipboard::changed(QClipboard::Mode mode)

Этот сигнал испускается, когда изменяются данные для данного режима буфера обмена mode.

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

См. также dataChanged(), selectionChanged() и findBufferChanged().

[signal] void QClipboard::dataChanged()

Этот сигнал испускается, когда данные буфера обмена изменяются.

В macOS и с версией Qt 4.3 или выше изменения буфера обмена, внесенные другими приложениями, будут обнаружены только при активации приложения.

См. также findBufferChanged(), selectionChanged() и changed().

[signal] void QClipboard::findBufferChanged()

Этот сигнал испускается при изменении буфера поиска. Это относится только к macOS.

В Qt версии 4.3 или выше изменения буфера обмена, произведённые другими приложениями, будут обнаружены только при активации приложения.

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

См. также dataChanged(), selectionChanged() и changed().

[signal] void QClipboard::selectionChanged()

Этот сигнал испускается при изменении выделения. Это относится только к системам окон, которые поддерживают выделение, например, X11. Windows и macOS не поддерживают выделения.

См. также dataChanged(), findBufferChanged() и changed().

void QClipboard::clear(QClipboard::Mode mode = Clipboard)

Очистить содержимое буфера обмена.

Аргумент mode используется для управления частью системного буфера обмена, которая используется. Если mode равен QClipboard::Clipboard, эта функция очищает глобальное содержимое буфера обмена. Если mode равен QClipboard::Selection, эта функция очищает глобальное содержимое выделения мыши. Если mode равен QClipboard::FindBuffer, эта функция очищает буфер строки поиска.

См. также QClipboard::Mode и supportsSelection().

QImage QClipboard::image(QClipboard::Mode mode = Clipboard) const

Возвращает изображение из буфера обмена или возвращает пустое изображение, если буфер обмена не содержит изображение или содержит изображение в формате, не поддерживаемом системой.

Аргумент mode используется для управления частью системного буфера обмена, которая используется. Если mode равен QClipboard::Clipboard, изображение извлекается из глобального буфера обмена. Если mode равен QClipboard::Selection, изображение извлекается из глобального выделения мыши.

См. также setImage(), pixmap(), mimeData() и QImage::isNull().

const QMimeData *QClipboard::mimeData(QClipboard::Mode mode = Clipboard) const

Возвращает указатель на QMimeData, представляющий текущие данные буфера обмена (может быть nullptr если данный mode не поддерживается платформой).

Аргумент mode используется для управления частью системного буфера обмена, которая используется. Если mode равен QClipboard::Clipboard, данные извлекаются из глобального буфера обмена. Если mode равен QClipboard::Selection, данные извлекаются из глобального выделения мыши. Если mode равен QClipboard::FindBuffer, данные извлекаются из буфера строки поиска.

Функции text(), image() и pixmap() являются более простыми обёртками для извлечения текстовых, графических и пиктограммных данных.

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

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

bool QClipboard::ownsClipboard() const

Возвращает true если этот объект буфера обмена владеет данными буфера обмена; в противном случае возвращает false.

bool QClipboard::ownsFindBuffer() const

Возвращает true если этот объект буфера обмена владеет данными буфера поиска; в противном случае возвращает false.

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

bool QClipboard::ownsSelection() const

Возвращает true если этот объект буфера обмена владеет данными выделения мыши; в противном случае возвращает false.

QPixmap QClipboard::pixmap(QClipboard::Mode mode = Clipboard) const

Возвращает пиктограмму из буфера обмена или пустое значение, если буфер обмена не содержит пиктограмму. Обратите внимание, что это может привести к потере информации. Например, если изображение 24-битное, а дисплей 8-битный, результат преобразуется в 8 бит, а если изображение имеет альфа-канал, результат просто имеет маску.

Аргумент mode используется для управления частью системного буфера обмена, которая используется. Если mode равен QClipboard::Clipboard, пиктограмма извлекается из глобального буфера обмена. Если mode равен QClipboard::Selection, пиктограмма извлекается из глобального выделения мыши.

См. также setPixmap(), image(), mimeData() и QPixmap::convertFromImage().

void QClipboard::setImage(const QImage &image, QClipboard::Mode mode = Clipboard)

Копирует image в буфер обмена.

Аргумент mode используется для управления частью системного буфера обмена, которая используется. Если mode равен QClipboard::Clipboard, изображение сохраняется в глобальном буфере обмена. Если mode равен QClipboard::Selection, данные сохраняются в глобальном выделении мыши.

Это сокращение для:

QMimeData *data = new QMimeData;
data->setImageData(image);
clipboard->setMimeData(data, mode);

См. также image(), setPixmap() и setMimeData().

void QClipboard::setMimeData(QMimeData *src, QClipboard::Mode mode = Clipboard)

Устанавливает данные буфера обмена на src. Владение данными передаётся буферу обмена. Если вы хотите удалить данные, вызовите clear() или снова вызовите setMimeData() с новыми данными.

Аргумент mode используется для управления частью системного буфера обмена, которая используется. Если mode равен QClipboard::Clipboard, данные сохраняются в глобальном буфере обмена. Если mode равен QClipboard::Selection, данные сохраняются в глобальном выделении мыши. Если mode равен QClipboard::FindBuffer, данные сохраняются в буфере строки поиска.

Функции setText(), setImage() и setPixmap() являются более простыми обёртками для установки текстовых, графических и пиктограммных данных соответственно.

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

void QClipboard::setPixmap(const QPixmap &pixmap, QClipboard::Mode mode = Clipboard)

Копирует pixmap в буфер обмена. Обратите внимание, что это медленнее, чем setImage(), потому что ему сначала нужно преобразовать QPixmap в QImage.

Аргумент mode используется для управления частью системного буфера обмена, которая используется. Если mode равен QClipboard::Clipboard, пиктограмма сохраняется в глобальном буфере обмена. Если mode равен QClipboard::Selection, пиктограмма сохраняется в глобальном выделении мыши.

См. также pixmap(), setImage() и setMimeData().

void QClipboard::setText(const QString &text, QClipboard::Mode mode = Clipboard)

Копирует text в буфер обмена как обычный текст.

Аргумент mode используется для управления частью системного буфера обмена, которая используется. Если mode равен QClipboard::Clipboard, текст сохраняется в глобальном буфере обмена. Если mode равен QClipboard::Selection, текст сохраняется в глобальном выделении мыши. Если mode равен QClipboard::FindBuffer, текст сохраняется в буфере строки поиска.

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

bool QClipboard::supportsFindBuffer() const

Возвращает true если буфер обмена поддерживает отдельный буфер поиска; в противном случае возвращает false.

bool QClipboard::supportsSelection() const

Возвращает true если буфер обмена поддерживает выделение мыши; в противном случае возвращает false.

QString QClipboard::text(QClipboard::Mode mode = Clipboard) const

Возвращает текст из буфера обмена в формате обычного текста или пустую строку, если буфер обмена не содержит текста.

Аргумент mode используется для управления частью системного буфера обмена, которая используется. Если mode равен QClipboard::Clipboard, текст извлекается из глобального буфера обмена. Если mode равен QClipboard::Selection, текст извлекается из глобального выделения мыши. Если mode равен QClipboard::FindBuffer, текст извлекается из буфера строки поиска.

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

QString QClipboard::text(QString &subtype, QClipboard::Mode mode = Clipboard) const

Это перегруженный метод.

Возвращает текст буфера обмена в подтипе subtype или пустую строку, если буфер обмена не содержит текста. Если subtype равно null, любой подтип приемлем, и subtype устанавливается в выбранный подтип.

Аргумент mode используется для управления тем, какая часть системного буфера обмена используется. Если mode равен QClipboard::Clipboard, текст извлекается из глобального буфера обмена. Если mode равен QClipboard::Selection, текст извлекается из глобального выделения мыши.

Общие значения для subtype — "plain" и "html".

Обратите внимание, что многократное вызов этого метода, например, из обработчика событий нажатия клавиши, может быть медленным. В таких случаях следует использовать сигнал dataChanged() вместо этого.

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