Struct qt_gui::QClipboard

#[repr(C)]pub struct QClipboard { /* fields omitted */ }

The QClipboard class provides access to the window system clipboard.

C++ class: QClipboard.

C++ documentation:

The QClipboard class provides access to the window system clipboard.

The clipboard offers a simple mechanism to copy and paste data between applications.

QClipboard supports the same data types that QDrag does, and uses similar mechanisms. For advanced clipboard usage read Drag and Drop.

There is a single QClipboard object in an application, accessible as QGuiApplication::clipboard().

Example:

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

QClipboard features some convenience functions to access common data types: setText() allows the exchange of Unicode text and setPixmap() and setImage() allows the exchange of QPixmaps and QImages between applications. The setMimeData() function is the ultimate in flexibility: it allows you to add any QMimeData into the clipboard. There are corresponding getters for each of these, e.g. text(), image() and pixmap(). You can clear the clipboard by calling clear().

A typical example of the use of these functions follows:

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"));
      }

Methods

impl QClipboard

pub fn changed(&self) -> Signal<(Mode,)>

This signal is emitted when the data for the given clipboard mode is changed.

Returns a built-in Qt signal QClipboard::changed that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the data for the given clipboard mode is changed.

This function was introduced in Qt 4.2.

See also dataChanged(), selectionChanged(), and findBufferChanged().

pub fn selection_changed(&self) -> Signal<()>

This signal is emitted when the selection is changed. This only applies to windowing systems that support selections, e.g. X11. Windows and macOS don't support selections.

Returns a built-in Qt signal QClipboard::selectionChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the selection is changed. This only applies to windowing systems that support selections, e.g. X11. Windows and macOS don't support selections.

See also dataChanged(), findBufferChanged(), and changed().

pub fn find_buffer_changed(&self) -> Signal<()>

This signal is emitted when the find buffer is changed. This only applies to macOS.

Returns a built-in Qt signal QClipboard::findBufferChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the find buffer is changed. This only applies to macOS.

With Qt version 4.3 or higher, clipboard changes made by other applications will only be detected when the application is activated.

This function was introduced in Qt 4.2.

See also dataChanged(), selectionChanged(), and changed().

pub fn data_changed(&self) -> Signal<()>

This signal is emitted when the clipboard data is changed.

Returns a built-in Qt signal QClipboard::dataChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted when the clipboard data is changed.

On macOS and with Qt version 4.3 or higher, clipboard changes made by other applications will only be detected when the application is activated.

See also findBufferChanged(), selectionChanged(), and changed().

pub unsafe fn clear_1a(&self, mode: Mode)

Clear the clipboard contents.

Calls C++ function: void QClipboard::clear(QClipboard::Mode mode = …).

C++ documentation:

Clear the clipboard contents.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, this function clears the global clipboard contents. If mode is QClipboard::Selection, this function clears the global mouse selection contents. If mode is QClipboard::FindBuffer, this function clears the search string buffer.

See also QClipboard::Mode and supportsSelection().

pub unsafe fn clear_0a(&self)

Clear the clipboard contents.

Calls C++ function: void QClipboard::clear().

C++ documentation:

Clear the clipboard contents.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, this function clears the global clipboard contents. If mode is QClipboard::Selection, this function clears the global mouse selection contents. If mode is QClipboard::FindBuffer, this function clears the search string buffer.

See also QClipboard::Mode and supportsSelection().

pub unsafe fn image_1a(&self, mode: Mode) -> CppBox<QImage>

Returns the clipboard image, or returns a null image if the clipboard does not contain an image or if it contains an image in an unsupported image format.

Calls C++ function: QImage QClipboard::image(QClipboard::Mode mode = …) const.

C++ documentation:

Returns the clipboard image, or returns a null image if the clipboard does not contain an image or if it contains an image in an unsupported image format.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the image is retrieved from the global clipboard. If mode is QClipboard::Selection, the image is retrieved from the global mouse selection.

See also setImage(), pixmap(), mimeData(), and QImage::isNull().

pub unsafe fn image_0a(&self) -> CppBox<QImage>

Returns the clipboard image, or returns a null image if the clipboard does not contain an image or if it contains an image in an unsupported image format.

Calls C++ function: QImage QClipboard::image() const.

C++ documentation:

Returns the clipboard image, or returns a null image if the clipboard does not contain an image or if it contains an image in an unsupported image format.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the image is retrieved from the global clipboard. If mode is QClipboard::Selection, the image is retrieved from the global mouse selection.

