|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.core.QObject
com.trolltech.qt.gui.QClipboard
public final class QClipboard
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 QApplication::clipboard()
.
Example:
QClipboard *clipboard = QApplication::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()
.FindBuffer
mode.QApplication
.
Nested Class Summary | |
---|---|
static class |
QClipboard.Mode
|
static class |
QClipboard.Text
This enum specifies string information that an accessible object returns. |
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9 |
Field Summary | |
---|---|
QSignalEmitter.Signal1 |
changed
This signal is emitted when the data for the given clipboard mode is changed. |
QSignalEmitter.Signal0 |
dataChanged
This signal is emitted when the clipboard data is changed. |
QSignalEmitter.Signal0 |
findBufferChanged
This signal is emitted when the find buffer is changed. |
QSignalEmitter.Signal0 |
selectionChanged
This signal is emitted when the selection is changed. |
Method Summary | |
---|---|
void |
clear()
Clear the clipboard contents. |
void |
clear(QClipboard.Mode mode)
Clear the clipboard contents. |
static QClipboard |
fromNativePointer(QNativePointer nativePointer)
|
QImage |
image()
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. |
QImage |
image(QClipboard.Mode mode)
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. |
QMimeData |
mimeData()
Returns a reference to a QMimeData representation of the current clipboard data. |
QMimeData |
mimeData(QClipboard.Mode mode)
Returns a reference to a QMimeData representation of the current clipboard data. |
boolean |
ownsClipboard()
Returns true if this clipboard object owns the clipboard data; otherwise returns false. |
boolean |
ownsFindBuffer()
Returns true if this clipboard object owns the find buffer data; otherwise returns false. |
boolean |
ownsSelection()
Returns true if this clipboard object owns the mouse selection data; otherwise returns false. |
QPixmap |
pixmap()
Returns the clipboard pixmap, or null if the clipboard does not contain a pixmap. |
QPixmap |
pixmap(QClipboard.Mode mode)
Returns the clipboard pixmap, or null if the clipboard does not contain a pixmap. |
void |
setImage(QImage arg__1)
Copies the image into the clipboard. |
void |
setImage(QImage arg__1,
QClipboard.Mode mode)
Copies the image into the clipboard. |
void |
setMimeData(QMimeData data)
Sets the clipboard data to src. |
void |
setMimeData(QMimeData data,
QClipboard.Mode mode)
Sets the clipboard data to src. |
void |
setPixmap(QPixmap arg__1)
Copies pixmap into the clipboard. |
void |
setPixmap(QPixmap arg__1,
QClipboard.Mode mode)
Copies pixmap into the clipboard. |
void |
setText(java.lang.String arg__1)
Copies text into the clipboard as plain text. |
void |
setText(java.lang.String arg__1,
QClipboard.Mode mode)
Copies text into the clipboard as plain text. |
boolean |
supportsFindBuffer()
Returns true if the clipboard supports a separate search buffer; otherwise returns false. |
boolean |
supportsSelection()
Returns true if the clipboard supports mouse selection; otherwise returns false. |
java.lang.String |
text()
Returns the clipboard text as plain text, or an empty string if the clipboard does not contain any text. |
java.lang.String |
text(QClipboard.Mode mode)
Returns the clipboard text as plain text, or an empty string if the clipboard does not contain any text. |
QClipboard.Text |
text(java.lang.String subtype)
Returns the clipboard text as plain text, or an empty string if the clipboard does not contain any text. |
QClipboard.Text |
text(java.lang.String subtype,
QClipboard.Mode mode)
Returns the clipboard text in subtype subtype, or an empty string if the clipboard does not contain any text. |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread |
Methods inherited from class java.lang.Object |
---|
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal1 changed
dataChanged()
, selectionChanged()
, and findBufferChanged()
.
public final QSignalEmitter.Signal0 dataChanged
On Mac OS X and with Qt version 4.3 or higher, clipboard changes made by other applications will only be detected when the application is activated.
findBufferChanged()
, selectionChanged()
, and changed()
.
public final QSignalEmitter.Signal0 findBufferChanged
With Qt version 4.3 or higher, clipboard changes made by other applications will only be detected when the application is activated.
dataChanged()
, selectionChanged()
, and changed()
.
public final QSignalEmitter.Signal0 selectionChanged
dataChanged()
, findBufferChanged()
, and changed()
.
Method Detail |
---|
public final void clear()
The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard
, this function clears the 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.
QClipboard::Mode
, and supportsSelection()
.
public final void clear(QClipboard.Mode mode)
The mode argument is used to control which part of the system clipboard is used. If mode is QClipboard::Clipboard
, this function clears the 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.
QClipboard::Mode
, and supportsSelection()
.
public final QImage image()
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.
setImage()
, pixmap()
, mimeData()
, and QImage::isNull()
.
public final QImage image(QClipboard.Mode mode)
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.
setImage()
, pixmap()
, mimeData()
, and QImage::isNull()
.
public final QMimeData mimeData()
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 text()
, image()
, and pixmap()
functions are simpler wrappers for retrieving text, image, and pixmap data.
setMimeData()
.
public final QMimeData mimeData(QClipboard.Mode mode)
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 text()
, image()
, and pixmap()
functions are simpler wrappers for retrieving text, image, and pixmap data.
setMimeData()
.
public final boolean ownsClipboard()
public final boolean ownsFindBuffer()
public final boolean ownsSelection()
public final QPixmap pixmap()
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.
setPixmap()
, image()
, mimeData()
, and QPixmap::convertFromImage().
public final QPixmap pixmap(QClipboard.Mode mode)
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.
setPixmap()
, image()
, mimeData()
, and QPixmap::convertFromImage().
public final void setImage(QImage arg__1)
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);
image()
, setPixmap()
, and setMimeData()
.
public final void setImage(QImage arg__1, QClipboard.Mode mode)
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);
image()
, setPixmap()
, and setMimeData()
.
public final void setMimeData(QMimeData data)
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.
mimeData()
.
public final void setMimeData(QMimeData data, QClipboard.Mode mode)
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.
mimeData()
.
public final void setPixmap(QPixmap arg__1)
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.
pixmap()
, setImage()
, and setMimeData()
.
public final void setPixmap(QPixmap arg__1, QClipboard.Mode mode)
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.
pixmap()
, setImage()
, and setMimeData()
.
public final void setText(java.lang.String arg__1)
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.
text()
, and setMimeData()
.
public final void setText(java.lang.String arg__1, QClipboard.Mode mode)
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.
text()
, and setMimeData()
.
public final boolean supportsFindBuffer()
public final boolean supportsSelection()
public final java.lang.String 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.
setText()
, and mimeData()
.
public final java.lang.String text(QClipboard.Mode mode)
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.
setText()
, and mimeData()
.
public static QClipboard fromNativePointer(QNativePointer nativePointer)
public final QClipboard.Text text(java.lang.String subtype, QClipboard.Mode mode)
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.
setText()
, and mimeData()
.
public final QClipboard.Text text(java.lang.String 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. If mode is QClipboard.FindBuffer, the text is retrieved from the search string buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |