QClipboard¶

Synopsis¶

Functions¶

def clear ([mode=Clipboard])
def emitChanged (mode)
def image ([mode=Clipboard])
def mimeData ([mode=Clipboard])
def ownsClipboard ()
def ownsFindBuffer ()
def ownsMode (mode)
def ownsSelection ()
def pixmap ([mode=Clipboard])
def setImage (arg__1[, mode=Clipboard])
def setMimeData (data[, mode=Clipboard])
def setPixmap (arg__1[, mode=Clipboard])
def setText (arg__1[, mode=Clipboard])
def supportsFindBuffer ()
def supportsMode (mode)
def supportsSelection ()
def text ([mode=Clipboard])
def text (subtype[, mode=QClipboard.Clipboard])

Slots¶

def ownerDestroyed ()

Signals¶

def changed (mode)
def dataChanged ()
def findBufferChanged ()
def selectionChanged ()

Detailed Description¶

The PySide.QtGui.QClipboard class provides access to the window system clipboard.

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

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

There is a single PySide.QtGui.QClipboard object in an application, accessible as QApplication.clipboard() .

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

A typical example of the use of these functions follows:
def paste(self):
    clipboard = QApplication.clipboard()
    mimeData = clipboard.mimeData()

    if mimeData.hasImage():
        setPixmap(mimeData.imageData())
    elif mimeData.hasHtml():
        setText(mimeData.html())
        setTextFormat(Qt.RichText)
    elif (mimeData.hasText():
        setText(mimeData.text())
        setTextFormat(Qt.PlainText)
    else:
        setText(tr("Cannot display data"))

Notes for X11 Users¶

The X11 Window System has the concept of a separate selection and clipboard. When text is selected, it is immediately available as the global mouse selection. The global mouse selection may later be copied to the clipboard. By convention, the middle mouse button is used to paste the global mouse selection.

X11 also has the concept of ownership; if you change the selection within a window, X11 will only notify the owner and the previous owner of the change, i.e. it will not notify all applications that the selection or clipboard data changed.

Lastly, the X11 clipboard is event driven, i.e. the clipboard will not function properly if the event loop is not running. Similarly, it is recommended that the contents of the clipboard are stored or retrieved in direct response to user-input events, e.g. mouse button or key presses and releases. You should not store or retrieve the clipboard contents in response to timer or non-user-input events.

Since there is no standard way to copy and paste files between applications on X11, various MIME types and conventions are currently in use. For instance, Nautilus expects files to be supplied with a x-special/gnome-copied-files MIME type with data beginning with the cut/copy action, a newline character, and the URL of the file.

Notes for Mac OS X Users¶

Mac OS X supports a separate find buffer that holds the current search string in Find operations. This find clipboard can be accessed by specifying the FindBuffer mode.

Notes for Windows and Mac OS X Users¶

Windows and Mac OS X do not support the global mouse selection; they only supports the global clipboard, i.e. they only add text to the clipboard when an explicit copy or cut is made.

Windows and Mac OS X does not have the concept of ownership; the clipboard is a fully global resource so all applications are notified of changes.

See also

PySide.QtGui.QApplication

PySide.QtGui.QClipboard.Mode¶

This enum type is used to control which part of the system clipboard is used by QClipboard.mimeData() , QClipboard.setMimeData() and related functions.

Constant	Description
QClipboard.Clipboard	indicates that data should be stored and retrieved from the global clipboard.
QClipboard.Selection	indicates that data should be stored and retrieved from the global mouse selection. Support for `Selection` is provided only on systems with a global mouse selection (e.g. X11).
QClipboard.FindBuffer	indicates that data should be stored and retrieved from the Find buffer. This mode is used for holding search strings on Mac OS X.

See also

QClipboard.supportsSelection()

PySide.QtGui.QClipboard.changed(mode)¶

Parameters:	mode – `PySide.QtGui.QClipboard.Mode`

PySide.QtGui.QClipboard.clear([mode=Clipboard])¶

Parameters:	mode – `PySide.QtGui.QClipboard.Mode`

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.

PySide.QtGui.QClipboard.dataChanged()¶

PySide.QtGui.QClipboard.emitChanged(mode)¶

Parameters:	mode – `PySide.QtGui.QClipboard.Mode`

PySide.QtGui.QClipboard.findBufferChanged()¶

PySide.QtGui.QClipboard.image([mode=Clipboard])¶

Parameters:	mode – `PySide.QtGui.QClipboard.Mode`
Return type:	`PySide.QtGui.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.

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.

PySide.QtGui.QClipboard.mimeData([mode=Clipboard])¶

Parameters:	mode – `PySide.QtGui.QClipboard.Mode`
Return type:	`PySide.QtCore.QMimeData`

Returns a reference to a PySide.QtCore.QMimeData representation of the current clipboard data.

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 PySide.QtGui.QClipboard.text() , PySide.QtGui.QClipboard.image() , and PySide.QtGui.QClipboard.pixmap() functions are simpler wrappers for retrieving text, image, and pixmap data.

See also

PySide.QtGui.QClipboard.setMimeData()

PySide.QtGui.QClipboard.ownerDestroyed()¶

PySide.QtGui.QClipboard.ownsClipboard()¶

Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QClipboard.ownsFindBuffer()¶

Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QClipboard.ownsMode(mode)¶

Parameters:	mode – `PySide.QtGui.QClipboard.Mode`
Return type:	`PySide.QtCore.bool`

PySide.QtGui.QClipboard.ownsSelection()¶

Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QClipboard.pixmap([mode=Clipboard])¶

Parameters:	mode – `PySide.QtGui.QClipboard.Mode`
Return type:	`PySide.QtGui.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.

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.

PySide.QtGui.QClipboard.selectionChanged()¶

PySide.QtGui.QClipboard.setImage(arg__1[, mode=Clipboard])¶

Parameters:	arg__1 – `PySide.QtGui.QImage` mode – `PySide.QtGui.QClipboard.Mode`

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:

data = QMimeData()
data.setImageData(image)
clipboard.setMimeData(data, mode)

PySide.QtGui.QClipboard.setMimeData(data[, mode=Clipboard])¶

Parameters:	data – `PySide.QtCore.QMimeData` mode – `PySide.QtGui.QClipboard.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 PySide.QtGui.QClipboard.clear() or call PySide.QtGui.QClipboard.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 PySide.QtGui.QClipboard.setText() , PySide.QtGui.QClipboard.setImage() and PySide.QtGui.QClipboard.setPixmap() functions are simpler wrappers for setting text, image and pixmap data respectively.

See also

PySide.QtGui.QClipboard.mimeData()

PySide.QtGui.QClipboard.setPixmap(arg__1[, mode=Clipboard])¶

Parameters:	arg__1 – `PySide.QtGui.QPixmap` mode – `PySide.QtGui.QClipboard.Mode`

Copies pixmap into the clipboard. Note that this is slower than PySide.QtGui.QClipboard.setImage() because it needs to convert the PySide.QtGui.QPixmap to a PySide.QtGui.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.

PySide.QtGui.QClipboard.setText(arg__1[, mode=Clipboard])¶

Parameters:	arg__1 – unicode mode – `PySide.QtGui.QClipboard.Mode`

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.

PySide.QtGui.QClipboard.supportsFindBuffer()¶

Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QClipboard.supportsMode(mode)¶

Parameters:	mode – `PySide.QtGui.QClipboard.Mode`
Return type:	`PySide.QtCore.bool`

PySide.QtGui.QClipboard.supportsSelection()¶

Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QClipboard.text(subtype[, mode=QClipboard.Clipboard])¶

Parameters:	subtype – unicode mode – `PySide.QtGui.QClipboard.Mode`
Return type:	(retval, subtype)

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.

PySide.QtGui.QClipboard.text([mode=Clipboard])

Parameters:	mode – `PySide.QtGui.QClipboard.Mode`
Return type:	unicode

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.

Table Of Contents

Previous topic

Next topic

QClipboard¶

Synopsis¶

Functions¶

Slots¶

Signals¶

Detailed Description¶

Notes for X11 Users¶

Notes for Mac OS X Users¶

Notes for Windows and Mac OS X Users¶

Table Of Contents

Previous topic

Next topic

Quick search

QClipboard¶

Synopsis¶

Functions¶

Slots¶

Signals¶

Detailed Description¶

Notes for X11 Users¶

Notes for Mac OS X Users¶

Notes for Windows and Mac OS X Users¶