Referencia de la Clase QClipboard

The QClipboard class provides access to the window system clipboard. Más...

#include <qclipboard.h>

Diagrama de herencias de QClipboard

Lista de todos los miembros.

Tipos públicos
enum	Mode { Clipboard, Selection, Clipboard, Selection }
enum	Mode { Clipboard, Selection, Clipboard, Selection }
Señales
void	selectionChanged ()
void	dataChanged ()
void	selectionChanged ()
void	dataChanged ()
Métodos públicos
void	clear (Mode mode)
void	clear ()
bool	supportsSelection () const
bool	ownsSelection () const
bool	ownsClipboard () const
void	setSelectionMode (bool enable)
bool	selectionModeEnabled () const
QString	text (Mode mode) const
QString	text (QCString &subtype, Mode mode) const
void	setText (const QString &, Mode mode)
QMimeSource *	data (Mode mode) const
void	setData (QMimeSource *, Mode mode)
QImage	image (Mode mode) const
QPixmap	pixmap (Mode mode) const
void	setImage (const QImage &, Mode mode)
void	setPixmap (const QPixmap &, Mode mode)
QString	text () const
QString	text (QCString &subtype) const
void	setText (const QString &)
QMimeSource *	data () const
void	setData (QMimeSource *)
QImage	image () const
QPixmap	pixmap () const
void	setImage (const QImage &)
void	setPixmap (const QPixmap &)
void	clear (Mode mode)
void	clear ()
bool	supportsSelection () const
bool	ownsSelection () const
bool	ownsClipboard () const
void	setSelectionMode (bool enable)
bool	selectionModeEnabled () const
QString	text (Mode mode) const
QString	text (QCString &subtype, Mode mode) const
void	setText (const QString &, Mode mode)
QMimeSource *	data (Mode mode) const
void	setData (QMimeSource *, Mode mode)
QImage	image (Mode mode) const
QPixmap	pixmap (Mode mode) const
void	setImage (const QImage &, Mode mode)
void	setPixmap (const QPixmap &, Mode mode)
QString	text () const
QString	text (QCString &subtype) const
void	setText (const QString &)
QMimeSource *	data () const
void	setData (QMimeSource *)
QImage	image () const
QPixmap	pixmap () const
void	setImage (const QImage &)
void	setPixmap (const QPixmap &)
Métodos protegidos
void	connectNotify (const char *)
bool	event (QEvent *)
void	connectNotify (const char *)
bool	event (QEvent *)
Amigas
class	QApplication
class	QBaseApplication
class	QDragManager
class	QMimeSource

---

Descripción detallada

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 QDragObject does, and uses similar mechanisms. For advanced clipboard usage read the drag-and-drop documentation.

There is a single QClipboard object in an application, and you can access it using QApplication::clipboard().

Example:

    QClipboard *cb = QApplication::clipboard();

    // Copy text from the clipboard (paste)
    QString text = cb->text(QClipboard::Clipboard);
    if ( !text.isNull() )
        qDebug( "The clipboard contains: " + text );

    // Copy text into the clipboard
    cb->setText( "This text can be pasted by other programs",
                 QClipboard::Clipboard );

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 setData() function is the ultimate in flexibility: it allows you to add any QMimeSource 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().

---

Documentación de las enumeraciones miembro de la clase

enum QClipboard::Mode

clipboard mode

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

Clipboard indicates that data should be stored and retrieved from the global clipboard.

Selection indicates that data should be stored and retrieved from the global mouse selection.

Note: Support for Selection is provided only on systems with a global mouse selection (e.g. X11).

Ver también:

QClipboard::supportsSelection()

Valores de enumeraciones:

Clipboard
Selection
Clipboard
Selection

enum QClipboard::Mode

Valores de enumeraciones:

Clipboard
Selection
Clipboard
Selection

---

Documentación de las funciones miembro

void QClipboard::clear