See also setImage(), pixmap(), mimeData(), and QImage::isNull().

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QClipboard::metaObject() const.

pub unsafe fn mime_data_1a(&self, mode: Mode) -> QPtr<QMimeData>

Returns a pointer to a QMimeData representation of the current clipboard data (can be NULL if the given mode is not supported by the platform).

Calls C++ function: const QMimeData* QClipboard::mimeData(QClipboard::Mode mode = …) const.

C++ documentation:

Returns a pointer to a QMimeData representation of the current clipboard data (can be NULL if the given mode is not supported by the platform).

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the data is retrieved from the global clipboard. If mode is QClipboard::Selection, the data is retrieved from the global mouse selection. If mode is QClipboard::FindBuffer, the data is retrieved from the search string buffer.

The text(), image(), and pixmap() functions are simpler wrappers for retrieving text, image, and pixmap data.

Note: The pointer returned might become invalidated when the contents of the clipboard changes; either by calling one of the setter functions or externally by the system clipboard changing.

See also setMimeData().

pub unsafe fn mime_data_0a(&self) -> QPtr<QMimeData>

Returns a pointer to a QMimeData representation of the current clipboard data (can be NULL if the given mode is not supported by the platform).

Calls C++ function: const QMimeData* QClipboard::mimeData() const.

C++ documentation:

Returns a pointer to a QMimeData representation of the current clipboard data (can be NULL if the given mode is not supported by the platform).

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the data is retrieved from the global clipboard. If mode is QClipboard::Selection, the data is retrieved from the global mouse selection. If mode is QClipboard::FindBuffer, the data is retrieved from the search string buffer.

The text(), image(), and pixmap() functions are simpler wrappers for retrieving text, image, and pixmap data.

Note: The pointer returned might become invalidated when the contents of the clipboard changes; either by calling one of the setter functions or externally by the system clipboard changing.

See also setMimeData().

pub unsafe fn owns_clipboard(&self) -> bool

Returns true if this clipboard object owns the clipboard data; otherwise returns false.

Calls C++ function: bool QClipboard::ownsClipboard() const.

C++ documentation:

Returns true if this clipboard object owns the clipboard data; otherwise returns false.

pub unsafe fn owns_find_buffer(&self) -> bool

Returns true if this clipboard object owns the find buffer data; otherwise returns false.

Calls C++ function: bool QClipboard::ownsFindBuffer() const.

C++ documentation:

Returns true if this clipboard object owns the find buffer data; otherwise returns false.

This function was introduced in Qt 4.2.

pub unsafe fn owns_selection(&self) -> bool

Returns true if this clipboard object owns the mouse selection data; otherwise returns false.

Calls C++ function: bool QClipboard::ownsSelection() const.

C++ documentation:

Returns true if this clipboard object owns the mouse selection data; otherwise returns false.

pub unsafe fn pixmap_1a(&self, mode: Mode) -> CppBox<QPixmap>

Returns the clipboard pixmap, or null if the clipboard does not contain a pixmap. Note that this can lose information. For example, if the image is 24-bit and the display is 8-bit, the result is converted to 8 bits, and if the image has an alpha channel, the result just has a mask.

Calls C++ function: QPixmap QClipboard::pixmap(QClipboard::Mode mode = …) const.

C++ documentation:

Returns the clipboard pixmap, or null if the clipboard does not contain a pixmap. Note that this can lose information. For example, if the image is 24-bit and the display is 8-bit, the result is converted to 8 bits, and if the image has an alpha channel, the result just has a mask.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the pixmap is retrieved from the global clipboard. If mode is QClipboard::Selection, the pixmap is retrieved from the global mouse selection.

See also setPixmap(), image(), mimeData(), and QPixmap::convertFromImage().

pub unsafe fn pixmap_0a(&self) -> CppBox<QPixmap>

Returns the clipboard pixmap, or null if the clipboard does not contain a pixmap. Note that this can lose information. For example, if the image is 24-bit and the display is 8-bit, the result is converted to 8 bits, and if the image has an alpha channel, the result just has a mask.

Calls C++ function: QPixmap QClipboard::pixmap() const.

C++ documentation:

Returns the clipboard pixmap, or null if the clipboard does not contain a pixmap. Note that this can lose information. For example, if the image is 24-bit and the display is 8-bit, the result is converted to 8 bits, and if the image has an alpha channel, the result just has a mask.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the pixmap is retrieved from the global clipboard. If mode is QClipboard::Selection, the pixmap is retrieved from the global mouse selection.

See also setPixmap(), image(), mimeData(), and QPixmap::convertFromImage().

pub unsafe fn qt_metacall(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int QClipboard::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* QClipboard::qt_metacast(const char* arg1).

pub unsafe fn set_image_2a(&self, arg1: impl CastInto<Ref<QImage>>, mode: Mode)

Copies the image into the clipboard.

Calls C++ function: void QClipboard::setImage(const QImage& arg1, QClipboard::Mode mode = …).

C++ documentation:

Copies the image into the clipboard.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the image is stored in the global clipboard. If mode is QClipboard::Selection, the data is stored in the global mouse selection.

This is shorthand for:

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

See also image(), setPixmap(), and setMimeData().

pub unsafe fn set_image_1a(&self, arg1: impl CastInto<Ref<QImage>>)

Copies the image into the clipboard.

Calls C++ function: void QClipboard::setImage(const QImage& arg1).

C++ documentation:

Copies the image into the clipboard.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the image is stored in the global clipboard. If mode is QClipboard::Selection, the data is stored in the global mouse selection.

This is shorthand for:

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

See also image(), setPixmap(), and setMimeData().

pub unsafe fn set_mime_data_2a(
    &self,
    data: impl CastInto<Ptr<QMimeData>>,
    mode: Mode
)

Sets the clipboard data to src. Ownership of the data is transferred to the clipboard. If you want to remove the data either call clear() or call setMimeData() again with new data.

Calls C++ function: void QClipboard::setMimeData(QMimeData* data, QClipboard::Mode mode = …).

C++ documentation:

Sets the clipboard data to src. Ownership of the data is transferred to the clipboard. If you want to remove the data either call clear() or call setMimeData() again with new data.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the data is stored in the global clipboard. If mode is QClipboard::Selection, the data is stored in the global mouse selection. If mode is QClipboard::FindBuffer, the data is stored in the search string buffer.

The setText(), setImage() and setPixmap() functions are simpler wrappers for setting text, image and pixmap data respectively.

See also mimeData().

pub unsafe fn set_mime_data_1a(&self, data: impl CastInto<Ptr<QMimeData>>)

Sets the clipboard data to src. Ownership of the data is transferred to the clipboard. If you want to remove the data either call clear() or call setMimeData() again with new data.

Calls C++ function: void QClipboard::setMimeData(QMimeData* data).

C++ documentation:

Sets the clipboard data to src. Ownership of the data is transferred to the clipboard. If you want to remove the data either call clear() or call setMimeData() again with new data.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the data is stored in the global clipboard. If mode is QClipboard::Selection, the data is stored in the global mouse selection. If mode is QClipboard::FindBuffer, the data is stored in the search string buffer.

The setText(), setImage() and setPixmap() functions are simpler wrappers for setting text, image and pixmap data respectively.

See also mimeData().

pub unsafe fn set_pixmap_2a(
    &self,
    arg1: impl CastInto<Ref<QPixmap>>,
    mode: Mode
)

Copies pixmap into the clipboard. Note that this is slower than setImage() because it needs to convert the QPixmap to a QImage first.

Calls C++ function: void QClipboard::setPixmap(const QPixmap& arg1, QClipboard::Mode mode = …).

C++ documentation:

Copies pixmap into the clipboard. Note that this is slower than setImage() because it needs to convert the QPixmap to a QImage first.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the pixmap is stored in the global clipboard. If mode is QClipboard::Selection, the pixmap is stored in the global mouse selection.

See also pixmap(), setImage(), and setMimeData().

pub unsafe fn set_pixmap_1a(&self, arg1: impl CastInto<Ref<QPixmap>>)

Copies pixmap into the clipboard. Note that this is slower than setImage() because it needs to convert the QPixmap to a QImage first.

Calls C++ function: void QClipboard::setPixmap(const QPixmap& arg1).

C++ documentation:

Copies pixmap into the clipboard. Note that this is slower than setImage() because it needs to convert the QPixmap to a QImage first.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the pixmap is stored in the global clipboard. If mode is QClipboard::Selection, the pixmap is stored in the global mouse selection.

See also pixmap(), setImage(), and setMimeData().

pub unsafe fn set_text_2a(&self, arg1: impl CastInto<Ref<QString>>, mode: Mode)

Copies text into the clipboard as plain text.

Calls C++ function: void QClipboard::setText(const QString& arg1, QClipboard::Mode mode = …).

C++ documentation:

Copies text into the clipboard as plain text.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the text is stored in the global clipboard. If mode is QClipboard::Selection, the text is stored in the global mouse selection. If mode is QClipboard::FindBuffer, the text is stored in the search string buffer.

See also text() and setMimeData().

pub unsafe fn set_text_1a(&self, arg1: impl CastInto<Ref<QString>>)

Copies text into the clipboard as plain text.

Calls C++ function: void QClipboard::setText(const QString& arg1).

C++ documentation:

Copies text into the clipboard as plain text.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the text is stored in the global clipboard. If mode is QClipboard::Selection, the text is stored in the global mouse selection. If mode is QClipboard::FindBuffer, the text is stored in the search string buffer.

See also text() and setMimeData().

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn supports_find_buffer(&self) -> bool

Returns true if the clipboard supports a separate search buffer; otherwise returns false.

Calls C++ function: bool QClipboard::supportsFindBuffer() const.

C++ documentation:

Returns true if the clipboard supports a separate search buffer; otherwise returns false.

pub unsafe fn supports_selection(&self) -> bool

Returns true if the clipboard supports mouse selection; otherwise returns false.

Calls C++ function: bool QClipboard::supportsSelection() const.

C++ documentation:

Returns true if the clipboard supports mouse selection; otherwise returns false.

pub unsafe fn text_mode(&self, mode: Mode) -> CppBox<QString>

Returns the clipboard text as plain text, or an empty string if the clipboard does not contain any text.

Calls C++ function: QString QClipboard::text(QClipboard::Mode mode = …) const.

C++ documentation:

Returns the clipboard text as plain text, or an empty string if the clipboard does not contain any text.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the text is retrieved from the global clipboard. If mode is QClipboard::Selection, the text is retrieved from the global mouse selection. If mode is QClipboard::FindBuffer, the text is retrieved from the search string buffer.

See also setText() and mimeData().

pub unsafe fn text_q_string_mode(
    &self,
    subtype: impl CastInto<Ref<QString>>,
    mode: Mode
) -> CppBox<QString>

This is an overloaded function.

Calls C++ function: QString QClipboard::text(QString& subtype, QClipboard::Mode mode = …) const.

C++ documentation:

This is an overloaded function.

Returns the clipboard text in subtype subtype, or an empty string if the clipboard does not contain any text. If subtype is null, any subtype is acceptable, and subtype is set to the chosen subtype.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the text is retrieved from the global clipboard. If mode is QClipboard::Selection, the text is retrieved from the global mouse selection.

Common values for subtype are "plain" and "html".

Note that calling this function repeatedly, for instance from a key event handler, may be slow. In such cases, you should use the dataChanged() signal instead.

See also setText() and mimeData().

pub unsafe fn text(&self) -> CppBox<QString>

Returns the clipboard text as plain text, or an empty string if the clipboard does not contain any text.

Calls C++ function: QString QClipboard::text() const.

C++ documentation:

Returns the clipboard text as plain text, or an empty string if the clipboard does not contain any text.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the text is retrieved from the global clipboard. If mode is QClipboard::Selection, the text is retrieved from the global mouse selection. If mode is QClipboard::FindBuffer, the text is retrieved from the search string buffer.

See also setText() and mimeData().

pub unsafe fn text_q_string(
    &self,
    subtype: impl CastInto<Ref<QString>>
) -> CppBox<QString>

This is an overloaded function.

Calls C++ function: QString QClipboard::text(QString& subtype) const.

C++ documentation:

This is an overloaded function.

Returns the clipboard text in subtype subtype, or an empty string if the clipboard does not contain any text. If subtype is null, any subtype is acceptable, and subtype is set to the chosen subtype.

The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard, the text is retrieved from the global clipboard. If mode is QClipboard::Selection, the text is retrieved from the global mouse selection.

Common values for subtype are "plain" and "html".

Note that calling this function repeatedly, for instance from a key event handler, may be slow. In such cases, you should use the dataChanged() signal instead.

See also setText() and mimeData().

pub unsafe fn tr(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QClipboard::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QClipboard::trUtf8(const char* s, const char* c, int n).

Trait Implementations

impl Deref for QClipboard

type Target = QObject

The resulting type after dereferencing.

fn deref(&self) -> &QObject

Calls C++ function: QObject* static_cast<QObject*>(QClipboard* ptr).

impl DynamicCast<QClipboard> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QClipboard>

Calls C++ function: QClipboard* dynamic_cast<QClipboard*>(QObject* ptr).

impl StaticDowncast<QClipboard> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QClipboard>

Calls C++ function: QClipboard* static_cast<QClipboard*>(QObject* ptr).

impl StaticUpcast<QObject> for QClipboard

unsafe fn static_upcast(ptr: Ptr<QClipboard>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(QClipboard* ptr).