com.trolltech.qt.gui
Class QClipboard

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.core.QObject
                  extended by com.trolltech.qt.gui.QClipboard
All Implemented Interfaces:
QtJambiInterface

public final class QClipboard
extends QObject

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();
        String originalText = clipboard.text();
        String newText = "new words";
        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:

The following code example is written in c++.

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

Notes for X11 Users

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

See also:
QApplication.


Nested Class Summary
static class 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.
static class QClipboard.Text
           
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 QSignalEmitter.Signal1 changed
          This signal takes 1 generic argument(s).
 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.
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Method Summary
 void clear()
          Clear the clipboard contents.
 void clear(QClipboard.Mode mode)
          Clear the clipboard contents.
 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 com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
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

changed

public final QSignalEmitter.Signal1 changed

This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <com.trolltech.qt.gui.QClipboard$Mode(named: mode)>:

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

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


dataChanged

public final QSignalEmitter.Signal0 dataChanged
This signal is emitted when the clipboard data is changed.

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.

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


findBufferChanged

public final QSignalEmitter.Signal0 findBufferChanged
This signal is emitted when the find buffer is changed. This only applies to Mac OS X.

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

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


selectionChanged

public final QSignalEmitter.Signal0 selectionChanged
This signal is emitted when the selection is changed. This only applies to windowing systems that support selections, e.g. X11. Windows and Mac OS X don't support selections.

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

Method Detail

clear

public final void clear()
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 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().


clear

public final void clear(QClipboard.Mode 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 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().


image

public final 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.

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().


image

public final 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.

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().


mimeData

public final QMimeData mimeData()
Returns a reference to a 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.

See also:
setMimeData().


mimeData

public final QMimeData mimeData(QClipboard.Mode mode)
Returns a reference to a 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.

See also:
setMimeData().


ownsClipboard

public final boolean ownsClipboard()
Returns true if this clipboard object owns the clipboard data; otherwise returns false.


ownsFindBuffer

public final boolean ownsFindBuffer()
Returns true if this clipboard object owns the find buffer data; otherwise returns false.


ownsSelection

public final boolean ownsSelection()
Returns true if this clipboard object owns the mouse selection data; otherwise returns false.


pixmap

public final QPixmap pixmap()
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().


pixmap

public final QPixmap pixmap(QClipboard.Mode mode)
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().


setImage

public final void setImage(QImage arg__1)
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, QClipboard.Mode.Clipboard);
        

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


setImage

public final void setImage(QImage arg__1,
                           QClipboard.Mode 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:

        QMimeData data = new QMimeData();
        data.setImageData(image);
        clipboard.setMimeData(data, QClipboard.Mode.Clipboard);
        

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


setMimeData

public final void setMimeData(QMimeData data)
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().


setMimeData

public final void setMimeData(QMimeData data,
                              QClipboard.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.

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().


setPixmap

public final void setPixmap(QPixmap arg__1)
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().


setPixmap

public final void setPixmap(QPixmap arg__1,
                            QClipboard.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.

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().


setText

public final void setText(java.lang.String arg__1)
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().


setText

public final void setText(java.lang.String arg__1,
                          QClipboard.Mode 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.

See also:
text(), and setMimeData().


supportsFindBuffer

public final boolean supportsFindBuffer()
Returns true if the clipboard supports a separate search buffer; otherwise returns false.


supportsSelection

public final boolean supportsSelection()
Returns true if the clipboard supports mouse selection; otherwise returns false.


text

public final java.lang.String text()
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().


text

public final 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.

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().


text

public final 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. 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().


text

public final 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.

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.