(

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.

Ver también:

QClipboard::Mode, supportsSelection()

void QClipboard::clear

(

void

)

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. This function uses the QClipboard::clear() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

void QClipboard::clear

(

Mode

mode

)

void QClipboard::clear

(

)

void QClipboard::connectNotify

(

const char *

signal

)

[protected, virtual]

This virtual function is called when something has been connected to signal in this object.

Atención:

This function violates the object-oriented principle of modularity. However, it might be useful when you need to perform expensive initialization only if something is connected to a signal.

Ver también:

connect(), disconnectNotify()

Reimplementado de QObject.

void QClipboard::connectNotify

(

const char *

signal

)

[protected, virtual]

This virtual function is called when something has been connected to signal in this object.

Atención:

This function violates the object-oriented principle of modularity. However, it might be useful when you need to perform expensive initialization only if something is connected to a signal.

Ver también:

connect(), disconnectNotify()

Reimplementado de QObject.

QMimeSource * QClipboard::data

(

Mode

mode

)

const

Returns a reference to a QMimeSource 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.

Ver también:

setData()

QMimeSource * QClipboard::data

(

)

const

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. This function uses the QClipboard::data() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

QMimeSource* QClipboard::data

(

Mode

mode

)

const

QMimeSource* QClipboard::data

(

)

const

void QClipboard::dataChanged

(

)

[signal]

void QClipboard::dataChanged

(

)

[signal]

This signal is emitted when the clipboard data is changed.

bool QClipboard::event

(

QEvent *

e

)

[protected, virtual]

Reimplementado de QObject.

bool QClipboard::event

(

QEvent *

e

)

[protected, virtual]

This virtual function receives events to an object and should return TRUE if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Ver también:

installEventFilter(), timerEvent(), QApplication::sendEvent(), QApplication::postEvent(), QWidget::event()

Reimplementado de QObject.

QImage QClipboard::image

(

Mode

mode

)

const

QImage QClipboard::image

(

)

const

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. This function uses the QClipboard::image() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

QImage QClipboard::image

(

Mode

mode

)

const

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.

Ver también:

setImage() pixmap() data(), QImage::isNull()

QImage QClipboard::image

(

)

const

bool QClipboard::ownsClipboard

(

)

const

bool QClipboard::ownsClipboard

(

)

const

Returns TRUE if this clipboard object owns the clipboard data; otherwise returns FALSE.

bool QClipboard::ownsSelection

(

)

const

Returns TRUE if this clipboard object owns the mouse selection data; otherwise returns FALSE.

bool QClipboard::ownsSelection

(

)

const

QPixmap QClipboard::pixmap

(

Mode

mode

)

const

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.

Ver también:

setPixmap() image() data() QPixmap::convertFromImage().

QPixmap QClipboard::pixmap

(

Mode

mode

)

const

QPixmap QClipboard::pixmap

(

)

const

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. This function uses the QClipboard::pixmap() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

QPixmap QClipboard::pixmap

(

)

const

void QClipboard::selectionChanged

(

)

[signal]

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

void QClipboard::selectionChanged

(

)

[signal]

bool QClipboard::selectionModeEnabled

(

)

const

bool QClipboard::selectionModeEnabled

(

)

const

Use the QClipboard::data(), QClipboard::setData() and related functions which take a QClipboard::Mode argument.

Returns the selection mode.

Ver también:

setSelectionMode(), supportsSelection()

void QClipboard::setData	(	QMimeSource *	src,
		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 setData() 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 retrieved from the global clipboard. If mode is QClipboard::Selection, the data is retrieved from the global mouse selection.

The QDragObject subclasses are reasonable objects to put into the clipboard (but do not try to call QDragObject::drag() on the same object). Any QDragObject placed in the clipboard should have a parent of 0. Do not put QDragMoveEvent or QDropEvent subclasses in the clipboard, as they do not belong to the event handler which receives them.

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

Ver también:

data()

void QClipboard::setData	(	QMimeSource *	,
		Mode	mode
	)

void QClipboard::setData

(

QMimeSource *

)

void QClipboard::setData

(

QMimeSource *

src

)

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. This function uses the QClipboard::setData() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

void QClipboard::setImage	(	const QImage &	,
		Mode	mode
	)

void QClipboard::setImage

(

const QImage &

image

)

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. This function uses the QClipboard::setImage() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

void QClipboard::setImage

(

const QImage &

)

void QClipboard::setImage	(	const QImage &	image,
		Mode	mode
	)

Copies 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:

        setData( new QImageDrag(image), mode )

Ver también:

image(), setPixmap() setData()

void QClipboard::setPixmap	(	const QPixmap &	pixmap,
		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.

Ver también:

pixmap() setImage() setData()

void QClipboard::setPixmap

(

const QPixmap &

)

void QClipboard::setPixmap	(	const QPixmap &	,
		Mode	mode
	)

void QClipboard::setPixmap

(

const QPixmap &

pixmap

)

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. This function uses the QClipboard::setPixmap() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

void QClipboard::setSelectionMode

(

bool

enable

)

void QClipboard::setSelectionMode

(

bool

enable

)

Use the QClipboard::data(), QClipboard::setData() and related functions which take a QClipboard::Mode argument.

Sets the clipboard selection mode. If enable is TRUE, then subsequent calls to QClipboard::setData() and other functions which put data into the clipboard will put the data into the mouse selection, otherwise the data will be put into the clipboard.

Ver también:

supportsSelection(), selectionModeEnabled()

void QClipboard::setText	(	const QString &	,
		Mode	mode
	)

void QClipboard::setText	(	const QString &	text,
		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.

Ver también:

text(), setData()

void QClipboard::setText

(

const QString &

text

)

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. This function uses the QClipboard::setText() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

void QClipboard::setText

(

const QString &

)

bool QClipboard::supportsSelection

(

)

const

Returns TRUE if the clipboard supports mouse selection; otherwise returns FALSE.

bool QClipboard::supportsSelection

(

)

const

QString QClipboard::text

(

QCString &

subtype

)

const

QString QClipboard::text

(

QCString &

subtype

)

const

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. Returns the clipboard text in subtype subtype, or a null string if the clipboard does not contain any text. This function uses the QClipboard::text() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

QString QClipboard::text	(	QCString &	subtype,
		Mode	mode
	)		const

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. Returns the clipboard text in subtype subtype, or a null 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".

Ver también:

setText(), data(), QString::operator!()

QString QClipboard::text

(

)

const

Esta es una función miembro sobrecargada que se suministra por conveniencia. Difiere de la anterior función solamente en los argumentos que acepta. This function uses the QClipboard::text() function which takes a QClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is QClipboard::Selection, otherwise the mode argument is QClipboard::Clipboard.

QString QClipboard::text

(

Mode

mode

)

const

Returns the clipboard text as plain text, or a null 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.

Ver también:

setText(), data(), QString::operator!()

QString QClipboard::text

(

Mode

mode

)

const

QString QClipboard::text	(	QCString &	subtype,
		Mode	mode
	)		const

QString QClipboard::text

(

)

const

---

Documentación de las funciones relacionadas y clases amigas

QApplication [friend]

Reimplementado de QObject.

QBaseApplication [friend]

Reimplementado de QObject.

QDragManager [friend]

QMimeSource [friend]

---

La documentación para esta clase fue generada a partir de los siguientes ficheros:

• src/qt/include/qclipboard.h
• src/qt/src/kernel/qclipboard.h
• src/qt/src/.moc/release-shared-mt/moc_qclipboard.cpp
• src/qt/src/kernel/qclipboard.cpp
• src/qt/src/kernel/qclipboard_mac.cpp
• src/qt/src/kernel/qclipboard_win.cpp
• src/qt/src/kernel/qclipboard_x11.cpp