QClipboard Class Reference · PyQt4 中文文檔

# QClipboard Class Reference ## [[QtGui](index.htm) module] 該QClipboard類提供窗口系統剪貼板。[More...](#details) 繼承[QObject](qobject.html)。 ### Types * `enum Mode { Clipboard, Selection, FindBuffer }` ### Methods * `clear (self, Mode?mode?=?QClipboard.Clipboard)` * `connectNotify (self, SIGNAL())` * `bool event (self, QEvent)` * `QImage image (self, Mode?mode?=?QClipboard.Clipboard)` * `QMimeData mimeData (self, Mode?mode?=?QClipboard.Clipboard)` * `bool ownsClipboard (self)` * `bool ownsFindBuffer (self)` * `bool ownsSelection (self)` * `QPixmap pixmap (self, Mode?mode?=?QClipboard.Clipboard)` * `setImage (self, QImage, Mode?mode?=?QClipboard.Clipboard)` * `setMimeData (self, QMimeData?data, Mode?mode?=?QClipboard.Clipboard)` * `setPixmap (self, QPixmap, Mode?mode?=?QClipboard.Clipboard)` * `setText (self, QString, Mode?mode?=?QClipboard.Clipboard)` * `bool supportsFindBuffer (self)` * `bool supportsSelection (self)` * `QString text (self, Mode?mode?=?QClipboard.Clipboard)` * `(QString, QString) text (self, QString?subtype, Mode?mode?=?QClipboard.Clipboard)` * `QString text (self, QString?subtype, Mode?mode?=?QClipboard.Clipboard)` ### Qt Signals * `void changed (QClipboard::Mode)` * `void dataChanged ()` * `void findBufferChanged ()` * `void selectionChanged ()` * * * ## Detailed Description 該QClipboard類提供窗口系統剪貼板。剪貼板提供復制和粘貼應用程序之間的數據的簡單機制。 QClipboard支持相同的數據類型[QDrag](qdrag.html)確實，并采用類似的機制。對于高級剪貼板的使用讀[Drag and Drop](index.htm)。有一個在應用程序中的單個QClipboard對象??，作為訪問[QApplication.clipboard](qapplication.html#clipboard)（）。例如： ``` QClipboard *clipboard = [QApplication](qapplication.html).clipboard(); [QString](qstring.html) originalText = clipboard->text(); ... clipboard->setText(newText); ``` QClipboard具有一些方便的功能來訪問常用數據類型：[setText](qclipboard.html#setText)（）允許Unicode文本的交換和[setPixmap](qclipboard.html#setPixmap)（）和[setImage](qclipboard.html#setImage)（）允許應用程序之間QPixmaps和QImages的交流。該[setMimeData](qclipboard.html#setMimeData)（）函數是極大的靈活性：它可以讓你添加任何[QMimeData](qmimedata.html)復制到剪貼板中。有相應的getter為每個這些，例如[text](qclipboard.html#text)（）[image](qclipboard.html#image)（）和[pixmap](qclipboard.html#pixmap)（）。你可以通過調用清除剪貼板[clear](qclipboard.html#clear)（）。使用這些功能的一個典型例子如下： ``` void DropArea.paste() { const QClipboard *clipboard = [QApplication](qapplication.html).clipboard(); const [QMimeData](qmimedata.html) *mimeData = clipboard->mimeData(); if (mimeData->hasImage()) { setPixmap(qvariant_cast<[QPixmap](qpixmap.html)>(mimeData->imageData())); } else if (mimeData->hasHtml()) { setText(mimeData->html()); setTextFormat([Qt](qt.html).RichText); } else if (mimeData->hasText()) { setText(mimeData->text()); setTextFormat([Qt](qt.html).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支持保存在查找操作的當前搜索字符串單獨發現的緩沖區。這一發現剪貼板可以通過指定訪問的[FindBuffer](qclipboard.html#Mode-enum)模式。 ### 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. * * * ## Type Documentation ``` QClipboard.Mode ``` 該枚舉類型是用來控制系統剪貼板中的一部分是由[QClipboard.mimeData](qclipboard.html#mimeData)（）[QClipboard.setMimeData](qclipboard.html#setMimeData)（）和相關函數。 | Constant | Value | Description | | --- | --- | --- | | `QClipboard.Clipboard` | `0` | 表示數據應該存儲和從全局剪貼板中檢索。 | | `QClipboard.Selection` | `1` | 表示數據應該存儲和從全局鼠標選擇檢索。支持`Selection`是只設置一個全局鼠標選擇（例如X11 ）系統。 | | `QClipboard.FindBuffer` | `2` | 表示數據應該存儲和查找緩沖區中檢索。此模式用于保持搜索字符串在Mac OS X。 | **See also** [QClipboard.supportsSelection](qclipboard.html#supportsSelection)（）。 * * * ## Method Documentation ``` QClipboard.clear (self, Mode?mode?=?QClipboard.Clipboard) ``` 清除剪貼板內容。該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is [QClipboard.Clipboard](qclipboard.html#Mode-enum)，此功能清除全局剪貼板中的內容。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)這個函數清除全局鼠標選擇內容。如果_mode_ is [QClipboard.FindBuffer](qclipboard.html#Mode-enum)這個函數清除搜索字符串緩沖區。 **See also** [QClipboard.Mode](qclipboard.html#Mode-enum)和[supportsSelection](qclipboard.html#supportsSelection)（）。 ``` QClipboard.connectNotify (self, SIGNAL()) ``` ``` bool QClipboard.event (self, QEvent) ``` 從重新實現[QObject.event](qobject.html#event)（）。 ``` QImage QClipboard.image (self, Mode?mode?=?QClipboard.Clipboard) ``` [ 返回剪貼板中的圖像，或者返回一個空圖像，如果剪貼板中不包含的圖像，或者如果它包含一個圖像中不支持的圖像格式。 ](qimage.html) [該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is](qimage.html) [QClipboard.Clipboard](qclipboard.html#Mode-enum)時，圖像從全局剪貼板檢索。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)時，圖像從全局鼠標選擇檢索。 **See also** [setImage](qclipboard.html#setImage)（）[pixmap](qclipboard.html#pixmap)（）[mimeData](qclipboard.html#mimeData)（）和[QImage.isNull](qimage.html#isNull)（）。 ``` QMimeData QClipboard.mimeData (self, Mode?mode?=?QClipboard.Clipboard) ``` [](qmimedata.html) [返回一個引用](qmimedata.html)[QMimeData](qmimedata.html)當前剪貼板中的數據的代表性。該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is [QClipboard.Clipboard](qclipboard.html#Mode-enum)時，數據被從全局剪貼板檢索。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)時，數據被從全局鼠標選擇檢索。如果_mode_ is [QClipboard.FindBuffer](qclipboard.html#Mode-enum)時，數據被從該搜索字符串緩沖區中檢索。該[text](qclipboard.html#text)（）[image](qclipboard.html#image)（）和[pixmap](qclipboard.html#pixmap)（）函數用于檢索的文本，圖像和像素映射數據簡單包裝。 **See also** [setMimeData](qclipboard.html#setMimeData)（）。 ``` bool QClipboard.ownsClipboard (self) ``` 返回True如果剪貼板對象擁有的剪貼板數據，否則返回False 。 ``` bool QClipboard.ownsFindBuffer (self) ``` 返回True如果剪貼板對象擁有的查找緩沖區中的數據，否則返回False 。這個函數中引入了Qt 4.2中。 ``` bool QClipboard.ownsSelection (self) ``` 返回True如果剪貼板對象擁有鼠標選擇數據，否則返回False 。 ``` QPixmap QClipboard.pixmap (self, Mode?mode?=?QClipboard.Clipboard) ``` [ 返回剪貼板像素映射，或者null，如果剪貼板中不包含像素圖。請注意，這可能會丟失信息。例如，如果圖像是24位和顯示器是8位，則結果被轉換為8位，并且如果圖像具有alpha通道，結果正好有一個掩膜。 ](qpixmap.html) [該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is](qpixmap.html) [QClipboard.Clipboard](qclipboard.html#Mode-enum)，像素圖是從全局剪貼板中檢索。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)，像素圖是從全局鼠標選擇檢索。 **See also** [setPixmap](qclipboard.html#setPixmap)（）[image](qclipboard.html#image)（）[mimeData](qclipboard.html#mimeData)（）和[QPixmap.convertFromImage](qpixmap.html#convertFromImage)（）。 ``` QClipboard.setImage (self, QImage, Mode?mode?=?QClipboard.Clipboard) ``` 副本_image_復制到剪貼板中。該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is [QClipboard.Clipboard](qclipboard.html#Mode-enum)中，圖像被存儲在全局剪貼板。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)時，數據被存儲在全局鼠標選擇。這是簡寫： ``` [QMimeData](qmimedata.html) *data = new [QMimeData](qmimedata.html); data->setImageData(image); clipboard->setMimeData(data, mode); ``` **See also** [image](qclipboard.html#image)（）[setPixmap](qclipboard.html#setPixmap)（）和[setMimeData](qclipboard.html#setMimeData)（）。 ``` QClipboard.setMimeData (self, QMimeData?data, Mode?mode?=?QClipboard.Clipboard) ``` 剪貼板數據集_src_。該數據的所有權轉移到剪貼板。如果你想刪除數據或者調用[clear](qclipboard.html#clear)（）或致電setMimeData （）再次與新的數據。該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is [QClipboard.Clipboard](qclipboard.html#Mode-enum)時，數據被存儲在全局剪貼板。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)時，數據被存儲在全局鼠標選擇。如果_mode_ is [QClipboard.FindBuffer](qclipboard.html#Mode-enum)時，數據被存儲在搜索字符串緩沖區。該[setText](qclipboard.html#setText)（）[setImage](qclipboard.html#setImage)（）和[setPixmap](qclipboard.html#setPixmap)（）函數分別用于設置文本，圖像和像素映射數據簡單的包裝。 **See also** [mimeData](qclipboard.html#mimeData)（）。 ``` QClipboard.setPixmap (self, QPixmap, Mode?mode?=?QClipboard.Clipboard) ``` Copies _pixmap_復制到剪貼板中。注意，這是慢[setImage](qclipboard.html#setImage)（），因為它需要轉換的[QPixmap](qpixmap.html)到[QImage](qimage.html)第一。該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is [QClipboard.Clipboard](qclipboard.html#Mode-enum)，像素圖被存儲在全局剪貼板。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)，像素圖被存儲在全局鼠標選擇。 **See also** [pixmap](qclipboard.html#pixmap)（）[setImage](qclipboard.html#setImage)（）和[setMimeData](qclipboard.html#setMimeData)（）。 ``` QClipboard.setText (self, QString, Mode?mode?=?QClipboard.Clipboard) ``` Copies _text_到剪貼板為純文本。該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is [QClipboard.Clipboard](qclipboard.html#Mode-enum)，文本被存儲在全局剪貼板。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)，文本存儲在全局鼠標選擇。如果_mode_ is [QClipboard.FindBuffer](qclipboard.html#Mode-enum)，文本存儲在搜索字符串緩沖區。 **See also** [text](qclipboard.html#text)（）和[setMimeData](qclipboard.html#setMimeData)（）。 ``` bool QClipboard.supportsFindBuffer (self) ``` 返回True如果剪貼板支持一個單獨的搜索緩存，否則返回False 。 ``` bool QClipboard.supportsSelection (self) ``` 返回True如果剪貼板支持鼠標選擇，否則返回False 。 ``` QString QClipboard.text (self, Mode?mode?=?QClipboard.Clipboard) ``` 返回剪貼板中的文本為純文本，或者一個空字符串，如果剪貼板中不包含任何文本。該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is [QClipboard.Clipboard](qclipboard.html#Mode-enum)，文本從全局剪貼板中檢索。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)，該文本從全局鼠標選擇檢索。如果_mode_ is [QClipboard.FindBuffer](qclipboard.html#Mode-enum)，該文本從搜索字符串緩沖區中檢索。 **See also** [setText](qclipboard.html#setText)（）和[mimeData](qclipboard.html#mimeData)（）。 ``` (QString, QString) QClipboard.text (self, QString?subtype, Mode?mode?=?QClipboard.Clipboard) ``` 這是一個重載函數。返回亞型剪貼板文本_subtype_，或一個空字符串，如果剪貼板中不包含任何文本。如果_subtype_為null ，任何亞型是可以接受的，并且_subtype_被設置為所選擇的子類型。該_mode_參數用來控制哪些系統剪貼板的一部分使用。如果_mode_ is [QClipboard.Clipboard](qclipboard.html#Mode-enum)，文本從全局剪貼板中檢索。如果_mode_ is [QClipboard.Selection](qclipboard.html#Mode-enum)，該文本從全局鼠標選擇檢索。為共同的價值觀_subtype_是“普通”和“HTML” 。請注意，多次調用該函數，例如從一個關鍵的事件處理程序，可能會很慢。在這種情況下，你應該使用`dataChanged()`信號代替。 **See also** [setText](qclipboard.html#setText)（）和[mimeData](qclipboard.html#mimeData)（）。 ``` QString QClipboard.text (self, QString?subtype, Mode?mode?=?QClipboard.Clipboard) ``` * * * ## Qt Signal Documentation ``` void changed (QClipboard::Mode) ``` 這是該信號的默認超載。這個信號被發射時，對于給定的剪貼板中的數據_mode_被改變。這個函數中引入了Qt 4.2中。 **See also** [dataChanged](qclipboard.html#dataChanged)（）[selectionChanged](qclipboard.html#selectionChanged)（）和[findBufferChanged](qclipboard.html#findBufferChanged)（）。 ``` void dataChanged () ``` 這是該信號的默認超載。當剪貼板中的數據改變這個信號被發射。在Mac OS X和與Qt版本4.3或更高版本，由其他應用程序所做的剪貼板的變化將只檢測時，應用程序被激活。 **See also** [findBufferChanged](qclipboard.html#findBufferChanged)（）[selectionChanged](qclipboard.html#selectionChanged)（）和[changed](qclipboard.html#changed)（）。 ``` void findBufferChanged () ``` 這是該信號的默認超載。當發現緩沖區改變這個信號被發射。這僅適用于Mac OS X。與Qt版本4.3或更高版本，由其他應用程序所做的剪貼板的變化將只檢測時，應用程序被激活。這個函數中引入了Qt 4.2中。 **See also** [dataChanged](qclipboard.html#dataChanged)（）[selectionChanged](qclipboard.html#selectionChanged)（）和[changed](qclipboard.html#changed)（）。 ``` void selectionChanged () ``` 這是該信號的默認超載。當選擇改變這個信號被發射。這僅適用于支持選項窗口系統，例如X11 。 Windows和Mac OS X不支持選擇。 **See also** [dataChanged](qclipboard.html#dataChanged)（）[findBufferChanged](qclipboard.html#findBufferChanged)（）和[changed](qclipboard.html#changed)（）。